Jaa

CreateResponseRealtimeClientMessage Class

Definition

Namespace:
Microsoft.Extensions.AI
Assembly:
Microsoft.Extensions.AI.Abstractions.dll
Package:
Microsoft.Extensions.AI.Abstractions v10.4.1
Source:
CreateResponseRealtimeClientMessage.cs

Represents a client message that triggers model inference to generate a response.

public ref class CreateResponseRealtimeClientMessage : Microsoft::Extensions::AI::RealtimeClientMessage
[System.Diagnostics.CodeAnalysis.Experimental("MEAI001", UrlFormat="https://aka.ms/dotnet-extensions-warnings/{0}")]
public class CreateResponseRealtimeClientMessage : Microsoft.Extensions.AI.RealtimeClientMessage
public class CreateResponseRealtimeClientMessage : Microsoft.Extensions.AI.RealtimeClientMessage
[<System.Diagnostics.CodeAnalysis.Experimental("MEAI001", UrlFormat="https://aka.ms/dotnet-extensions-warnings/{0}")>]
type CreateResponseRealtimeClientMessage = class
    inherit RealtimeClientMessage
type CreateResponseRealtimeClientMessage = class
    inherit RealtimeClientMessage
Public Class CreateResponseRealtimeClientMessage
Inherits RealtimeClientMessage
Inheritance
Object
RealtimeClientMessage
CreateResponseRealtimeClientMessage
Attributes
ExperimentalAttribute

Remarks

Sending this message instructs the provider to generate a new response from the model. The response may include one or more output items (text, audio, or tool calls). Properties on this message optionally override the session-level configuration for this response only.

Not all providers support explicit response triggering. Voice-activity-detection (VAD) driven providers may respond automatically when speech is detected or input is committed, in which case this message may be treated as a no-op. Per-response overrides (instructions, tools, voice, etc.) are advisory and may be silently ignored by providers that do not support them.

Constructors

Name Description
CreateResponseRealtimeClientMessage()

Initializes a new instance of the CreateResponseRealtimeClientMessage class.

Properties

Name Description
AdditionalProperties

Gets or sets any additional properties associated with the response request.
ExcludeFromConversation

Gets or sets a value indicating whether the response output should be excluded from the conversation context.
Instructions

Gets or sets the instructions that guide the model on desired responses.
Items

Gets or sets the list of the conversation items to create a response for.
MaxOutputTokens

Gets or sets the maximum number of output tokens for the response, inclusive of all modalities and tool calls.
MessageId

Gets or sets the optional message ID associated with the message. This can be used for tracking and correlation purposes.

(Inherited from RealtimeClientMessage)
OutputAudioOptions

Gets or sets the output audio options for the response.
OutputModalities

Gets or sets the output modalities for the response (e.g., "text", "audio").
OutputVoice

Gets or sets the voice of the output audio.
RawRepresentation

Gets or sets the raw representation of the message. This can be used to send the raw data to the model.

(Inherited from RealtimeClientMessage)
ToolMode

Gets or sets the tool choice mode for the response.
Tools

Gets or sets the AI tools available for generating the response.

Applies to