OpenAIPromptExecutionSettings.Modalities Property

[System.Text.Json.Serialization.JsonIgnore(Condition=System.Text.Json.Serialization.JsonIgnoreCondition.WhenWritingNull)]
[System.Text.Json.Serialization.JsonPropertyName("modalities")]
public object? Modalities { get; set; }

[<System.Text.Json.Serialization.JsonIgnore(Condition=System.Text.Json.Serialization.JsonIgnoreCondition.WhenWritingNull)>]
[<System.Text.Json.Serialization.JsonPropertyName("modalities")>]
member this.Modalities : obj with get, set

Public Property Modalities As Object

Property Value

Attributes

JsonIgnoreAttribute JsonPropertyNameAttribute

Remarks

Specifies the modalities to use for the response. This can be represented in several ways:

• As a OpenAI.Chat.ChatResponseModalities flags enum: ChatResponseModalities.Text | ChatResponseModalities.Audio
• As an IEnumerable<T> of modality names: new[] { "text", "audio" }
• As a String representation: "Text, Audio"
• As a JsonElement containing either a string or an array of strings

If this property is null, OpenAI.Chat.ChatResponseModalities.Default will be used, which typically means text-only responses. When audio is enabled, you should also set the Audio property.