AgentsClient.DeleteVectorStoreFileAsync Method

Definition

Namespace:

Azure.AI.Projects

Assembly:

Azure.AI.Projects.dll

Package:

Azure.AI.Projects v1.0.0-beta.1

Overloads

DeleteVectorStoreFileAsync(String, String, RequestContext)

[Protocol Method] 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. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler DeleteVectorStoreFileAsync(String, String, CancellationToken) convenience overload with strongly typed models first.

DeleteVectorStoreFileAsync(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.

DeleteVectorStoreFileAsync(String, String, RequestContext)

Source:

AgentsClient.cs

[Protocol Method] 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.

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
• Please try the simpler DeleteVectorStoreFileAsync(String, String, CancellationToken) convenience overload with strongly typed models first.

public virtual System.Threading.Tasks.Task<Azure.Response> DeleteVectorStoreFileAsync (string vectorStoreId, string fileId, Azure.RequestContext context);

abstract member DeleteVectorStoreFileAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteVectorStoreFileAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function DeleteVectorStoreFileAsync (vectorStoreId As String, fileId As String, context As RequestContext) As Task(Of Response)

Parameters

vectorStoreId

String

Identifier of the vector store.

fileId

String

Identifier of the file.

context

RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Task<Response>

The response returned from the service.

Exceptions

ArgumentNullException

vectorStoreId or fileId is null.

ArgumentException

vectorStoreId or fileId is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

DeleteVectorStoreFileAsync(String, String, CancellationToken)

Source:

AgentsClient.cs

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.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.Projects.VectorStoreFileDeletionStatus>> DeleteVectorStoreFileAsync (string vectorStoreId, string fileId, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteVectorStoreFileAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Projects.VectorStoreFileDeletionStatus>>
override this.DeleteVectorStoreFileAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Projects.VectorStoreFileDeletionStatus>>

Public Overridable Function DeleteVectorStoreFileAsync (vectorStoreId As String, fileId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of VectorStoreFileDeletionStatus))

Parameters

vectorStoreId

String

Identifier of the vector store.

fileId

String

Identifier of the file.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<VectorStoreFileDeletionStatus>>

Exceptions

ArgumentNullException

vectorStoreId or fileId is null.

ArgumentException

vectorStoreId or fileId is an empty string, and was expected to be non-empty.