VectorStores.GetVectorStoreFileBatchFiles 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.
Returns a list of vector store files in a batch.
public virtual Azure.Pageable<Azure.AI.Agents.Persistent.VectorStoreFile> GetVectorStoreFileBatchFiles(string vectorStoreId, string batchId, Azure.AI.Agents.Persistent.VectorStoreFileStatusFilter? filter = default, int? limit = default, Azure.AI.Agents.Persistent.ListSortOrder? order = default, string after = default, string before = default, System.Threading.CancellationToken cancellationToken = default);abstract member GetVectorStoreFileBatchFiles : string * string * Nullable<Azure.AI.Agents.Persistent.VectorStoreFileStatusFilter> * Nullable<int> * Nullable<Azure.AI.Agents.Persistent.ListSortOrder> * string * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.AI.Agents.Persistent.VectorStoreFile>
override this.GetVectorStoreFileBatchFiles : string * string * Nullable<Azure.AI.Agents.Persistent.VectorStoreFileStatusFilter> * Nullable<int> * Nullable<Azure.AI.Agents.Persistent.ListSortOrder> * string * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.AI.Agents.Persistent.VectorStoreFile>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 Pageable(Of VectorStoreFile)Parameters
- vectorStoreId
- String
Identifier of the vector store.
- batchId
- String
Identifier of the file batch.
- filter
- Nullable<VectorStoreFileStatusFilter>
Filter by file status.
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
Exceptions
vectorStoreId or batchId is null.
vectorStoreId or batchId is an empty string, and was expected to be non-empty.
