AgentsClient.DeleteVectorStore Method

Definition

Namespace:

Azure.AI.Projects

Assembly:

Azure.AI.Projects.dll

Package:

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

Overloads

DeleteVectorStore(String, RequestContext)	[Protocol Method] Deletes the vector store object matching the specified ID. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler DeleteVectorStore(String, CancellationToken) convenience overload with strongly typed models first.
DeleteVectorStore(String, CancellationToken)	Deletes the vector store object matching the specified ID.

DeleteVectorStore(String, RequestContext)

Source:

AgentsClient.cs

[Protocol Method] Deletes the vector store object matching the specified ID.

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

public virtual Azure.Response DeleteVectorStore (string vectorStoreId, Azure.RequestContext context);

abstract member DeleteVectorStore : string * Azure.RequestContext -> Azure.Response
override this.DeleteVectorStore : string * Azure.RequestContext -> Azure.Response

Public Overridable Function DeleteVectorStore (vectorStoreId As String, context As RequestContext) As Response

Parameters

vectorStoreId

String

Identifier of the vector store.

context

RequestContext

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

Returns

Response

The response returned from the service.

Exceptions

ArgumentNullException

vectorStoreId is null.

ArgumentException

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

RequestFailedException

Service returned a non-success status code.

DeleteVectorStore(String, CancellationToken)

Source:

AgentsClient.cs

Deletes the vector store object matching the specified ID.

public virtual Azure.Response<Azure.AI.Projects.VectorStoreDeletionStatus> DeleteVectorStore (string vectorStoreId, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteVectorStore : string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Projects.VectorStoreDeletionStatus>
override this.DeleteVectorStore : string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Projects.VectorStoreDeletionStatus>

Public Overridable Function DeleteVectorStore (vectorStoreId As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of VectorStoreDeletionStatus)

Parameters

vectorStoreId

String

Identifier of the vector store.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response<VectorStoreDeletionStatus>

Exceptions

ArgumentNullException

vectorStoreId is null.

ArgumentException

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