VectorStores.GetVectorStoreAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| Name | Description |
|---|---|
| GetVectorStoreAsync(String, RequestContext) |
[Protocol Method] Returns the vector store object matching the specified ID.
|
| GetVectorStoreAsync(String, CancellationToken) |
Returns the vector store object matching the specified ID. |
GetVectorStoreAsync(String, RequestContext)
- Source:
- VectorStores.cs
- Source:
- VectorStores.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
The response returned from the service.
Exceptions
vectorStoreId is null.
vectorStoreId is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
Applies to
GetVectorStoreAsync(String, CancellationToken)
- Source:
- VectorStores.cs
- Source:
- VectorStores.cs
Returns the vector store object matching the specified ID.
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.Agents.Persistent.PersistentAgentsVectorStore>> GetVectorStoreAsync(string vectorStoreId, System.Threading.CancellationToken cancellationToken = default);abstract member GetVectorStoreAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Agents.Persistent.PersistentAgentsVectorStore>>
override this.GetVectorStoreAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Agents.Persistent.PersistentAgentsVectorStore>>Public Overridable Function GetVectorStoreAsync (vectorStoreId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of PersistentAgentsVectorStore))Parameters
- vectorStoreId
- String
Identifier of the vector store.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Exceptions
vectorStoreId is null.
vectorStoreId is an empty string, and was expected to be non-empty.
