ความรู้
API การอนุญาต
NOTE
- เพื่อขอรับ AUTH_TOKEN โปรดดูที่ ขอรับ AUTH_TOKEN.
- โปรดตรวจสอบให้แน่ใจว่าการร้องขอ API ทั้งหมดรวม AUTH_TOKEN ในส่วนหัวของคำร้องขอ ดังที่แสดงด้านล่าง:
SDK การอนุญาต
NOTE
- ก่อนรวม SDK โปรดตรวจสอบให้แน่ใจว่าคุณได้รับ APP_ID และ APP_KEY แล้ว
- ในการขอรับข้อมูลประจำตัวของคุณ ดูที่ ขอรับ APP_ID และ APP_KEY.
ฐานความรู้
API คำขอ
- ตัวอย่าง
- คำอธิบายฟิลด์
| ชื่อพารามิเตอร์ | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
| page | Integer | N | หมายเลขหน้า เริ่มจาก 0. |
| size | Integer | N | จำนวนระเบียนที่ต้องการส่งกลับต่อหน้า |
| keyword | String | N | คำหลักที่ต้องการค้นหา |
API การตอบกลับ
- ตัวอย่าง
- คำอธิบายฟิลด์
| ชื่อพารามิเตอร์ | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
| pageNum | Integer | Y | หมายเลขหน้า เริ่มจาก 0. |
| pageSize | Integer | Y | จำนวนระเบียนที่ต้องการส่งกลับต่อหน้า |
| total | Integer | Y | จำนวนระเบียนทั้งหมด |
| pages | Integer | Y | จำนวนหน้าทั้งหมด |
| currentPageTotal | Integer | Y | จำนวนระเบียนที่ส่งกลับในหน้าปัจจุบัน |
| content | Array<Object> | Y | เนื้อหาของรายการฐานความรู้ |
| content.id | Integer | Y | รหัสประจำตัวเฉพาะของฐานความรู้ |
| content.name | String | Y | ชื่อของฐานความรู้ |
| content.description | String | Y | คำอธิบายของฐานความรู้ |
| content.status | String | Y | สถานะของฐานความรู้ ENABLED/DISABLED |
| content.totalDoc | Integer | Y | จำนวนเอกสารทั้งหมดในฐานความรู้ |
| content.totalRecord | Integer | Y | จำนวนระเบียนทั้งหมดในฐานความรู้ |
| content.createDatetime | Timestamp | Y | เวลาสร้างฐานความรู้ |
| content.updateDatetime | Timestamp | Y | เวลาอัปเดตฐานความรู้ |
เอกสารความรู้
API คำขอ
- ตัวอย่าง
- คำอธิบายฟิลด์
| ชื่อพารามิเตอร์ | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
| page | Integer | N | หมายเลขหน้า เริ่มจาก 0. |
| size | Integer | N | จำนวนระเบียนที่ต้องการส่งกลับต่อหน้า |
| keyword | String | N | คำหลักที่ต้องการค้นหา |
| knowledgeBaseId | Integer | Y | ตัวระบุเฉพาะสำหรับฐานความรู้ |
API การตอบกลับ
- ตัวอย่าง
- คำอธิบายฟิลด์
| ชื่อพารามิเตอร์ | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
| pageNum | Integer | Y | หมายเลขหน้า เริ่มจาก 0. |
| pageSize | Integer | Y | จำนวนระเบียนที่ต้องการส่งกลับต่อหน้า |
| total | Integer | Y | จำนวนระเบียนทั้งหมด |
| pages | Integer | Y | จำนวนหน้าทั้งหมด |
| currentPageTotal | Integer | Y | จำนวนระเบียนที่ส่งกลับในหน้าปัจจุบัน |
| content | Array<Object> | Y | เนื้อหาของเอกสารฐานความรู้ |
| content.id | Integer | Y | รหัสเฉพาะสำหรับเอกสารฐานความรู้ |
| content.name | String | Y | ชื่อของเอกสารฐานความรู้ |
| content.type | String | Y | ประเภทของเอกสารฐานความรู้ TEXT_PLAIN/MARKDOWN/ APPLICATION_PDF/DOCX |
| content.source | String | Y | แหล่งที่มาของเอกสารฐานความรู้ LOCAL/ONLINE |
| content.status | String | Y | สถานะของเอกสารฐานความรู้ UN_PROCESS/PROCESSING/ PROCESSING_FAILED/PROCESSED |
| content.totalRecord | Integer | Y | จำนวนทั้งหมดของระเบียนในเอกสารฐานความรู้ |
| content.createDatetime | Timestamp | Y | เวลาสร้างเอกสารฐานความรู้ |
| content.updateDatetime | Timestamp | Y | เวลาอัปเดตเอกสารฐานความรู้ |
อัปโหลดเอกสารความรู้
API คำขอ
- ตัวอย่าง
- คำอธิบายฟิลด์
| ชื่อพารามิเตอร์ | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
| knowledgeBaseId | Integer | Y | ตัวระบุเฉพาะสำหรับฐานความรู้ |
| document | File | Y | เอกสารที่จะถูกอัปโหลด |
API การตอบกลับ
- ตัวอย่าง
- คำอธิบายฟิลด์
| ชื่อพารามิเตอร์ | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
| id | String | Y | รหัสชั่วคราวของเอกสารที่อัปโหลด |
แยกข้อมูลจากเอกสารความรู้
ทริกเกอร์กระบวนการ
API คำขอ
- ตัวอย่าง
- คำอธิบายฟิลด์
| ชื่อพารามิเตอร์ | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
| id | Integer | Y | รหัสชั่วคราวของเอกสารที่อัปโหลด |
| knowledgeBaseId | Integer | Y | รหัสระบุเอกลักษณ์สำหรับคลังความรู้ |
| source | String | Y | แหล่งที่มาของเอกสาร |
| ragStatus | String | N | ว่าจะเปิดใช้งานการปรับปรุงการค้นหา (RAG) หรือไม่ ENABLED/DISABLED |
| segmentIdentifier | String | N | ตัวระบุส่วน LINE_BREAK/LINE_BREAK_2 |
| segmentSize | Integer | N | ขนาดจำกัดของส่วน (0-2000) |
API การตอบกลับ
- ตัวอย่าง
- คำอธิบายฟิลด์
| ชื่อพารามิเตอร์ | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
| taskId | Integer | Y | รหัสของงาน |
| status | String | Y | สถานะของงาน CREATED/IN_PROCESS/FAILED/FINISHED |
| totalNum | Integer | Y | จำนวนรายการทั้งหมดในงาน |
| successNum | Integer | Y | จำนวนรายการที่ประมวลผลสำเร็จในงาน |
| failureNum | Integer | Y | จำนวนรายการที่ล้มเหลวในการประมวลผลในงาน |
รายละเอียดกระบวนการ
API คำขอ
- ตัวอย่าง
- คำอธิบายฟิลด์
| ชื่อพารามิเตอร์ | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
| id | Integer | Y | รหัสของงาน |
API การตอบกลับ
- ตัวอย่าง
- คำอธิบายฟิลด์
| ชื่อพารามิเตอร์ | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
| taskId | Integer | Y | รหัสของงาน |
| status | String | Y | สถานะของงาน CREATED/IN_PROCESS/FAILED/FINISHED |
| totalNum | Integer | Y | จำนวนรายการทั้งหมดในงาน |
| successNum | Integer | Y | จำนวนรายการที่ประมวลผลสำเร็จในงาน |
| failureNum | Integer | Y | จำนวนรายการที่ล้มเหลวในการประมวลผลในงาน |
| data | Object | Y | ความคืบหน้าของงานและข้อมูลเพิ่มเติม |
ตัวอย่างเอกสารความรู้
API คำขอ
- ตัวอย่าง
- คำอธิบายฟิลด์
| ชื่อพารามิเตอร์ | ประเภท | จำเป็นต้องกรอกหรือไม่ | คำอธิบาย |
|---|---|---|---|
| page | Integer | N | หมายเลขหน้าหรือค่าเริ่มต้นเป็น 0 |
| size | Integer | N | จำนวนบันทึกที่ส่งคืนต่อหน้า |
| knowledgeBaseId | Integer | Y | รหัสเฉพาะของฐานความรู้ |
| knowledgeDocId | Integer | Y | รหัสเฉพาะของเอกสารในฐานความรู้ |
API การตอบกลับ
- ตัวอย่าง
- คำอธิบายฟิลด์
| ชื่อพารามิเตอร์ | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
| id | Integer | Y | รหัสเฉพาะของเอกสาร |
| hasMore | Boolean | Y | ระบุว่ามีเนื้อหาที่แบ่งออกเพิ่มเติมหรือไม่ |
| segments | Array<Object> | Y | รายการเนื้อหาที่แบ่งส่วนแล้ว |
| segments.number | Integer | Y | หมายเลขของส่วนเอกสาร (เริ่มจาก 0) |
| segments.tokens | Integer | Y | การประมาณจำนวนโทเค็นสำหรับส่วนเอกสาร |
| segments.raw | String | Y | ข้อมูลดิบสำหรับส่วนเอกสาร |