vector_store_file_batches

Creates, updates, deletes, gets or lists a vector_store_file_batches resource.

Overview

Name	vector_store_file_batches
Type	Resource
Id	azure.ai_agents.vector_store_file_batches

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The identifier, which can be referenced in API endpoints. Required.
vector_store_id	string	The ID of the vector store that the file is attached to. Required.
created_at	string (date-time)	The Unix timestamp (in seconds) for when the vector store files batch was created. Required.
file_counts	object	Files count grouped by status processed or being processed by this vector store. Required.
object	string	The object type, which is always vector_store.file_batch. Required. Default value is "vector_store.files_batch".
status	string	The status of the vector store files batch, which can be either in_progress, completed, cancelled or failed. Required. Known values are: "in_progress", "completed", "cancelled", and "failed". (in_progress, completed, cancelled, failed)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	vector_store_id, batch_id, endpoint		Retrieve a vector store file batch.
create	insert	vector_store_id, endpoint		Create a vector store file batch.
list_files	exec	vector_store_id, batch_id, endpoint	filter, limit, order, after, before	Returns a list of vector store files in a batch.
cancel	exec	vector_store_id, batch_id, endpoint		Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
batch_id	string	Identifier of the file batch. Required.
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
vector_store_id	string	Identifier of the vector store. Required.
after	string
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. Default value is None.
filter	string	Filter by file status. Known values are: "in_progress", "completed", "failed", and "cancelled". Default value is None.
limit	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. Default value is None.
order	string	Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. Known values are: "asc" and "desc". Default value is None.

SELECT examples

get

Retrieve a vector store file batch.

SELECT
id,
vector_store_id,
created_at,
file_counts,
object,
status
FROM azure.ai_agents.vector_store_file_batches
WHERE vector_store_id = '{{ vector_store_id }}' -- required
AND batch_id = '{{ batch_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

INSERT examples

create

Create a vector store file batch.

INSERT INTO azure.ai_agents.vector_store_file_batches (
vector_store_id,
endpoint
)
SELECT 
'{{ vector_store_id }}',
'{{ endpoint }}'
RETURNING
id,
vector_store_id,
created_at,
file_counts,
object,
status
;

Manifest

# Description fields are for documentation purposes
- name: vector_store_file_batches
props:
  - name: vector_store_id
    value: "{{ vector_store_id }}"
    description: Required parameter for the vector_store_file_batches resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the vector_store_file_batches resource.

Lifecycle Methods

list_files

Returns a list of vector store files in a batch.

EXEC azure.ai_agents.vector_store_file_batches.list_files 
@vector_store_id='{{ vector_store_id }}' --required, 
@batch_id='{{ batch_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@filter='{{ filter }}', 
@limit='{{ limit }}', 
@order='{{ order }}', 
@after='{{ after }}', 
@before='{{ before }}'
;

cancel

Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.

EXEC azure.ai_agents.vector_store_file_batches.cancel 
@vector_store_id='{{ vector_store_id }}' --required, 
@batch_id='{{ batch_id }}' --required, 
@endpoint='{{ endpoint }}' --required
;