Skip to content

VectorStoreFile

A list of files attached to a vector store.

Example Usage

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

let value: VectorStoreFile = {
  id: "<id>",
  object: "vector_store.file",
  usageBytes: 298795,
  createdAt: 949291,
  vectorStoreId: "<id>",
  status: "in_progress",
  lastError: {
    code: "server_error",
    message: "<value>",
  },
};

Fields

FieldTypeRequiredDescription
idstring✔️The identifier, which can be referenced in API endpoints.
object"vector_store.file"✔️The object type, which is always 'vector_store.file'.
usageBytesnumber✔️The total vector store usage in bytes. Note that this may be different from the original file size.
createdAtnumber✔️The Unix timestamp (in seconds) for when the vector store file was created.
vectorStoreIdstring✔️The ID of the vector store that the File is attached to.
statuscomponents.VectorStoreFileStatus✔️The status of the vector store file. 'in_progress' means currently processing, 'completed' indicates the file is ready for use, 'cancelled' means processing was cancelled, 'failed' means an error occurred.
lastErrorcomponents.VectorStoreFileError✔️The last error associated with this vector store file. Will be null if there are no errors.
chunkingStrategycomponents.ChunkingStrategyN/A
attributesRecord<string, components.VectorStoreFileAttributes>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.