Vector Stores
List vector stores
Create vector store
Retrieve vector store
Modify vector store
Delete vector store
Search vector store
ModelsExpand Collapse
AutoFileChunkingStrategyParam = object { type } The default strategy. This strategy currently uses a max_chunk_size_tokens of 800 and chunk_overlap_tokens of 400.
The default strategy. This strategy currently uses a max_chunk_size_tokens of 800 and chunk_overlap_tokens of 400.
Always auto.
FileChunkingStrategyParam = AutoFileChunkingStrategyParam { type } or StaticFileChunkingStrategyObjectParam { static, type } The chunking strategy used to chunk the file(s). If not set, will use the auto strategy.
The chunking strategy used to chunk the file(s). If not set, will use the auto strategy.
AutoFileChunkingStrategyParam = object { type } The default strategy. This strategy currently uses a max_chunk_size_tokens of 800 and chunk_overlap_tokens of 400.
The default strategy. This strategy currently uses a max_chunk_size_tokens of 800 and chunk_overlap_tokens of 400.
Always auto.
StaticFileChunkingStrategyObjectParam = object { static, type } Customize your own chunking strategy by setting chunk size and chunk overlap.
Customize your own chunking strategy by setting chunk size and chunk overlap.
Always static.
OtherFileChunkingStrategyObject = object { type } This is returned when the chunking strategy is unknown. Typically, this is because the file was indexed before the chunking_strategy concept was introduced in the API.
This is returned when the chunking strategy is unknown. Typically, this is because the file was indexed before the chunking_strategy concept was introduced in the API.
Always other.
StaticFileChunkingStrategy = object { chunk_overlap_tokens, max_chunk_size_tokens }
The number of tokens that overlap between chunks. The default value is 400.
Note that the overlap must not exceed half of max_chunk_size_tokens.
The maximum number of tokens in each chunk. The default value is 800. The minimum value is 100 and the maximum value is 4096.
StaticFileChunkingStrategyObject = object { static, type }
Always static.
StaticFileChunkingStrategyObjectParam = object { static, type } Customize your own chunking strategy by setting chunk size and chunk overlap.
Customize your own chunking strategy by setting chunk size and chunk overlap.
Always static.
VectorStore = object { id, created_at, file_counts, 8 more } A vector store is a collection of processed files can be used by the file_search tool.
A vector store is a collection of processed files can be used by the file_search tool.
The identifier, which can be referenced in API endpoints.
The Unix timestamp (in seconds) for when the vector store was created.
file_counts: object { cancelled, completed, failed, 2 more }
The number of files that were cancelled.
The number of files that have been successfully processed.
The number of files that have failed to process.
The number of files that are currently being processed.
The total number of files.
The Unix timestamp (in seconds) for when the vector store was last active.
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.
The name of the vector store.
The object type, which is always vector_store.
status: "expired" or "in_progress" or "completed"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.
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.
The total number of bytes used by the files in the vector store.
expires_after: optional object { anchor, days } The expiration policy for a vector store.
The expiration policy for a vector store.
Anchor timestamp after which the expiration policy applies. Supported anchors: last_active_at.
The number of days after the anchor time that the vector store will expire.
The Unix timestamp (in seconds) for when the vector store will expire.
VectorStoreDeleted = object { id, deleted, object }
Vector StoresFiles
List vector store files
Create vector store file
Update vector store file attributes
Retrieve vector store file
Delete vector store file
Retrieve vector store file content
ModelsExpand Collapse
VectorStoreFile = object { id, created_at, last_error, 6 more } A list of files attached to a vector store.
A list of files attached to a vector store.
The identifier, which can be referenced in API endpoints.
The Unix timestamp (in seconds) for when the vector store file was created.
last_error: object { code, message } The last error associated with this vector store file. Will be null if there are no errors.
The last error associated with this vector store file. Will be null if there are no errors.
code: "server_error" or "unsupported_file" or "invalid_file"One of server_error, unsupported_file, or invalid_file.
One of server_error, unsupported_file, or invalid_file.
A human-readable description of the error.
The object type, which is always vector_store.file.
status: "in_progress" or "completed" or "cancelled" or "failed"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.
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.
The total vector store usage in bytes. Note that this may be different from the original file size.
The ID of the vector store that the File is attached to.
attributes: optional map[string or number or boolean]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, booleans, or numbers.
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, booleans, or numbers.
chunking_strategy: optional StaticFileChunkingStrategyObject { static, type } or OtherFileChunkingStrategyObject { type } The strategy used to chunk the file.
The strategy used to chunk the file.
StaticFileChunkingStrategyObject = object { static, type }
Always static.
OtherFileChunkingStrategyObject = object { type } This is returned when the chunking strategy is unknown. Typically, this is because the file was indexed before the chunking_strategy concept was introduced in the API.
This is returned when the chunking strategy is unknown. Typically, this is because the file was indexed before the chunking_strategy concept was introduced in the API.
Always other.
VectorStoreFileDeleted = object { id, deleted, object }
Vector StoresFile Batches
Create vector store file batch
Retrieve vector store file batch
Cancel vector store file batch
List vector store files in a batch
ModelsExpand Collapse
VectorStoreFileBatch = object { id, created_at, file_counts, 3 more } A batch of files attached to a vector store.
A batch of files attached to a vector store.
The identifier, which can be referenced in API endpoints.
The Unix timestamp (in seconds) for when the vector store files batch was created.
file_counts: object { cancelled, completed, failed, 2 more }
The number of files that where cancelled.
The number of files that have been processed.
The number of files that have failed to process.
The number of files that are currently being processed.
The total number of files.
The object type, which is always vector_store.file_batch.
status: "in_progress" or "completed" or "cancelled" or "failed"The status of the vector store files batch, which can be either in_progress, completed, cancelled or failed.
The status of the vector store files batch, which can be either in_progress, completed, cancelled or failed.
The ID of the vector store that the File is attached to.