Share via

VectorStoreFileBatchesOperations interface

Package:
@azure/ai-agents

Interface representing a VectorStoreFileBatches operations.

Properties

cancel

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

Create a vector store file batch.
createAndPoll

Create a vector store file batch and poll.
get

Retrieve a vector store file batch.
list

Returns a list of vector store files in a batch.

Property Details

cancel

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

cancel: (vectorStoreId: string, batchId: string, options?: VectorStoreFileBatchesCancelVectorStoreFileBatchOptionalParams) => Promise<VectorStoreFileBatch>

Property Value

(vectorStoreId: string, batchId: string, options?: VectorStoreFileBatchesCancelVectorStoreFileBatchOptionalParams) => Promise<VectorStoreFileBatch>

create

Create a vector store file batch.

create: (vectorStoreId: string, options?: VectorStoreFileBatchesCreateVectorStoreFileBatchOptionalParams) => Promise<VectorStoreFileBatch>

Property Value

(vectorStoreId: string, options?: VectorStoreFileBatchesCreateVectorStoreFileBatchOptionalParams) => Promise<VectorStoreFileBatch>

createAndPoll

Create a vector store file batch and poll.

createAndPoll: (vectorStoreId: string, options?: VectorStoreFileBatchesCreateVectorStoreFileBatchOptionalParams) => PollerLike<OperationState<VectorStoreFileBatch>, VectorStoreFileBatch>

Property Value

(vectorStoreId: string, options?: VectorStoreFileBatchesCreateVectorStoreFileBatchOptionalParams) => PollerLike<OperationState<VectorStoreFileBatch>, VectorStoreFileBatch>

get

Retrieve a vector store file batch.

get: (vectorStoreId: string, batchId: string, options?: VectorStoreFileBatchesGetVectorStoreFileBatchOptionalParams) => Promise<VectorStoreFileBatch>

Property Value

(vectorStoreId: string, batchId: string, options?: VectorStoreFileBatchesGetVectorStoreFileBatchOptionalParams) => Promise<VectorStoreFileBatch>

list

Returns a list of vector store files in a batch.

list: (vectorStoreId: string, batchId: string, options?: VectorStoreFileBatchesListVectorStoreFileBatchFilesOptionalParams) => PagedAsyncIterableIterator<VectorStoreFileBatch, VectorStoreFileBatch[], PageSettings>

Property Value

(vectorStoreId: string, batchId: string, options?: VectorStoreFileBatchesListVectorStoreFileBatchFilesOptionalParams) => PagedAsyncIterableIterator<VectorStoreFileBatch, VectorStoreFileBatch[], PageSettings>