IOpenAIClient.GetVectorStoreFileBatchFilesAsync

IOpenAIClient.GetVectorStoreFileBatchFilesAsync method

Retrieves a list of files within a specific vector store file batch asynchronously.

public Task<VectorStoreFileListResponse> GetVectorStoreFileBatchFilesAsync(string vectorStoreId, 
    string fileBatchId, VectorStoreFileBatchFileListQueryParameters queryParameters = null, 
    CancellationToken? cancellationToken = default)
ParameterTypeDescription
vectorStoreIdStringThe ID of the vector store containing the file batch.
fileBatchIdStringThe ID of the file batch to retrieve files from.
queryParametersVectorStoreFileBatchFileListQueryParametersOptional query parameters to filter the list of files.
cancellationTokenNullable`1A token to cancel the operation.

Return Value

A task that represents the asynchronous operation. The task result contains a list of files within the file batch.

Exceptions

exceptioncondition
AIClientExceptionThrown when the vector store Id is null or empty.
AIClientExceptionThrown when the vector store file batch Id is null or empty.

See Also