OpenAITextToAudioExecutionSettings Class
Definition
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.
Execution settings for OpenAI text-to-audio request.
public sealed class OpenAITextToAudioExecutionSettings : Microsoft.SemanticKernel.PromptExecutionSettingstype OpenAITextToAudioExecutionSettings = class
inherit PromptExecutionSettingsPublic NotInheritable Class OpenAITextToAudioExecutionSettings
Inherits PromptExecutionSettings- Inheritance
Constructors
| OpenAITextToAudioExecutionSettings() |
Creates an instance of OpenAITextToAudioExecutionSettings class with default voice - "alloy". |
| OpenAITextToAudioExecutionSettings(String) |
Creates an instance of OpenAITextToAudioExecutionSettings class. |
Properties
| 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) |
| ResponseFormat |
The format to audio in. Supported formats are mp3, opus, aac, and flac. |
| ServiceId |
Service identifier. This identifies the service these settings are configured for e.g., azure_openai_eastus, openai, ollama, huggingface, etc. (Inherited from PromptExecutionSettings) |
| Speed |
The speed of the generated audio. Select a value from 0.25 to 4.0. 1.0 is the default. |
| Voice |
The voice to use when generating the audio. Supported voices are alloy, echo, fable, onyx, nova, and shimmer. |
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. (Inherited from PromptExecutionSettings) |
| FromExecutionSettings(PromptExecutionSettings) |
Converts PromptExecutionSettings to derived OpenAITextToAudioExecutionSettings type. |
| ThrowIfFrozen() |
Throws an InvalidOperationException if the PromptExecutionSettings are frozen. (Inherited from PromptExecutionSettings) |