需要访问旧版文档站？前往旧版文档官网首页。 (在新标签页打开)
声网文档中心

结构体

  • Web

更新时间不可用

IConversationalAIAPIEventHandlers

TypeScript
export interface IConversationalAIAPIEventHandlers

用于对话式 AI 引擎 API 模块的事件处理器接口。

信息

自 1.6.0 版本新增。

TMessageReceipt

TypeScript
export type TMessageReceipt = {
  moduleType: EModuleType
  messageType: EChatMessageType
  message: string
  turnId: number
}

消息回执类型定义。

信息

自 1.7.0 版本新增。

成员参数

参数数据类型描述
moduleTypeEModuleType发送该消息的模块类型。详见 EModuleType。
messageTypeEChatMessageType消息的类型。详见 EChatMessageType。
messagestring消息的内容。
turnIdnumber会话轮次的唯一标识符。
表格内容超出当前宽度，可横向滚动查看更多列。

TUserManualEventPayload

TypeScript
export type TUserManualEventPayload = {
  success: boolean
  requestId: string
  turnId?: number
  errorMessage?: string
}

手动 SoS/EoS 通用载荷。

成员参数

参数数据类型描述
successboolean服务端是否成功处理本次手动信令。
requestIdstring请求 ID，与调用 manualSOS 或 manualEOS 后返回的 requestId 对应。
turnIdnumber关联的对话轮次 ID。服务端失败回调未携带 turn_id 时可为空。
errorMessagestring服务端返回的原始错误信息。成功时通常为空。
表格内容超出当前宽度，可横向滚动查看更多列。

TUserManualSosEvent

TypeScript
export type TUserManualSosEvent = {
  eventId: string
  timestamp: number
  payload: TUserManualEventPayload
}

手动 SoS 事件对象。

成员参数

参数数据类型描述
eventIdstring事件唯一 ID。
timestampnumber事件时间戳，单位为毫秒。
payloadTUserManualEventPayload事件载荷。详见 TUserManualEventPayload。
表格内容超出当前宽度，可横向滚动查看更多列。

TUserManualEosEvent

TypeScript
export type TUserManualEosEvent = {
  eventId: string
  timestamp: number
  payload: TUserManualEventPayload
}

手动 EoS 事件对象。

成员参数

参数数据类型描述
eventIdstring事件唯一 ID。
timestampnumber事件时间戳，单位为毫秒。
payloadTUserManualEventPayload事件载荷。详见 TUserManualEventPayload。
表格内容超出当前宽度，可横向滚动查看更多列。

TAgentManualEosPayload

TypeScript
export type TAgentManualEosPayload = {
  reason: string
  maxDurationMs: number
  turnId: number
}

服务端超限自动 EoS 载荷。

成员参数

参数数据类型描述
reasonstring服务端自动结束当前用户发言的原因。
maxDurationMsnumber当前配置的单轮最大音频时长，单位为毫秒。
turnIdnumber关联的对话轮次 ID。
表格内容超出当前宽度，可横向滚动查看更多列。

TAgentManualEosEvent

TypeScript
export type TAgentManualEosEvent = {
  eventId: string
  timestamp: number
  payload: TAgentManualEosPayload
}

服务端超限自动 EoS 事件对象。

成员参数

参数数据类型描述
eventIdstring事件唯一 ID。
timestampnumber事件时间戳，单位为毫秒。
payloadTAgentManualEosPayload事件载荷。详见 TAgentManualEosPayload。
表格内容超出当前宽度，可横向滚动查看更多列。

IChatMessageBase

TypeScript
export interface IChatMessageBase {
  messageType: EChatMessageType
}

包含基础消息类型属性的 IChatMessageBase 接口。

信息

自 v1.7.0 版本新增。

成员参数

参数数据类型描述
messageTypeEChatMessageType消息类型，详见 EChatMessageType。
表格内容超出当前宽度，可横向滚动查看更多列。

IChatMessageImage

TypeScript
export interface IChatMessageImage extends IChatMessageBase {
  messageType: EChatMessageType.IMAGE
  uuid: string
  url?: string
}

表示一个基于图片的聊天消息，包含 url 形式的图片数据。

成员参数

参数数据类型描述
messageTypeEChatMessageType.IMAGE消息类型，必须为 IMAGE。详见 EChatMessageType。
uuidstring图片消息的唯一标识符。
urlstring可选。指向图片资源的 URL。
表格内容超出当前宽度，可横向滚动查看更多列。

SpeakMessage

TypeScript
export interface SpeakMessage {
  text: string
  priority?: EChatMessagePriority
  interruptable?: boolean
}

用于绕过大模型，直接通过智能体的 TTS 流程播报文本。

成员参数

参数数据类型描述
textstring要播报的文本。
priorityEChatMessagePriority播报请求的处理优先级，默认值为 INTERRUPTED。详见 EChatMessagePriority。
interruptableboolean是否允许用户说话打断本次播报，默认值为 true。
表格内容超出当前宽度，可横向滚动查看更多列。

ThinkMessage

TypeScript
export interface ThinkMessage {
  text: string
  onListeningAction?: ThinkListeningAction
  onThinkingAction?: ThinkThinkingAction
  onSpeakingAction?: ThinkSpeakingAction
  interruptable?: boolean
  metadata?: Record<string, string>
}

用于将文本作为用户输入注入对话，并交由大模型处理。

成员参数

参数数据类型描述
textstring要注入大模型的指令文本。
onListeningActionThinkListeningAction智能体处于倾听状态时的处理动作，默认值为 INTERRUPT。详见 ThinkListeningAction。
onThinkingActionThinkThinkingAction智能体处于思考状态时的处理动作，默认值为 IGNORE。详见 ThinkThinkingAction。
onSpeakingActionThinkSpeakingAction智能体处于说话状态时的处理动作，默认值为 IGNORE。详见 ThinkSpeakingAction。
interruptableboolean是否允许用户说话打断本次指令生成的响应，默认值为 true。
metadataRecord<string, string>可选的业务自定义键值对。
表格内容超出当前宽度，可横向滚动查看更多列。

ISubtitleHelperItem

TypeScript
export interface ISubtitleHelperItem<T> {
  uid: string
  stream_id: number
  turn_id: number
  _time: number
  text: string
  status: ETurnStatus
  metadata: T | null
}

字幕辅助项接口。

信息

自 1.6.0 版本新增。

定义字幕系统中单个字幕项的数据结构。包含用户 ID、流 ID、轮次 ID、时间戳、文本内容、状态和元数据等信息。

成员参数

参数数据类型描述
uidstring用户的唯一标识符。
stream_idnumber流标识符。
turn_idnumber会话中的轮次标识符。
_timenumber字幕的时间戳（单位为毫秒）。
textstring字幕文本内容。
statusETurnStatus字幕项的当前状态。详见 ETurnStatus。
metadataT | null附加的元数据信息。详见 T。
表格内容超出当前宽度，可横向滚动查看更多列。

TAgentMetric

TypeScript
export type TAgentMetric = {
  type: EModuleType
  name: string
  value: number
  timestamp: number
}

TAgentMetric 用于定义智能体指标统计数据类型。

信息

自 1.6.0 版本新增。

用于在智能体运行时存储指标数据，包括指标模块类型、名称、数值和时间戳。

成员参数

参数数据类型描述
typeEModuleType指标模块类型，详见 EModuleType。
namestring指标名称。
valuenumber指标数值。
timestampnumber数据采集时间戳（毫秒）。
表格内容超出当前宽度，可横向滚动查看更多列。

TModuleError

TypeScript
export type TModuleError = {
  type: EModuleType
  code: number
  message: string
  timestamp: number
}

TModuleError 模块错误类型定义。

信息

自 1.6.0 版本新增。

用于表示来自不同 AI 模块的错误信息，包括错误类型、错误码、错误信息和时间戳，便于错误处理和调试。错误码为模块特定内容，应由各模块单独说明。时间戳为 Unix 毫秒格式。错误信息应具备良好可读性，并提供可操作的信息。

成员参数

参数数据类型描述
typeEModuleType发生错误的模块类型，详见 EModuleType。
codenumber模块特定的错误码。
messagestring具备可读性的错误描述信息。
timestampnumber错误发生时的 Unix 毫秒时间戳。
表格内容超出当前宽度，可横向滚动查看更多列。

TStateChangeEvent

TypeScript
export type TStateChangeEvent = {
  state: EAgentState
  turnID: number
  timestamp: number
  reason: string
}

TStateChangeEvent 为状态变更事件的数据类型定义。

信息

自 1.6.0 版本新增。

成员参数

参数数据类型描述
stateEAgentState语音代理的当前状态。详见 EAgentState。
turnIDnumber当前会话轮次的唯一标识符。
timestampnumber状态变更发生时的时间戳（单位为毫秒）。
reasonstring状态变更的原因描述。
表格内容超出当前宽度，可横向滚动查看更多列。

咨询电话

400 632 6626

上海声网科技有限公司

Copyright © 2026 声网保留所有权利