OpenAI API

Vector store file batch

object

A batch of files attached to a vector store.

idstringrequired

The identifier, which can be referenced in API endpoints.

objectstringrequired

The object type, which is always vector_store.file_batch.

Allowed values:vector_store.files_batch

created_atintegerrequired

The Unix timestamp (in seconds) for when the vector store files batch was created.

vector_store_idstringrequired

The ID of the vector store that the File is attached to.

statusstringrequired

The status of the vector store files batch, which can be either in_progress, completed, cancelled or failed.

Allowed values:in_progresscompletedcancelledfailed

file_countsobjectrequired
Show Child Parameters
Example

Vector store files

object

A list of files attached to a vector store.

idstringrequired

The identifier, which can be referenced in API endpoints.

objectstringrequired

The object type, which is always vector_store.file.

Allowed values:vector_store.file

usage_bytesintegerrequired

The total vector store usage in bytes. Note that this may be different from the original file size.

created_atintegerrequired

The Unix timestamp (in seconds) for when the vector store file was created.

vector_store_idstringrequired

The ID of the vector store that the File is attached to.

statusstringrequired

The status of the vector store file, which can be either in_progress, completed, cancelled, or failed. The status completed indicates that the vector store file is ready for use.

Allowed values:in_progresscompletedcancelledfailed

last_errorobjectrequired

The last error associated with this vector store file. Will be null if there are no errors.

Show Child Parameters
chunking_strategyOne Of
object

The strategy used to chunk the file.

Static Chunking Strategyobject
* Additional properties are NOT allowed.
Show Child Parameters
Example

Vector store

object

A vector store is a collection of processed files can be used by the file_search tool.

idstringrequired

The identifier, which can be referenced in API endpoints.

objectstringrequired

The object type, which is always vector_store.

Allowed values:vector_store

created_atintegerrequired

The Unix timestamp (in seconds) for when the vector store was created.

namestringrequired

The name of the vector store.

usage_bytesintegerrequired

The total number of bytes used by the files in the vector store.

file_countsobjectrequired
Show Child Parameters
statusstringrequired

The status of the vector store, which can be either expired, in_progress, or completed. A status of completed indicates that the vector store is ready for use.

Allowed values:expiredin_progresscompleted

expires_afterobject

The expiration policy for a vector store.

Show Child Parameters
expires_atinteger

The Unix timestamp (in seconds) for when the vector store will expire.

last_active_atintegerrequired

The Unix timestamp (in seconds) for when the vector store was last active.

metadataobjectrequired

Set of 16 key-value pairs that can be attached to an object. This can be
useful for storing additional information about the object in a structured
format, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings
with a maximum length of 512 characters.

Example