VoiceAgentRealtimeClientConnectOptions interface
连接实时客户端与语音代理的选项。
属性
| abort |
取消连接尝试。 |
| agent |
用于关联语音会话的标识符。 |
| agent |
选择特定的不可变代理版本。 |
| connection |
在毫秒级内覆盖客户端连接超时。 |
| on |
接收连接状态转换。 |
| query | 该连接的WebSocket升级URL的额外查询参数。
提供一个纯对象,包括一个空原型对象。
值覆盖匹配端点查询参数; |
| store | 覆盖该会话创建的对话是否被持久化。 |
| structured |
用于渲染代理结构化提示输入的值。
在 |
| transport | 选择用于实时连接的传输方式。 默认值为 |
继承属性
| on |
在执行请求的作时,每次从服务器接收响应时调用的函数。 可以多次调用。 |
| request |
为此作创建和发送 HTTP 请求时使用的选项。 |
| tracing |
启用跟踪时使用的选项。 |
属性详细信息
abortSignal
agentSessionId
用于关联语音会话的标识符。
agentSessionId?: string
属性值
string
agentVersionOverride
选择特定的不可变代理版本。
agentVersionOverride?: string
属性值
string
connectionTimeoutInMs
在毫秒级内覆盖客户端连接超时。
connectionTimeoutInMs?: number
属性值
number
onConnectionStateChange
接收连接状态转换。
onConnectionStateChange?: VoiceAgentConnectionStateChangedHandler
属性值
query
该连接的WebSocket升级URL的额外查询参数。
提供一个纯对象,包括一个空原型对象。
值覆盖匹配端点查询参数; undefined 移除一个参数。
这些值会自动通过URL编码。 数字必须有限。
SDK管理的参数、认证参数和以 开头的 h- 名称都被保留(不区分大小写),并导致 TypeError。 使用相应的类型选项,分别用于会话、版本、存储、传输和结构化提示输入。
两者都structured_inputstructured_inputs比较保留。
不要包含秘密信息:查询参数可能出现在服务器或代理日志中。
query?: Readonly<Record<string, string | number | boolean | undefined>>
属性值
Readonly<Record<string, string | number | boolean | undefined>>
store
覆盖该会话创建的对话是否被持久化。
store?: boolean
属性值
boolean
structuredInputs
用于渲染代理结构化提示输入的值。
在 connect() 调用时序列化,在认证前进行。
structuredInputs?: Record<string, unknown>
属性值
Record<string, unknown>
transport
选择用于实时连接的传输方式。 默认值为 "websocket". 设置为 谈判 "webrtc" WebRTC 对等连接;呼叫者负责通过 rtc.call.sdp.create 和 rtc.call.sdp.created 事件完成 SDP 报价/接答交换(参见 VoiceAgentRealtimeEvent)。
transport?: VoiceAgentTransport
属性值
继承属性详细信息
onResponse
在执行请求的作时,每次从服务器接收响应时调用的函数。 可以多次调用。
onResponse?: RawResponseCallback
属性值
继承自 OperationOptions.onResponse
requestOptions
为此作创建和发送 HTTP 请求时使用的选项。
requestOptions?: OperationRequestOptions
属性值
继承自 OperationOptions.requestOptions
tracingOptions
启用跟踪时使用的选项。
tracingOptions?: OperationTracingOptions
属性值
继承自 OperationOptions.tracingOptions