รับข้อมูลอ้างอิงความรู้

รับข้อมูลอ้างอิงความรู้

ดึงข้อมูลส่วนของฐานความรู้ (knowledge base slice) ที่ถูกอ้างอิงในคำตอบของ Agent โดยรวมถึงเนื้อหาของ slice, รหัสเอกสาร, ชื่อเอกสาร, 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 ${API Key} ใช้ Authorization: Bearer ${API Key} สำหรับการรับรองความถูกต้อง สามารถขอ API key ได้จากหน้า API Key

พารามิเตอร์สำหรับร้องขอ

ฟิลด์ ประเภท จำเป็น คำอธิบาย
message_id string ใช่ รหัสข้อความของคำตอบจาก Agent

การตอบกลับ

ตัวอย่างการตอบกลับ

{ "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 รหัสการสนทนา
question_id string รหัสข้อความของคำถามผู้ใช้
answer_id string รหัสข้อความของคำตอบ Agent
correlate_dataset JSON Array ข้อมูล Dataset ที่เกี่ยวข้อง
content string เนื้อหาของ slice ฐานความรู้
data_id string รหัสเอกสาร
data_name string ชื่อเอกสาร
source_url string URL แหล่งที่มาเอกสาร
score string คะแนนความเกี่ยวข้องเชิงความหมายระหว่าง slice ฐานความรู้กับปัญหา

การตอบกลับเมื่อเกิดข้อผิดพลาด

ฟิลด์ ประเภท คำอธิบาย
code int รหัสข้อผิดพลาด
message string รายละเอียดข้อผิดพลาด

รหัสข้อผิดพลาด

รหัส ข้อความ
40000 พารามิเตอร์ไม่ถูกต้อง
40379 เครดิตไม่เพียงพอ
200222 การตั้งค่า Agent ไม่รองรับฟีเจอร์นี้
40378 Agent ถูกลบแล้ว
20055 API ถูกระงับการใช้งาน
40127 การรับรองตัวตนของนักพัฒนาไม่สำเร็จ