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

A list of files attached to a vector store.

Fields

:attributes - optional - ExOpenAI.Components.VectorStoreFileAttributes.t()
:chunking_strategy - optional - map()
The strategy used to chunk the file.
:created_at - required - integer()
The Unix timestamp (in seconds) for when the vector store file was created.
:id - required - String.t()
The identifier, which can be referenced in API endpoints.
:last_error - required - {:%{}, [], [{{:required, [], [:code]}, {:|, [], [{:|, [], [:server_error, :unsupported_file]}, :invalid_file]}}, {{:required, [], [:message]}, {{:., [], [{:__aliases__, [alias: false], [:String]}, :t]}, [], []}}]} | any()
:object - required - :"vector_store.file"
The object type, which is always vector_store.file.
Allowed values: "vector_store.file"
:status - required - :in_progress | :completed | :cancelled | :failed
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.
Allowed values: "in_progress", "completed", "cancelled", "failed"
:usage_bytes - required - integer()
The total vector store usage in bytes. Note that this may be different from the original file size.
:vector_store_id - required - String.t()
The ID of the vector store that the File is attached to.

Summary

Types

t()

Types

t()

@type t() :: %ExOpenAI.Components.VectorStoreFileObject{
  attributes: ExOpenAI.Components.VectorStoreFileAttributes.t() | nil,
  chunking_strategy: map() | nil,
  created_at: integer(),
  id: String.t(),
  last_error:
    %{
      code: (:server_error | :unsupported_file) | :invalid_file,
      message: String.t()
    }
    | any(),
  object: :"vector_store.file",
  status: ((:in_progress | :completed) | :cancelled) | :failed,
  usage_bytes: integer(),
  vector_store_id: String.t()
}