FoundryAITool.CreateImageGenerationTool Method

Definition

Namespace:

Microsoft.Agents.AI.AzureAI

Assembly:

Microsoft.Agents.AI.AzureAI.dll

Package:

Microsoft.Agents.AI.AzureAI v1.0.0-rc5

Creates an AITool for image generation.

public static Microsoft.Extensions.AI.AITool CreateImageGenerationTool(string model, OpenAI.Responses.ImageGenerationToolQuality? quality = default, OpenAI.Responses.ImageGenerationToolSize? size = default, OpenAI.Responses.ImageGenerationToolOutputFileFormat? outputFileFormat = default, int? outputCompressionFactor = default, OpenAI.Responses.ImageGenerationToolModerationLevel? moderationLevel = default, OpenAI.Responses.ImageGenerationToolBackground? background = default, OpenAI.Responses.ImageGenerationToolInputFidelity? inputFidelity = default, OpenAI.Responses.ImageGenerationToolInputImageMask? inputImageMask = default, int? partialImageCount = default);

static member CreateImageGenerationTool : string * Nullable<OpenAI.Responses.ImageGenerationToolQuality> * Nullable<OpenAI.Responses.ImageGenerationToolSize> * Nullable<OpenAI.Responses.ImageGenerationToolOutputFileFormat> * Nullable<int> * Nullable<OpenAI.Responses.ImageGenerationToolModerationLevel> * Nullable<OpenAI.Responses.ImageGenerationToolBackground> * Nullable<OpenAI.Responses.ImageGenerationToolInputFidelity> * OpenAI.Responses.ImageGenerationToolInputImageMask * Nullable<int> -> Microsoft.Extensions.AI.AITool

Public Shared Function CreateImageGenerationTool (model As String, Optional quality As Nullable(Of ImageGenerationToolQuality) = Nothing, Optional size As Nullable(Of ImageGenerationToolSize) = Nothing, Optional outputFileFormat As Nullable(Of ImageGenerationToolOutputFileFormat) = Nothing, Optional outputCompressionFactor As Nullable(Of Integer) = Nothing, Optional moderationLevel As Nullable(Of ImageGenerationToolModerationLevel) = Nothing, Optional background As Nullable(Of ImageGenerationToolBackground) = Nothing, Optional inputFidelity As Nullable(Of ImageGenerationToolInputFidelity) = Nothing, Optional inputImageMask As ImageGenerationToolInputImageMask = Nothing, Optional partialImageCount As Nullable(Of Integer) = Nothing) As AITool

Parameters

model

String

The model to use for image generation.

quality

Nullable<OpenAI.Responses.ImageGenerationToolQuality>

Optional image quality setting.

size

Nullable<OpenAI.Responses.ImageGenerationToolSize>

Optional image size setting.

outputFileFormat

Nullable<OpenAI.Responses.ImageGenerationToolOutputFileFormat>

Optional output file format.

outputCompressionFactor

Nullable<Int32>

Optional output compression factor.

moderationLevel

Nullable<OpenAI.Responses.ImageGenerationToolModerationLevel>

Optional moderation level.

background

Nullable<OpenAI.Responses.ImageGenerationToolBackground>

Optional background setting.

inputFidelity

Nullable<OpenAI.Responses.ImageGenerationToolInputFidelity>

Optional input fidelity setting.

inputImageMask

OpenAI.Responses.ImageGenerationToolInputImageMask

Optional input image mask.

partialImageCount

Nullable<Int32>

Optional partial image count.

Returns

AITool

An AITool for image generation.