通过单独的 API 调用处理文档

使用单独的 API 调用（用于创建处理事务、上传文件和启动处理事务）处理文档的典型流程包括以下步骤：

获取所有可用 Skill 的列表
创建空的处理事务
向处理事务中添加待处理的文件集
启动处理事务
监控处理事务状态
下载源文件和结果文件

发送到服务器的每个请求都必须包含身份验证信息（例如，访问令牌）。有关更多信息，请参阅身份验证。

获取所有可用 Skill 的列表

为此，请向 skills 资源发送 GET 请求：

GET https://your-server/api/publicapi/v1/skills

运行以下命令： 在 Windows 上：

curl -X GET "https://your-server/api/publicapi/v1/skills" \
-H "Authorization: Bearer token"

适用于 Linux：

curl -X GET 'https://your-server/api/publicapi/v1/skills' \
-H 'Authorization: Bearer token'

因此，您将获得有关添加到该应用实例的所有 Skill 的信息。

创建空白处理事务

为此，请向 transactions 资源发送以下 POST 请求：

POST https://your-server/api/publicapi/v1/transactions

运行以下命令： Windows：

curl -X POST "https://your-server/api/publicapi/v1/transactions" \
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: application/json" \
-d "{
  \"skillId\": \"00000000-0000-0000-0000-000000000001\"
}"

Linux：

curl -X POST 'https://your-server/api/publicapi/v1/transactions' \
-H 'accept: */*' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: application/json' \
-d '{
  "skillId": "00000000-0000-0000-0000-000000000001"
}'

在请求正文中指定上一次 API 调用返回的 skillId Parameter。这样，您将收到包含所创建处理事务 id 的响应。

在处理事务中添加待处理的一组文件

重要！ 每个处理事务最多可包含 1000 个文件。可以通过两种方式添加一组文件：

直接添加到处理事务
先添加到 Document，然后将该 Document 添加到处理事务

直接向处理事务添加文件

为此，请向 transactions/<transaction-id>/files 资源发送一个 POST 请求：

POST https://your-server/api/publicapi/v1/transactions/transaction-id/files

在请求正文中发送要处理的文件。有关可用于自定义文件的参数详情，请参见 API Reference。运行以下命令： Windows：

curl -X POST "https://your-server/api/publicapi/v1/transactions/transaction-id/files" \
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: multipart/form-data" \
-F "Model={
   \"files\": [
     {
     }
   ]
}" \
-F "Files=@testImage.tif;type=image/tiff"

适用于 Linux：

curl -X POST 'https://your-server/api/publicapi/v1/transactions/transaction-id/files' \
-H 'accept: */*' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: multipart/form-data' \
-F 'Model={
   "files": [
     {
     }
   ]
}' \
-F 'Files=@testImage.tif;type=image/tiff'

因此，您将收到一个包含已添加文件及其标识符的响应。您可以通过多次重复此调用，按需添加任意数量的文件。上传文件的其他选项：

向文档添加文件

首先，通过向 transactions/<transaction-id>/documents 资源发送 POST 请求来创建一个 Document：

POST https://your-server/api/publicapi/v1/transactions/transaction-id/documents

适用于 Windows：

curl -X POST "https://your-server/api/publicapi/v1/transactions/transaction-id/documents" \
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: application/json" \
-d "{
  \"documents\": [
    {
    }
  ]
}"

适用于 Linux：

curl -X POST 'https://your-server/api/publicapi/v1/transactions/transaction-id/documents' \
-H 'accept: */*' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: application/json' \
-d '{
  "documents": [
    {
    }
  ]
}'

因此，您将收到包含文档标识符的响应。然后，通过向 transactions/<transaction-id>/documents/<document-id>/sourceFiles 资源发送 POST 请求，将文件添加到该文档：

POST https://your-server/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles

适用于 Windows：

curl -X POST "https://your-server/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles" \
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: multipart/form-data" \
-F "Model={
   \"files\": [
     {
     }
   ]
}" \
-F "Files=@testImage.tif;type=image/tiff"

Linux 版：

curl -X POST 'https://your-server/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles' \
-H 'accept: */*' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: multipart/form-data' \
-F 'Model={
   "files": [
     {
     }
   ]
}' \
-F 'Files=@testImage.tif;type=image/tiff'

启动处理事务

要使用指定的 Skill 和文件启动处理事务，请向 transactions/<transaction-id>/start 资源发送以下 POST 请求：

POST https://your-server/api/publicapi/v1/transactions/transaction-id/start

Windows：

curl -X POST "https://your-server/api/publicapi/v1/transactions/transaction-id/start" \
-H "accept: */*" \
-H "Authorization: Bearer token"

适用于 Linux：

curl -X POST 'https://your-server/api/publicapi/v1/transactions/transaction-id/start' \
-H 'accept: */*' \
-H 'Authorization: Bearer token'

监控处理事务状态

要使用带有短超时的循环开始监控处理事务状态（我们不建议将检查频率设置为高于每秒一次），请向在请求 URI 中包含事务标识符的 transactions/<transaction_id> 资源发送 GET 请求：

GET https://your-server/api/publicapi/v1/transactions/transaction-id

适用于 Windows：

curl -X GET "https://your-server/api/publicapi/v1/transactions/transaction-id" \
-H "Authorization: Bearer token"

Linux 版：

curl -X GET 'https://your-server/api/publicapi/v1/transactions/transaction-id' \
-H 'Authorization: Bearer token'

因此，您将收到包含处理事务状态的响应。处理事务可能处于以下状态之一：

New。处理事务已创建，但尚未加入处理队列。
Queued。处理事务已加入处理队列。
InProgress。处理事务正在处理。
Processed。处理事务已成功处理。
ProcessedWithWarnings。处理事务已处理，但出现了警告。
NotProcessed。处理事务因错误未被处理。
Deleted。处理事务被用户删除，或依据保留策略自动删除。

如果处理事务状态为 Processed 或 ProcessedWithWarnings，请前往步骤 6。

下载源文件

若要获取包含标识符的文档列表，请向 transactions/<transaction-id>/documents 资源发送 GET 请求，并指定该处理事务的标识符：

GET https://your-server/api/publicapi/v1/transactions/transaction-id/documents

适用于 Windows：

curl -X GET "https://your-server/api/publicapi/v1/transactions/transaction-id/documents" \
-H "Authorization: Bearer token"

适用于 Linux：

curl -X GET 'https://your-server/api/publicapi/v1/transactions/transaction-id/documents' \
-H 'Authorization: Bearer token'

因此，您将收到在此处理事务中创建的所有文档的列表。响应还包含这些文档的标识符，您可能需要使用这些标识符来请求特定文档的详细信息。要获取添加到特定文档的文件列表，请向 transactions/<transaction-id>/documents/<document-id> 资源发送 GET 请求：

GET https://your-server/api/publicapi/v1/transactions/transaction-id/documents/document-id

适用于 Windows：

curl -X GET "https://your-server/api/publicapi/v1/transactions/transaction-id/documents/document-id" \
-H "Authorization: Bearer token"

Linux：

curl -X GET 'https://your-server/api/publicapi/v1/transactions/transaction-id/documents/document-id' \
-H 'Authorization: Bearer <token>'

因此，您将收到有关文档的信息。响应还包含添加到文档中的文件标识符。要下载源文件，请向 transactions/<transaction-id>/files/<file-id>/download 资源发送 GET 请求：

GET https://your-server/api/publicapi/v1/transactions/transaction-id/files/file-id/download

适用于 Windows：

curl -X GET "https://your-server/api/publicapi/v1/transactions/transaction-id/files/file-id/download" \
-H "Authorization: Bearer token"

适用于 Linux：

curl -X GET 'https://your-server/api/publicapi/v1/transactions/transaction-id/files/file-id/download' \
-H 'Authorization: Bearer token'

入门指南

输出文件格式

API 参考文档

获取所有可用 Skill 的列表

创建空白处理事务

在处理事务中添加待处理的一组文件

直接向处理事务添加文件

向文档添加文件

启动处理事务

监控处理事务状态

下载源文件

入门指南

输出文件格式

API 参考文档

​获取所有可用 Skill 的列表

​创建空白处理事务

​在处理事务中添加待处理的一组文件

​直接向处理事务添加文件

​向文档添加文件

​启动处理事务

​监控处理事务状态

​下载源文件

获取所有可用 Skill 的列表

创建空白处理事务

在处理事务中添加待处理的一组文件

直接向处理事务添加文件

向文档添加文件

启动处理事务

监控处理事务状态

下载源文件