関連ドキュメントの取得
関連ドキュメントの取得
message_idという入力パラメータに基づき、エージェントがそのメッセージに対して返答した際に参照したドキュメントのデータを取得します。このデータには参照されたドキュメントのID、名前、およびリソースURLといった情報が含まれます。
リクエストメソッド
POST
リクエストURL
https://api.gptbots.ai/v1/bot/data/references
リクエスト認証
認証の詳細は「概要」セクションをご参照ください。
リクエスト
リクエスト例
curl -X POST
-H 'Authorization: Bearer your_apikey'
-H 'Content-Type: application/json'
-d '{"message_id": "xxxxx"}'
"https://api.gptbots.ai/v1/bot/data/references"
curl -X POST
-H 'Authorization: Bearer your_apikey'
-H 'Content-Type: application/json'
-d '{"message_id": "xxxxx"}'
"https://api.gptbots.ai/v1/bot/data/references"
このコードブロックをポップアップで表示
リクエストヘッダー
| フィールド | タイプ | 説明 |
|---|---|---|
| Authorization | Bearer ${token} | 認証には Authorization: Bearer ${token} を使用してください。トークンはAPIキーページから取得できます。 |
| Content-Type | application/json | データの形式は application/json を設定してください。 |
リクエストボディ
| フィールド | タイプ | 必須 | 説明 |
|---|---|---|---|
| message_id | String | true | エージェントのレスポンスに対応するメッセージID |
レスポンス
レスポンス例
{
"code": 0,
"msg": "success",
"data": {
"conversationId": "65dc320df07244300b25b993",
"questionId": "65dc323ef07244300b25b9c5",
"answerId": "65dc323ef07244300b25b9c6",
"refDoc": [
{
"dataId": "65dc3234f07244300b25b9b9",
"dataName": "中国の歴史",
"sourceUrl": "https://www.example.com/chinese-history"
}
]
}
}
{
"code": 0,
"msg": "success",
"data": {
"conversationId": "65dc320df07244300b25b993",
"questionId": "65dc323ef07244300b25b9c5",
"answerId": "65dc323ef07244300b25b9c6",
"refDoc": [
{
"dataId": "65dc3234f07244300b25b9b9",
"dataName": "中国の歴史",
"sourceUrl": "https://www.example.com/chinese-history"
}
]
}
}
このコードブロックをポップアップで表示
成功時のレスポンス
| フィールド | タイプ | 説明 |
|---|---|---|
| conversationId | String | 会話ID |
| questionId | String | ユーザー質問のメッセージID |
| answerId | String | エージェント回答のメッセージID |
| refDoc | JSON Array | 参照されたドキュメントデータ |
| dataId | String | ドキュメントID |
| dataName | String | ドキュメントの名前 |
| sourceUrl | String | ドキュメントのソースURL |
エラー時のレスポンス
| フィールド | タイプ | 説明 |
|---|---|---|
| code | Int | エラーコード |
| msg | String | エラーの詳細内容 |
エラーコード
| コード | メッセージ |
|---|---|
| 40000 | 無効なパラメータ |
| 40379 | クレジットが不足しています |
| 40378 | エージェントが削除されました |
| 20055 | このAPIは使用できません |
| 40127 | 開発者認証に失敗しました |