API Reference / Agent API / 関連データセットの取得

関連データセットの取得

エージェントの回答に使われたナレッジベースの情報（関連する一部分）を取得します。取得できる情報には、その内容、元になったドキュメントのIDやタイトル、出典となるURL、そして回答との関連度スコアなどが含まれます。

リクエストメソッド

GET

リクエストURL

https://api-${endpoint}.gptbots.ai/v1/correlate/dataset

リクエスト認証

認証方法の説明についてはAPI Overviewをご参照ください。

リクエスト

リクエスト例

curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/correlate/dataset?message_id=65e04591a0e1e42392696d78' \ -H 'Authorization: Bearer ${API Key}'

                      
                      curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/correlate/dataset?message_id=65e04591a0e1e42392696d78' \
-H 'Authorization: Bearer ${API Key}'

このコードブロックをポップアップで表示

リクエストヘッダー

フィールド	タイプ	説明
Authorization	Bearer ${token}	認証には `Authorization: Bearer ${token}` を使用してください。トークンはAPIキーページから取得できます。
Content-Type	application/json	データの形式は `application/json` を設定してください。

リクエストボディ

フィールド	タイプ	必須	説明
message_id	String	必須	エージェントのレスポンスメッセージID

レスポンス

レスポンス例

{ "conversation_id": "65dc320df07244300b25b993", "question_id": "65dc323ef07244300b25b9c5", "answer_id": "65dc323ef07244300b25b9c6", "correlate_dataset": [ { "content": "The Great Wall of China was built to resist the invasion of northern nomadic tribes.", "data_id": "65dc3234f07244300b25b9b9", "data_name": "Chinese History", "source_url": "https://www.example.com/chinese-history", "score": 0.93492633 } ] }

                      
                      {
    "conversation_id": "65dc320df07244300b25b993",
    "question_id": "65dc323ef07244300b25b9c5",
    "answer_id": "65dc323ef07244300b25b9c6",
    "correlate_dataset": [
        {
            "content": "The Great Wall of China was built to resist the invasion of northern nomadic tribes.",
            "data_id": "65dc3234f07244300b25b9b9",
            "data_name": "Chinese History",
            "source_url": "https://www.example.com/chinese-history",
            "score": 0.93492633
        }
    ]
}

このコードブロックをポップアップで表示

成功時のレスポンス

フィールド	タイプ	説明
conversation_id	String	会話ID
question_id	String	ユーザーの質問メッセージID
answer_id	String	エージェントのレスポンスメッセージID
correlate_dataset	JSON Array	関連ナレッジデータセット
content	String	ナレッジスライスの内容
data_id	String	ドキュメントID
data_name	String	ドキュメント名
source_url	String	ドキュメントの出典URL
score	String	ナレッジスライスと質問との意味的関連度スコア

エラー時のレスポンス

フィールド	タイプ	説明
code	Int	エラーコード
message	String	エラーの詳細情報

エラーコード

コード	メッセージ
40000	無効なパラメータ
40379	クレジットが不足しています
200222	エージェントの設定がこの機能に対応していません
40378	エージェントが削除されました
20055	このAPIは使用できません
40127	開発者認証に失敗しました