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

Represents the content or the URL of an image generated by the OpenAI API.

Fields

  • :b64_json - optional - String.t()
    The base64-encoded JSON of the generated image. Returned by default for the GPT image models, and only present if response_format is set to b64_json for dall-e-2 and dall-e-3.

  • :revised_prompt - optional - String.t()
    For dall-e-3 only, the revised prompt that was used to generate the image.

  • :url - optional - String.t()
    When using dall-e-2 or dall-e-3, the URL of the generated image if response_format is set to url (default value). Unsupported for the GPT image models.

Summary

Types

@type t() :: %ExOpenAI.Components.Image{
  b64_json: String.t() | nil,
  revised_prompt: String.t() | nil,
  url: String.t() | nil
}