このトピックでは、iOS SDK で使用されるデータの型について説明します。
データ構造の概要
構造タイプ | データの型 | 説明 |
Enum | メッセージ会話エージェントの接続ステータス | |
メッセージ会話エージェントの応答ステータス | ||
メッセージ会話エージェントのメッセージステータス | ||
メッセージ会話エージェントのメッセージタイプ | ||
メッセージ会話エージェントのメッセージ再生ステータス | ||
Class | メッセージ会話のユーザー情報 | |
メッセージ会話のエージェント情報 | ||
メッセージ会話エージェントの接続トークン | ||
メッセージ会話の 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
メッセージ会話エージェントの接続トークン
プロパティ名 | タイプ | 説明 |
appId | String | アプリケーション ID |
appSign | String | アプリケーション署名 |
token | String | 認証トークン |
timestamp | Int | 有効期限のタイムスタンプ |
role | String? | ロール。'admin' に設定すると、IM コントロールインターフェイスを呼び出すことができます |
nonce | String? | "AK-ランダム文字列"、最大 64 バイト、A-Z、a-z、0-9 および "_" に限定されます |
ARTCAIChatTemplateConfig
メッセージ会話のテンプレート構成パラメーター
プロパティ名 | タイプ | 説明 |
bailianAppParams | [String: Any]? | Alibaba Cloud Model Studio のアプリケーションセンターのパラメーター |
agentVoiceId | String? | エージェントの音声トーン ID。Empty の場合はエージェントの構成値を使用します |
ARTCAIChatAgentShareConfig
メッセージ会話エージェントの共有構成情報
プロパティ名 | タイプ | 説明 |
shareId | String? | エージェント共有 ID |
expireTime | Date? | 有効期限 |
region | String? | サービスリージョン |
ARTCAIChatMessage
メッセージ会話エージェントのメッセージ定義
プロパティ名 | タイプ | 説明 |
dialogueId | String | メッセージ ID |
isDialogueEnd | Bool | 現在の対話応答が終了したかどうか |
nodeId | String? | 現在がサブメッセージの場合、サブメッセージ情報 (ノード ID) をマークするために使用されます |
requestId | String | 会話ラウンド ID |
messageState | メッセージステータス | |
messageType | メッセージタイプ | |
text | String | 元のテキストコンテンツ |
isEnd | Bool | 現在のメッセージが終了したかどうか |
senderId | String? | 送信者 ID: ユーザーまたはエージェント |
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 |