通过阅读本文，您可以了解iOS SDK涉及的数据类型。
数据结构概览
结构类型 | 数据类型 | 描述 |
Enum | 消息对话智能体连接状态 | |
消息对话智能体响应状态 | ||
消息对话智能体消息状态 | ||
消息对话智能体消息类型 | ||
消息对话智能体消息播放状态 | ||
Class | 消息对话用户信息 | |
消息对话智能体信息 | ||
消息对话智能体连接Token | ||
用于消息对话的 TemplateConfig 参数 | ||
消息对话智能体共享配置信息 | ||
消息对话智能体消息定义 | ||
消息对话智能体发送消息请求 | ||
消息对话智能体消息列表请求 |
数据结构详情
Enum
ARTCAIChatEngineState
消息对话智能体连接状态
枚举值 | 值 | 描述 |
Init | 0 | 未连接 |
Connecting | 1 | 连接中 |
Connected | 2 | 已连接 |
Disconnect | 3 | 连接断开 |
ARTCAIChatAgentResponseState
消息对话智能体响应状态
枚举值 | 值 | 描述 |
Listening | 1 | 聆听中 |
Thinking | 2 | 思考中 |
Replying | 3 | 回复中 |
ARTCAIChatMessageState
消息对话智能体消息状态
枚举值 | 值 | 描述 |
Init | 1 | 初始状态 |
Transfering | 2 | 传输中（发送中/接收中） |
Printing | 3 | 输出中 |
Interrupted | 4 | 打断了 |
Finished | 5 | 结束了 |
Failed | 6 | 出错了 |
ARTCAIChatMessageType
消息对话智能体消息类型
枚举值 | 值 | 描述 |
Text | 0 | 文本类型 |
Voice | 1 | 语音类型 |
ARTCAIChatMessagePlayState
消息对话智能体消息播放状态
枚举值 | 值 | 描述 |
Init | 0 | 初始状态 |
Playing | 1 | 播放中 |
Stopped | 2 | 播放已停止 |
Failed | 3 | 播放出错了 |
Class
ARTCAIChatUserInfo
消息对话用户信息
属性名 | 类型 | 描述 |
userId | String | 用户Id |
deviceId | String? | 设备Id |
ARTCAIChatAgentInfo
消息对话智能体信息
属性名 | 类型 | 描述 |
agentId | String | 智能体Id |
region | String | 智能体服务所在的区域，默认使用上海区域 |
ARTCAIChatAuthToken
消息对话智能体连接Token
属性名 | 类型 | 描述 |
appId | String | 应用id |
appSign | String | 应用签名 |
token | String | 鉴权token |
timestamp | Int | 过期时间戳 |
role | String? | 角色，为 admin 时可调用 IM 管控接口 |
nonce | String? | "AK-随机串"，最长64字节，仅限 A-Z,a-z,0-9 及 "_" |
ARTCAIChatTemplateConfig
用于消息对话的 TemplateConfig 参数
属性名 | 类型 | 描述 |
bailianAppParams | [String: Any]? | 百炼应用中心参数 |
agentVoiceId | String? | 智能体讲话音色 ID，为空表示使用智能体配置值 |
ARTCAIChatAgentShareConfig
消息对话智能体共享配置信息
属性名 | 类型 | 描述 |
shareId | String? | 智能体分享ID |
expireTime | Date? | 过期时间 |
region | String? | 服务所在区域 |
ARTCAIChatMessage
消息对话智能体消息定义
属性名 | 类型 | 描述 |
dialogueId | String | 消息 ID |
isDialogueEnd | Bool | 当前 dialogue 是否回答结束 |
nodeId | String? | 如果当前是子消息，则用于标记子消息信息（Node ID） |
requestId | String | 对话回合 ID |
messageState | 消息状态 | |
messageType | 消息类型 | |
text | String | 原始文本内容 |
isEnd | Bool | 当前消息是否已结束 |
senderId | String? | 发送方用户标识：用户 或 智能体 |
sendTime | TimeInterval | 消息发送时间 |
source | String? | 消息发送源：chat(消息对话智能体) 或 call(通话智能体) |
sourceType | String? | 消息类型，不同场景下的值不同： 通话场景：greeting / normal / speech 消息对话场景：normal / announcement / custom |
reasoningText | String? | 推理过程中的内容 |
isReasoningEnd | Bool | 推理是否结束 |
attachmentList | [ARTCAIChatAttachment]? | 附件列表 |
extend | String? | 用户自定义扩展信息 |
ARTCAIChatSendMessageRequest
消息对话智能体发送消息请求
属性名 | 类型 | 描述 |
requestId | String | 请求 ID |
messageType | 消息类型 | |
text | String | 原始文本内容，messageType 为文本类型时不能为空 |
attachmentUploader | ARTCAIChatAttachmentUploader? | 附件上传器 |
ARTCAIChatMessageListRequest
消息对话智能体消息列表请求
属性名 | 类型 | 描述 |
startTime | TimeInterval | 开始 Unix 时间戳（不含），单位为秒 |
endTime | TimeInterval | 结束 Unix 时间戳（包含），单位为秒 |
pageNumber | Int | 分页数 |
pageSize | Int | 分页大小，最大 100，默认 20 |
isDesc | Bool | 是否倒序，默认 true |