OpenAIClient.GetImageGenerationsAsync Method

Reference

Definition

Namespace:: Azure.AI.OpenAI

Assembly:: Azure.AI.OpenAI.dll

Package:: Azure.AI.OpenAI v1.0.0-beta.17

Source:: OpenAIClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Get a set of generated images influenced by a provided textual prompt.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.OpenAI.ImageGenerations>> GetImageGenerationsAsync (Azure.AI.OpenAI.ImageGenerationOptions imageGenerationOptions, System.Threading.CancellationToken cancellationToken = default);

abstract member GetImageGenerationsAsync : Azure.AI.OpenAI.ImageGenerationOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.OpenAI.ImageGenerations>>
override this.GetImageGenerationsAsync : Azure.AI.OpenAI.ImageGenerationOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.OpenAI.ImageGenerations>>

Public Overridable Function GetImageGenerationsAsync (imageGenerationOptions As ImageGenerationOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ImageGenerations))

Parameters

imageGenerationOptions: ImageGenerationOptions

The configuration information for the image generation request that controls the content, size, and other details about generated images.

cancellationToken: CancellationToken

An optional cancellation token that may be used to abort an ongoing request.

Returns

Task<Response<ImageGenerations>>

The response information for the image generations request.

Exceptions

ArgumentNullException

imageGenerationOptions is null.

ArgumentException

imageGenerationOptions.DeploymentName.DeploymentName is null or empty when using Azure OpenAI. Azure OpenAI image generation requires a valid dall-e-3 model deployment.

Applies to

Share via