Gemini.Types.Generation.Image (GeminiEx v0.8.4)

View Source

Type definitions for image generation using Google's Imagen models.

Imagen is Google's text-to-image generation model that creates high-quality images from text descriptions. These types support image generation, editing, and upscaling operations through the Vertex AI API.

Supported Models

  • imagegeneration@006 - Latest stable Imagen model
  • imagen-3.0-generate-001 - Imagen 3.0 generation model

Example

config = %ImageGenerationConfig{
  number_of_images: 4,
  aspect_ratio: "1:1",
  safety_filter_level: :block_some,
  person_generation: :allow_adult
}

{:ok, images} = Gemini.APIs.Images.generate(
  "A serene mountain landscape at sunset",
  config
)

See Gemini.APIs.Images for API functions.

Summary

Types

aspect_ratio()

Aspect ratio for generated images.

edit_mode()

Edit mode for image editing operations.

person_generation()

Person generation policy.

safety_filter_level()

Safety filter levels for generated images.

t()
upscale_factor()

Upscale factor for image enhancement.

Functions

build_edit_params(prompt, image_data, mask_data, config)

Builds parameters map for image editing API request.

build_generation_params(prompt, config)

Builds parameters map for image generation API request.

build_upscale_params(image_data, config)

Builds parameters map for image upscaling API request.

format_edit_mode(atom)

Converts edit mode to API format.

format_person_generation(atom)

Converts person generation policy to API format.

format_safety_filter_level(atom)

Converts safety filter level atom to API format.

format_upscale_factor(atom)

Converts upscale factor to API format.

parse_generated_image(data)

Parses a generated image from API response.

parse_safety_filter_level(level)

Converts API-style safety filter level string to atom.

Types

aspect_ratio()

@type aspect_ratio() :: String.t()

Aspect ratio for generated images.

Common aspect ratios:

  • "1:1" - Square (1024x1024)
  • "9:16" - Portrait, mobile (768x1344)
  • "16:9" - Landscape, desktop (1344x768)
  • "4:3" - Standard portrait (896x1152)
  • "3:4" - Standard landscape (1152x896)

edit_mode()

@type edit_mode() :: :inpainting | :outpainting | :product_image

Edit mode for image editing operations.

  • :inpainting - Edit specific regions (requires mask)
  • :outpainting - Extend image beyond original boundaries (requires mask)
  • :product_image - Product-focused editing

person_generation()

@type person_generation() :: :allow_adult | :allow_all | :dont_allow

Person generation policy.

  • :allow_adult - Allow generation of adult humans
  • :allow_all - Allow generation of humans of all ages
  • :dont_allow - Do not generate recognizable people

safety_filter_level()

@type safety_filter_level() :: :block_most | :block_some | :block_few | :block_none

Safety filter levels for generated images.

  • :block_most - Strictest filtering, blocks most potentially sensitive content
  • :block_some - Moderate filtering (recommended for most use cases)
  • :block_few - Permissive filtering, blocks only highly sensitive content
  • :block_none - No safety filtering applied

t()

@type t() :: Gemini.Types.Generation.Image.ImageGenerationConfig.t()

upscale_factor()

@type upscale_factor() :: :x2 | :x4

Upscale factor for image enhancement.

  • :x2 - 2x upscale (e.g., 1024x1024 -> 2048x2048)
  • :x4 - 4x upscale (e.g., 1024x1024 -> 4096x4096)

Functions

build_edit_params(prompt, image_data, mask_data, config)

@spec build_edit_params(
  String.t(),
  String.t(),
  String.t() | nil,
  Gemini.Types.Generation.Image.EditImageConfig.t()
) :: map()

Builds parameters map for image editing API request.

build_generation_params(prompt, config)

@spec build_generation_params(
  String.t(),
  Gemini.Types.Generation.Image.ImageGenerationConfig.t()
) ::
  map()

Builds parameters map for image generation API request.

build_upscale_params(image_data, config)

@spec build_upscale_params(
  String.t(),
  Gemini.Types.Generation.Image.UpscaleImageConfig.t()
) :: map()

Builds parameters map for image upscaling API request.

format_edit_mode(atom)

@spec format_edit_mode(edit_mode()) :: String.t()

Converts edit mode to API format.

Examples

iex> format_edit_mode(:inpainting)
"inpainting"

format_person_generation(atom)

@spec format_person_generation(person_generation()) :: String.t()

Converts person generation policy to API format.

Examples

iex> format_person_generation(:allow_adult)
"allowAdult"

format_safety_filter_level(atom)

@spec format_safety_filter_level(safety_filter_level()) :: String.t()

Converts safety filter level atom to API format.

Examples

iex> format_safety_filter_level(:block_some)
"blockSome"

format_upscale_factor(atom)

@spec format_upscale_factor(upscale_factor()) :: String.t()

Converts upscale factor to API format.

Examples

iex> format_upscale_factor(:x2)
"x2"

parse_generated_image(data)

@spec parse_generated_image(map()) :: Gemini.Types.Generation.Image.GeneratedImage.t()

Parses a generated image from API response.

parse_safety_filter_level(level)

@spec parse_safety_filter_level(String.t() | atom()) :: safety_filter_level()

Converts API-style safety filter level string to atom.

Examples

iex> parse_safety_filter_level("BLOCK_SOME")
:block_some

iex> parse_safety_filter_level(:block_most)
:block_most