OpenAITextToImageExecutionSettings Class

Definition

Namespace:: Microsoft.SemanticKernel.Connectors.OpenAI

Assembly:: Microsoft.SemanticKernel.Connectors.OpenAI.dll

Package:: Microsoft.SemanticKernel.Connectors.OpenAI v1.45.0

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.

Text to image execution settings for an OpenAI image generation request.

[System.Text.Json.Serialization.JsonNumberHandling(System.Text.Json.Serialization.JsonNumberHandling.AllowReadingFromString)]
public sealed class OpenAITextToImageExecutionSettings : Microsoft.SemanticKernel.PromptExecutionSettings

[<System.Text.Json.Serialization.JsonNumberHandling(System.Text.Json.Serialization.JsonNumberHandling.AllowReadingFromString)>]
type OpenAITextToImageExecutionSettings = class
    inherit PromptExecutionSettings

Public NotInheritable Class OpenAITextToImageExecutionSettings
Inherits PromptExecutionSettings

Inheritance: Object

PromptExecutionSettings
OpenAITextToImageExecutionSettings

Attributes: JsonNumberHandlingAttribute

Constructors

OpenAITextToImageExecutionSettings()

Properties

EndUserId	A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.
ExtensionData	Extra properties that may be included in the serialized execution settings. (Inherited from PromptExecutionSettings)
FunctionChoiceBehavior	Gets or sets the behavior defining the way functions are chosen by LLM and how they are invoked by AI connectors. (Inherited from PromptExecutionSettings)
IsFrozen	Gets a value that indicates whether the PromptExecutionSettings are currently modifiable. (Inherited from PromptExecutionSettings)
ModelId	Model identifier. This identifies the AI model these settings are configured for e.g., gpt-4, gpt-3.5-turbo (Inherited from PromptExecutionSettings)
Quality	The quality of the image that will be generated.
ResponseFormat	The format of the generated images. Can be a OpenAI.Images.GeneratedImageFormat or a `string` where:
ServiceId	Service identifier. This identifies the service these settings are configured for e.g., azure_openai_eastus, openai, ollama, huggingface, etc. (Inherited from PromptExecutionSettings)
Size	Optional width and height of the generated image.
Style	The style of the generated images.

Methods

Clone()	Creates a new PromptExecutionSettings object that is a copy of the current instance.
Freeze()	Makes the current PromptExecutionSettings unmodifiable and sets its IsFrozen property to true.
FromExecutionSettings(PromptExecutionSettings)	Create a new settings object with the values from another settings object.
ThrowIfFrozen()	Throws an InvalidOperationException if the PromptExecutionSettings are frozen. (Inherited from PromptExecutionSettings)

Applies to