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

A batch of files attached to a vector store.

Fields

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

  • :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.

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

  • :status - required - :in_progress | :completed | :cancelled | :failed
    The status of the vector store files batch, which can be either in_progress, completed, cancelled or failed.
    Allowed values: "in_progress", "completed", "cancelled", "failed"

  • :vector_store_id - required - String.t()
    The ID of the vector store that the File is attached to.

Summary

Types

t()

Types

Link to this type

t()

View Source 
@type t() :: %ExOpenAI.Components.VectorStoreFileBatchObject{
  created_at: integer(),
  file_counts: %{
    cancelled: integer(),
    completed: integer(),
    failed: integer(),
    in_progress: integer(),
    total: integer()
  },
  id: String.t(),
  object: :"vector_store.files_batch",
  status: ((:in_progress | :completed) | :cancelled) | :failed,
  vector_store_id: String.t()
}