AgentsClient.GetVectorStoreAsync Method

Definition

Namespace:

Azure.AI.Projects

Assembly:

Azure.AI.Projects.dll

Package:

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

Overloads

GetVectorStoreAsync(String, RequestContext)	[Protocol Method] Returns 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 GetVectorStoreAsync(String, CancellationToken) convenience overload with strongly typed models first.
GetVectorStoreAsync(String, CancellationToken)	Returns the vector store object matching the specified ID.

GetVectorStoreAsync(String, RequestContext)

Source:

AgentsClient.cs

[Protocol Method] Returns 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 GetVectorStoreAsync(String, CancellationToken) convenience overload with strongly typed models first.

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

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

Public Overridable Function GetVectorStoreAsync (vectorStoreId As String, context As RequestContext) As Task(Of 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

Task<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.

GetVectorStoreAsync(String, CancellationToken)

Source:

AgentsClient.cs

Returns the vector store object matching the specified ID.

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

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

Public Overridable Function GetVectorStoreAsync (vectorStoreId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of VectorStore))

Parameters

vectorStoreId

String

Identifier of the vector store.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<VectorStore>>

Exceptions

ArgumentNullException

vectorStoreId is null.

ArgumentException

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