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

interface VectorStore {
    created_at: number;
    file_counts: OpenAIClient.Beta.VectorStores.VectorStore.FileCounts;
    id: string;
    last_active_at: null | number;
    metadata: unknown;
    name: string;
    object: "vector_store";
    status: "completed" | "expired" | "in_progress";
    usage_bytes: number;
    expires_after?: OpenAIClient.Beta.VectorStores.VectorStore.ExpiresAfter;
    expires_at?: null | number;
}

Properties

created_at: number

The Unix timestamp (in seconds) for when the vector store was created.

id: string

The identifier, which can be referenced in API endpoints.

last_active_at: null | number

The Unix timestamp (in seconds) for when the vector store was last active.

metadata: unknown

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 maxium of 512 characters long.

name: string

The name of the vector store.

object: "vector_store"

The object type, which is always vector_store.

status: "completed" | "expired" | "in_progress"

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.

usage_bytes: number

The total number of bytes used by the files in the vector store.

The expiration policy for a vector store.

expires_at?: null | number

The Unix timestamp (in seconds) for when the vector store will expire.