发送文件
发送文件进行标准分析
要开始文件分析，请使用 multipart/form-data 格式向 /document 端点发送 POST 请求。
端点：https://api.caas.qitech.app/document_analysis/document
请求格式
请求必须以 multipart/form-data 格式发送，包含数据字段和文件字段。分析所需的必填字段为 id、document_analysis_type、document_bytes。
请求示例：
curl -X POST "https://api.caas.qitech.app/document_analysis/document" \
-H "Authorization: SUA_CHAVE_API" \
-H "Content-Type: multipart/form-data" \
-F "id=solicitacao-abc-12345" \
-F "document_analysis_type=proof_of_address" \
-F "document_bytes=@/caminho/para/seu/comprovante.pdf"
发送属性说明
| 属性 | 描述 |
|---|---|
| id（必填） | 由您提供的请求唯一标识符。此 ID 可在以后用于检索分析结果。 |
| document_analysis_type（必填） | 一个字符串，指定要对文档执行的分析类型。支持的类型请参见下表。 |
| document_bytes（必填） | 待分析的文档文件。必须作为 multipart 请求体中的文件发送。注意：请勿将此字段作为 base64 编码字符串发送。 |
| async（可选，默认=false） | 一个布尔值（true 或 false），定义处理模式。 - false（同步）：API 将尝试处理文档并在同一请求中返回结果。 - true（异步）：API 将确认接收并在后台处理。结果将通过 webhook 发送到预先配置的 URL（更多信息请参见关于 webhooks 的部分）。 |
async 字段应用于指示异步请求。同步请求应仅用于小型文档和需要 立即响应的快速分析。如果请求超过 30 秒，将自动重定向到队列，返回状态为 202 Accepted，分析结果将发送到预先配置的 webhook URL（更多信息请参见关于 webhooks 的部分）。
支持的分析类型
document_analysis_type 字段确定将应用于您文档的数据提取模型。以下是目前支持的类型。
| 分析类型 | 文档类型 | 描述 |
|---|---|---|
| company_statute_default | 公司章程/合同 | 执行公司章程的基本提取和验证。提取公司和股东的一般信息。 |
| company_statute_credit_assignment | 公司章程/合同 | 执行公司章程的高级提取，包括验证签署信贷转让合同的权限。 |
| proof_of_address_default | 居住证明（水电费账单、燃气费、网费、政府信函、声明等） | 提取并验证居住证明信息，如邮政编码、完整地址、姓名和日期。 |
| invoice | 发票、DANFEs | 提取发票中的关键信息，包括供应商/客户详情、总额和项目。 |
| bankslip | 银行付款单 | 提取银行付款单信息，如受益人、金额和到期日。 |
| ccb_default | 银行信贷票据（CCBs） | 提取银行信贷票据的数据。 |
对于此处未列出的分析类型，请通过 suporte.caas@qitech.com.br 联系我们的支持团队，咨询自定义实现。
响应
成功响应（200 OK）
如果同步分析中的文档处理成功，API 将返回 HTTP 200 OK 状态和包含提取数据的 JSON 对象。此 JSON 对象的结构将根据请求的 document_analysis_type 而有所不同。如果请求超时，API 将返回 HTTP 202 Accepted 状态，请求将异步处理。稍后可以使用 GET 请求检索文档分析，如下所述。
接受响应（202 OK）
如果文档以异步方式处理，API 将返回 HTTP 202 Accepted 状态，请求将异步处理。稍后可以使用 GET 请求检索文档分析，如下所述。
错误响应（4xx）
如果请求或文档存在问题，API 将返回 4xx 状态码和描述错误的 JSON 正文。
错误代码参考
以下表格列出了 API 返回的所有 可能的错误代码。您可以使用这些代码在应用程序中实现健壮的错误处理。
类别 1：请求错误（DOC001xx）
| 代码 | 标题 | 描述 |
|---|---|---|
DOC00100 | Missing required field | 请求在 multipart/form-data 正文中不包含必填字段。 |
DOC00101 | Invalid field length | form-data 字段中某个值的长度无效。 |
DOC00102 | Invalid content type at request | 请求的 Content-Type 头不是 multipart/form-data。 |
DOC00103 | Invalid field at request | 请求在 form-data 正文中包含意外或无效字段。 |
类别 2：文件处理错误（DOC002xx）
当发送的文件本身存在阻止处理的问题时，会发生这些错误。
| 代码 | 标题 | 描述 |
|---|---|---|
DOC00200 | Invalid Document Analysis Type | document_analysis_type 对发送的文档无效。（例如：对水电费账单使用 company_statute_default 分析。） |
DOC00201 | Invalid File Size | 发送的文档大小超过允许的最大限制。 |
DOC00202 | Invalid File Type | 由于类型或格式不一致，文件无法处理（例如：发送了一个 .jpg 文件，但类型为 application/pdf）。 |
DOC00203 | PDF exceeds page limit | 提供的 PDF 文件包含的页数超过了处理允许的最大限制（当前限制为 200 页）。 |
类别 3：文档分析错误（DOC003xx）
这些错误发生在数据提取和分析阶段，即文件成功打开之后。
| 代码 | 标题 | 描述 |
|---|---|---|
DOC00300 | Missing Information | 文档不包含完成分析所需的基本信息。 |
DOC00301 | Bad Quality | 文档质量（例如：分辨率、可读性、清晰度）太低，无法准确分析。 |
DOC00302 | Invalid Data | 文档包含不一致或无效的数据（例如：校验和不正确、字段相互矛盾）。 |
DOC00303 | Incorrect Document Type | 文档内容与所选 document_analysis_type 的预期文档类型不符。 |
DOC00304 | Invalid PDF File | 提供的文件不是有效或格式良好的 PDF，无法打开。 |
DOC00305 | Password Protected PDF | 发送的 PDF 已用密码加密，无法处理。 |
DOC00306 | Parsing Error | 无法处理文档分析。 |
检索文档分析
您可以随时使用其 唯一的 id 检索之前提交的文档分析结果。
https://api.caas.qitech.app/document_analysis/document/{document_id}
将 document_id 替换为您发送 POST 请求时使用的相同值。