Zuva DocAI
使用 Zuva DocAI 將 Contracts AI 嵌入到您的產品工作流程中。 無需從頭開始進行 AI 開發,即可利用 DocAI API 從合約中提取資訊。
此連接器適用於以下產品和區域:
| 服務 | Class | Regions |
|---|---|---|
| 副駕駛工作室 | 進階 | 除下列區域外的所有 Power Automate 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| 邏輯應用程式 | 標準 | 所有 Logic Apps 區域, 但下列區域除外: - Azure Government 區域 - Azure 中國區域 - 美國國防部 (DoD) |
| Power Apps | 進階 | 除下列區域外的所有 Power Apps 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| Power Automate(自動化服務) | 進階 | 除下列區域外的所有 Power Automate 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| 連絡人 | |
|---|---|
| 名稱 | Zuva 支持 |
| URL | https://zuva.ai/support/ |
| support@zuva.ai |
| 連接器中繼資料 | |
|---|---|
| Publisher | 祖瓦公司 |
| 網站 | https://zuva.ai/ |
| 隱私策略 | https://zuva.ai/privacy/ |
| 類別 | AI |
此連接器使用戶能夠利用 Zuva 一流的合同 AI,從合同(和相關文檔)中查找和提取實體、句子和段落。 該連接器經過設計和培訓,可精確定位多個行業和用例的法律條款,提供即插即用的模塊套件,將 Contracts AI 嵌入您的工作流程中。 此連接器隨附 OCR 來讀取您的文檔,以及文檔分類和標準化功能。
先決條件
您將需要一個 Zuva 帳戶和一個 DocAI 代幣。 首先註冊 一個免費帳戶。
如何取得認證
Zuva DocAI 擁有多個區域伺服器。 您需要為要使用的特定區域建立 API 權杖。
請參閱 DocAI 快速入門指南 ,以取得有關 Zuva 帳戶和權杖的詳細資訊。
開始使用連接器
要使用 Zuva DocAI 連接器,您需要設置類似以下的流程:
步驟 1:取得檔案
出於測試目的,您可以在 Power Automate 中建立「即時雲端流程」。 選擇「手動觸發流程」並建立流程。 新增輸入,然後選擇「檔案」類型。
步驟 2:提交檔案
新增 Submit a file 操作,然後選擇上一步中的「檔案內容」作為輸入。
注意:檔案不應以任何方式進行轉換(即沒有 base64 編碼)。 DocAI 僅接受原始二進位資料。
步驟 3:開始處理文件
新增下列其中一個動作,選擇您要使用的服務:
Create Language Classification RequestCreate Document Classification RequestCreate Multi-Level Classification RequestCreate Field Extraction RequestCreate OCR Request
其中每一個都接受檔案 ID (從動作傳 Submit a file 回) 作為輸入。
欄位擷取也需要欄位 ID 作為輸入。 欄位 ID 可以在 欄位程式庫 (需要登入) 中找到,如果您已訓練自訂欄位,則可從 AI 訓練師 找到,或以程式設計方式使用 Get Field List 動作。
步驟 4:輪詢以完成要求
使用 Do Until 區塊(位於「控制」部分),並將正確的狀態檢查動作新增至區塊內部:
Get Field Extraction Request StatusGet Language Classification Request StatusGet Document Classification Request StatusGet MLC request StatusGet OCR Request Status
動作會 Get ____ status 從其對應 Create ____ Request 動作中輸入要求 ID。
您還應該在區塊內Delay新增一個 10 秒Do until的區塊,以確保檔案有足夠的時間進行處理。
將區塊的 Do Until 條件設定為 Is Finished? 等於 true。
第 4 步:取得結果
最後,使用對應至您要求的其中一個 [取得結果] 動作,並使用原始 [建立] 作業中的 [要求識別碼] 作為輸入:
Get Field Extraction Request Text ResultsGet Language Classification Request StatusGet Document Classification Request StatusGet MLC request StatusGet OCR Results TextGet OCR Results Images
請注意,對於語言、文件分類和 MLC,結果會包含在狀態回應中。
您可能希望查看 DocAI 文檔 ,以獲取有關字段提取結果結構的更多信息。
已知問題與限制
每個請求的欄位
單一 Create Field Extraction Request 動作中最多可以包含 100 個欄位。
自訂欄位
該連接器不支援與訓練自訂欄位或取得單一欄位的中繼資料相關的任何 DocAI 端點。
與基礎 API 的差異
此外,請注意,連接器功能與基礎API的檔案不會一對一對應。 特別是連接器:
- 公開額外的
is_finished布林值,可用來判斷請求是完成還是失敗 - 所有請求都對單個文件進行操作,而不是多個文件的批次。
常見錯誤和補救措施
請務必上傳原始二進位檔,而不是 base64 編碼的字串。 您可以使用 OCR 服務,並檢查它是否傳回預期的文字。
FAQ
在哪裡可以找到有關 Zuva DocAI 的更多資訊?
在哪裡可以找到有關 Zuva DocAI 的其他文件?
https://zuva.ai/documentation/
正在建立連線
連接器支援下列驗證類型:
| 預設值 | 建立連線的參數。 | 所有區域 | 不可共享 |
預設
適用:所有地區
建立連線的參數。
這不是可共用的連線。 如果 Power App 與其他使用者共用,系統會明確提示其他使用者建立新連線。
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| 代幣 | securestring | 您的 DocAI 代幣 | 對 |
| 基礎 URL | 字串 | 例如,https://us.app.zuva.ai/api/v2 | 對 |
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒 |
動作
| 刪除檔案 |
從 Zuva 刪除現有檔案。 |
| 取得 MLC 要求狀態 |
取得現有 MLC 要求的狀態和可用結果。 |
| 取得 OCR 請求影像 |
從已完成的 OCR 請求中獲取圖像。 |
| 取得 OCR 請求文字 |
從已完成的 OCR 請求中獲取文本。 |
| 取得 OCR 請求狀態 |
檢查現有 OCR 請求的狀態。 |
| 取得文件分類要求狀態 |
取得現有文件分類要求的狀態和可用結果。 |
| 取得欄位擷取要求狀態 |
檢查現有欄位擷取要求的狀態。 |
| 取得欄位擷取要求結果 |
從已完成的欄位擷取請求取得文字結果。 |
| 取得欄位清單 |
取得所有可用欄位的清單。 |
| 取得語言分類要求狀態 |
取得現有文件分類要求的狀態和可用結果。 |
| 建立 OCR 請求 |
建立要將 OCR 套用至指定檔案的新請求。 |
| 建立多層分類要求 |
建立指定檔案的多層分類要求。 |
| 建立文件分類要求 |
建立指定文件分類的請求。 |
| 建立欄位擷取要求 |
建立從指定檔案擷取的新要求。 |
| 建立語言分類要求 |
建立指定檔案語言的要求。 |
| 提交檔案 |
提交文件到 Zuva DocAI。 |
| 標準化日期 |
將包含一或多個日期的字串正規化。 對於找到的每個日期,端點會傳回一組代表年、月和日的整數。 |
刪除檔案
取得 MLC 要求狀態
取得現有 MLC 要求的狀態和可用結果。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
請求編號
|
request_id | True | string |
MLC 要求的要求識別碼,如 CreateMlcRequest 所傳回。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
MLC 請求狀態
|
status | string |
要求的狀態 ('已排入佇列'、[處理中'、'完成'或'失敗'之一)。 |
|
完成了嗎?
|
is_finished | boolean |
布林值,指示請求是否已達到終止狀態(完成或失敗)。 |
|
Classifications
|
classifications | array of string |
文件的階層分類。 |
取得 OCR 請求影像
從已完成的 OCR 請求中獲取圖像。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
OCR 要求標識符
|
request_id | True | string |
現有 OCR 要求的唯一識別碼,由 CreateOcrRequest 傳回。 |
傳回
包含文件每一頁的 zip 檔案。
- 圖片
- binary
取得 OCR 請求文字
從已完成的 OCR 請求中獲取文本。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
OCR 要求標識符
|
request_id | True | string |
現有 OCR 要求的唯一識別碼,由 CreateOcrRequest 傳回。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
文字
|
text | string |
文件的 OCR 文字。 |
取得 OCR 請求狀態
檢查現有 OCR 請求的狀態。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
OCR 要求標識符
|
request_id | True | string |
現有 OCR 要求的唯一識別碼,由 CreateOcrRequest 傳回。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
OCR 請求狀態
|
status | string |
要求的狀態 ('已排入佇列'、[處理中'、'完成'或'失敗'之一)。 |
|
完成了嗎?
|
is_finished | boolean |
布林值,指示請求是否已達到終止狀態(完成或失敗)。 |
取得文件分類要求狀態
取得現有文件分類要求的狀態和可用結果。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
請求編號
|
request_id | True | string |
文件分類要求的要求識別碼,由 CreateDocumentClasssificationRequest 傳回。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
分類要求狀態
|
status | string |
要求的狀態 ('已排入佇列'、[處理中'、'完成'或'失敗'之一)。 |
|
完成了嗎?
|
is_finished | boolean |
布林值,指示請求是否已達到終止狀態(完成或失敗)。 |
|
Classification
|
classification | string |
偵測到的文件類型。 |
|
是合約嗎?
|
is_contract | boolean |
該文件是否被承認為合同。 |
取得欄位擷取要求狀態
檢查現有欄位擷取要求的狀態。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
擷取要求ID
|
request_id | True | string |
現有擷取要求的唯一識別碼,由 CreateExtractionRequest 傳回。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
欄位擷取要求狀態
|
status | string |
要求的狀態 ('已排入佇列'、[處理中'、'完成'或'失敗'之一)。 |
|
完成了嗎?
|
is_finished | boolean |
布林值,指示請求是否已達到終止狀態(完成或失敗)。 |
取得欄位擷取要求結果
從已完成的欄位擷取請求取得文字結果。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
擷取要求ID
|
request_id | True | string |
現有擷取要求的唯一識別碼,由 CreateExtractionRequest 傳回。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Results
|
results | array of object |
欄位擷取結果的陣列。 |
|
欄位識別碼
|
results.field_id | string |
擷取欄位的唯一識別碼。 |
|
提取
|
results.extractions | array of object |
針對此特定欄位擷取的結果陣列。 |
|
文字
|
results.extractions.text | string |
為欄位擷取的文字。 |
|
範圍
|
results.extractions.spans | array of object |
有關文件中文字位置的資訊。 |
|
開始
|
results.extractions.spans.start | integer |
文件文字中擷取的第一個字元的索引。 |
|
結束
|
results.extractions.spans.end | integer |
文件文字中擷取的最後一個字元的索引。 |
|
開始
|
results.extractions.spans.pages.start | integer |
開始擷取的頁碼。 |
|
結束
|
results.extractions.spans.pages.end | integer |
擷取結束的頁碼。 |
取得欄位清單
取得所有可用欄位的清單。
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
|
array of object | ||
|
欄位識別碼
|
field_id | string |
欄位的唯一識別碼。 |
|
名稱
|
name | string |
功能變數名稱 |
|
Description
|
description | string |
欄位的描述。 |
|
偏見
|
bias | double |
基礎 ML 模型所使用的偏差。 |
|
F 分數
|
f_score | double |
該領域的 F 分數,其準確性的統計衡量標準。 |
|
精確度
|
precision | double |
場地的精準度。 |
|
召回
|
recall | double |
該領域的召回。 |
|
文件計數
|
document_count | integer |
該領域已訓練的文件數量。 |
|
是客製化嗎?
|
is_custom | boolean |
布林值,指出欄位是否為自訂。 |
|
受過訓練嗎?
|
is_trained | boolean |
布林值,指出是否已訓練自訂欄位。 |
取得語言分類要求狀態
取得現有文件分類要求的狀態和可用結果。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
請求編號
|
request_id | True | string |
語言分類要求的要求識別碼,由 CreateLanguageRequest 傳回。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
語言請求狀態
|
status | string |
要求的狀態 ('已排入佇列'、[處理中'、'完成'或'失敗'之一)。 |
|
完成了嗎?
|
is_finished | boolean |
布林值,指示請求是否已達到終止狀態(完成或失敗)。 |
|
語言
|
language | string |
文件的主要偵測語言。 |
建立 OCR 請求
建立要將 OCR 套用至指定檔案的新請求。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
檔案 ID
|
file_id | string |
檔案的唯一識別碼,由 SubmitFile 作業傳回。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
OCR 請求 ID
|
request_id | string |
用於取得 OCR 請求的狀態和結果的 ID。 |
建立多層分類要求
建立指定檔案的多層分類要求。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
檔案 ID
|
file_id | string |
檔案的唯一識別碼,由 SubmitFile 作業傳回。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
MLC 要求 ID
|
request_id | string |
用於取得此請求的狀態和結果的ID。 |
建立文件分類要求
建立指定文件分類的請求。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
檔案 ID
|
file_id | string |
檔案的唯一識別碼,由 SubmitFile 作業傳回。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
分類要求標識符
|
request_id | string |
用於取得此請求的狀態和結果的ID。 |
建立欄位擷取要求
建立從指定檔案擷取的新要求。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
檔案 ID
|
file_id | string |
要從中提取文字的檔案。 |
|
|
欄位識別碼
|
field_ids | array of string |
要擷取的欄位 ID。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
擷取要求識別碼
|
request_id | string |
用於取得此請求的狀態和結果的ID。 |
建立語言分類要求
建立指定檔案語言的要求。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
檔案 ID
|
file_id | string |
檔案的唯一識別碼,由 SubmitFile 作業傳回。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
語言要求標識符
|
request_id | string |
用於取得此請求的狀態和結果的ID。 |
提交檔案
提交文件到 Zuva DocAI。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
檔案
|
File | binary |
要上傳的二進位檔案內容或純文字字串。 二進位內容不應採用 Base64 編碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
檔案 ID
|
file_id | string |
檔案的 Zuva 指派的唯一識別碼。 |
|
內容類型
|
attributes.content-type | string |
偵測到檔案的 MIME 內容類型 |
|
Expiration
|
expiration | string |
排程從 DocAI 中刪除檔案的時間。 |
標準化日期
將包含一或多個日期的字串正規化。 對於找到的每個日期,端點會傳回一組代表年、月和日的整數。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
文字
|
text | string |
要正規化的文字字串。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
請求編號
|
request_id | string |
請求的 ID |
|
收發簡訊
|
text | string |
提供的原文。 |
|
沙-256
|
sha-256 | string |
SHA-256 雜湊。 |
|
date
|
date | array of object |
date |
|
Day
|
date.day | integer |
整數的月份中的日期。 |
|
月
|
date.month | integer |
月份表示為 1 到 12 之間的整數。 |
|
年
|
date.year | integer |
年份表示為整數。 |
定義
字串
這是基本資料類型「string」。
二進位
這是基本數據類型 『binary』。