Module: RunApi::IdeogramV3

Defined in:

lib/runapi/ideogram_v3.rb,
lib/runapi/ideogram_v3/types.rb,
lib/runapi/ideogram_v3/client.rb,
lib/runapi/ideogram_v3/contract_gen.rb,
lib/runapi/ideogram_v3/resources/edit_image.rb,
lib/runapi/ideogram_v3/resources/remix_image.rb,
lib/runapi/ideogram_v3/resources/reframe_image.rb,
lib/runapi/ideogram_v3/resources/text_to_image.rb

Defined Under Namespace

Modules: Resources, Types Classes: Client

Constant Summary

AuthenticationError =

RunApi::Core::AuthenticationError

RateLimitError =

RunApi::Core::RateLimitError

InsufficientCreditsError =

RunApi::Core::InsufficientCreditsError

NotFoundError =

RunApi::Core::NotFoundError

ValidationError =

RunApi::Core::ValidationError

TaskFailedError =

RunApi::Core::TaskFailedError

TaskTimeoutError =

RunApi::Core::TaskTimeoutError

CONTRACT =

{
  "edit-image" => {
    "models" => ["ideogram-v3-character-edit", "ideogram-v3-edit"],
    "fields_by_model" => {
      "ideogram-v3-character-edit" => {
        "mask_url" => {
          "required" => true
        },
        "output_count" => {
          "enum" => [1, 2, 3, 4],
          "type" => "integer"
        },
        "reference_image_urls" => {
          "required" => true
        },
        "rendering_speed" => {
          "enum" => ["turbo", "balanced", "quality"]
        },
        "seed" => {
          "type" => "integer"
        },
        "source_image_url" => {
          "required" => true
        },
        "style" => {
          "enum" => ["auto", "realistic", "fiction"]
        }
      },
      "ideogram-v3-edit" => {
        "mask_url" => {
          "required" => true
        },
        "output_count" => {
          "enum" => [1, 2, 3, 4],
          "type" => "integer"
        },
        "rendering_speed" => {
          "enum" => ["turbo", "balanced", "quality"]
        },
        "seed" => {
          "type" => "integer"
        },
        "source_image_url" => {
          "required" => true
        }
      }
    }
  },
  "reframe-image" => {
    "models" => ["ideogram-v3-reframe"],
    "fields_by_model" => {
      "ideogram-v3-reframe" => {
        "aspect_ratio" => {
          "enum" => ["1:1", "3:4", "9:16", "4:3", "16:9"]
        },
        "output_count" => {
          "enum" => [1, 2, 3, 4],
          "type" => "integer"
        },
        "rendering_speed" => {
          "enum" => ["turbo", "balanced", "quality"]
        },
        "seed" => {
          "type" => "integer"
        },
        "source_image_url" => {
          "required" => true
        },
        "style" => {
          "enum" => ["auto", "general", "realistic", "design"]
        }
      }
    }
  },
  "remix-image" => {
    "models" => ["ideogram-v3-character-remix", "ideogram-v3-remix"],
    "fields_by_model" => {
      "ideogram-v3-character-remix" => {
        "aspect_ratio" => {
          "enum" => ["1:1", "3:4", "9:16", "4:3", "16:9"]
        },
        "output_count" => {
          "enum" => [1, 2, 3, 4],
          "type" => "integer"
        },
        "reference_image_urls" => {
          "required" => true
        },
        "rendering_speed" => {
          "enum" => ["turbo", "balanced", "quality"]
        },
        "seed" => {
          "type" => "integer"
        },
        "source_image_url" => {
          "required" => true
        },
        "style" => {
          "enum" => ["auto", "realistic", "fiction"]
        }
      },
      "ideogram-v3-remix" => {
        "aspect_ratio" => {
          "enum" => ["1:1", "3:4", "9:16", "4:3", "16:9"]
        },
        "output_count" => {
          "enum" => [1, 2, 3, 4],
          "type" => "integer"
        },
        "rendering_speed" => {
          "enum" => ["turbo", "balanced", "quality"]
        },
        "seed" => {
          "type" => "integer"
        },
        "source_image_url" => {
          "required" => true
        },
        "style" => {
          "enum" => ["auto", "general", "realistic", "design"]
        }
      }
    }
  },
  "text-to-image" => {
    "models" => ["ideogram-v3-character", "ideogram-v3-text-to-image"],
    "fields_by_model" => {
      "ideogram-v3-character" => {
        "aspect_ratio" => {
          "enum" => ["1:1", "3:4", "9:16", "4:3", "16:9"]
        },
        "output_count" => {
          "enum" => [1, 2, 3, 4],
          "type" => "integer"
        },
        "reference_image_urls" => {
          "required" => true
        },
        "rendering_speed" => {
          "enum" => ["turbo", "balanced", "quality"]
        },
        "seed" => {
          "type" => "integer"
        },
        "style" => {
          "enum" => ["auto", "realistic", "fiction"]
        }
      },
      "ideogram-v3-text-to-image" => {
        "aspect_ratio" => {
          "enum" => ["1:1", "3:4", "9:16", "4:3", "16:9"]
        },
        "output_count" => {
          "enum" => [1, 2, 3, 4],
          "type" => "integer"
        },
        "rendering_speed" => {
          "enum" => ["turbo", "balanced", "quality"]
        },
        "seed" => {
          "type" => "integer"
        },
        "style" => {
          "enum" => ["auto", "general", "realistic", "design"]
        }
      }
    }
  }
}.freeze