openai/openai-dotnet

Public

mirrored from https://github.com/openai/openai-dotnetAvailable

CodeCommitsIssuesPull requestsActionsInsightsSecurity
OpenAI_2.0.0-beta.12

Branches

Tags

  • No tags available.
0Branches0Tags
Go to file
Add file
Code

Clone

HTTPS

Download ZIP

src/Custom/Images/GeneratedImageSize.cs

81lines · modepreview

using System;

namespace OpenAI.Images;

// CUSTOM: Added custom struct in favor of the generated extensible enum.
/// <summary>
/// Represents the available output dimensions for generated images.
/// </summary>
[CodeGenModel("CreateImageRequestSize")]
[CodeGenSuppress("GeneratedImageSize", typeof(string))]
[CodeGenSuppress("op_Implicit", typeof(string))]
public readonly partial struct GeneratedImageSize : IEquatable<GeneratedImageSize>
{
    private readonly string _value;

    /// <summary> Initializes a new instance of <see cref="GeneratedImageSize"/>. </summary>
    /// <exception cref="ArgumentNullException"> <paramref name="value"/> is null. </exception>
    internal GeneratedImageSize(string value)
    {
        _value = value ?? throw new ArgumentNullException(nameof(value));
    }

    /// <summary>
    /// Creates a new instance of <see cref="GeneratedImageSize"/>.
    /// </summary>
    /// <remarks>
    /// <b>Note:</b> arbitrary dimensions are not supported and a given model will only support a set of predefined
    /// sizes. If supported dimensions are not known, try using one of the static properties like <see cref="W1024xH1024"/>.
    /// </remarks>
    /// <param name="width"> The desired width, in pixels, for an image. </param>
    /// <param name="height"> The desired height, in pixels, for an image. </param>
    public GeneratedImageSize(int width, int height)
    {
        _value = $"{width}x{height}";
    }

    /// <summary>
    /// A small, square image with 256 pixels of both width and height.
    /// <para>
    /// Supported <b>only</b> for the older <c>dall-e-2</c> model.
    /// </para>
    /// </summary>
    [CodeGenMember("_256x256")]
    public static readonly GeneratedImageSize W256xH256 = new(256, 256);

    /// <summary>
    /// A medium-small, square image with 512 pixels of both width and height.
    /// <para>
    /// Supported <b>only</b> for the older <c>dall-e-2</c> model.
    /// </para>
    /// </summary>
    [CodeGenMember("_512x512")]
    public static readonly GeneratedImageSize W512xH512 = new(512, 512);

    /// <summary>
    /// A square image with 1024 pixels of both width and height.
    /// <para>
    /// <b>Supported</b> and <b>default</b> for both <c>dall-e-2</c> and <c>dall-e-3</c> models.
    /// </para>
    /// </summary>
    [CodeGenMember("_1024x1024")]
    public static readonly GeneratedImageSize W1024xH1024 = new(1024, 1024);

    /// <summary>
    /// An extra tall image, 1024 pixels wide by 1792 pixels high.
    /// <para>
    /// Supported <b>only</b> for the <c>dall-e-3</c> model.
    /// </para>
    /// </summary>
    [CodeGenMember("_1792x1024")]
    public static readonly GeneratedImageSize W1024xH1792 = new(1024, 1792);

    /// <summary>
    /// An extra wide image, 1792 pixels wide by 1024 pixels high.
    /// <para>
    /// Supported <b>only</b> for the <c>dall-e-3</c> model.
    /// </para>
    /// </summary>
    [CodeGenMember("_1024x1792")]
    public static readonly GeneratedImageSize W1792xH1024 = new(1792, 1024);
}