VectorStore interface
A vector store is a collection of processed files can be used by the file_search tool.
Properties
| created |
The Unix timestamp (in seconds) for when the vector store was created. |
| expires |
Details on when this vector store expires |
| expires |
The Unix timestamp (in seconds) for when the vector store will expire. |
| file |
Files count grouped by status processed or being processed by this vector store. |
| id | The identifier, which can be referenced in API endpoints. |
| last |
The Unix timestamp (in seconds) for when the vector store was last active. |
| 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. |
| object | The object type, which is always |
| status | The status of the vector store, which can be either |
| usage |
The total number of bytes used by the files in the vector store. |
Property Details
createdAt
The Unix timestamp (in seconds) for when the vector store was created.
createdAt: DateProperty Value
Date
expiresAfter
Details on when this vector store expires
expiresAfter?: VectorStoreExpirationPolicyProperty Value
expiresAt
The Unix timestamp (in seconds) for when the vector store will expire.
expiresAt?: null | DateProperty Value
null | Date
fileCounts
Files count grouped by status processed or being processed by this vector store.
fileCounts: VectorStoreFileCountProperty Value
id
The identifier, which can be referenced in API endpoints.
id: stringProperty Value
string
lastActiveAt
The Unix timestamp (in seconds) for when the vector store was last active.
lastActiveAt: null | DateProperty Value
null | Date
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: stringProperty Value
string
object
The object type, which is always vector_store
object: "vector_store"Property Value
"vector_store"
status
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.
status: VectorStoreStatusProperty Value
usageBytes
The total number of bytes used by the files in the vector store.
usageBytes: numberProperty Value
number