VectorStores
interface VectorStores
Vector stores are used to store files for use by the file_search tool.
Inheritors
Functions
Link copied to clipboard
abstract suspend fun cancel(vectorStoreId: <Error class: unknown class>, batchId: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>?
Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.
Link copied to clipboard
abstract suspend fun createVectorStore(request: <Error class: unknown class>? = null, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>
Create a new vector store.
Link copied to clipboard
abstract suspend fun createVectorStoreFile(id: <Error class: unknown class>, request: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>
Create a vector store file by attaching a File to a vector store.
Link copied to clipboard
abstract suspend fun createVectorStoreFilesBatch(id: <Error class: unknown class>, request: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>
Create a batch of vector store files.
Link copied to clipboard
abstract suspend fun delete(id: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): Boolean
Delete a vector store.
abstract suspend fun delete(id: <Error class: unknown class>, fileId: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): Boolean
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, OpenAI.delete(fileId).
Link copied to clipboard
abstract suspend fun updateVectorStore(id: <Error class: unknown class>, request: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>
Update a vector store.
Link copied to clipboard
abstract suspend fun vectorStore(id: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>?
Retrieve a vector store.
Link copied to clipboard
abstract suspend fun vectorStoreFileBatch(vectorStoreId: <Error class: unknown class>, batchId: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>?
Retrieves a vector store file batch.
Link copied to clipboard
abstract suspend fun vectorStoreFiles(id: <Error class: unknown class>, limit: Int? = null, order: <Error class: unknown class>? = null, after: <Error class: unknown class>? = null, before: <Error class: unknown class>? = null, filter: <Error class: unknown class>? = null, requestOptions: <Error class: unknown class>? = null): List<<Error class: unknown class>>
Returns a list of vector store files.
Link copied to clipboard
abstract suspend fun vectorStoreFilesBatches(vectorStoreId: <Error class: unknown class>, batchId: <Error class: unknown class>, limit: Int? = null, order: <Error class: unknown class>? = null, after: <Error class: unknown class>? = null, before: <Error class: unknown class>? = null, filter: <Error class: unknown class>? = null, requestOptions: <Error class: unknown class>? = null): List<<Error class: unknown class>>
Returns a list of vector store files in a batch.
Link copied to clipboard
abstract suspend fun vectorStores(limit: Int? = null, order: <Error class: unknown class>? = null, after: <Error class: unknown class>? = null, before: <Error class: unknown class>? = null, requestOptions: <Error class: unknown class>? = null): List<<Error class: unknown class>>
List all vector stores.