Demo
Đăng nhập

5.1.3.2. Lấy về tệp (đối với API key gán quyền Read)

a. Lấy về tệp (không kèm dữ liệu)

API:

MethodURL
GEThttps://app.docbase.ai/api/v1/submissions/<submission_id>

Response:

Copied
{
    "id": "5138c6f9-0ed5-4a06-90ed-8ef0a8bf2430",
    "created_at": "2024-05-06T08:37:33.102602Z",
    "updated_at": "2024-08-07T04:03:00.708027Z",
    "last_ocr_time": "2024-05-06T08:37:33.102472Z",
    "deleted_at": null,
    "name": "Hoa_don",
    "status": "for_review",
    "ocr_error_code": null,
    "note": null,
    "reviewing": false,
    "sorted_documents": null,
    "last_export_time": null,
    "turnaround_time": null,
    "validate_time": null,
    "edit_rate": null,
    "validated_at": null,
    "auto_verified": false,
    "upload_source": "web",
    "message_id": null,
    "folder": "fd38c314-e9ce-4794-be0d-db091f96a962",
    "validated_by": null,
    "owner": "537004c7-c79f-450c-9a4a-751cc5ba9644",
    "validator": null,
    "rejected_by": null,
    "reviewing_by": null,
    "documents_count": 1,
    "files_count": 1,
    "unclassified_pages_count": 0,
    "unclassified_files": [],
    "documents": [...],
    "files": [...]
    "pages_count": 1
}

Ví dụ cho trường documents

Copied
"documents": [
  {
      "id": "27d72697-1076-452b-8d85-8f437979e68d",
      "page_set": [
          "a5c39172-40d1-412b-a531-d4449ae80477",
          "1d08d58f-5462-4afe-b922-71fe0986c153"
      ],
      "created_at": "2024-05-06T08:37:40.914655Z",
      "updated_at": "2024-05-06T08:37:40.914680Z",
      "deleted_at": null,
      "name": "Hóa đơn",
      "status": "for_review",
      "last_data_changed": null,
      "note": null,
      "ocr_error_code": "0",
      "last_validated_at": null,
      "last_verified_at": null,
      "sorted_pages": null,
      "document_type": "invoice",
      "archived": false,
      "submission": "5138c6f9-0ed5-4a06-90ed-8ef0a8bf2430",
      "users": []
  }
]

Ví dụ cho trường files

Copied
"files": [
    {
        "id": "94a1d7d1-ac0b-4396-99d2-a11337200b85",
        "created_at": "2024-05-06T08:37:33.106847Z",
        "updated_at": "2024-05-06T08:37:33.106867Z",
        "deleted_at": null,
        "name": "Hoa_don.jpg",
        "path": "files/01f5ada6-22b1-4b69-a510-fb87967eacf5/fd38c314-e9ce-4794-be0d-db091f96a962/origins/487d8a98-d736-4c13-9d2c-d728177f656f.jpg",
        "extension": "jpg",
        "mime_type": null,
        "thumbnail_path": null,
        "size": 207235,
        "input_email": null,
        "submission": "5138c6f9-0ed5-4a06-90ed-8ef0a8bf2430",
        "org": "01f5ada6-22b1-4b69-a510-fb87967eacf5"
    }
],

Các trường thông tin quan trọng gồm:

  • documents_count: Số văn bản tài liệu đọc được (hóa đơn, bảng kê, giấy tờ, ...)
  • files_count: Số file của bộ hồ sơ
  • pages_count: Tổng số trang tài liệu của bộ hồ sơ
  • unclassified_pages_count: Số trang tài liệu không xác định được,
  • documents: Danh sách của văn bản tài liệu, mỗi phần tử trong danh sách sẽ gồm các thông tin như:
    • name: Tên văn bản tài liệu
    • document_type: Loại văn bản tài liệu
    • page_set: Các trang trong văn bản tài liệu này. Các văn bản có dữ liệu dạng bảng sẽ được đính kèm thêm trang ảnh là phần văn bản có bảng. Danh sách này là danh sách các ID của trang văn bản.
  • files: Danh sách các tệp trong bộ tài liệu, mỗi phần tử trong danh sách gồm các thông tin như:
    • id: ID của tệp tài liệu
    • name: Tên tệp tài liệu
    • size: Độ lớn về dung lượng của tệp
  • unclassified_files: Danh sách các tệp không xác định trong bộ tài liệu

b. Lấy về tệp (có kèm dữ liệu)

API:

MethodURL
GEThttps://app.docbase.ai/api/v1/submissions/<submission_id>/data

Response:

Cấu trúc trả về tương tự phần a., tuy nhiên ở trong phần documents, sẽ có thêm 1 trường là data_set: là 1 danh sách của các dữ liệu đọc được trong văn bản.

Copied
{
...,
"documents": [
        {
            "id": "27d72697-1076-452b-8d85-8f437979e68d",
	          ...,
            "users": [],
            "data_set": []
    }
  ]
}

Data set là các dữ liệu trong một văn bản tài liệu, sẽ gồm các dữ liệu Data được phân chia theo dạng cây với các kiểu dữ liệu được đề cập ở phần Kiểu dữ liệu.

c. Lấy về nhiều tệp (không kèm dữ liệu)

API:

MethodURL
GEThttps://app.docbase.ai/api/v1/folders/<folder_id>/submissions

Params:

KeyMô tả/Giá trị
limitGiới hạn số tệp lấy về
offsetSố trang, bắt đầu từ 0
searchTìm kiếm theo tên
statusfor_review/process_error/for_verify/verified/processing/exported
startChặn trên của ngày tải lên
endChặn dưới của ngày tải lên

Response:

response_api_key_1

d. Lấy về thông tin chung của bộ hồ sơ

API:

MethodURL
GEThttps://app.docbase.ai/api/v1/submissions/<submission_id>/general-data

Response:

Response Câu trúc trả về gồm:

  • count: Số tệp
  • next: URL cho trang tiếp theo
  • previous: URL cho trang trước
  • results: Danh sánh thông tin các tệp, mỗi phần tử trong danh sách sẽ có giá trị tương tự phần response của phần a.

e. Lấy về ảnh của tệp

API:

MethodURL
GEThttps://app.docbase.ai/api/v1/files/<file_id>/document

Response:

Dạng ảnh của tệp

f. Lấy về ảnh của từng trang trong tệp

API:

MethodURL
GEThttps://app.docbase.ai/api/v1/pages/<page_id>/photo

Response:

Dạng ảnh của từng trang trong tệp

Chú ý tham số:

KeyMô tả
folder_idid của thư mục lấy trên hệ thống
Để lấy id của thư mục: Vào Tài liệu → {{Thư mục bất kỳ}} → Cài đặt
ID của thư mục sẽ xuất hiện trong mục Thông tin thư mục
thong_tin_thu_muc
file_idid của tệp lấy trên hệ thống
page_idid của trang lấy trên hệ thống