ImageGenTool Class

Definition

Image generation tool.

public class ImageGenTool : Azure.AI.AgentServer.Responses.Models.Tool, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Responses.Models.ImageGenTool>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Responses.Models.ImageGenTool>
type ImageGenTool = class
    inherit Tool
    interface IJsonModel<ImageGenTool>
    interface IPersistableModel<ImageGenTool>
Public Class ImageGenTool
Inherits Tool
Implements IJsonModel(Of ImageGenTool), IPersistableModel(Of ImageGenTool)
Inheritance
ImageGenTool
Implements

Constructors

Name Description
ImageGenTool()

Initializes a new instance of ImageGenTool.

Properties

Name Description
Action

Whether to generate a new image or edit an existing image. Default: auto.

Background

Background type for the generated image. One of transparent, opaque, or auto. Default: auto.

Description

Optional user-defined description for this tool or configuration.

InputFidelity

Gets or sets the InputFidelity.

InputImageMask

Optional mask for inpainting. Contains image_url (string, optional) and file_id (string, optional).

Model

Gets or sets the Model.

Moderation

Moderation level for the generated image. Default: auto.

Name

Optional user-defined name for this tool or configuration.

OutputCompression

Compression level for the output image. Default: 100.

OutputFormat

The output format of the generated image. One of png, webp, or jpeg. Default: png.

PartialImages

Number of partial images to generate in streaming mode, from 0 (default value) to 3.

Quality

The quality of the generated image. One of low, medium, high, or auto. Default: auto.

Size

The size of the generated image. One of 1024x1024, 1024x1536, 1536x1024, or auto. Default: auto.

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<ImageGenTool>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<ImageGenTool>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IJsonModel<Tool>.Create(Utf8JsonReader, ModelReaderWriterOptions) (Inherited from Tool)
IJsonModel<Tool>.Write(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from Tool)
IPersistableModel<ImageGenTool>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<ImageGenTool>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<ImageGenTool>.Write(ModelReaderWriterOptions)
IPersistableModel<Tool>.Create(BinaryData, ModelReaderWriterOptions) (Inherited from Tool)
IPersistableModel<Tool>.GetFormatFromOptions(ModelReaderWriterOptions) (Inherited from Tool)
IPersistableModel<Tool>.Write(ModelReaderWriterOptions) (Inherited from Tool)

Applies to