Compartilhar via

AgentsClient.GetVectorStoreFileBatchFiles Method

  • Reference

Definition

Namespace:
Azure.AI.Projects
Assembly:
Azure.AI.Projects.dll
Package:
Azure.AI.Projects v1.0.0-beta.1

Overloads

GetVectorStoreFileBatchFiles(String, String, Nullable<VectorStoreFileStatusFilter>, Nullable<Int32>, Nullable<ListSortOrder>, String, String, CancellationToken)

Returns a list of vector store files in a batch.
GetVectorStoreFileBatchFiles(String, String, String, Nullable<Int32>, String, String, String, RequestContext)

[Protocol Method] Returns a list of vector store files in a batch.

GetVectorStoreFileBatchFiles(String, String, Nullable<VectorStoreFileStatusFilter>, Nullable<Int32>, Nullable<ListSortOrder>, String, String, CancellationToken)

Source:
AgentsClient.cs

Returns a list of vector store files in a batch.

public virtual Azure.Response<Azure.AI.Projects.AgentPageableListOfVectorStoreFile> GetVectorStoreFileBatchFiles (string vectorStoreId, string batchId, Azure.AI.Projects.VectorStoreFileStatusFilter? filter = default, int? limit = default, Azure.AI.Projects.ListSortOrder? order = default, string after = default, string before = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetVectorStoreFileBatchFiles : string * string * Nullable<Azure.AI.Projects.VectorStoreFileStatusFilter> * Nullable<int> * Nullable<Azure.AI.Projects.ListSortOrder> * string * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Projects.AgentPageableListOfVectorStoreFile>
override this.GetVectorStoreFileBatchFiles : string * string * Nullable<Azure.AI.Projects.VectorStoreFileStatusFilter> * Nullable<int> * Nullable<Azure.AI.Projects.ListSortOrder> * string * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Projects.AgentPageableListOfVectorStoreFile>
Public Overridable Function GetVectorStoreFileBatchFiles (vectorStoreId As String, batchId As String, Optional filter As Nullable(Of VectorStoreFileStatusFilter) = Nothing, 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 Response(Of AgentPageableListOfVectorStoreFile)

Parameters

vectorStoreId
String

Identifier of the vector store.

batchId
String

Identifier of the file batch.

filter
Nullable<VectorStoreFileStatusFilter>

Filter by file status.

limit
Nullable<Int32>

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

Response<AgentPageableListOfVectorStoreFile>

Exceptions

ArgumentNullException

vectorStoreId or batchId is null.

ArgumentException

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

Applies to

GetVectorStoreFileBatchFiles(String, String, String, Nullable<Int32>, String, String, String, RequestContext)

Source:
AgentsClient.cs

[Protocol Method] Returns a list of vector store files in a batch.

public virtual Azure.Response GetVectorStoreFileBatchFiles (string vectorStoreId, string batchId, string filter, int? limit, string order, string after, string before, Azure.RequestContext context);
abstract member GetVectorStoreFileBatchFiles : string * string * string * Nullable<int> * string * string * string * Azure.RequestContext -> Azure.Response
override this.GetVectorStoreFileBatchFiles : string * string * string * Nullable<int> * string * string * string * Azure.RequestContext -> Azure.Response
Public Overridable Function GetVectorStoreFileBatchFiles (vectorStoreId As String, batchId As String, filter As String, limit As Nullable(Of Integer), order As String, after As String, before As String, context As RequestContext) As Response

Parameters

vectorStoreId
String

Identifier of the vector store.

batchId
String

Identifier of the file batch.

filter
String

Filter by file status. Allowed values: "in_progress" | "completed" | "failed" | "cancelled".

limit
Nullable<Int32>

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

Response

The response returned from the service.

Exceptions

ArgumentNullException

vectorStoreId or batchId is null.

ArgumentException

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

RequestFailedException

Service returned a non-success status code.

Applies to