Skip to content

Latest commit

 

History

History
35 lines (29 loc) · 7.9 KB

vectorstorefileobject.md

File metadata and controls

35 lines (29 loc) · 7.9 KB

VectorStoreFileObject

A list of files attached to a vector store.

Example Usage

import { VectorStoreFileObject } from "argot-open-ai/models/components";

let value: VectorStoreFileObject = {
  id: "<id>",
  object: "vector_store.file",
  usageBytes: 829898,
  createdAt: 968287,
  vectorStoreId: "<id>",
  status: "failed",
  lastError: {
    code: "server_error",
    message: "<value>",
  },
};

Fields

Field Type Required Description
id string ✔️ The identifier, which can be referenced in API endpoints.
object components.VectorStoreFileObjectObject ✔️ The object type, which is always vector_store.file.
usageBytes number ✔️ The total vector store usage in bytes. Note that this may be different from the original file size.
createdAt number ✔️ The Unix timestamp (in seconds) for when the vector store file was created.
vectorStoreId string ✔️ The ID of the vector store that the File is attached to.
status components.VectorStoreFileObjectStatus ✔️ The status of the vector store file, which can be either in_progress, completed, cancelled, or failed. The status completed indicates that the vector store file is ready for use.
lastError components.VectorStoreFileObjectLastError ✔️ The last error associated with this vector store file. Will be null if there are no errors.
chunkingStrategy components.VectorStoreFileObjectChunkingStrategy ➖ The strategy used to chunk the file.