ResponseCreatedRealtimeServerMessage 类
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
表示用于创建响应项的实时消息。
public ref class ResponseCreatedRealtimeServerMessage : Microsoft::Extensions::AI::RealtimeServerMessage
[System.Diagnostics.CodeAnalysis.Experimental("MEAI001", UrlFormat="https://aka.ms/dotnet-extensions-warnings/{0}")]
public class ResponseCreatedRealtimeServerMessage : Microsoft.Extensions.AI.RealtimeServerMessage
public class ResponseCreatedRealtimeServerMessage : Microsoft.Extensions.AI.RealtimeServerMessage
[<System.Diagnostics.CodeAnalysis.Experimental("MEAI001", UrlFormat="https://aka.ms/dotnet-extensions-warnings/{0}")>]
type ResponseCreatedRealtimeServerMessage = class
inherit RealtimeServerMessage
type ResponseCreatedRealtimeServerMessage = class
inherit RealtimeServerMessage
Public Class ResponseCreatedRealtimeServerMessage
Inherits RealtimeServerMessage
- 继承
- 属性
注解
与消息ResponseCreated一起使用ResponseDone。
提供程序实现应在模型开始生成新响应时以及ResponseDone响应完成时发出此消息ResponseCreated。 内置 OpenTelemetryRealtimeClientSession 中间件依赖于这些消息来跟踪响应生命周期。
本身不支持响应生命周期事件的提供程序(例如,仅流式传输内容部件和信号轮次完成事件)的提供程序应合成这些消息,以确保正确的中间件行为。 在这种情况下, ResponseId 可以设置为合成值或左 null值。
构造函数
| 名称 | 说明 |
|---|---|
| ResponseCreatedRealtimeServerMessage(RealtimeServerMessageType) |
初始化 ResponseCreatedRealtimeServerMessage 类的新实例。 |
属性
| 名称 | 说明 |
|---|---|
| AdditionalProperties |
获取或设置与响应关联的任何其他属性。 |
| Error |
获取或设置响应的错误内容(如果有)。 |
| Items |
获取或设置响应中包含的会话项的列表。 |
| MaxOutputTokens |
获取或设置响应的最大输出令牌数,包括所有形式和工具调用。 |
| MessageId |
获取或设置与响应关联的可选消息 ID。 这可用于跟踪和关联目的。 (继承自 RealtimeServerMessage) |
| OutputAudioOptions |
获取或设置响应的输出音频选项。 如果为 null,将使用默认对话音频选项。 |
| OutputModalities |
获取或设置响应的输出形式。 如“text”、“audio”。 如果为 null,则将使用默认聊天形式。 |
| OutputVoice |
获取或设置输出音频的语音。 |
| RawRepresentation |
获取或设置响应的原始表示形式。 这可用于保存从模型接收的原始数据结构。 (继承自 RealtimeServerMessage) |
| ResponseId |
获取或设置唯一的响应 ID。 |
| Status |
获取或设置响应的状态。 |
| Type |
获取或设置实时响应的类型。 (继承自 RealtimeServerMessage) |
| Usage |
获取或设置按响应令牌使用情况进行计费。 |