数据结构

通过阅读本文,您可以了解Android SDK涉及的数据类型。

数据结构概览

结构类型

数据类型

描述

Enum

ARTCAIChatEngineState

引擎状态

ARTCAIChatAgentState

智能体状态

ARTCAIChatMessageType

消息类型

ARTCAIChatMessageState

智能体消息状态

ARTCAIChatErrorCode

智能体错误码

ARTCAIChatMessagePlayState

Chat智能体消息播放类型

Class

ARTCAIChatMessage

消息对话消息结构体

ARTCAIChatAttachment

附件对象结构体

ARTCAIChatSendMessageRequest

消息发送请求对象

ARTCAIChatMessageListRequest

历史消息列表请求对象

ARTCAIChatUserInfo

用户信息对象

ARTCAIChatAgentInfo

智能体信息

ARTCAIChatAuthToken

授权信息对象

ARTCAIChatTemplateConfig

消息对话的TemplateConfig参数

数据结构详情

Enum

ARTCAIChatEngineState

引擎状态

枚举名

描述

Init

未连接

Connecting

连接中

Connected

已连接

Disconnected

链接断开

ConnectFailed

链接失败

ARTCAIChatAgentState

智能体状态

枚举名

描述

Listening

聆听中

Thinking

思考中

Replaying

回复中

ARTCAIChatMessageType

消息类型

枚举名

描述

Text

文本类型

Voice

按键语音

ARTCAIChatMessageState

智能体消息状态

枚举名

描述

Init

初始状态

Transfering

传输中(发送中/接收中)

Printing

输出中

Interrupted

打断了

Finished

结束了

Failed

出错了

ARTCAIChatErrorCode

智能体错误码

枚举名

描述

None

无错误

UnknownError

未知错误

InvalidEngineState

引擎状态非法

InvalidParam

接口参数非法

InvalidUserInfo

用户信息参数非法

InvalidAuthInfo

鉴权非法

SendMessageFailed

发送消息失败

InterruptAgentFailed

中断智能体失败

DeleteMessageFailed

删除消息失败

AgentNotFound

Agent找不到

ChatInternalError

未知错误

StartPlayMessageFailed

文本播放错误

StopPlayMessageFailed

文本结束播放错误

VoiceMessageRecordFailed

按键语音采集错误

VoiceMessageSendFailed

按键语音发送错误

KickedOutBySystem

被系统踢出

KickedByUserReplace

相同UserId的不同设备登录导致通话无法进行

AgentError

Agent报的错误

AttachmentNotAllUploadSuccess

有附件没有上传成功

ARTCAIChatMessagePlayState

消息对话智能体消息播放类型

枚举名

描述

Init

初始状态

Playing

播放中

Stopped

停止播放

Failed

播放错误

Class

ARTCAIChatMessage

消息对话消息结构体

参数

类型

含义

dialogueId

String

消息ID

requestId

String

对话回合请求ID

messageState

int

消息状态

messageType

String

消息类型

sendTime

long

消息发送或接收时间

text

String

消息内容

senderId

String

消息发送者

isEnd

boolean

对应sentenceId是否已结束

isDialogueEnd

boolean

当前提问的问题智能体是否完整回答结束, 如果当前智能体回答存在多个子消息,那么isDialogueEnd=true的情况下,表示当前智能体回答已经完整回答结束。

reasoningText

String

深度思考的文本内容,如果内容非空,则有思考中的过程及文案

isReasoningEnd

boolean

思考过程是否结束

source

String

消息发送源:chat(消息对话智能体) 或 call(通话智能体)

sourceType

String

消息类型,不同场景下的值不同

  • 通话场景:

    • greeting:欢迎语

    • normal:语音回复

    • speech:主动播报

  • 消息对话场景:

    • normal:文本回复

    • announcement:主动推送文字

    • custom:自定义消息

nodeID

String

分片消息对应的节点信息

extend

String

用户自定义扩展信息

ARTCAIChatAttachment

附件对象结构体

参数

类型

含义

attachmentId

String

附件ID

attachmentType

String

附件类型,Image、Audio、Video、Other

attachmentName

String

附件名称

path

String

附件文件完整路径

extra

String

附件的额外信息

progress

float

附件的上传进度,百分比进度:0.00-100.00

ARTCAIChatSendMessageRequest

消息发送请求对象

参数

类型

含义

requestId

String

请求ID

messageType

ARTCAIChatMessageType

消息类型,可以指定Text(文本)和Voice(按键语音)

text

String

消息内容

ARTCAIChatMessageListRequest

历史消息列表请求对象

参数

类型

含义

startTime

long

开始Unix时间戳(不含),单位为秒

endTime

long

结束Unix时间戳(不含),单位为秒

pageNumber

int

分页数

pageSize

int

分页大小,最大100,默认20

isDesc

boolean

是否降序

ARTCAIChatUserInfo

用户信息对象

参数

类型

含义

userId

String

用户ID

deviceId

String

设备ID,可空

ARTCAIChatAgentInfo

智能体信息

参数

类型

含义

agentId

String

智能体Id

region

String

智能体服务所在的区域,默认使用上海区域

ARTCAIChatAuthToken

授权信息对象

参数

类型

含义

appId

String

互动消息应用ID

appSign

String

互动消息应用签名

token

String

鉴权token

timestamp

long

过期时间戳

role

String

角色,为admin时,表示该用户可以调用管控IM接口,可为空

nonce

String

”AK-随机串“,最长64字节, 仅限A-Z,a-z,0-9及“_”,可为空

ARTCAIChatTemplateConfig

消息对话的TemplateConfig参数

参数

类型

含义

bailianAppParams

String

阿里云百炼应用中心参数

agentVoiceId

String

智能体讲话音色Id,为空表示使用智能体配置值