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

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
#nullable enable

namespace Ideogram
{
public partial interface IGenerateClient
{
/// <summary>
/// Edit with Ideogram 3.0<br/>
/// Edit a given image synchronously using the provided mask with Ideogram 3.0. The mask indicates which part of the image<br/>
/// should be edited, while the prompt and chosen style can further guide the edit.<br/>
/// Supported image formats include JPEG, PNG, and WebP.<br/>
/// Images links are available for a limited period of time; if you would like to keep the image, you must download it.
/// </summary>
/// <param name="request"></param>
/// <param name="cancellationToken">The token to cancel the operation with</param>
/// <exception cref="global::Ideogram.ApiException"></exception>
global::System.Threading.Tasks.Task<global::Ideogram.ImageGenerationResponseV3> PostEditImageV3Async(
global::Ideogram.EditImageRequestV3 request,
global::System.Threading.CancellationToken cancellationToken = default);

/// <summary>
/// Edit with Ideogram 3.0<br/>
/// Edit a given image synchronously using the provided mask with Ideogram 3.0. The mask indicates which part of the image<br/>
/// should be edited, while the prompt and chosen style can further guide the edit.<br/>
/// Supported image formats include JPEG, PNG, and WebP.<br/>
/// Images links are available for a limited period of time; if you would like to keep the image, you must download it.
/// </summary>
/// <param name="imageFile">
/// The image being edited; only JPEG, WebP and PNG formats are supported at this time
/// </param>
/// <param name="imageFilename">
/// The image being edited; only JPEG, WebP and PNG formats are supported at this time
/// </param>
/// <param name="mask">
/// A black and white image of the same size as the image being edited. Black regions in the mask should match up with the regions of the image that you would like to edit; only JPEG, WebP and PNG formats are supported at this time
/// </param>
/// <param name="maskname">
/// A black and white image of the same size as the image being edited. Black regions in the mask should match up with the regions of the image that you would like to edit; only JPEG, WebP and PNG formats are supported at this time
/// </param>
/// <param name="prompt">
/// The prompt used to describe the edited result.<br/>
/// Example: A photo of a cat.
/// </param>
/// <param name="magicPrompt">
/// Determine if MagicPrompt should be used in generating the request or not<br/>
/// Example: ON
/// </param>
/// <param name="numImages">
/// Default Value: 1
/// </param>
/// <param name="seed">
/// Example: 12345
/// </param>
/// <param name="renderingSpeed">
/// The rendering speed to use.<br/>
/// Default Value: BALANCED
/// </param>
/// <param name="colorPalette">
/// Only available for model version V_2 and V_2_TURBO. A color palette for generation, must EITHER be specified via one of the presets (name) or explicitly via hexadecimal representations of the color with optional weights (members).
/// </param>
/// <param name="styleCodes">
/// A list of 8 character hexadecimal codes representing the style of the image. Cannot be used in conjunction with style_reference_images or style_type.<br/>
/// Example: [AAFF5733, 0133FF57, DE3357FF]
/// </param>
/// <param name="styleReferenceImages">
/// A set of images to use as style references. The images should be in JPEG, PNG or WebP format.
/// </param>
/// <param name="cancellationToken">The token to cancel the operation with</param>
/// <exception cref="global::System.InvalidOperationException"></exception>
global::System.Threading.Tasks.Task<global::Ideogram.ImageGenerationResponseV3> PostEditImageV3Async(
byte[] imageFile,
string imageFilename,
byte[] mask,
string maskname,
string prompt,
global::Ideogram.MagicPromptOption? magicPrompt = default,
int? numImages = default,
int? seed = default,
global::Ideogram.RenderingSpeed? renderingSpeed = default,
global::Ideogram.ColorPaletteWithPresetNameOrMembers? colorPalette = default,
global::System.Collections.Generic.IList<string>? styleCodes = default,
global::System.Collections.Generic.IList<byte[]>? styleReferenceImages = default,
global::System.Threading.CancellationToken cancellationToken = default);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
#nullable enable

namespace Ideogram
{
public partial interface IGenerateClient
{
/// <summary>
/// Generate with Ideogram 3.0<br/>
/// Generates images synchronously based on a given prompt and optional parameters using the Ideogram 3.0 model.<br/>
/// Images links are available for a limited period of time; if you would like to keep the image, you must download it.
/// </summary>
/// <param name="request"></param>
/// <param name="cancellationToken">The token to cancel the operation with</param>
/// <exception cref="global::Ideogram.ApiException"></exception>
global::System.Threading.Tasks.Task<global::Ideogram.ImageGenerationResponseV3> PostGenerateImageV3Async(
global::Ideogram.GenerateImageRequestV3 request,
global::System.Threading.CancellationToken cancellationToken = default);

/// <summary>
/// Generate with Ideogram 3.0<br/>
/// Generates images synchronously based on a given prompt and optional parameters using the Ideogram 3.0 model.<br/>
/// Images links are available for a limited period of time; if you would like to keep the image, you must download it.
/// </summary>
/// <param name="prompt">
/// The prompt to use to generate the image.<br/>
/// Example: A photo of a cat
/// </param>
/// <param name="seed">
/// Example: 12345
/// </param>
/// <param name="resolution">
/// The resolutions supported for model version V_3.<br/>
/// Example: 1024x1024
/// </param>
/// <param name="aspectRatio">
/// The aspect ratio to use for image generation, which determines the image's resolution. Cannot be used in conjunction with resolution. Defaults to 1:1.
/// </param>
/// <param name="renderingSpeed">
/// The rendering speed to use.<br/>
/// Default Value: BALANCED
/// </param>
/// <param name="magicPrompt">
/// Determine if MagicPrompt should be used in generating the request or not<br/>
/// Example: ON
/// </param>
/// <param name="negativePrompt">
/// Description of what to exclude from an image. Descriptions in the prompt take precedence<br/>
/// to descriptions in the negative prompt.<br/>
/// Example: brush strokes, painting
/// </param>
/// <param name="numImages">
/// Number of images to generate.<br/>
/// Default Value: 1
/// </param>
/// <param name="colorPalette">
/// Only available for model version V_2 and V_2_TURBO. A color palette for generation, must EITHER be specified via one of the presets (name) or explicitly via hexadecimal representations of the color with optional weights (members).
/// </param>
/// <param name="styleCodes">
/// A list of 8 character hexadecimal codes representing the style of the image. Cannot be used in conjunction with style_reference_images or style_type.<br/>
/// Example: [AAFF5733, 0133FF57, DE3357FF]
/// </param>
/// <param name="styleType">
/// The style type to generate with.<br/>
/// Example: REALISTIC
/// </param>
/// <param name="styleReferenceImages">
/// A set of images to use as style references. The images should be in JPEG, PNG or WebP format.
/// </param>
/// <param name="cancellationToken">The token to cancel the operation with</param>
/// <exception cref="global::System.InvalidOperationException"></exception>
global::System.Threading.Tasks.Task<global::Ideogram.ImageGenerationResponseV3> PostGenerateImageV3Async(
string prompt,
int? seed = default,
global::Ideogram.ResolutionV3? resolution = default,
global::Ideogram.AspectRatioV3? aspectRatio = default,
global::Ideogram.RenderingSpeed? renderingSpeed = default,
global::Ideogram.MagicPromptOption? magicPrompt = default,
string? negativePrompt = default,
int? numImages = default,
global::Ideogram.ColorPaletteWithPresetNameOrMembers? colorPalette = default,
global::System.Collections.Generic.IList<string>? styleCodes = default,
global::Ideogram.StyleTypeV3? styleType = default,
global::System.Collections.Generic.IList<byte[]>? styleReferenceImages = default,
global::System.Threading.CancellationToken cancellationToken = default);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
#nullable enable

namespace Ideogram
{
public partial interface IGenerateClient
{
/// <summary>
/// Reframe with Ideogram 3.0<br/>
/// Reframe a square image to a chosen resolution with Ideogram 3.0. The supported image formats include JPEG, PNG, and WebP.<br/>
/// Image links are available for a limited period of time; if you would like to keep the image, you must download it
/// </summary>
/// <param name="request"></param>
/// <param name="cancellationToken">The token to cancel the operation with</param>
/// <exception cref="global::Ideogram.ApiException"></exception>
global::System.Threading.Tasks.Task<global::Ideogram.ImageGenerationResponseV3> PostReframeImageV3Async(
global::Ideogram.ReframeImageRequestV3 request,
global::System.Threading.CancellationToken cancellationToken = default);

/// <summary>
/// Reframe with Ideogram 3.0<br/>
/// Reframe a square image to a chosen resolution with Ideogram 3.0. The supported image formats include JPEG, PNG, and WebP.<br/>
/// Image links are available for a limited period of time; if you would like to keep the image, you must download it
/// </summary>
/// <param name="imageFile">
/// The image being reframed; only JPEG, WebP and PNG formats are supported at this time.
/// </param>
/// <param name="imageFilename">
/// The image being reframed; only JPEG, WebP and PNG formats are supported at this time.
/// </param>
/// <param name="resolution">
/// The resolutions supported for model version V_3.<br/>
/// Example: 1024x1024
/// </param>
/// <param name="numImages">
/// Default Value: 1
/// </param>
/// <param name="seed">
/// Example: 12345
/// </param>
/// <param name="renderingSpeed">
/// The rendering speed to use.<br/>
/// Default Value: BALANCED
/// </param>
/// <param name="colorPalette">
/// Only available for model version V_2 and V_2_TURBO. A color palette for generation, must EITHER be specified via one of the presets (name) or explicitly via hexadecimal representations of the color with optional weights (members).
/// </param>
/// <param name="styleCodes">
/// A list of 8 character hexadecimal codes representing the style of the image. Cannot be used in conjunction with style_reference_images or style_type.<br/>
/// Example: [AAFF5733, 0133FF57, DE3357FF]
/// </param>
/// <param name="styleReferenceImages">
/// A set of images to use as style references. The images should be in JPEG, PNG or WebP format.
/// </param>
/// <param name="cancellationToken">The token to cancel the operation with</param>
/// <exception cref="global::System.InvalidOperationException"></exception>
global::System.Threading.Tasks.Task<global::Ideogram.ImageGenerationResponseV3> PostReframeImageV3Async(
byte[] imageFile,
string imageFilename,
global::Ideogram.ResolutionV3 resolution,
int? numImages = default,
int? seed = default,
global::Ideogram.RenderingSpeed? renderingSpeed = default,
global::Ideogram.ColorPaletteWithPresetNameOrMembers? colorPalette = default,
global::System.Collections.Generic.IList<string>? styleCodes = default,
global::System.Collections.Generic.IList<byte[]>? styleReferenceImages = default,
global::System.Threading.CancellationToken cancellationToken = default);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
#nullable enable

namespace Ideogram
{
public partial interface IGenerateClient
{
/// <summary>
/// Remix with Ideogram 3.0<br/>
/// Remix provided images synchronously based on a given prompt and optional parameters with the Ideogram 3.0 model.<br/>
/// Input images are cropped to the chosen aspect ratio before being remixed.<br/>
/// Supported image formats include JPEG, PNG, and WebP.<br/>
/// Images links are available for a limited period of time; if you would like to keep the image, you must download it.
/// </summary>
/// <param name="request"></param>
/// <param name="cancellationToken">The token to cancel the operation with</param>
/// <exception cref="global::Ideogram.ApiException"></exception>
global::System.Threading.Tasks.Task<global::Ideogram.ImageGenerationResponseV3> PostRemixImageV3Async(
global::Ideogram.RemixImageRequestV3 request,
global::System.Threading.CancellationToken cancellationToken = default);

/// <summary>
/// Remix with Ideogram 3.0<br/>
/// Remix provided images synchronously based on a given prompt and optional parameters with the Ideogram 3.0 model.<br/>
/// Input images are cropped to the chosen aspect ratio before being remixed.<br/>
/// Supported image formats include JPEG, PNG, and WebP.<br/>
/// Images links are available for a limited period of time; if you would like to keep the image, you must download it.
/// </summary>
/// <param name="imageFile">
/// The image to remix binary; only JPEG, WebP and PNG formats are supported at this time
/// </param>
/// <param name="imageFilename">
/// The image to remix binary; only JPEG, WebP and PNG formats are supported at this time
/// </param>
/// <param name="prompt">
/// The prompt to use to generate the image.<br/>
/// Example: A photo of a cat
/// </param>
/// <param name="imageWeight">
/// Default Value: 50<br/>
/// Example: 50
/// </param>
/// <param name="seed">
/// Example: 12345
/// </param>
/// <param name="resolution">
/// The resolutions supported for model version V_3.<br/>
/// Example: 1024x1024
/// </param>
/// <param name="aspectRatio">
/// The aspect ratio to use for image generation, which determines the image's resolution. Cannot be used in conjunction with resolution. Defaults to 1:1.
/// </param>
/// <param name="renderingSpeed">
/// The rendering speed to use.<br/>
/// Default Value: BALANCED
/// </param>
/// <param name="magicPrompt">
/// Determine if MagicPrompt should be used in generating the request or not<br/>
/// Example: ON
/// </param>
/// <param name="negativePrompt">
/// Description of what to exclude from an image. Descriptions in the prompt take precedence<br/>
/// to descriptions in the negative prompt.<br/>
/// Example: brush strokes, painting
/// </param>
/// <param name="numImages">
/// Number of images to generate.<br/>
/// Default Value: 1
/// </param>
/// <param name="colorPalette">
/// Only available for model version V_2 and V_2_TURBO. A color palette for generation, must EITHER be specified via one of the presets (name) or explicitly via hexadecimal representations of the color with optional weights (members).
/// </param>
/// <param name="styleCodes">
/// A list of 8 character hexadecimal codes representing the style of the image. Cannot be used in conjunction with style_reference_images or style_type.<br/>
/// Example: [AAFF5733, 0133FF57, DE3357FF]
/// </param>
/// <param name="styleType">
/// The style type to generate with.<br/>
/// Example: REALISTIC
/// </param>
/// <param name="styleReferenceImages">
/// A set of images to use as style references. The images should be in JPEG, PNG or WebP format.
/// </param>
/// <param name="cancellationToken">The token to cancel the operation with</param>
/// <exception cref="global::System.InvalidOperationException"></exception>
global::System.Threading.Tasks.Task<global::Ideogram.ImageGenerationResponseV3> PostRemixImageV3Async(
byte[] imageFile,
string imageFilename,
string prompt,
int? imageWeight = default,
int? seed = default,
global::Ideogram.ResolutionV3? resolution = default,
global::Ideogram.AspectRatioV3? aspectRatio = default,
global::Ideogram.RenderingSpeed? renderingSpeed = default,
global::Ideogram.MagicPromptOption? magicPrompt = default,
string? negativePrompt = default,
int? numImages = default,
global::Ideogram.ColorPaletteWithPresetNameOrMembers? colorPalette = default,
global::System.Collections.Generic.IList<string>? styleCodes = default,
global::Ideogram.StyleTypeV3? styleType = default,
global::System.Collections.Generic.IList<byte[]>? styleReferenceImages = default,
global::System.Threading.CancellationToken cancellationToken = default);
}
}
Loading
Loading