Skip to main content

vector_store_file_batches

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

Overview

Namevector_store_file_batches
TypeResource
Idopenai.vector_stores.vector_store_file_batches

Fields

NameDatatypeDescription
idstringThe identifier, which can be referenced in API endpoints.
created_atintegerThe Unix timestamp (in seconds) for when the vector store files batch was created.
file_countsobject
objectstringThe object type, which is always vector_store.file_batch.
statusstringThe status of the vector store files batch, which can be either in_progress, completed, cancelled or failed.
vector_store_idstringThe ID of the vector store that the File is attached to.

Methods

NameAccessible byRequired ParamsDescription
get_vector_store_file_batchSELECTbatch_id, vector_store_id
create_vector_store_file_batchINSERTvector_store_id, data__file_ids
cancel_vector_store_file_batchEXECbatch_id, vector_store_id

SELECT examples

SELECT
id,
created_at,
file_counts,
object,
status,
vector_store_id
FROM openai.vector_stores.vector_store_file_batches
WHERE batch_id = '{{ batch_id }}'
AND vector_store_id = '{{ vector_store_id }}';

INSERT example

Use the following StackQL query and manifest file to create a new vector_store_file_batches resource.

/*+ create */
INSERT INTO openai.vector_stores.vector_store_file_batches (
data__file_ids,
data__chunking_strategy,
vector_store_id
)
SELECT
'{{ file_ids }}',
'{{ chunking_strategy }}',
'{{ vector_store_id }}'
;