Skip to content

Latest commit

 

History

History
42 lines (26 loc) · 1.9 KB

VectorStoreObject.md

File metadata and controls

42 lines (26 loc) · 1.9 KB

VectorStoreObject

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

Properties

Name Type Description Notes
id String The identifier, which can be referenced in API endpoints.
_object ObjectEnum The object type, which is always `vector_store`.
createdAt Integer The Unix timestamp (in seconds) for when the vector store was created.
name String The name of the vector store.
usageBytes Integer The total number of bytes used by the files in the vector store.
fileCounts VectorStoreObjectFileCounts
status StatusEnum 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.
expiresAfter VectorStoreExpirationAfter [optional]
expiresAt Integer The Unix timestamp (in seconds) for when the vector store will expire. [optional]
lastActiveAt Integer The Unix timestamp (in seconds) for when the vector store was last active.
metadata Object 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. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.

Enum: ObjectEnum

Name Value
VECTOR_STORE "vector_store"

Enum: StatusEnum

Name Value
EXPIRED "expired"
IN_PROGRESS "in_progress"
COMPLETED "completed"