AgentsClient.GetVectorStoresAsync 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
| GetVectorStoresAsync(Nullable<Int32>, Nullable<ListSortOrder>, String, String, CancellationToken) |
Returns a list of vector stores. |
| GetVectorStoresAsync(Nullable<Int32>, String, String, String, RequestContext) |
[Protocol Method] Returns a list of vector stores.
|
GetVectorStoresAsync(Nullable<Int32>, Nullable<ListSortOrder>, String, String, CancellationToken)
- Source:
- AgentsClient.cs
Returns a list of vector stores.
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.Projects.AgentPageableListOfVectorStore>> GetVectorStoresAsync (int? limit = default, Azure.AI.Projects.ListSortOrder? order = default, string after = default, string before = default, System.Threading.CancellationToken cancellationToken = default);abstract member GetVectorStoresAsync : Nullable<int> * Nullable<Azure.AI.Projects.ListSortOrder> * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Projects.AgentPageableListOfVectorStore>>
override this.GetVectorStoresAsync : Nullable<int> * Nullable<Azure.AI.Projects.ListSortOrder> * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Projects.AgentPageableListOfVectorStore>>Public Overridable Function GetVectorStoresAsync (Optional limit As Nullable(Of Integer) = Nothing, Optional order As Nullable(Of ListSortOrder) = Nothing, Optional after As String = Nothing, Optional before As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of AgentPageableListOfVectorStore))Parameters
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
- order
- Nullable<ListSortOrder>
Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.
- after
- String
A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
- before
- String
A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Applies to
GetVectorStoresAsync(Nullable<Int32>, String, String, String, RequestContext)
- Source:
- AgentsClient.cs
[Protocol Method] Returns a list of vector stores.
- This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
- Please try the simpler GetVectorStoresAsync(Nullable<Int32>, Nullable<ListSortOrder>, String, String, CancellationToken) convenience overload with strongly typed models first.
public virtual System.Threading.Tasks.Task<Azure.Response> GetVectorStoresAsync (int? limit, string order, string after, string before, Azure.RequestContext context);abstract member GetVectorStoresAsync : Nullable<int> * string * string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetVectorStoresAsync : Nullable<int> * string * string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function GetVectorStoresAsync (limit As Nullable(Of Integer), order As String, after As String, before As String, context As RequestContext) As Task(Of Response)Parameters
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
- order
- String
Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. Allowed values: "asc" | "desc".
- after
- String
A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
- before
- String
A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.
- 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
Service returned a non-success status code.
Applies to
Azure SDK for .NET