Skip to content
For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Primary navigation

Suggested
Overview Models Agents Tools Voice & Audio Production API reference
API Dashboard
Try ChatGPT
API Reference

Vector Stores

Create vector store
vector_stores.create(VectorStoreCreateParams**kwargs) -> VectorStore
POST/vector_stores
Delete vector store
vector_stores.delete(strvector_store_id) -> VectorStoreDeleted
DELETE/vector_stores/{vector_store_id}
List vector stores
vector_stores.list(VectorStoreListParams**kwargs) -> SyncCursorPage[VectorStore]
GET/vector_stores
Retrieve vector store
vector_stores.retrieve(strvector_store_id) -> VectorStore
GET/vector_stores/{vector_store_id}
Search vector store
vector_stores.search(strvector_store_id, VectorStoreSearchParams**kwargs) -> SyncPage[VectorStoreSearchResponse]
POST/vector_stores/{vector_store_id}/search
Modify vector store
vector_stores.update(strvector_store_id, VectorStoreUpdateParams**kwargs) -> VectorStore
POST/vector_stores/{vector_store_id}
ModelsExpand Collapse
class AutoFileChunkingStrategyParam: …

The default strategy. This strategy currently uses a max_chunk_size_tokens of 800 and chunk_overlap_tokens of 400.

FileChunkingStrategy

The strategy used to chunk the file.

FileChunkingStrategyParam

The chunking strategy used to chunk the file(s). If not set, will use the auto strategy. Only applicable if file_ids is non-empty.

class OtherFileChunkingStrategyObject: …

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.

class StaticFileChunkingStrategy: …
class StaticFileChunkingStrategyObject: …
class StaticFileChunkingStrategyObjectParam: …

Customize your own chunking strategy by setting chunk size and chunk overlap.

class VectorStore: …

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

class VectorStoreDeleted: …
class VectorStoreSearchResponse: …

Vector StoresFile Batches

Cancel vector store file batch
vector_stores.file_batches.cancel(strbatch_id, FileBatchCancelParams**kwargs) -> VectorStoreFileBatch
POST/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel
Create vector store file batch
vector_stores.file_batches.create(strvector_store_id, FileBatchCreateParams**kwargs) -> VectorStoreFileBatch
POST/vector_stores/{vector_store_id}/file_batches
List vector store files in a batch
vector_stores.file_batches.list_files(strbatch_id, FileBatchListFilesParams**kwargs) -> SyncCursorPage[VectorStoreFile]
GET/vector_stores/{vector_store_id}/file_batches/{batch_id}/files
Retrieve vector store file batch
vector_stores.file_batches.retrieve(strbatch_id, FileBatchRetrieveParams**kwargs) -> VectorStoreFileBatch
GET/vector_stores/{vector_store_id}/file_batches/{batch_id}
ModelsExpand Collapse
class VectorStoreFileBatch: …

A batch of files attached to a vector store.

Vector StoresFiles

Retrieve vector store file content
vector_stores.files.content(strfile_id, FileContentParams**kwargs) -> SyncPage[FileContentResponse]
GET/vector_stores/{vector_store_id}/files/{file_id}/content
Create vector store file
vector_stores.files.create(strvector_store_id, FileCreateParams**kwargs) -> VectorStoreFile
POST/vector_stores/{vector_store_id}/files
Delete vector store file
vector_stores.files.delete(strfile_id, FileDeleteParams**kwargs) -> VectorStoreFileDeleted
DELETE/vector_stores/{vector_store_id}/files/{file_id}
List vector store files
vector_stores.files.list(strvector_store_id, FileListParams**kwargs) -> SyncCursorPage[VectorStoreFile]
GET/vector_stores/{vector_store_id}/files
Retrieve vector store file
vector_stores.files.retrieve(strfile_id, FileRetrieveParams**kwargs) -> VectorStoreFile
GET/vector_stores/{vector_store_id}/files/{file_id}
Update vector store file attributes
vector_stores.files.update(strfile_id, FileUpdateParams**kwargs) -> VectorStoreFile
POST/vector_stores/{vector_store_id}/files/{file_id}
ModelsExpand Collapse
class FileContentResponse: …
class VectorStoreFile: …

A list of files attached to a vector store.

class VectorStoreFileDeleted: …