View Source ExOpenAI.Components.VectorStoreObject (ex_openai.ex v2.0.0-beta2)

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

Fields

  • :created_at - required - integer()
    The Unix timestamp (in seconds) for when the vector store was created.

  • :expires_after - optional - ExOpenAI.Components.VectorStoreExpirationAfter.t()

  • :expires_at - optional - integer() | any()

  • :file_counts - required - {:%{}, [], [{{:required, [], [:cancelled]}, {:integer, [], []}}, {{:required, [], [:completed]}, {:integer, [], []}}, {{:required, [], [:failed]}, {:integer, [], []}}, {{:required, [], [:in_progress]}, {:integer, [], []}}, {{:required, [], [:total]}, {:integer, [], []}}]}

  • :id - required - String.t()
    The identifier, which can be referenced in API endpoints.

  • :last_active_at - required - integer() | any()

  • :metadata - required - ExOpenAI.Components.Metadata.t()

  • :name - required - String.t()
    The name of the vector store.

  • :object - required - :vector_store
    The object type, which is always vector_store.
    Allowed values: "vector_store"

  • :status - required - :expired | :in_progress | :completed
    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.
    Allowed values: "expired", "in_progress", "completed"

  • :usage_bytes - required - integer()
    The total number of bytes used by the files in the vector store.

Summary

Types

t()

Types

Link to this type

t()

View Source 
@type t() :: %ExOpenAI.Components.VectorStoreObject{
  created_at: integer(),
  expires_after: ExOpenAI.Components.VectorStoreExpirationAfter.t() | nil,
  expires_at: (integer() | any()) | nil,
  file_counts: %{
    cancelled: integer(),
    completed: integer(),
    failed: integer(),
    in_progress: integer(),
    total: integer()
  },
  id: String.t(),
  last_active_at: integer() | any(),
  metadata: ExOpenAI.Components.Metadata.t(),
  name: String.t(),
  object: :vector_store,
  status: (:expired | :in_progress) | :completed,
  usage_bytes: integer()
}