5.2.1.20.10. メッセージ履歴の取得¶
クライアントとアシスタントの間でやり取りを行ったメッセージ履歴を取得するタスクです。
注意
このタスクはロジックフローを生成AIアシスタントとして登録、実行した場合に利用可能です。
5.2.1.20.10.1. 入力値¶
im_copilotGetAssistantMessageHistory <object> *
├─ limit <integer>
└─ threadId <string> *
| 項目名 | 必須/任意 | 型 | 配列/リスト | 説明 |
|---|---|---|---|---|
| im_copilotGetAssistantMessageHistory | 必須 | object | なし | - |
| limit | 任意 | integer | なし | メッセージ履歴の最大取得件数を指定してください。 |
| threadId | 必須 | string | なし | メッセージ履歴を特定するスレッドIDを指定してください。 |
コラム
最大取得件数を指定すると新しいデータから取得件数分の履歴データが取得されます。
5.2.1.20.10.2. 出力値¶
im_copilotGetAssistantMessageHistory <object>
├─ contents <object[]>
│ ├─ image <binary>
│ ├─ text <string>
├─ recordDate <date>
└─ role <string>
| 項目名 | 型 | 配列/リスト | 説明 |
|---|---|---|---|
| im_copilotGetAssistantMessageHistory | object | 配列 | メッセージ履歴 |
| contents | object | 配列 | メッセージ本文、画像のリスト |
| image | binary | なし | 画像 |
| text | string | なし | メッセージ本文 |
| recordDate | date | なし | メッセージ保存日時 |
| role | string | なし | 役割 |
コラム
メッセージ履歴は古い履歴から登録順にソートされた配列が返却されます。
指定されたスレッドIDのメッセージ履歴が存在しない場合は空配列が返却されます。