Packages

ex_openai

2.0.0-beta2
2.0.0-beta3 2.0.0-beta2 2.0.0-beta 1.8.1-beta 1.8.0 1.8.0-beta 1.7.0 1.6.0 1.5.1 1.5.0 1.4.0 1.3.1 1.3.0 1.2.1 1.2.0 1.1.2 1.1.1 1.1.0 1.0.4 1.0.3 1.0.2 1.0.1 1.0.0 0.3.0 0.2.1 0.2.0 0.1.1 0.1.0

Auto-generated Elixir SDK for OpenAI APIs with proper typespec and @docs support

HexDocs

Current section

Files

Jump to
Readme
28 Versions
4 Dependencies
1 Dependant
Files
Activity
ex_openai lib ex_openai generated components image_gen_tool_call.ex
Raw

lib/ex_openai/generated/components/image_gen_tool_call.ex 

defmodule ExOpenAI.Components.ImageGenToolCall do

  use ExOpenAI.Jason



  @moduledoc """

  An image generation request made by the model.





  ## Fields



  * `:id` - **required** - `String.t()`  

    The unique ID of the image generation call.



  * `:result` - **required** - `String.t() | any()`



  * `:status` - **required** - `:in_progress | :completed | :generating | :failed`  

    The status of the image generation call.  

    Allowed values: `"in_progress"`, `"completed"`, `"generating"`, `"failed"`



  * `:type` - **required** - `:image_generation_call`  

    The type of the image generation call. Always `image_generation_call`.  

    Allowed values: `"image_generation_call"`

  """

  @type t() :: %{

          __struct__: __MODULE__,

          id: String.t(),

          result: String.t() | any(),

          status: ((:in_progress | :completed) | :generating) | :failed,

          type: :image_generation_call

        }

  defstruct [:id, :result, :status, :type]

end