Class ImagesEndpoint

Namespace

OpenAI.Images

Assembly

OpenAI-DotNet.dll

Given a prompt and/or an input image, the model will generate a new image.
https://platform.openai.com/docs/api-reference/images

public sealed class ImagesEndpoint : OpenAIBaseEndpoint

Inheritance

object

OpenAIBaseEndpoint

ImagesEndpoint

Inherited Members

OpenAIBaseEndpoint.EnableDebug

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

IsAzureDeployment

Indicates if the endpoint has an Azure Deployment.

protected override bool? IsAzureDeployment { get; }

Property Value

bool?

Remarks

If the endpoint is an Azure deployment, is true. If it is not an Azure deployment, is false. If it is not an Azure supported Endpoint, is null.

Root

The root endpoint address.

protected override string Root { get; }

Property Value

string

Methods

CreateImageEditAsync(ImageEditRequest, CancellationToken)

Creates an edited or extended image given an original image and a prompt.

public Task<IReadOnlyList<ImageResult>> CreateImageEditAsync(ImageEditRequest request, CancellationToken cancellationToken = default)

Parameters

request ImageEditRequest

ImageEditRequest.

cancellationToken CancellationToken

Optional, CancellationToken.

Returns

Task<IReadOnlyList<ImageResult>>

A list of generated texture urls to download.

CreateImageVariationAsync(ImageVariationRequest, CancellationToken)

Creates a variation of a given image.

public Task<IReadOnlyList<ImageResult>> CreateImageVariationAsync(ImageVariationRequest request, CancellationToken cancellationToken = default)

Parameters

request ImageVariationRequest

ImageVariationRequest.

cancellationToken CancellationToken

Optional, CancellationToken.

Returns

Task<IReadOnlyList<ImageResult>>

A list of generated texture urls to download.

GenerateImageAsync(ImageGenerationRequest, CancellationToken)

Creates an image given a prompt.

public Task<IReadOnlyList<ImageResult>> GenerateImageAsync(ImageGenerationRequest request, CancellationToken cancellationToken = default)

Parameters

request ImageGenerationRequest

ImageGenerationRequest.

cancellationToken CancellationToken

Optional, CancellationToken.

Returns

Task<IReadOnlyList<ImageResult>>

A list of generated texture urls to download.