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 @@ -25,7 +25,7 @@ partial void ProcessPostEditImageResponseContent(
/// Edit<br/>
/// Edit a given image synchronously using the provided mask. The mask indicates which part of the image<br/>
/// should be edited, while the prompt and chosen style type can further guide the edit.<br/>
/// Supported image formats include JPEG, PNG, and WEBP.<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>
Expand Down Expand Up @@ -299,20 +299,20 @@ partial void ProcessPostEditImageResponseContent(
/// Edit<br/>
/// Edit a given image synchronously using the provided mask. The mask indicates which part of the image<br/>
/// should be edited, while the prompt and chosen style type can further guide the edit.<br/>
/// Supported image formats include JPEG, PNG, and WEBP.<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, WEBPs and PNGs are supported at this time
/// 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, WEBPs and PNGs are supported at this time
/// 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, WEBPs and PNGs are supported at this time
/// 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, WEBPs and PNGs are supported at this time
/// 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/>
Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ partial void ProcessPostRemixImageResponseContent(
/// Remix<br/>
/// Remix provided images synchronously based on a given prompt and optional parameters<br/>
/// Input images are cropped to the chosen aspect ratio before being remixed.<br/>
/// Supported image formats include JPEG, PNG, and WEBP.<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>
Expand Down Expand Up @@ -268,17 +268,17 @@ partial void ProcessPostRemixImageResponseContent(
/// Remix<br/>
/// Remix provided images synchronously based on a given prompt and optional parameters<br/>
/// Input images are cropped to the chosen aspect ratio before being remixed.<br/>
/// Supported image formats include JPEG, PNG, and WEBP.<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="imageRequest">
/// A request to generate a new image using a provided image and a prompt.
/// </param>
/// <param name="imageFile">
/// An image binary; only JPEG, WEBPs and PNGs are supported at this time
/// An image binary; only JPEG, WebP and PNG formats are supported at this time
/// </param>
/// <param name="imageFilename">
/// An image binary; only JPEG, WEBPs and PNGs are supported at this time
/// An image binary; only JPEG, WebP and PNG formats are supported at this time
/// </param>
/// <param name="cancellationToken">The token to cancel the operation with</param>
/// <exception cref="global::System.InvalidOperationException"></exception>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ partial void ProcessPostUpscaleImageResponseContent(
/// <summary>
/// Upscale<br/>
/// Upscale provided images synchronously with an optional prompt.<br/>
/// Supported image formats include JPEG, PNG, and WEBP.<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>
Expand Down Expand Up @@ -266,17 +266,17 @@ partial void ProcessPostUpscaleImageResponseContent(
/// <summary>
/// Upscale<br/>
/// Upscale provided images synchronously with an optional prompt.<br/>
/// Supported image formats include JPEG, PNG, and WEBP.<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="imageRequest">
/// A request to upscale a provided image with the help of an optional prompt.
/// </param>
/// <param name="imageFile">
/// An image binary; only JPEG, WEBPs and PNGs are supported at this time
/// An image binary; only JPEG, WebP and PNG formats are supported at this time
/// </param>
/// <param name="imageFilename">
/// An image binary; only JPEG, WEBPs and PNGs are supported at this time
/// An image binary; only JPEG, WebP and PNG formats are supported at this time
/// </param>
/// <param name="cancellationToken">The token to cancel the operation with</param>
/// <exception cref="global::System.InvalidOperationException"></exception>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ public partial interface IGenerateClient
/// Edit<br/>
/// Edit a given image synchronously using the provided mask. The mask indicates which part of the image<br/>
/// should be edited, while the prompt and chosen style type can further guide the edit.<br/>
/// Supported image formats include JPEG, PNG, and WEBP.<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>
Expand All @@ -22,20 +22,20 @@ public partial interface IGenerateClient
/// Edit<br/>
/// Edit a given image synchronously using the provided mask. The mask indicates which part of the image<br/>
/// should be edited, while the prompt and chosen style type can further guide the edit.<br/>
/// Supported image formats include JPEG, PNG, and WEBP.<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, WEBPs and PNGs are supported at this time
/// 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, WEBPs and PNGs are supported at this time
/// 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, WEBPs and PNGs are supported at this time
/// 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, WEBPs and PNGs are supported at this time
/// 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/>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
#nullable enable

namespace Ideogram
{
public partial interface IGenerateClient
{
/// <summary>
/// Reframe<br/>
/// Reframe a square image to a chosen resolution. 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.GenerateImageResponse> PostReframeImageAsync(
global::Ideogram.ReframeImageRequest request,
global::System.Threading.CancellationToken cancellationToken = default);

/// <summary>
/// Reframe<br/>
/// Reframe a square image to a chosen resolution. 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">
/// (For model_version for 2.0 only, cannot be used in conjunction with aspect_ratio) The resolution to use for image generation, represented in width x height. If not specified, defaults to using aspect_ratio.<br/>
/// Example: RESOLUTION_1024_1024
/// </param>
/// <param name="model">
/// The model used to generate an image or edit one. /generate and /remix supports all model types, however, /edit is only supported for V_2 and V_2_TURBO.<br/>
/// Default Value: V_2<br/>
/// Example: V_2_TURBO
/// </param>
/// <param name="numImages">
/// Default Value: 1
/// </param>
/// <param name="seed">
/// Example: 12345
/// </param>
/// <param name="styleType">
/// The style type to generate with; this is only applicable for models V_2 and above and should not be specified for model versions V_1.<br/>
/// Example: REALISTIC
/// </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.GenerateImageResponse> PostReframeImageAsync(
byte[] imageFile,
string imageFilename,
global::Ideogram.Resolution resolution,
global::Ideogram.ModelEnum model,
int? numImages = default,
int? seed = default,
global::Ideogram.StyleType? styleType = default,
global::System.Threading.CancellationToken cancellationToken = default);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ public partial interface IGenerateClient
/// Remix<br/>
/// Remix provided images synchronously based on a given prompt and optional parameters<br/>
/// Input images are cropped to the chosen aspect ratio before being remixed.<br/>
/// Supported image formats include JPEG, PNG, and WEBP.<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>
Expand All @@ -22,17 +22,17 @@ public partial interface IGenerateClient
/// Remix<br/>
/// Remix provided images synchronously based on a given prompt and optional parameters<br/>
/// Input images are cropped to the chosen aspect ratio before being remixed.<br/>
/// Supported image formats include JPEG, PNG, and WEBP.<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="imageRequest">
/// A request to generate a new image using a provided image and a prompt.
/// </param>
/// <param name="imageFile">
/// An image binary; only JPEG, WEBPs and PNGs are supported at this time
/// An image binary; only JPEG, WebP and PNG formats are supported at this time
/// </param>
/// <param name="imageFilename">
/// An image binary; only JPEG, WEBPs and PNGs are supported at this time
/// An image binary; only JPEG, WebP and PNG formats are supported at this time
/// </param>
/// <param name="cancellationToken">The token to cancel the operation with</param>
/// <exception cref="global::System.InvalidOperationException"></exception>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ public partial interface IGenerateClient
/// <summary>
/// Upscale<br/>
/// Upscale provided images synchronously with an optional prompt.<br/>
/// Supported image formats include JPEG, PNG, and WEBP.<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>
Expand All @@ -20,17 +20,17 @@ public partial interface IGenerateClient
/// <summary>
/// Upscale<br/>
/// Upscale provided images synchronously with an optional prompt.<br/>
/// Supported image formats include JPEG, PNG, and WEBP.<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="imageRequest">
/// A request to upscale a provided image with the help of an optional prompt.
/// </param>
/// <param name="imageFile">
/// An image binary; only JPEG, WEBPs and PNGs are supported at this time
/// An image binary; only JPEG, WebP and PNG formats are supported at this time
/// </param>
/// <param name="imageFilename">
/// An image binary; only JPEG, WEBPs and PNGs are supported at this time
/// An image binary; only JPEG, WebP and PNG formats are supported at this time
/// </param>
/// <param name="cancellationToken">The token to cancel the operation with</param>
/// <exception cref="global::System.InvalidOperationException"></exception>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ public partial interface IVisionClient
/// <summary>
/// Describe<br/>
/// Describe an image<br/>
/// Supported image formats include JPEG, PNG, and WEBP
/// Supported image formats include JPEG, PNG, and WebP
/// </summary>
/// <param name="request"></param>
/// <param name="cancellationToken">The token to cancel the operation with</param>
Expand All @@ -19,7 +19,7 @@ public partial interface IVisionClient
/// <summary>
/// Describe<br/>
/// Describe an image<br/>
/// Supported image formats include JPEG, PNG, and WEBP
/// Supported image formats include JPEG, PNG, and WebP
/// </summary>
/// <param name="imageFile"></param>
/// <param name="imageFilename"></param>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
namespace Ideogram
{
/// <summary>
/// An image binary; only JPEG, WEBPs and PNGs are supported at this time
/// An image binary; only JPEG, WebP and PNG formats are supported at this time
/// </summary>
public sealed partial class DescribeRequest
{
Expand Down
Loading
Loading