Current section

Files

Jump to
ex_openai lib ex_openai generated components image_gen_usage.ex
Raw

lib/ex_openai/generated/components/image_gen_usage.ex

defmodule ExOpenAI.Components.ImageGenUsage do
use ExOpenAI.Jason
@moduledoc """
For `gpt-image-1` only, the token usage information for the image generation.
## Fields
* `:input_tokens` - **required** - `integer()`
The number of tokens (images and text) in the input prompt.
* `:input_tokens_details` - **required** - `ExOpenAI.Components.ImageGenInputUsageDetails.t()`
* `:output_tokens` - **required** - `integer()`
The number of output tokens generated by the model.
* `:output_tokens_details` - **optional** - `ExOpenAI.Components.ImageGenOutputTokensDetails.t()`
* `:total_tokens` - **required** - `integer()`
The total number of tokens (images and text) used for the image generation.
"""
@type t() :: %{
__struct__: __MODULE__,
input_tokens: integer(),
input_tokens_details: ExOpenAI.Components.ImageGenInputUsageDetails.t(),
output_tokens: integer(),
output_tokens_details: ExOpenAI.Components.ImageGenOutputTokensDetails.t() | nil,
total_tokens: integer()
}
defstruct [
:input_tokens,
:input_tokens_details,
:output_tokens,
:output_tokens_details,
:total_tokens
]
end