Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -66,11 +66,14 @@ public partial interface IImagesGenerateClient
/// <param name="images">
/// Optional source images to edit (max 16, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only.
/// </param>
/// <param name="maskAssetIdentifier">
/// An existing upload or generated image asset to use as the mask, by reference. The same rules as `mask` apply. Takes priority over `mask` if both are supplied.
/// </param>
/// <param name="mask">
/// An optional mask for the first source image (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Fully transparent pixels mark the areas to edit. The mask must have the same dimensions as the first source image, and requires source `images` in the same request.
/// An optional mask for the first source image (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Fully transparent pixels mark the areas to edit. The mask must have the same dimensions as the first source image, and requires source images in the same request.
/// </param>
/// <param name="maskname">
/// An optional mask for the first source image (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Fully transparent pixels mark the areas to edit. The mask must have the same dimensions as the first source image, and requires source `images` in the same request.
/// An optional mask for the first source image (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Fully transparent pixels mark the areas to edit. The mask must have the same dimensions as the first source image, and requires source images in the same request.
/// </param>
/// <param name="background">
/// The output background. `transparent` returns images with an alpha channel, `opaque` forces a solid background, and `auto` lets the model decide from the prompt.<br/>
Expand Down Expand Up @@ -128,6 +131,7 @@ public partial interface IImagesGenerateClient
bool? dryRun = default,
global::System.Collections.Generic.IList<global::Ideogram.AssetIdentifier>? imageAssetIdentifiers = default,
global::System.Collections.Generic.IList<byte[]>? images = default,
global::Ideogram.AssetIdentifier? maskAssetIdentifier = default,
byte[]? mask = default,
string? maskname = default,
global::Ideogram.GenerateImageGptImage25FlareRequestBackground? background = default,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,11 +69,14 @@ public partial interface IImagesGenerateClient
/// <param name="images">
/// Optional source images to edit (max 16, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only.
/// </param>
/// <param name="maskAssetIdentifier">
/// An existing upload or generated image asset to use as the mask, by reference. The same rules as `mask` apply. Takes priority over `mask` if both are supplied.
/// </param>
/// <param name="mask">
/// An optional mask for the first source image (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Fully transparent pixels mark the areas to edit. The mask must have the same dimensions as the first source image, and requires source `images` in the same request.
/// An optional mask for the first source image (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Fully transparent pixels mark the areas to edit. The mask must have the same dimensions as the first source image, and requires source images in the same request.
/// </param>
/// <param name="maskname">
/// An optional mask for the first source image (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Fully transparent pixels mark the areas to edit. The mask must have the same dimensions as the first source image, and requires source `images` in the same request.
/// An optional mask for the first source image (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Fully transparent pixels mark the areas to edit. The mask must have the same dimensions as the first source image, and requires source images in the same request.
/// </param>
/// <param name="background">
/// The output background. `transparent` returns images with an alpha channel, `opaque` forces a solid background, and `auto` lets the model decide from the prompt.<br/>
Expand Down Expand Up @@ -131,6 +134,7 @@ public partial interface IImagesGenerateClient
bool? dryRun = default,
global::System.Collections.Generic.IList<global::Ideogram.AssetIdentifier>? imageAssetIdentifiers = default,
global::System.Collections.Generic.IList<byte[]>? images = default,
global::Ideogram.AssetIdentifier? maskAssetIdentifier = default,
byte[]? mask = default,
string? maskname = default,
global::Ideogram.GenerateImageGptImage25SunburstRequestBackground? background = default,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,9 @@ public partial interface IImagesGenerateClient
/// <param name="images">
/// Optional source images to edit (max 5, max 25MB each; JPEG, PNG, or WEBP). The first image is the one being edited; any others are extra references. Multipart requests only.
/// </param>
/// <param name="maskAssetIdentifier">
/// An existing upload or generated image asset to use as the mask, by reference. The same rules as `mask` apply. Takes priority over `mask` if both are supplied.
/// </param>
/// <param name="mask">
/// An optional mask that limits the edit to part of the first source image (max 25MB; JPEG, PNG, or WEBP). Multipart requests only. Black marks the area to edit and white the area to keep; values in between are rounded to the nearer of the two. The mask must have the same width and height as the first source image and contain both black and white areas. A masked request can include at most three other source images. With a mask, the output is always the first source image's own size, so `size` cannot be set.
/// </param>
Expand Down Expand Up @@ -151,6 +154,7 @@ public partial interface IImagesGenerateClient
global::Ideogram.MagicPromptMode? magicPrompt = default,
global::System.Collections.Generic.IList<global::Ideogram.AssetIdentifier>? imageAssetIdentifiers = default,
global::System.Collections.Generic.IList<byte[]>? images = default,
global::Ideogram.AssetIdentifier? maskAssetIdentifier = default,
byte[]? mask = default,
string? maskname = default,
string? size = default,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,11 +75,14 @@ public partial interface IImagesGenerateClient
/// <param name="characterReferenceImages">
/// An image of the character to feature (max 25MB; JPEG, PNG, or WEBP).
/// </param>
/// <param name="characterReferenceMaskAssetIdentifier">
/// An existing upload or generated image asset to use as the character reference mask, by reference. The same rules as `character_reference_mask` apply. Takes priority over `character_reference_mask` if both are supplied.
/// </param>
/// <param name="characterReferenceMask">
/// Optional grayscale mask marking where the character is in the `character_reference_images` image, at the same size as that image (JPEG, PNG, or WEBP). Multipart requests only.
/// Optional grayscale mask marking where the character is in the character reference image, at the same size as that image (JPEG, PNG, or WEBP). Multipart requests only.
/// </param>
/// <param name="characterReferenceMaskname">
/// Optional grayscale mask marking where the character is in the `character_reference_images` image, at the same size as that image (JPEG, PNG, or WEBP). Multipart requests only.
/// Optional grayscale mask marking where the character is in the character reference image, at the same size as that image (JPEG, PNG, or WEBP). Multipart requests only.
/// </param>
/// <param name="seed">
/// Random seed. Set for reproducible generation.<br/>
Expand Down Expand Up @@ -158,6 +161,7 @@ public partial interface IImagesGenerateClient
string? characterReferenceCollectionVersionId = default,
global::System.Collections.Generic.IList<global::Ideogram.AssetIdentifier>? characterReferenceAssetIdentifiers = default,
global::System.Collections.Generic.IList<byte[]>? characterReferenceImages = default,
global::Ideogram.AssetIdentifier? characterReferenceMaskAssetIdentifier = default,
byte[]? characterReferenceMask = default,
string? characterReferenceMaskname = default,
int? seed = default,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -98,11 +98,14 @@ public partial interface IImagesInpaintClient
/// <param name="characterReferenceImages">
/// An image to use as the character reference (max 25MB). JPEG, PNG, and WEBP are supported.
/// </param>
/// <param name="characterReferenceMaskAssetIdentifier">
/// An existing upload or generated image asset to use as the character reference mask, by reference. The same rules as `character_reference_mask` apply. Takes priority over `character_reference_mask` if both are supplied.
/// </param>
/// <param name="characterReferenceMask">
/// Optional grayscale mask for the uploaded character reference image, the same size as that image, marking where the character is. Only JPEG, PNG, and WEBP formats are supported. Multipart requests only; applies only with `character_reference_images`.
/// Optional grayscale mask for the character reference image, the same size as that image, marking where the character is. Only JPEG, PNG, and WEBP formats are supported. Multipart requests only; cannot be combined with `character_reference_collection_id`.
/// </param>
/// <param name="characterReferenceMaskname">
/// Optional grayscale mask for the uploaded character reference image, the same size as that image, marking where the character is. Only JPEG, PNG, and WEBP formats are supported. Multipart requests only; applies only with `character_reference_images`.
/// Optional grayscale mask for the character reference image, the same size as that image, marking where the character is. Only JPEG, PNG, and WEBP formats are supported. Multipart requests only; cannot be combined with `character_reference_collection_id`.
/// </param>
/// <param name="magicPrompt">
/// Controls magic prompt (automatic prompt rewriting). Defaults to `auto`.<br/>
Expand Down Expand Up @@ -180,6 +183,7 @@ public partial interface IImagesInpaintClient
string? characterReferenceCollectionVersionId = default,
global::System.Collections.Generic.IList<global::Ideogram.AssetIdentifier>? characterReferenceAssetIdentifiers = default,
global::System.Collections.Generic.IList<byte[]>? characterReferenceImages = default,
global::Ideogram.AssetIdentifier? characterReferenceMaskAssetIdentifier = default,
byte[]? characterReferenceMask = default,
string? characterReferenceMaskname = default,
global::Ideogram.MagicPromptMode? magicPrompt = default,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,25 +78,28 @@ public partial interface IImagesPreciseEditClient
/// structured prompt; valid structured JSON is used as is.
/// </param>
/// <param name="imageAssetIdentifier">
/// The image to edit, as an existing upload or generated image asset. Supply this or `image`, never both. Takes priority over `image` if both are supplied. Cannot be combined with `mask`.
/// The image to edit, as an existing upload or generated image asset. Supply this or `image`, never both. Takes priority over `image` if both are supplied.
/// </param>
/// <param name="image">
/// The image to edit, as raw bytes (max 50MB; JPEG, PNG, or WEBP). Multipart requests only; ignored if `image_asset_identifier` is also supplied. Required when supplying a `mask` or a `context_window`. The output always matches this image's width and height, and pixels the edit did not meaningfully change are copied exactly from it.
/// The image to edit, as raw bytes (max 50MB; JPEG, PNG, or WEBP). Multipart requests only; ignored if `image_asset_identifier` is also supplied. The output always matches this image's width and height, and pixels the edit did not meaningfully change are copied exactly from it.
/// </param>
/// <param name="imagename">
/// The image to edit, as raw bytes (max 50MB; JPEG, PNG, or WEBP). Multipart requests only; ignored if `image_asset_identifier` is also supplied. Required when supplying a `mask` or a `context_window`. The output always matches this image's width and height, and pixels the edit did not meaningfully change are copied exactly from it.
/// The image to edit, as raw bytes (max 50MB; JPEG, PNG, or WEBP). Multipart requests only; ignored if `image_asset_identifier` is also supplied. The output always matches this image's width and height, and pixels the edit did not meaningfully change are copied exactly from it.
/// </param>
/// <param name="referenceImageAssetIdentifiers">
/// Optional additional images to guide the edit, by reference. These are never edited themselves; only `image_asset_identifier` or `image` is. Requires the image being edited to be supplied by reference too, and cannot be combined with `mask`.
/// Optional additional images to guide the edit, by reference. These are never edited themselves; only `image_asset_identifier` or `image` is. Requires the image being edited to be supplied by reference too. A request with a mask can include at most three.
/// </param>
/// <param name="referenceImages">
/// Optional images to guide the edit (max 4, max 50MB each; JPEG, PNG, or WEBP). They are never edited themselves; only `image` is. Multipart requests only; ignored if `reference_image_asset_identifiers` is also supplied. A request with a `mask` can include at most three, because the mask takes up one reference slot.
/// </param>
/// <param name="maskAssetIdentifier">
/// An existing upload or generated image asset to use as the mask, by reference. The same rules as `mask` apply. Takes priority over `mask` if both are supplied.
/// </param>
/// <param name="mask">
/// An optional mask that limits the edit to part of `image` (max 50MB; JPEG, PNG, or WEBP). Multipart requests only. Black marks the area to edit and white the area to keep; values in between are rounded to the nearer of the two. The mask must have the same width and height as `image` and contain both black and white areas. Requires `image` as raw bytes; masks cannot be combined with asset references. A masked request can include at most three `reference_images`.
/// An optional mask that limits the edit to part of `image` (max 50MB; JPEG, PNG, or WEBP). Multipart requests only. Black marks the area to edit and white the area to keep; values in between are rounded to the nearer of the two. The mask must have the same width and height as the image being edited and contain both black and white areas. A masked request can include at most three reference images.
/// </param>
/// <param name="maskname">
/// An optional mask that limits the edit to part of `image` (max 50MB; JPEG, PNG, or WEBP). Multipart requests only. Black marks the area to edit and white the area to keep; values in between are rounded to the nearer of the two. The mask must have the same width and height as `image` and contain both black and white areas. Requires `image` as raw bytes; masks cannot be combined with asset references. A masked request can include at most three `reference_images`.
/// An optional mask that limits the edit to part of `image` (max 50MB; JPEG, PNG, or WEBP). Multipart requests only. Black marks the area to edit and white the area to keep; values in between are rounded to the nearer of the two. The mask must have the same width and height as the image being edited and contain both black and white areas. A masked request can include at most three reference images.
/// </param>
/// <param name="contextWindow">
/// Which region of the image to edit.<br/>
Expand Down Expand Up @@ -153,6 +156,7 @@ public partial interface IImagesPreciseEditClient
string? imagename = default,
global::System.Collections.Generic.IList<global::Ideogram.AssetIdentifier>? referenceImageAssetIdentifiers = default,
global::System.Collections.Generic.IList<byte[]>? referenceImages = default,
global::Ideogram.AssetIdentifier? maskAssetIdentifier = default,
byte[]? mask = default,
string? maskname = default,
string? contextWindow = default,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,11 +93,14 @@ public partial interface IImagesRemixClient
/// <param name="characterReferenceImages">
/// An image to use as the character reference (max 25MB). JPEG, PNG, and WEBP are supported.
/// </param>
/// <param name="characterReferenceMaskAssetIdentifier">
/// An existing upload or generated image asset to use as the character reference mask, by reference. The same rules as `character_reference_mask` apply. Takes priority over `character_reference_mask` if both are supplied.
/// </param>
/// <param name="characterReferenceMask">
/// Optional grayscale mask for the uploaded character reference image, the same size as that image, marking where the character is. Only JPEG, PNG, and WEBP formats are supported. Multipart requests only; applies only with `character_reference_images`.
/// Optional grayscale mask for the character reference image, the same size as that image, marking where the character is. Only JPEG, PNG, and WEBP formats are supported. Multipart requests only; cannot be combined with `character_reference_collection_id`.
/// </param>
/// <param name="characterReferenceMaskname">
/// Optional grayscale mask for the uploaded character reference image, the same size as that image, marking where the character is. Only JPEG, PNG, and WEBP formats are supported. Multipart requests only; applies only with `character_reference_images`.
/// Optional grayscale mask for the character reference image, the same size as that image, marking where the character is. Only JPEG, PNG, and WEBP formats are supported. Multipart requests only; cannot be combined with `character_reference_collection_id`.
/// </param>
/// <param name="seed">
/// Random seed. Set for reproducible generation.<br/>
Expand Down Expand Up @@ -177,6 +180,7 @@ public partial interface IImagesRemixClient
string? characterReferenceCollectionVersionId = default,
global::System.Collections.Generic.IList<global::Ideogram.AssetIdentifier>? characterReferenceAssetIdentifiers = default,
global::System.Collections.Generic.IList<byte[]>? characterReferenceImages = default,
global::Ideogram.AssetIdentifier? characterReferenceMaskAssetIdentifier = default,
byte[]? characterReferenceMask = default,
string? characterReferenceMaskname = default,
int? seed = default,
Expand Down
Loading
Loading