你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。

VoiceAgentRealtimeResponse interface

语音代理服务在两场response.createdresponse.done事件中均有实时响应。

属性

audio

实时响应使用的音频配置,包括平坦语音提供者、位置和格式字段。output

conversation_id

回答被添加到哪个对话中,取决于事件中的conversation场域response.create。 如果 auto,则 该响应将被添加到默认对话中,且 的 conversation_id 值将是类似 conv_1234的 id。 如果 none,则该回答不会被添加到任何对话中,且 的 conversation_id 值为 null。 如果VAD自动触发回复,回复会被添加到默认对话中

id

响应的唯一ID将为 resp_1234。

max_output_tokens

单个助手响应的最大输出令牌数,包括工具调用,用于该响应。

metadata

与响应关联的自定义字符串键值对。

object

对象类型必须是 realtime.response。

output

由响应生成的输出项列表。

output_modalities

模型用来响应的模态集合,目前唯一可能的值是 [\"audio\"]。 [\"text\"] 音频输出始终包含文本文字稿。 将输出设置为模式 text 会禁用模型的音频输出。

status

响应的最终状态(completed, cancelled, failed, , 或 incomplete, in_progress)。

status_details

关于状态的更多细节。

usage

响应的使用统计数据,这对应于计费。 实时API会话会维护对话上下文,并向对话添加新的项目,因此前几回合的输出(文本和音频令牌)将成为后续回合的输入。

属性详细信息

audio

实时响应使用的音频配置,包括平坦语音提供者、位置和格式字段。output

audio?: VoiceResponseAudio

属性值

conversation_id

回答被添加到哪个对话中,取决于事件中的conversation场域response.create。 如果 auto,则 该响应将被添加到默认对话中,且 的 conversation_id 值将是类似 conv_1234的 id。 如果 none,则该回答不会被添加到任何对话中,且 的 conversation_id 值为 null。 如果VAD自动触发回复,回复会被添加到默认对话中

conversation_id?: string

属性值

string

id

响应的唯一ID将为 resp_1234。

id?: string

属性值

string

max_output_tokens

单个助手响应的最大输出令牌数,包括工具调用,用于该响应。

max_output_tokens?: number | "inf"

属性值

number | "inf"

metadata

与响应关联的自定义字符串键值对。

metadata?: Metadata

属性值

object

对象类型必须是 realtime.response。

object?: "realtime.response"

属性值

"realtime.response"

output

由响应生成的输出项列表。

output?: RealtimeConversationItemUnion[]

属性值

output_modalities

模型用来响应的模态集合,目前唯一可能的值是 [\"audio\"]。 [\"text\"] 音频输出始终包含文本文字稿。 将输出设置为模式 text 会禁用模型的音频输出。

output_modalities?: ("text" | "audio")[]

属性值

("text" | "audio")[]

status

响应的最终状态(completed, cancelled, failed, , 或 incomplete, in_progress)。

status?: "failed" | "in_progress" | "cancelled" | "completed" | "incomplete"

属性值

"failed" | "in_progress" | "cancelled" | "completed" | "incomplete"

status_details

关于状态的更多细节。

status_details?: RealtimeResponseStatusDetails

属性值

usage

响应的使用统计数据,这对应于计费。 实时API会话会维护对话上下文,并向对话添加新的项目,因此前几回合的输出(文本和音频令牌)将成为后续回合的输入。

usage?: RealtimeResponseUsage

属性值