Share via

VectorStoreFilesOperations interface

Package:
@azure/ai-agents

Interface representing a VectorStoreFiles operations.

Properties

create

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

Create a vector store file by attaching a file to a vector store and poll.
delete

Deletes a vector store file. This removes the file‐to‐store link (does not delete the file itself).
get

Retrieves a vector store file.
list

Returns a list of vector store files.

Property Details

create

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

create: (vectorStoreId: string, options?: VectorStoreFilesCreateVectorStoreFileOptionalParams) => Promise<VectorStoreFile>

Property Value

(vectorStoreId: string, options?: VectorStoreFilesCreateVectorStoreFileOptionalParams) => Promise<VectorStoreFile>

createAndPoll

Create a vector store file by attaching a file to a vector store and poll.

createAndPoll: (vectorStoreId: string, options?: VectorStoreFilesCreateVectorStoreFileOptionalParams) => PollerLike<OperationState<VectorStoreFile>, VectorStoreFile>

Property Value

(vectorStoreId: string, options?: VectorStoreFilesCreateVectorStoreFileOptionalParams) => PollerLike<OperationState<VectorStoreFile>, VectorStoreFile>

delete

Deletes a vector store file. This removes the file‐to‐store link (does not delete the file itself).

delete: (vectorStoreId: string, fileId: string, options?: VectorStoreFilesDeleteVectorStoreFileOptionalParams) => Promise<VectorStoreFileDeletionStatus>

Property Value

(vectorStoreId: string, fileId: string, options?: VectorStoreFilesDeleteVectorStoreFileOptionalParams) => Promise<VectorStoreFileDeletionStatus>

get

Retrieves a vector store file.

get: (vectorStoreId: string, fileId: string, options?: VectorStoreFilesGetVectorStoreFileOptionalParams) => Promise<VectorStoreFile>

Property Value

(vectorStoreId: string, fileId: string, options?: VectorStoreFilesGetVectorStoreFileOptionalParams) => Promise<VectorStoreFile>

list

Returns a list of vector store files.

list: (vectorStoreId: string, options?: VectorStoreFilesListVectorStoreFilesOptionalParams) => PagedAsyncIterableIterator<VectorStoreFile, VectorStoreFile[], PageSettings>

Property Value

(vectorStoreId: string, options?: VectorStoreFilesListVectorStoreFilesOptionalParams) => PagedAsyncIterableIterator<VectorStoreFile, VectorStoreFile[], PageSettings>