รับรายการเอกสารความรู้

รับรายการเอกสารความรู้

ดึงรายการเอกสารความรู้ในฐานข้อมูลความรู้ภายใน Agent

วิธีการร้องขอ

GET

URL สำหรับร้องขอ

https://api-${endpoint}.gptbots.ai/v1/bot/doc/query/page

การยืนยันตัวตนในการร้องขอ

ดูรายละเอียดการยืนยันตัวตนได้ที่ Overview

การร้องขอ

ตัวอย่างการร้องขอ

curl -X GET 'https://api.gptbots.ai/v1/bot/doc/query/page?page=1&page_size=10&knowledge_base_id=67457fea6f658672d6482542' \ -H 'Authorization: Bearer ${API Key}'
                      
                      curl -X GET 'https://api.gptbots.ai/v1/bot/doc/query/page?page=1&page_size=10&knowledge_base_id=67457fea6f658672d6482542' \
-H 'Authorization: Bearer ${API Key}'

                    
บล็อกโค้ดนี้ในหน้าต่างลอย

Header ของการร้องขอ

ฟิลด์ ประเภท รายละเอียด
Authorization Bearer ${API Key} ใช้ Authorization: Bearer ${API Key} สำหรับยืนยันตัวตน รับ API Key ได้จากหน้า API Key

พารามิเตอร์ของการร้องขอ

ฟิลด์ ประเภท จำเป็นต้องกรอก รายละเอียด
knowledge_base_id String ใช่ รหัสของฐานข้อมูลความรู้
page Integer ใช่ หมายเลขหน้า เริ่มต้นที่ 1
page_size Integer ใช่ จำนวนเอกสารต่อหน้า กำหนดในช่วง 10-100

การตอบกลับ

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

{ "list": [ { "id": "xxxxxx", "name": "My Doc", "format": "pdf", "source_url": "https://gptbots.ai/article_1.pdf", "status": "ACTIVE", "chunk": 100, "token": 1000000, "char_count": 10000000, "create_time": 1699843200, "update_time": 1699843200, "creator_id": "xxxxxx", "creator_email": "johnlee@gptbots.ai" }, { "id": "xxxxxx", "name": "My Doc 2", "format": "txt", "source_url": "https://gptbots.ai/article_2.html", "status": "ACTIVE", "chunk": 100, "token": 1000000, "char_count": 10000000, "create_time": 1699843200, "update_time": 1699843200, "creator_id": "xxxxxx", "creator_email": "johnlee@gptbots.ai" } ], "total": 100 }
                      
                      {
    "list": [
        {
            "id": "xxxxxx",
            "name": "My Doc",
            "format": "pdf",
            "source_url": "https://gptbots.ai/article_1.pdf",
            "status": "ACTIVE",
            "chunk": 100,
            "token": 1000000,
            "char_count": 10000000,
            "create_time": 1699843200,
            "update_time": 1699843200,
            "creator_id": "xxxxxx",
            "creator_email": "johnlee@gptbots.ai"
        },
        {
            "id": "xxxxxx",
            "name": "My Doc 2",
            "format": "txt",
            "source_url": "https://gptbots.ai/article_2.html",
            "status": "ACTIVE",
            "chunk": 100,
            "token": 1000000,
            "char_count": 10000000,
            "create_time": 1699843200,
            "update_time": 1699843200,
            "creator_id": "xxxxxx",
            "creator_email": "johnlee@gptbots.ai"
        }
    ],
    "total": 100
}

                    
บล็อกโค้ดนี้ในหน้าต่างลอย

การตอบกลับเมื่อสำเร็จ

ชื่อฟิลด์ ประเภท รายละเอียด
list Array<Object> รายการเอกสาร
id String รหัสเอกสาร
name String ชื่อเอกสาร
format String รูปแบบของเอกสาร
source_url String URL ต้นทางของเอกสาร
status String สถานะของเอกสาร
chunk Integer จำนวนชิ้นความรู้ในเอกสาร
token Integer จำนวนโทเคนในเอกสาร
char_count Integer จำนวนตัวอักษรในเอกสาร
create_time Long เวลาสร้างเอกสาร (timestamp)
update_time Long เวลาปรับปรุงเอกสาร (timestamp)
creator_id String รหัสผู้สร้างเอกสาร
creator_email String อีเมลของผู้สร้างเอกสาร
total Integer จำนวนเอกสารทั้งหมดที่พบ

การตอบกลับเมื่อไม่สำเร็จ

ฟิลด์ ประเภท รายละเอียด
code Int รหัสข้อผิดพลาด
message String รายละเอียดข้อผิดพลาด