全部產品
Search
文件中心

Intelligent Media Services:資料結構

更新時間:May 17, 2025

通過閱讀本文,您可以瞭解iOS SDK涉及的資料類型。

資料結構概覽

結構類型

資料類型

描述

Enum

ARTCAIChatEngineState

訊息對話智能體串連狀態

ARTCAIChatAgentResponseState

訊息對話智能體響應狀態

ARTCAIChatMessageState

訊息對話智能體訊息狀態

ARTCAIChatMessageType

訊息對話智能體訊息類型

ARTCAIChatMessagePlayState

訊息對話智能體訊息播放狀態

Class

ARTCAIChatUserInfo

訊息對話使用者資訊

ARTCAIChatAgentInfo

訊息對話智能體資訊

ARTCAIChatAuthToken

訊息對話智能體串連Token

ARTCAIChatTemplateConfig

用於訊息對話的 TemplateConfig 參數

ARTCAIChatAgentShareConfig

訊息對話智能體共用配置資訊

ARTCAIChatMessage

訊息對話智能體訊息定義

ARTCAIChatSendMessageRequest

訊息對話智能體發送訊息請求

ARTCAIChatMessageListRequest

訊息對話智能體訊息列表請求

資料結構詳情

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

ARTCAIChatMessageState

訊息狀態

messageType

ARTCAIChatMessageType

訊息類型

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

ARTCAIChatMessageType

訊息類型

text

String

原始常值內容,messageType 為文本類型時不可為空

attachmentUploader

ARTCAIChatAttachmentUploader?

附件上傳器

ARTCAIChatMessageListRequest

訊息對話智能體訊息列表請求

屬性名稱

類型

描述

startTime

TimeInterval

開始 Unix 時間戳記(不含),單位為秒

endTime

TimeInterval

結束 Unix 時間戳記(包含),單位為秒

pageNumber

Int

分頁數

pageSize

Int

分頁大小,最大 100,預設 20

isDesc

Bool

是否倒序,預設 true