รับรายการฟิลด์ข้อมูลเมตา
รับรายการฟิลด์ข้อมูลเมตา
เรียกดูคำจำกัดความของฟิลด์ข้อมูลเมตาใน Agent โดยจัดกลุ่มผลลัพธ์เป็นฟิลด์ส่วนกลางและฟิลด์เฉพาะของแต่ละฐานความรู้ ระบบจะไม่ส่งคืนฟิลด์ที่กำหนดไว้ล่วงหน้า เช่น document_name
เมธอดคำขอ
GET
Endpoint
https://api-${endpoint}.gptbots.ai/v1/bot/doc/metadata/field/list
การยืนยันตัวตน
ดูรายละเอียดการยืนยันตัวตนได้ที่ ภาพรวม API
คำขอ
ตัวอย่างคำขอ
curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/bot/doc/metadata/field/list' \
-H 'Authorization: Bearer ${API Key}'
curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/bot/doc/metadata/field/list' \
-H 'Authorization: Bearer ${API Key}'
บล็อกโค้ดนี้ในหน้าต่างลอย
ส่วนหัวคำขอ
| ฟิลด์ | ประเภท | คำอธิบาย |
|---|---|---|
| Authorization | Bearer ${API Key} | ยืนยันตัวตนด้วย Authorization: Bearer ${API Key} และรับ API Key ได้จากหน้าคีย์ API |
พารามิเตอร์คำขอ
ไม่มีพารามิเตอร์คำขอ ระบบจะระบุ Agent จาก API Key
การตอบกลับ
ตัวอย่างการตอบกลับ
{
"global_fields": [
{
"id": "665f1c8a9b2e4d001a3f0001",
"name": "category",
"display_name": "หมวดหมู่",
"type": "LIST",
"options": ["เทคนิค", "ผลิตภัณฑ์"],
"description": "หมวดหมู่เอกสาร",
"ai_search_filter": true,
"is_predefined": false
}
],
"knowledge_bases": [
{
"knowledge_base_id": "kb_001",
"knowledge_base_name": "เอกสารผลิตภัณฑ์",
"fields": [
{
"id": "665f1c8a9b2e4d001a3f0009",
"name": "product_line",
"display_name": "สายผลิตภัณฑ์",
"type": "STRING",
"options": null,
"description": "",
"ai_search_filter": false,
"is_predefined": false
}
]
},
{
"knowledge_base_id": "kb_002",
"knowledge_base_name": "คำถามที่พบบ่อยหลังการขาย",
"fields": []
}
]
}
{
"global_fields": [
{
"id": "665f1c8a9b2e4d001a3f0001",
"name": "category",
"display_name": "หมวดหมู่",
"type": "LIST",
"options": ["เทคนิค", "ผลิตภัณฑ์"],
"description": "หมวดหมู่เอกสาร",
"ai_search_filter": true,
"is_predefined": false
}
],
"knowledge_bases": [
{
"knowledge_base_id": "kb_001",
"knowledge_base_name": "เอกสารผลิตภัณฑ์",
"fields": [
{
"id": "665f1c8a9b2e4d001a3f0009",
"name": "product_line",
"display_name": "สายผลิตภัณฑ์",
"type": "STRING",
"options": null,
"description": "",
"ai_search_filter": false,
"is_predefined": false
}
]
},
{
"knowledge_base_id": "kb_002",
"knowledge_base_name": "คำถามที่พบบ่อยหลังการขาย",
"fields": []
}
]
}
บล็อกโค้ดนี้ในหน้าต่างลอย
การตอบกลับเมื่อสำเร็จ
| ฟิลด์ | ประเภท | คำอธิบาย |
|---|---|---|
| global_fields | Array<Object> | ฟิลด์ส่วนกลางที่ใช้กับเอกสารทั้งหมดภายใต้ Agent |
| id | String | ฟิลด์ ID ใช้เมื่อแก้ไข/ลบ |
| name | String | ตัวระบุภายในของฟิลด์ ตัวพิมพ์เล็ก ไม่ซ้ำกัน |
| display_name | String | ชื่อที่แสดงของฟิลด์ ไม่ซ้ำกัน |
| type | String | ประเภทฟิลด์: STRING / NUMBER / DATETIME / LIST |
| options | Array<String> | ตัวเลือกการแจงนับประเภท LIST ประเภทอื่นๆ คือ null |
| description | String | คำอธิบายฟิลด์ |
| ai_search_filter | Boolean | ระบุว่าใช้ฟิลด์นี้เป็นตัวกรอง AI Search หรือไม่ |
| is_predefined | Boolean | ระบุว่าเป็นฟิลด์ที่ระบบกำหนดไว้ล่วงหน้าหรือไม่ |
| knowledge_bases | Array<Object> | แต่ละฐานความรู้และฟิลด์เฉพาะของฐานความรู้นั้น |
| knowledge_base_id | String | ID ของฐานความรู้ |
| knowledge_base_name | String | ชื่อฐานความรู้ |
| fields | Array<Object> | ฟิลด์เฉพาะของฐานความรู้นี้ มีโครงสร้างเหมือน global_fields |
การตอบกลับเมื่อเกิดข้อผิดพลาด
| ฟิลด์ | ประเภท | คำอธิบาย |
|---|---|---|
| code | Integer | รหัสข้อผิดพลาด |
| message | String | รายละเอียดข้อผิดพลาด |
