VectorStore

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

Example Usage

import { VectorStore } from "@meetkai/mka1/models/components";

let value: VectorStore = {
  id: "vs_abc123",
  object: "vector_store",
  createdAt: 1704067200,
  name: "Product Documentation",
  usageBytes: 1024000,
  fileCounts: {
    inProgress: 0,
    completed: 5,
    failed: 0,
    cancelled: 0,
    total: 5,
  },
  status: "completed",
  lastActiveAt: 1704153600,
  metadata: {
    "department": "engineering",
  },
  lastUsedAt: 805359,
};

Fields

Field	Type	Required	Description
id	string	✔️	The identifier, which can be referenced in API endpoints.
object	"vector_store"	✔️	The object type, which is always 'vector_store'.
createdAt	number	✔️	The Unix timestamp (in seconds) for when the vector store was created.
name	string	✔️	The name of the vector store.
usageBytes	number	✔️	The total number of bytes used by the files in the vector store.
fileCounts	components.FileCounts	✔️	File processing status counts.
status	components.VectorStoreStatus	✔️	The status of the vector store. 'expired' means the store has expired, 'in_progress' means files are still being processed, 'completed' indicates that the vector store is ready for use.
expiresAfter	components.VectorStoreExpiresAfter	➖	The expiration policy for a vector store.
expiresAt	number	➖	The Unix timestamp (in seconds) for when the vector store will expire.
lastActiveAt	number	✔️	The Unix timestamp (in seconds) for when the vector store was last active.
metadata	Record<string, components.VectorStoreMetadata>	✔️	Set of 16 key-value pairs that can be attached to an object. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters, booleans, or numbers.
description	string	➖	A description for the vector store. Can be used to describe the vector store's purpose.
lastUsedAt	number	✔️	The Unix timestamp (in seconds) for when the vector store was last used.