Package io.github.stefanbratanov.jvm.openai

Class VectorStoreFilesClient

java.lang.Object

io.github.stefanbratanov.jvm.openai.VectorStoreFilesClient

public final class VectorStoreFilesClient
extends Object

Vector store files represent files inside a vector store.

Based on Vector Store Files

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VectorStoreFilesClient.PaginatedVectorStoreFiles

Method Summary

Modifier and Type	Method	Description
VectorStoreFile	createVectorStoreFile(String vectorStoreId, CreateVectorStoreFileRequest request)	Create a vector store file by attaching a File to a vector store.
DeletionStatus	deleteVectorStoreFile(String vectorStoreId, String fileId)	Delete a vector store file.
VectorStoreFilesClient.PaginatedVectorStoreFiles	listVectorStoreFiles(String vectorStoreId, PaginationQueryParameters paginationQueryParameters)	Returns a list of vector store files.
VectorStoreFile	retrieveVectorStoreFile(String vectorStoreId, String fileId)	Retrieves a vector store file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

createVectorStoreFile

public VectorStoreFile createVectorStoreFile(String vectorStoreId,
 CreateVectorStoreFileRequest request)

Create a vector store file by attaching a File to a vector store.

Throws:

OpenAIException - in case of API errors

listVectorStoreFiles

public VectorStoreFilesClient.PaginatedVectorStoreFiles listVectorStoreFiles(String vectorStoreId,
 PaginationQueryParameters paginationQueryParameters)

Returns a list of vector store files.

Throws:

OpenAIException - in case of API errors

retrieveVectorStoreFile

public VectorStoreFile retrieveVectorStoreFile(String vectorStoreId,
 String fileId)

Retrieves a vector store file.

Throws:

OpenAIException - in case of API errors

deleteVectorStoreFile

public DeletionStatus deleteVectorStoreFile(String vectorStoreId,
 String fileId)

Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the delete file endpoint.

Throws:

OpenAIException - in case of API errors