ex_openai

defmodule ExOpenAI.Components.CreateEmbeddingResponse do
  use ExOpenAI.Jason

  @moduledoc """
  Module for representing the OpenAI schema CreateEmbeddingResponse.

  ## Fields

  * `:data` - **required** - `[ExOpenAI.Components.Embedding.t()]`  
    The list of embeddings generated by the model.

  * `:model` - **required** - `String.t()`  
    The name of the model used to generate the embedding.

  * `:object` - **required** - `:list`  
    The object type, which is always "list".  
    Allowed values: `"list"`

  * `:usage` - **required** - `{:%{}, [], [{{:required, [], [:prompt_tokens]}, {:integer, [], []}}, {{:required, [], [:total_tokens]}, {:integer, [], []}}]}`  
    The usage information for the request.
  """
  @type t() :: %{
          __struct__: __MODULE__,
          data: list(ExOpenAI.Components.Embedding.t()),
          model: String.t(),
          object: :list,
          usage: %{required(:prompt_tokens) => integer(), required(:total_tokens) => integer()}
        }
  defstruct [:data, :model, :object, :usage]
end