Share via

OpenAIPromptExecutionSettings.Audio Property

Definition

Namespace:
Microsoft.SemanticKernel.Connectors.OpenAI
Assembly:
Microsoft.SemanticKernel.Connectors.OpenAI.dll
Package:
Microsoft.SemanticKernel.Connectors.OpenAI v1.45.0

Gets or sets the audio options to use for the completion when audio modality is enabled.

[System.Text.Json.Serialization.JsonIgnore(Condition=System.Text.Json.Serialization.JsonIgnoreCondition.WhenWritingNull)]
[System.Text.Json.Serialization.JsonPropertyName("audio")]
public object? Audio { get; set; }
[<System.Text.Json.Serialization.JsonIgnore(Condition=System.Text.Json.Serialization.JsonIgnoreCondition.WhenWritingNull)>]
[<System.Text.Json.Serialization.JsonPropertyName("audio")>]
member this.Audio : obj with get, set
Public Property Audio As Object

Property Value

Object
Attributes
JsonIgnoreAttribute JsonPropertyNameAttribute

Remarks

Use this property to configure the output audio voice and format when the Modalities property includes audio. This can be represented in several ways:

  • As a OpenAI.Chat.ChatAudioOptions object: new ChatAudioOptions(ChatOutputAudioVoice.Alloy, ChatOutputAudioFormat.Mp3)
  • As a JsonElement containing the serialized audio options
  • As a String containing the JSON representation of the audio options

Applies to