Interface IVectorStoreFiles

Namespace

OpenAI.Interfaces

Assembly

AntRunnerLib.dll

public interface IVectorStoreFiles

Methods

CancelVectorStoreFileBatch(String, String, CancellationToken)

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

Task<VectorStoreFileBatchObject> CancelVectorStoreFileBatch(string vectorStoreId, string batchId, CancellationToken cancellationToken = null)

Parameters

vectorStoreId System.String

batchId System.String

cancellationToken CancellationToken

Returns

Task<VectorStoreFileBatchObject>

CreateVectorStoreFile(String, CreateVectorStoreFileRequest, CancellationToken)

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

Task<VectorStoreFileObject> CreateVectorStoreFile(string vectorStoreId, CreateVectorStoreFileRequest requestBody, CancellationToken cancellationToken = null)

Parameters

vectorStoreId System.String

requestBody CreateVectorStoreFileRequest

cancellationToken CancellationToken

Returns

Task<VectorStoreFileObject>

CreateVectorStoreFileBatch(String, CreateVectorStoreFileBatchRequest, CancellationToken)

Create a vector store file batch.

Task<VectorStoreFileBatchObject> CreateVectorStoreFileBatch(string vectorStoreId, CreateVectorStoreFileBatchRequest requestBody, CancellationToken cancellationToken = null)

Parameters

vectorStoreId System.String

requestBody CreateVectorStoreFileBatchRequest

cancellationToken CancellationToken

Returns

Task<VectorStoreFileBatchObject>

DeleteVectorStoreFile(String, String, CancellationToken)

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, use the delete file endpoint.

Task<DeletionStatusResponse> DeleteVectorStoreFile(string vectorStoreId, string fileId, CancellationToken cancellationToken = null)

Parameters

vectorStoreId System.String

fileId System.String

cancellationToken CancellationToken

Returns

Task<DeletionStatusResponse>

GetVectorStoreFile(String, String, CancellationToken)

Retrieves a vector store file.

Task<VectorStoreFileObject> GetVectorStoreFile(string vectorStoreId, string fileId, CancellationToken cancellationToken = null)

Parameters

vectorStoreId System.String

fileId System.String

cancellationToken CancellationToken

Returns

Task<VectorStoreFileObject>

GetVectorStoreFileBatch(String, String, CancellationToken)

Retrieves a vector store file batch.

Task<VectorStoreFileBatchObject> GetVectorStoreFileBatch(string vectorStoreId, string batchId, CancellationToken cancellationToken = null)

Parameters

vectorStoreId System.String

batchId System.String

cancellationToken CancellationToken

Returns

Task<VectorStoreFileBatchObject>

ListFilesInVectorStoreBatch(String, String, PaginationRequest, CancellationToken)

Returns a list of vector store files in a batch.

Task<VectorStoreFileBatchListObjectResponse> ListFilesInVectorStoreBatch(string vectorStoreId, string batchId, PaginationRequest baseListRequest, CancellationToken cancellationToken = null)

Parameters

vectorStoreId System.String

batchId System.String

baseListRequest PaginationRequest

cancellationToken CancellationToken

Returns

Task<VectorStoreFileBatchListObjectResponse>

ListVectorStoreFiles(String, VectorStoreFileListRequest, CancellationToken)

Returns a list of vector store files.

Task<VectorStoreFileListObject> ListVectorStoreFiles(string vectorStoreId, VectorStoreFileListRequest baseListRequest, CancellationToken cancellationToken = null)

Parameters

vectorStoreId System.String

baseListRequest VectorStoreFileListRequest

cancellationToken CancellationToken

Returns

Task<VectorStoreFileListObject>