Share via


VectorStoreOptions interface

Request object for creating a vector store.

Properties

chunkingStrategy

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.

configuration

The vector store configuration, used when vector store is created from Azure asset URIs.

expiresAfter

Details on when this vector store expires

fileIds

A list of file IDs that the vector store should use. Useful for tools like file_search that can access files.

metadata

A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.

name

The name of the vector store.

Property Details

chunkingStrategy

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.

chunkingStrategy?: VectorStoreChunkingStrategyRequest

Property Value

configuration

The vector store configuration, used when vector store is created from Azure asset URIs.

configuration?: VectorStoreConfiguration

Property Value

expiresAfter

Details on when this vector store expires

expiresAfter?: VectorStoreExpirationPolicy

Property Value

fileIds

A list of file IDs that the vector store should use. Useful for tools like file_search that can access files.

fileIds?: string[]

Property Value

string[]

metadata

A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.

metadata?: null | Record<string, string>

Property Value

null | Record<string, string>

name

The name of the vector store.

name?: string

Property Value

string