Package version:

Interface VectorStore

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

interface VectorStore {
    createdAt: Date;
    expiresAfter?: VectorStoreExpirationPolicy;
    expiresAt?: any;
    fileCounts: VectorStoreFileCount;
    id: string;
    lastActiveAt: any;
    metadata: any;
    name: string;
    object: "vector_store";
    status: VectorStoreStatus;
    usageBytes: number;
}

Properties

createdAt expiresAfter? expiresAt? fileCounts id lastActiveAt metadata name object status usageBytes

Properties

createdAt

createdAt: Date

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

OptionalexpiresAfter

expiresAfter?: VectorStoreExpirationPolicy

Details on when this vector store expires

OptionalexpiresAt

expiresAt?: any

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

fileCounts

fileCounts: VectorStoreFileCount

Files count grouped by status processed or being processed by this vector store.

id

id: string

The identifier, which can be referenced in API endpoints.

lastActiveAt

lastActiveAt: any

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

metadata

metadata: any

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

name: string

The name of the vector store.

object

object

The object type, which is always vector_store

status

status: VectorStoreStatus

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.

usageBytes

usageBytes: number

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

Settings

Member Visibility