ArchAstro.Types.AIImageResult (archastro v0.2.0)

Copy Markdown

The result returned by an AI image generation or editing operation. Contains the generated image (as inline data or a URL) along with dimension, size, and usage metadata.

Summary

Types

t()

Functions

from_map(data)
matches?(value)
to_map(value)

Types

t()

@type t() :: %ArchAstro.Types.AIImageResult{
  aspect_ratio: String.t() | ArchAstro.Unset.t(),
  height: integer() | ArchAstro.Unset.t(),
  image_data: String.t() | ArchAstro.Unset.t(),
  image_size: String.t() | ArchAstro.Unset.t(),
  image_type: String.t() | ArchAstro.Unset.t(),
  image_url: String.t() | ArchAstro.Unset.t(),
  model: String.t(),
  revised_prompt: String.t() | ArchAstro.Unset.t(),
  size: String.t() | ArchAstro.Unset.t(),
  usage: %{optional(String.t()) => ArchAstro.JSON.t()} | ArchAstro.Unset.t(),
  width: integer() | ArchAstro.Unset.t()
}

Functions

from_map(data)

@spec from_map(ArchAstro.JSON.object()) :: t()

matches?(value)

@spec matches?(ArchAstro.JSON.t()) :: boolean()

to_map(value)

@spec to_map(t()) :: ArchAstro.JSON.object()