Share via

HostedImageGenerationTool Class

Definition

Namespace:
Microsoft.Extensions.AI
Assembly:
Microsoft.Extensions.AI.Abstractions.dll
Package:
Microsoft.Extensions.AI.Abstractions v10.0.0
Source:
HostedImageGenerationTool.cs

Represents a hosted tool that can be specified to an AI service to enable it to perform image generation.

public ref class HostedImageGenerationTool : Microsoft::Extensions::AI::AITool
[System.Diagnostics.CodeAnalysis.Experimental("MEAI001")]
public class HostedImageGenerationTool : Microsoft.Extensions.AI.AITool
public class HostedImageGenerationTool : Microsoft.Extensions.AI.AITool
[<System.Diagnostics.CodeAnalysis.Experimental("MEAI001")>]
type HostedImageGenerationTool = class
    inherit AITool
type HostedImageGenerationTool = class
    inherit AITool
Public Class HostedImageGenerationTool
Inherits AITool
Inheritance
Object
AITool
HostedImageGenerationTool
Attributes
ExperimentalAttribute

Remarks

This tool does not itself implement image generation. It is a marker that can be used to inform a service that the service is allowed to perform image generation if the service is capable of doing so.

Constructors

Name Description
HostedImageGenerationTool()

Initializes a new instance of the HostedImageGenerationTool class with the specified options.

Properties

Name Description
AdditionalProperties

Gets any additional properties associated with the tool.

(Inherited from AITool)
Description

Gets a description of the tool, suitable for use in describing the purpose to a model.

(Inherited from AITool)
Name

Gets the name of the tool.

(Inherited from AITool)
Options

Gets or sets the options used to configure image generation.

Methods

Name Description
GetService(Type, Object)

Asks the AITool for an object of the specified type serviceType.

(Inherited from AITool)
GetService<TService>(Object)

Asks the AITool for an object of type TService.

(Inherited from AITool)
ToString()

Returns a string that represents the current object.

(Inherited from AITool)

Extension Methods

Name Description
AsOpenAIResponseTool(AITool)

Creates an OpenAI ResponseTool from an AITool.

Applies to