Class AbstractBaseImageRequest

Namespace

OpenAI.Images

Assembly

OpenAI-DotNet.dll

Abstract base image class for making requests.

public abstract class AbstractBaseImageRequest

Inheritance

object

AbstractBaseImageRequest

Derived

ImageEditRequest

ImageVariationRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

AbstractBaseImageRequest(Model, int, ImageSize, ImageResponseFormat, string)

Constructor.

protected AbstractBaseImageRequest(Model model = null, int numberOfResults = 1, ImageSize size = ImageSize.Large, ImageResponseFormat responseFormat = ImageResponseFormat.Url, string user = null)

Parameters

model Model

The model to use for image generation.

numberOfResults int

The number of images to generate. Must be between 1 and 10.

size ImageSize

The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024.

responseFormat ImageResponseFormat

The format in which the generated images are returned. Must be one of url or b64_json.

Defaults to Url

user string

A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.

Exceptions

ArgumentOutOfRangeException

Properties

Model

The model to use for image generation.

[JsonPropertyName("model")]
[FunctionProperty("The model to use for image generation.", true, "dall-e-2", new object[] { })]
public string Model { get; }

Property Value

string

Number

The number of images to generate. Must be between 1 and 10.

[JsonPropertyName("n")]
[FunctionProperty("The number of images to generate. Must be between 1 and 10.", false, 1, new object[] { })]
public int Number { get; }

Property Value

int

ResponseFormat

The format in which the generated images are returned. Must be one of url or b64_json.

Defaults to Url

[JsonPropertyName("response_format")]
[JsonConverter(typeof(JsonStringEnumConverter<ImageResponseFormat>))]
[FunctionProperty("The format in which the generated images are returned. Must be one of url or b64_json.", false, null, new object[] { })]
public ImageResponseFormat ResponseFormat { get; }

Property Value

ImageResponseFormat

Size

The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024.

[JsonPropertyName("size")]
[FunctionProperty("The size of the generated images.", false, "256x256", new object[] { "512x512", "1024x1024" })]
public string Size { get; }

Property Value

string

User

A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.

[JsonPropertyName("user")]
[FunctionProperty("A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.", false, null, new object[] { })]
public string User { get; }

Property Value

string