Tổng quan về nền tảng
API OmniDoc phục vụ các quy trình làm việc với tệp và nội dung trong phạm vi một tài khoản. Người gọi tạo ra các tài nguyên bằng khóa API, sau đó sử dụng các ID ổn định nhận được để truy vấn, kết hợp, xử lý hoặc tải xuống chúng.
Mô hình tài nguyên
Phần tiêu đề “Mô hình tài nguyên”| Tài nguyên | Mục đích |
|---|---|
| Tài liệu / Tệp | Các tệp nguồn và các mục trong thư viện tệp thuộc sở hữu của tài khoản |
| Công việc / Thao tác | Dịch thuật không đồng bộ, xử lý tài liệu hoặc các tác vụ âm thanh và video |
| Artifact | Kết quả mà một tác vụ cung cấp để xem trước hoặc tải xuống |
| Hoạt động tín dụng | Hồ sơ về việc một thao tác tính phí đã được tính và hoàn trả như thế nào |
Mỗi tài nguyên đều được kiểm tra đối chiếu với tài khoản sở hữu. Khách hàng chỉ cần lưu giữ các ID công khai và không nên suy luận chi tiết triển khai từ ID, tên tệp hoặc địa chỉ tải xuống.
Luồng cuộc gọi thông thường
Phần tiêu đề “Luồng cuộc gọi thông thường”- Tạo hoặc chọn một tài nguyên đầu vào.
- Đảm bảo tài khoản có đủ tín dụng: số dư được kiểm tra so với ngưỡng trước khi công việc bắt đầu, và chi phí thực tế sẽ được tính khi công việc hoàn tất.
- Tạo công việc với một
Idempotency-Key. - Kiểm tra trạng thái công việc; các công việc dịch tệp cũng có thể sử dụng SSE hoặc webhook.
- Đọc kết quả và bản ghi tín dụng cho công việc này.
Hằng số
Phần tiêu đề “Hằng số”Tích hợp bên ngoài luôn sử dụng khóa API, với cùng quyền hạn như tài khoản đã tạo ra khóa đó. Xem xác thực .
Bắt đầu nhanh → Tải lên một tệp, tạo một tác vụ, kiểm tra trạng thái của nó và tải xuống kết quả