Package io.github.stefanbratanov.jvm.openai

Class VectorStoreFileBatchesClient

java.lang.Object

io.github.stefanbratanov.jvm.openai.VectorStoreFileBatchesClient

public final class VectorStoreFileBatchesClient
extends Object

Vector store file batches represent operations to add multiple files to a vector store.

Based on Vector Store File Batches

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VectorStoreFileBatchesClient.PaginatedVectorStoreFiles

Method Summary

Modifier and Type	Method	Description
VectorStoreFileBatch	cancelVectorStoreFileBatch(String vectorStoreId, String batchId)	Cancel a vector store file batch.
VectorStoreFileBatch	createVectorStoreFileBatch(String vectorStoreId, CreateVectorStoreFileBatchRequest request)	Create a vector store file batch.
VectorStoreFileBatchesClient.PaginatedVectorStoreFiles	listVectorStoreFilesInBatch(String vectorStoreId, String batchId, PaginationQueryParameters paginationQueryParameters, Optional<String> filter)	Returns a list of vector store files in a batch.
VectorStoreFileBatch	retrieveVectorStoreFileBatch(String vectorStoreId, String batchId)	Retrieves a vector store file batch.

Methods inherited from class java.lang.Object

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

Method Details

createVectorStoreFileBatch

public VectorStoreFileBatch createVectorStoreFileBatch(String vectorStoreId,
 CreateVectorStoreFileBatchRequest request)

Create a vector store file batch.

Throws:

OpenAIException - in case of API errors

retrieveVectorStoreFileBatch

public VectorStoreFileBatch retrieveVectorStoreFileBatch(String vectorStoreId,
 String batchId)

Retrieves a vector store file batch.

Throws:

OpenAIException - in case of API errors

cancelVectorStoreFileBatch

public VectorStoreFileBatch cancelVectorStoreFileBatch(String vectorStoreId,
 String batchId)

Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.

Throws:

OpenAIException - in case of API errors

listVectorStoreFilesInBatch

public VectorStoreFileBatchesClient.PaginatedVectorStoreFiles listVectorStoreFilesInBatch(String vectorStoreId,
 String batchId,
 PaginationQueryParameters paginationQueryParameters,
 Optional<String> filter)

Returns a list of vector store files in a batch.

Parameters:

filter - Filter by file status

Throws:

OpenAIException - in case of API errors