Kiến thức
API Ủy quyền
NOTE
- Để có được AUTH_TOKEN, xem Lấy AUTH_TOKEN.
- Vui lòng đảm bảo rằng tất cả các yêu cầu API bao gồm AUTH_TOKEN trong tiêu đề yêu cầu, như được hiển thị bên dưới:
SDK Ủy quyền
NOTE
- Trước khi tích hợp SDK, vui lòng đảm bảo rằng bạn đã lấy được APP_ID và APP_KEY.
- Để nhận thông tin xác thực của bạn, xem Nhận APP_ID và APP_KEY.
Cơ sở tri thức
API Yêu cầu
- Ví dụ
- Mô tả trường
| Tên tham số | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
| page | Integer | N | Số trang, bắt đầu từ 0. |
| size | Integer | N | Số bản ghi trả về cho mỗi trang. |
| keyword | String | N | Từ khóa để tìm kiếm. |
API Phản hồi
- Ví dụ
- Mô tả trường
| Tên tham số | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
| pageNum | Integer | Y | Số trang, bắt đầu từ 0. |
| pageSize | Integer | Y | Số bản ghi trả về cho mỗi trang. |
| total | Integer | Y | Tổng số bản ghi. |
| pages | Integer | Y | Tổng số trang. |
| currentPageTotal | Integer | Y | Số bản ghi trả về trong trang hiện tại. |
| content | Array<Object> | Y | Nội dung của danh sách cơ sở tri thức. |
| content.id | Integer | Y | Định danh duy nhất cho cơ sở tri thức. |
| content.name | String | Y | Tên của cơ sở tri thức. |
| content.description | String | Y | Mô tả của cơ sở tri thức. |
| content.status | String | Y | Trạng thái của cơ sở tri thức. ENABLED/DISABLED |
| content.totalDoc | Integer | Y | Tổng số tài liệu trong cơ sở tri thức. |
| content.totalRecord | Integer | Y | Tổng số bản ghi trong cơ sở tri thức. |
| content.createDatetime | Timestamp | Y | Thời gian tạo cơ sở tri thức. |
| content.updateDatetime | Timestamp | Y | Thời gian cập nhật của cơ sở tri thức. |
Tài liệu tri thức
API Yêu cầu
- Ví dụ
- Mô tả trường
| Tên tham số | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
| page | Integer | N | Số trang, bắt đầu từ 0. |
| size | Integer | N | Số bản ghi trả về cho mỗi trang. |
| keyword | String | N | Từ khóa để tìm kiếm. |
| knowledgeBaseId | Integer | Y | Định danh duy nhất cho cơ sở tri thức. |
API Phản hồi
- Ví dụ
- Mô tả trường
| Tên tham số | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
| pageNum | Integer | Y | Số trang, bắt đầu từ 0. |
| pageSize | Integer | Y | Số bản ghi trả về cho mỗi trang. |
| total | Integer | Y | Tổng số bản ghi. |
| pages | Integer | Y | Tổng số trang. |
| currentPageTotal | Integer | Y | Số bản ghi trả về trong trang hiện tại. |
| content | Array<Object> | Y | Nội dung của các tài liệu trong cơ sở tri thức |
| content.id | Integer | Y | Định danh duy nhất cho tài liệu trong cơ sở tri thức. |
| content.name | String | Y | Tên của tài liệu trong cơ sở tri thức. |
| content.type | String | Y | Loại tài liệu trong cơ sở tri thức. TEXT_PLAIN/MARKDOWN/ APPLICATION_PDF/DOCX |
| content.source | String | Y | Nguồn của tài liệu cơ sở kiến thức. LOCAL/ONLINE |
| content.status | String | Y | Tình trạng của tài liệu cơ sở kiến thức. UN_PROCESS/PROCESSING/ PROCESSING_FAILED/PROCESSED |
| content.totalRecord | Integer | Y | Tổng số bản ghi trong tài liệu cơ sở kiến thức. |
| content.createDatetime | Timestamp | Y | Thời gian tạo tài liệu cơ sở kiến thức. |
| content.updateDatetime | Timestamp | Y | Thời gian cập nhật tài liệu cơ sở kiến thức. |
Tải lên tài liệu kiến thức
API Yêu cầu
- Ví dụ
- Mô tả trường
| Tên tham số | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
| knowledgeBaseId | Integer | Y | Định danh duy nhất cho cơ sở tri thức. |
| document | File | Y | Tài liệu cần được tải lên. |
API Phản hồi
- Ví dụ
- Mô tả trường
| Tên tham số | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
| id | String | Y | ID tạm thời của tài liệu đã tải lên. |
Trích xuất Tài liệu Kiến thức
Kích hoạt quy trình
API Yêu cầu
- Ví dụ
- Mô tả trường
| Tên tham số | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
| id | Integer | Y | ID tạm thời của tài liệu đã tải lên. |
| knowledgeBaseId | Integer | Y | Định danh duy nhất cho kho kiến thức. |
| source | String | Y | Nguồn của tài liệu. |
| ragStatus | String | N | Có bật Tăng cường Tìm kiếm (RAG) hay không. ENABLED/DISABLED |
| segmentIdentifier | String | N | Bộ định danh phân đoạn. LINE_BREAK/LINE_BREAK_2 |
| segmentSize | Integer | N | Giới hạn kích thước phân đoạn (0-2000) |
API Phản hồi
- Ví dụ
- Mô tả trường
| Tên tham số | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
| taskId | Integer | Y | ID của tác vụ. |
| status | String | Y | Trạng thái của tác vụ. CREATED/IN_PROCESS/FAILED/FINISHED |
| totalNum | Integer | Y | Tổng số mục trong tác vụ. |
| successNum | Integer | Y | Số mục được xử lý thành công trong tác vụ. |
| failureNum | Integer | Y | Số lượng mục không được xử lý trong nhiệm vụ. |
Chi tiết quy trình
API Yêu cầu
- Ví dụ
- Mô tả trường
| Tên tham số | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
| id | Integer | Y | ID của tác vụ. |
API Phản hồi
- Ví dụ
- Mô tả trường
| Tên tham số | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
| taskId | Integer | Y | ID của tác vụ. |
| status | String | Y | Trạng thái của tác vụ. CREATED/IN_PROCESS/FAILED/FINISHED |
| totalNum | Integer | Y | Tổng số mục trong tác vụ. |
| successNum | Integer | Y | Số mục được xử lý thành công trong tác vụ. |
| failureNum | Integer | Y | Số lượng mục không được xử lý trong nhiệm vụ. |
| data | Object | Y | Tiến trình của nhiệm vụ và thông tin bổ sung. |
Xem trước tài liệu kiến thức
API Yêu cầu
- Ví dụ
- Mô tả trường
| Tên tham số | Loại | Có bắt buộc không | Mô tả |
|---|---|---|---|
| page | Integer | N | Số trang (giá trị bắt đầu từ 0) |
| size | Integer | N | Số bản ghi trả về trên một trang |
| knowledgeBaseId | Integer | Y | Định danh duy nhất của cơ sở kiến thức |
| knowledgeDocId | Integer | Y | Định danh duy nhất của tài liệu trong cơ sở kiến thức |
API Phản hồi
- Ví dụ
- Mô tả trường
| Tên tham số | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
| id | Integer | Y | Định danh duy nhất của tài liệu. |
| hasMore | Boolean | Y | Chỉ ra liệu có còn nội dung đã phân đoạn khác hay không. |
| segments | Array<Object> | Y | Danh sách các nội dung được phân đoạn. |
| segments.number | Integer | Y | Số của đoạn tài liệu (bắt đầu từ 0). |
| segments.tokens | Integer | Y | Ước lượng token cho đoạn tài liệu. |
| segments.raw | String | Y | Dữ liệu thô cho đoạn tài liệu. |