AIForged （預覽版）
AIForged 是針對複雜問題的智能文檔處理解決方案。 AIForged 可以自動處理和提取非結構化圖像中的結構化數據。 該連接器提供與 AIForged 的智能文檔提取的集成和自動化
此連接器適用於以下產品和區域：
| 服務 | 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） |
| 連絡人 | |
|---|---|
| 名稱 | 人工智能製造 |
| URL | https://www.aiforged.com |
| support@aiforged.com |
| 連接器中繼資料 | |
|---|---|
| Publisher | 拉克人工智能 （PTY） 有限公司 |
| 網站 | https://www.aiforged.com |
| 隱私策略 | https://portal.aiforged.com/privacypolicy.html |
| 類別 | 人工智慧;內容和文件 |
AIForged 是一個基於雲的智能文檔處理解決方案，用於解決複雜的文檔提取問題。 AIForged 平台將來自 Microsoft、Google、Amazon、ABBYY 等行業領先 AI 服務的多個服務無縫集成到一個模型中，使您能夠同時使用這些服務以獲得最佳結果。 AIForged 智能文檔處理使企業能夠以更低的成本以更高的準確性、更快的速度提高產量。
先決條件
您需要以下內容：
Microsoft Power Apps 或 Power Automate 方案
您需要 Microsoft 365 帳戶、Power Automate 方案和 AIForged 帳戶/服務。
AIForged 帳戶和服務
若要使用此聯結器，您需要一個 AIForged 帳戶。 您還需要配置和訓練 AIForged 服務以獲得準確的結果。 如需更多指示 ，請在 AIForged 上註冊 ，並依照 建立專案中定義的步驟設定 AIForged 專案和服務。
這是一個關於如何從社會安全卡中提取信息的實踐示例 實踐示例 - 社會安全。
另請參閱我們的實際示例，從信貸申請中提取信息 實際示例 - 信貸申請。
如何取得認證
需要一個 AIForged 帳戶才能使用 AIForged。 您可以從 Microsoft Store 或 Microsoft Store 網站安裝 AIForged 應用程式來註冊。
安裝應用程式後，您可以使用簡單的 註冊步驟註冊。
要激活該帳戶，您應該會收到一封包含激活鏈接的電子郵件。 單擊激活鏈接後，AIForged 將打開並顯示激活信息。 啟用帳戶後，您可以使用認證登入，然後在聯結器中使用認證。
如何建立和訓練 AIForged 服務
首先，您需要建立專案容器以用於計費目的。 建立專案之後，您可以遵循 AIForged 應用程式中的精靈步驟來新增智慧型服務。
以下是從文件中提取資訊的實務範例清單
實踐示例 - 社會安全卡。
開始使用連接器
如需入門的詳細資訊，請參閱下列 Power Automate - 入門指南
Authentication
此聯結器會使用 OAuth2 驗證 （請參閱上述步驟，瞭解如何取得驗證）。 建立新連接器 （在 Power Apps/Logic Apps 中） 時，您需要提供註冊的驗證資訊。
已知問題與限制
您無法為您在連接器中使用的認證啟用 MFA/2FA。
常見錯誤和補救措施
如需任何支持或幫助，請在 AIForged Support 創建支持票證或發送電子郵件至 support@aiforged.com
FAQ
如需詳細資訊和常見問題集，請參閱 AIForged 文件。
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒 |
動作
| 上傳取得文件分類 |
上傳取得文件分類 |
| 上傳和分類文件 |
上傳和分類文件 |
| 上傳和提取資訊以進行驗證 |
上傳和提取資訊以進行驗證 |
| 使用結構化搜尋準則來尋找文件。 結果可以分頁 |
使用結構化搜尋準則來尋找文件。 結果可以分頁 |
| 依 ID 刪除文件 |
依 ID 刪除文件 |
| 依 Id 取得參數 def 的父服務 |
依 Id 取得參數 def 的父服務 |
| 依 ID 取得定義 |
依 ID 取得定義 |
| 依 ID 取得文件 |
依 ID 取得文件 |
| 依使用者和專案取得 |
依使用者和專案取得 |
| 依名稱尋找專案 |
依名稱尋找專案 |
| 依專案取得所有類別 |
依專案取得所有類別 |
| 依影像類型取得文件識別碼的資料 Blob |
依影像類型取得文件識別碼的資料 Blob |
| 刪除參數 |
刪除參數 |
| 刪除文件 Blob |
刪除文件 Blob |
| 取得使用者的 API 金鑰 |
取得使用者的 API 金鑰 |
| 取得分類資訊 |
取得分類資訊 |
| 取得參數值 |
取得參數值 |
| 取得參數的最新驗證 |
取得參數的最新驗證 |
| 取得參數的驗證 |
取得參數的驗證 |
| 取得參數階層 |
取得參數階層 |
| 取得專案中所有服務的欄位階層 |
取得專案中所有服務的欄位階層 |
| 取得文件及其相關文件 |
取得文件及其相關文件 |
| 取得文件影像 |
取得文件影像 |
| 取得文件影像 |
取得文件影像 |
| 取得服務的欄位階層 |
取得服務的欄位階層 |
| 取得服務的預覽文件和影像 |
取得服務的預覽文件和影像 |
| 取得特定專案 |
取得特定專案 |
| 取得系統列舉值 |
取得系統列舉值 |
| 取得系統和應用程式資訊 |
取得系統和應用程式資訊 |
| 取得與專案相關的服務 |
取得與專案相關的服務 |
| 取得資料類型 |
取得資料類型 |
| 取得連結至使用者的專案和服務 |
取得連結至使用者的專案和服務 |
| 取得驗證分析 |
取得驗證分析 |
| 取得驗證圖片粉碎 |
取得驗證圖片粉碎 |
| 取得驗證摘要 |
取得驗證摘要 |
| 取得驗證摘要 |
取得驗證摘要 |
| 擷取文件參數 |
擷取文件參數 |
| 獲取當前服務數據和時間 |
獲取當前服務數據和時間 |
| 獲取當前登錄的用戶 |
獲取當前登錄的用戶 |
| 透過 ID 取得服務 |
透過 ID 取得服務 |
| 透過身分證件取得驗證 |
透過身分證件取得驗證 |
| 透過驗證識別碼取得參數 |
透過驗證識別碼取得參數 |
| 逐個 Blob 金鑰取得 Blob |
逐個 Blob 金鑰取得 Blob |
上傳取得文件分類
上傳取得文件分類
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
服務識別碼
|
stpdId | integer |
服務識別碼 |
|
|
專案識別碼
|
projectId | integer |
專案識別碼 |
|
|
文件識別碼
|
docId | integer |
文件識別碼 |
|
|
API 版本標頭
|
X-Api-Version | True | string |
API 版本標頭 |
傳回
用於訓練和分類的類別/類別
上傳和分類文件
上傳和分類文件
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
服務識別碼
|
stpdId | integer |
服務識別碼 |
|
|
專案編號
|
projectId | integer |
專案編號 |
|
|
檔案資料
|
file | file |
檔案資料 |
|
|
API 版本標頭
|
X-Api-Version | True | string |
API 版本標頭 |
傳回
文件中繼資料資訊
上傳和提取資訊以進行驗證
上傳和提取資訊以進行驗證
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
服務識別碼
|
stpdId | integer |
服務識別碼 |
|
|
專案識別碼
|
projectId | integer |
專案識別碼 |
|
|
檔案
|
file | file |
檔案 |
|
|
API 版本標頭
|
X-Api-Version | True | string |
API 版本標頭 |
傳回
文件中繼資料資訊
使用結構化搜尋準則來尋找文件。 結果可以分頁
使用結構化搜尋準則來尋找文件。 結果可以分頁
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
文件的擁有者
|
userId | string |
文件的擁有者 |
|
|
專案識別碼
|
projectId | integer |
專案識別碼 |
|
|
服務識別碼
|
stpdId | integer |
服務識別碼 |
|
|
資料夾或使用方式
|
usage | integer |
資料夾或使用方式 |
|
|
狀態
|
status | integer |
狀態 |
|
|
類別名稱篩選器
|
classname | string |
類別名稱篩選器 |
|
|
檔案名稱篩選器
|
filename | string |
檔案名稱篩選器 |
|
|
檔案類型篩選器
|
filetype | string |
檔案類型篩選器 |
|
|
文件的開始日期範圍
|
start | date-time |
文件的開始日期範圍 |
|
|
文件的結束日期範圍
|
end | date-time |
文件的結束日期範圍 |
|
|
文件的主要或父項
|
masterid | integer |
文件的主要或父項 |
|
|
頁碼
|
pageNo | integer |
頁碼 |
|
|
頁面大小
|
pageSize | integer |
頁面大小 |
|
|
依欄位排序
|
sortField | integer |
依欄位排序 |
|
|
根據排序欄位排序方向
|
sortDirection | integer |
根據排序欄位排序方向 |
|
|
篩選註解
|
comment | string |
篩選註解 |
|
|
篩選結果
|
result | string |
篩選結果 |
|
|
篩選結果識別碼
|
resultId | string |
篩選結果識別碼 |
|
|
篩選結果索引
|
resultIndex | integer |
篩選結果索引 |
|
|
篩選外部 ID
|
externalId | string |
篩選外部 ID |
|
|
篩選文件 GUID
|
docGuid | string |
篩選文件 GUID |
|
|
API 版本標頭
|
X-Api-Version | True | string |
API 版本標頭 |
傳回
依 ID 刪除文件
依 ID 刪除文件
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
要刪除的文件識別碼
|
id | integer |
要刪除的文件識別碼 |
|
|
API 版本標頭
|
X-Api-Version | True | string |
API 版本標頭 |
傳回
文件中繼資料資訊
依 Id 取得參數 def 的父服務
依 Id 取得參數 def 的父服務
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
參數定義 ID
|
id | integer |
參數定義 ID |
|
|
API 版本標頭
|
X-Api-Version | True | string |
API 版本標頭 |
傳回
服務、設定和規則定義
依 ID 取得定義
依 ID 取得定義
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
定義 ID
|
id | integer |
定義 ID |
|
|
API 版本標頭
|
X-Api-Version | True | string |
API 版本標頭 |
傳回
服務、設定和規則定義
依 ID 取得文件
依 ID 取得文件
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
文件識別碼
|
id | integer |
文件識別碼 |
|
|
API 版本標頭
|
X-Api-Version | True | string |
API 版本標頭 |
傳回
文件中繼資料資訊
依使用者和專案取得
依使用者和專案取得
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
使用者 ID
|
userId | string |
使用者 ID |
|
|
專案識別碼
|
projectId | integer |
專案識別碼 |
|
|
API 版本標頭
|
X-Api-Version | True | string |
API 版本標頭 |
傳回
依名稱尋找專案
依名稱尋找專案
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
使用者 ID
|
userId | string |
使用者 ID |
|
|
專案名稱
|
projectName | string |
專案名稱 |
|
|
API 版本標頭
|
X-Api-Version | True | string |
API 版本標頭 |
傳回
專案是計費和服務的容器
依專案取得所有類別
依專案取得所有類別
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
ptoject ID
|
projectId | integer |
ptoject ID |
|
|
API 版本標頭
|
X-Api-Version | True | string |
API 版本標頭 |
傳回
依影像類型取得文件識別碼的資料 Blob
依影像類型取得文件識別碼的資料 Blob
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
擁有文件的使用者 ID
|
userId | string |
擁有文件的使用者 ID |
|
|
Blob 識別碼
|
id | integer |
Blob 識別碼 |
|
|
Blob 類型
|
type | integer |
Blob 類型 |
|
|
API 版本標頭
|
X-Api-Version | True | string |
API 版本標頭 |
傳回
- response
- file
刪除參數
刪除參數
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
參數 id
|
paramid | integer |
參數 id |
|
|
API 版本標頭
|
X-Api-Version | True | string |
API 版本標頭 |
傳回
從文件擷取的連結欄位值
刪除文件 Blob
刪除文件 Blob
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Blob 識別碼
|
id | integer |
Blob 識別碼 |
|
|
API 版本標頭
|
X-Api-Version | True | string |
API 版本標頭 |
傳回
- response
- file
取得使用者的 API 金鑰
取得使用者的 API 金鑰
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
使用者 ID
|
userId | string |
使用者 ID |
|
|
API 版本標頭
|
X-Api-Version | True | string |
API 版本標頭 |
傳回
- response
- string
取得分類資訊
取得分類資訊
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
分類的 ID
|
Id | integer |
分類的 ID |
|
|
API 版本標頭
|
X-Api-Version | True | string |
API 版本標頭 |
傳回
用於訓練和分類的類別/類別
取得參數值
取得參數值
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
文件識別碼
|
docId | integer |
文件識別碼 |
|
|
服務識別碼
|
stpdId | integer |
服務識別碼 |
|
|
參數類別
|
category | integer |
參數類別 |
|
|
參數分組
|
grouping | integer |
參數分組 |
|
|
包含驗證資料
|
includeverification | boolean |
包含驗證資料 |
|
|
API 版本標頭
|
X-Api-Version | True | string |
API 版本標頭 |
傳回
取得參數的最新驗證
取得參數的最新驗證
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
文件 ID
|
docId | integer |
文件 ID |
|
|
參數識別碼
|
parameterId | integer |
參數識別碼 |
|
|
定義 ID
|
pdId | integer |
定義 ID |
|
|
API 版本標頭
|
X-Api-Version | True | string |
API 版本標頭 |
傳回
文件欄位的系統和使用者驗證資訊
取得參數的驗證
取得參數的驗證
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
文件 ID
|
docId | integer |
文件 ID |
|
|
參數識別碼
|
parameterId | integer |
參數識別碼 |
|
|
API 版本標頭
|
X-Api-Version | True | string |
API 版本標頭 |
傳回
取得參數階層
取得參數階層
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
文件識別碼
|
docId | integer |
文件識別碼 |
|
|
服務識別碼
|
stpdId | integer |
服務識別碼 |
|
|
包含驗證資料
|
includeverification | boolean |
包含驗證資料 |
|
|
API 版本標頭
|
X-Api-Version | True | string |
API 版本標頭 |
傳回
取得專案中所有服務的欄位階層
取得專案中所有服務的欄位階層
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
使用者 ID
|
userId | string |
使用者 ID |
|
|
專案識別碼
|
projectId | integer |
專案識別碼 |
|
|
服務識別碼
|
stpdId | integer |
服務識別碼 |
|
|
群組 ID
|
groupId | integer |
群組 ID |
|
|
包括計數器統計數據
|
includeCount | boolean |
包括計數器統計數據 |
|
|
僅包含服務
|
onlyServices | boolean |
僅包含服務 |
|
|
包含設定
|
includeSettings | boolean |
包含設定 |
|
|
包括兒童
|
includeChildren | boolean |
包括兒童 |
|
|
API 版本標頭
|
X-Api-Version | True | string |
API 版本標頭 |
傳回
取得文件及其相關文件
取得文件及其相關文件
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
文件 ID
|
id | integer |
文件 ID |
|
|
API 版本標頭
|
X-Api-Version | True | string |
API 版本標頭 |
傳回
文件中繼資料資訊
取得文件影像
取得文件影像
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
文件識別碼
|
id | integer |
文件識別碼 |
|
|
服務識別碼
|
stpdId | integer |
服務識別碼 |
|
|
API 版本標頭
|
X-Api-Version | True | string |
API 版本標頭 |
傳回
取得文件影像
取得文件影像
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
文件 ID
|
id | integer |
文件 ID |
|
|
影像類型
|
type | integer |
影像類型 |
|
|
影像內容類型
|
contentType | string |
影像內容類型 |
|
|
測試過濾器
|
text | string |
測試過濾器 |
|
|
相關的 Blob ID
|
blobid | integer |
相關的 Blob ID |
|
|
頁面索引
|
pageindex | integer |
頁面索引 |
|
|
要傳回的影像數量
|
imagesCount | integer |
要傳回的影像數量 |
|
|
API 版本標頭
|
X-Api-Version | True | string |
API 版本標頭 |
傳回
取得服務的欄位階層
取得服務的欄位階層
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
專案識別碼
|
projectId | integer |
專案識別碼 |
|
|
服務識別碼
|
stpdId | integer |
服務識別碼 |
|
|
包括計數器統計數據
|
includeCount | boolean |
包括計數器統計數據 |
|
|
包含設定
|
includeSettings | boolean |
包含設定 |
|
|
包含子定義
|
includeChildren | boolean |
包含子定義 |
|
|
API 版本標頭
|
X-Api-Version | True | string |
API 版本標頭 |
傳回
服務、設定和規則定義
取得服務的預覽文件和影像
取得服務的預覽文件和影像
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
擁有服務的使用者
|
userId | string |
擁有服務的使用者 |
|
|
專案識別碼
|
projectId | integer |
專案識別碼 |
|
|
服務識別碼
|
stpdId | integer |
服務識別碼 |
|
|
API 版本標頭
|
X-Api-Version | True | string |
API 版本標頭 |
傳回
取得特定專案
取得特定專案
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
使用者 ID
|
userId | string |
使用者 ID |
|
|
專案識別碼
|
projectId | integer |
專案識別碼 |
|
|
API 版本標頭
|
X-Api-Version | True | string |
API 版本標頭 |
傳回
專案是計費和服務的容器
取得系統列舉值
取得系統列舉值
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
API 版本標頭
|
X-Api-Version | True | string |
API 版本標頭 |
傳回
取得系統和應用程式資訊
取得系統和應用程式資訊
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
API 版本標頭
|
X-Api-Version | True | string |
API 版本標頭 |
傳回
- response
- object
取得與專案相關的服務
取得與專案相關的服務
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
使用者 ID
|
userId | string |
使用者 ID |
|
|
專案識別碼
|
projectId | integer |
專案識別碼 |
|
|
服務類型篩選器
|
stlfilter | integer |
服務類型篩選器 |
|
|
按引擎過濾
|
enginefilter | string |
按引擎過濾 |
|
|
API 版本標頭
|
X-Api-Version | True | string |
API 版本標頭 |
傳回
取得資料類型
取得資料類型
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
API 版本標頭
|
X-Api-Version | True | string |
API 版本標頭 |
傳回
取得連結至使用者的專案和服務
取得連結至使用者的專案和服務
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
使用者 ID
|
userId | string |
使用者 ID |
|
|
API 版本標頭
|
X-Api-Version | True | string |
API 版本標頭 |
傳回
取得驗證分析
取得驗證分析
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
專案識別碼
|
projectId | integer |
專案識別碼 |
|
|
服務識別碼
|
stpdId | integer |
服務識別碼 |
|
|
只有最新的
|
latestOnly | boolean |
只有最新的 |
|
|
API 版本標頭
|
X-Api-Version | True | string |
API 版本標頭 |
傳回
取得驗證圖片粉碎
取得驗證圖片粉碎
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
用戶為碎紙
|
userId | string |
用戶為碎紙 |
|
|
文件 ID
|
docId | integer |
文件 ID |
|
|
參數識別碼
|
parId | integer |
參數識別碼 |
|
|
驗證ID
|
verificationId | integer |
驗證ID |
|
|
圖像應該是內嵌的
|
inline | boolean |
圖像應該是內嵌的 |
|
|
API 版本標頭
|
X-Api-Version | True | string |
API 版本標頭 |
傳回
- response
- file
取得驗證摘要
取得驗證摘要
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
專案識別碼
|
projectId | integer |
專案識別碼 |
|
|
API 版本標頭
|
X-Api-Version | True | string |
API 版本標頭 |
傳回
取得驗證摘要
取得驗證摘要
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
專案編號
|
projectId | integer |
專案編號 |
|
|
服務識別碼
|
stpdId | integer |
服務識別碼 |
|
|
定義 ID
|
pdId | integer |
定義 ID |
|
|
僅限最新或歷史記錄
|
latestOnly | boolean |
僅限最新或歷史記錄 |
|
|
API 版本標頭
|
X-Api-Version | True | string |
API 版本標頭 |
傳回
擷取文件參數
擷取文件參數
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
文件識別碼
|
docid | integer |
文件識別碼 |
|
|
API 版本標頭
|
X-Api-Version | True | string |
API 版本標頭 |
傳回
獲取當前服務數據和時間
獲取當前服務數據和時間
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
API 版本標頭
|
X-Api-Version | True | string |
API 版本標頭 |
傳回
- response
- date-time
獲取當前登錄的用戶
獲取當前登錄的用戶
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
API 版本標頭
|
X-Api-Version | True | string |
API 版本標頭 |
傳回
用戶資訊
透過 ID 取得服務
透過 ID 取得服務
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
服務識別碼
|
stpdId | integer |
服務識別碼 |
|
|
API 版本標頭
|
X-Api-Version | True | string |
API 版本標頭 |
傳回
服務、設定和規則定義
透過身分證件取得驗證
透過身分證件取得驗證
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
驗證ID
|
verificationId | integer |
驗證ID |
|
|
API 版本標頭
|
X-Api-Version | True | string |
API 版本標頭 |
傳回
文件欄位的系統和使用者驗證資訊
透過驗證識別碼取得參數
透過驗證識別碼取得參數
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
驗證標識碼
|
verificationId | integer |
驗證標識碼 |
|
|
API 版本標頭
|
X-Api-Version | True | string |
API 版本標頭 |
傳回
從文件擷取的連結欄位值
逐個 Blob 金鑰取得 Blob
逐個 Blob 金鑰取得 Blob
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Blob 識別碼
|
id | integer |
Blob 識別碼 |
|
|
API 版本標頭
|
X-Api-Version | True | string |
API 版本標頭 |
傳回
- response
- file
定義
AIForged.ViewModels.UserViewModel
用戶資訊
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | string | |
|
使用者名稱
|
userName | string | |
|
全名
|
fullName | string | |
|
電子郵件
|
|||
|
職位名稱
|
jobTitle | string | |
|
電話號碼
|
phoneNumber | phone | |
|
組態
|
configuration | string | |
|
isEnabled
|
isEnabled | boolean | |
|
是鎖定
|
isLockedOut | boolean | |
|
friendlyName
|
friendlyName | string | |
|
由...創建
|
createdBy | string | |
|
updatedBy （更新者）
|
updatedBy | string | |
|
建立日期
|
createdDate | date-time | |
|
更新日期
|
updatedDate | date-time | |
|
角色
|
roles | array of string |
AIForged.ViewModels.ClassesViewModel
用於訓練和分類的類別/類別
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | integer | |
|
userId
|
userId | string | |
|
projectId
|
projectId | integer | |
|
名稱
|
name | string | |
|
描述
|
description | string | |
|
留言
|
comment | string | |
|
dtc
|
dtc | date-time | |
|
DTM
|
dtm | date-time | |
|
型別
|
type | AIForged.DAL.ClassType |
系統類別類型 |
|
相關
|
related | integer |
AIForged.DAL.類別類型
AIForged.ViewModels.DocumentViewModel
文件中繼資料資訊
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | integer | |
|
userId
|
userId | string | |
|
projectId
|
projectId | integer | |
|
serviceId 服務 ID
|
serviceId | integer | |
|
狀態
|
status | AIForged.DAL.DocumentStatus |
在系統中指出文件的狀態 |
|
使用方式
|
usage | AIForged.DAL.UsageType |
我們為什麼要儲存此文件 |
|
類別標識符
|
classId | integer | |
|
內容類型
|
contentType | string | |
|
filename
|
filename | string | |
|
檔案類型
|
fileType | string | |
|
dtc
|
dtc | date-time | |
|
DTM
|
dtm | date-time | |
|
documentId
|
documentId | guid | |
|
externalId（外部識別碼）
|
externalId | string | |
|
masterId
|
masterId | integer | |
|
結果
|
result | string | |
|
結果標識碼
|
resultId | string | |
|
結果索引
|
resultIndex | integer | |
|
留言
|
comment | string | |
|
availability
|
availability | AIForged.DAL.Availability |
記錄的可評估性 |
|
結果參數
|
resultParameters | array of AIForged.ViewModels.DocumentParameterViewModel | |
|
資料
|
data | array of AIForged.ViewModels.DocumentDataViewModel | |
|
檔
|
documents | array of AIForged.ViewModels.DocumentViewModel | |
|
源ID
|
originId | integer | |
|
可以驗證
|
canVerify | boolean | |
|
可以分類
|
canClassify | boolean | |
|
可以火車
|
canTrain | boolean | |
|
訓練有素
|
trained | boolean | |
|
linkedDocsCount
|
linkedDocsCount | integer | |
|
訓練欄位計數
|
trainingFieldCount | integer | |
|
訓練參數計數
|
trainedParametersCount | integer |
AIForged.DAL.文件狀態
AIForged.DAL.Usage類型
AIForged.DAL.可用性
AIForged.ViewModels.DocumentParameterViewModel
從文件擷取的連結欄位值
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | integer | |
|
documentId
|
documentId | integer | |
|
paramDefId
|
paramDefId | integer | |
|
parentId
|
parentId | integer | |
|
源Id
|
sourceId | integer | |
|
value
|
value | string | |
|
資料
|
data | byte | |
|
索引
|
index | integer | |
|
col索引
|
colIndex | integer | |
|
colSpan
|
colSpan | integer | |
|
行索引
|
rowIndex | integer | |
|
rowSpan （行跨度）
|
rowSpan | integer | |
|
availability
|
availability | AIForged.DAL.Availability |
記錄的可評估性 |
|
參數定義
|
paramDef |
服務、設定和規則定義 |
|
|
孩童
|
children | array of AIForged.ViewModels.DocumentParameterViewModel | |
|
驗證
|
verifications | array of AIForged.ViewModels.VerificationViewModel |
AIForged.ViewModels.ParameterDefViewModel
服務、設定和規則定義
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | integer | |
|
projectId
|
projectId | integer | |
|
serviceTypeId
|
serviceTypeId | integer | |
|
serviceId 服務 ID
|
serviceId | integer | |
|
類別標識符
|
classId | integer | |
|
parentId
|
parentId | integer | |
|
名稱
|
name | string | |
|
標籤
|
label | string | |
|
tags
|
tags | string | |
|
描述
|
description | string | |
|
dtc
|
dtc | date-time | |
|
DTM
|
dtm | date-time | |
|
狀態
|
status | AIForged.DAL.ParameterDefinitionStatus |
定義狀態 |
|
分類
|
category | AIForged.DAL.ParameterDefinitionCategory |
定義類別 |
|
群組
|
grouping | AIForged.DAL.GroupingType |
欄位分組類型 |
|
valueType
|
valueType | AIForged.DAL.ValueType |
用於規則和設定的值類型 |
|
valueTypeName
|
valueTypeName | string | |
|
defaultValue
|
defaultValue | string | |
|
required
|
required | AIForged.DAL.RequiredOption |
指出是否需要選項 |
|
索引
|
index | integer | |
|
資訊
|
info | string | |
|
參考
|
reference | string | |
|
評等
|
rating | float | |
|
availability
|
availability | AIForged.DAL.Availability |
記錄的可評估性 |
|
孩童
|
children | array of AIForged.ViewModels.ParameterDefViewModel | |
|
設定
|
settings | array of AIForged.DAL.Models.ParameterDefSettingViewModel | |
|
總收費
|
totalCharge | double | |
|
使用者數量
|
userCount | integer | |
|
參數計數
|
parameterCount | integer | |
|
文件計數
|
documentCount | integer | |
|
確認
|
validation | string |
AIForged.DAL.ParameterDefinitionStatus
AIForged.DAL.參數定義類別
AIForged.DAL.GroupingType
AIForged.DAL.值類型
AIForged.DAL.RequiredOption
AIForged.DAL.Models.ParameterDefSettingViewModel
規則和設定的詳細設定
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | integer | |
|
參數DefId
|
parameterDefId | integer | |
|
型別
|
type | AIForged.DAL.SettingType |
與參數相關的設定類型 |
|
狀態
|
status | AIForged.DAL.SettingStatus |
與參數相關的設定狀態 |
|
dtc
|
dtc | date-time | |
|
DTM
|
dtm | date-time | |
|
留言
|
comment | string | |
|
資訊
|
info | string | |
|
資料
|
data | string | |
|
最小值
|
minValue | string | |
|
最大值
|
maxValue | string | |
|
信賴度
|
confidence | float | |
|
最小置信度
|
minConfidence | float | |
|
最大置信度
|
maxConfidence | float | |
|
isCase感性
|
isCaseSensative | boolean | |
|
反轉
|
invert | boolean | |
|
一線
|
oneLine | boolean | |
|
一個字
|
oneWord | boolean | |
|
是手寫
|
isHandwriting | boolean | |
|
方向
|
orientation | AIForged.DAL.Orientation |
欄位的文字方向 |
|
標記
|
marking | AIForged.DAL.MarkingType |
標記文字類型 |
|
細胞
|
cells | integer | |
|
清除之前
|
clearBefore | AIForged.DAL.OptionStatusFlags |
選項的狀態旗標 |
|
清除之後
|
clearAfter | AIForged.DAL.OptionStatusFlags |
選項的狀態旗標 |
|
cleanupValues之前
|
cleanupValuesBefore | boolean | |
|
cleanupValues之後
|
cleanupValuesAfter | boolean | |
|
validateValues之前
|
validateValuesBefore | boolean | |
|
validateValues之後
|
validateValuesAfter | boolean | |
|
abortOnValidationError
|
abortOnValidationError | boolean | |
|
isReplacementCaseSensative
|
isReplacementCaseSensative | boolean | |
|
compile結果
|
compileResults | string | |
|
maxRetry
|
maxRetry | integer | |
|
timeout
|
timeout | string | |
|
userId
|
userId | string |
AIForged.DAL.設定類型
AIForged.DAL.設定狀態
AIForged.DAL.Orientation
AIForged.DAL.MarkingType
AIForged.DAL.OptionStatusFlags
AIForged.ViewModels.VerificationViewModel
文件欄位的系統和使用者驗證資訊
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | integer | |
|
參數標識
|
parameterId | integer | |
|
userId
|
userId | string | |
|
value
|
value | string | |
|
DT
|
dt | date-time | |
|
信賴度
|
confidence | float | |
|
符號信心
|
symbolsConfidence | string | |
|
型別
|
type | AIForged.DAL.VerificationType |
驗證類型 |
|
狀態
|
status | AIForged.DAL.VerificationStatus |
驗證狀態旗標 |
|
結果
|
result | string | |
|
箱
|
box | string | |
|
資訊
|
info | string | |
|
資料
|
data | byte | |
|
使用者名稱
|
userName | string | |
|
serviceId 服務 ID
|
serviceId | integer | |
|
serviceDocId
|
serviceDocId | integer | |
|
提供者
|
provider | string | |
|
設定標識
|
settingId | integer | |
|
工作項目
|
workItem | integer | |
|
交易 ID
|
transactionId | integer | |
|
費用
|
charge | double |
AIForged.DAL.驗證類型
AIForged.DAL.驗證狀態
AIForged.ViewModels.DocumentDataViewModel
文件 Blob 資料
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | integer | |
|
documentId
|
documentId | integer | |
|
blobId
|
blobId | integer | |
|
型別
|
type | AIForged.DAL.DocumentDataType |
指出與文件相關的資料類型 |
|
資料
|
data | byte | |
|
預覽
|
preview | byte | |
|
收發簡訊
|
text | string | |
|
資訊
|
info | string | |
|
內容類型
|
contentType | string | |
|
結果標識碼
|
resultId | string | |
|
索引
|
index | integer | |
|
寬度
|
width | double | |
|
height
|
height | double | |
|
解析
|
resolution | double | |
|
availability
|
availability | AIForged.DAL.Availability |
記錄的可評估性 |
AIForged.DAL.DocumentDataType
AIForged.ViewModels.DocParam摘要
包含參數資訊的統計資料文件摘要
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
projectId
|
projectId | integer | |
|
服務類型
|
serviceType | integer | |
|
serviceId 服務 ID
|
serviceId | integer | |
|
使用方式
|
usage | AIForged.DAL.UsageType |
我們為什麼要儲存此文件 |
|
狀態
|
status | AIForged.DAL.DocumentStatus |
在系統中指出文件的狀態 |
|
名稱
|
name | string | |
|
類別標識符
|
classId | integer | |
|
className
|
className | string | |
|
serviceName
|
serviceName | string | |
|
檔案類型
|
fileType | string | |
|
DT
|
dt | date-time | |
|
count
|
count | integer | |
|
labelled計數
|
labelledCount | integer | |
|
pdId
|
pdId | integer | |
|
paramDefName
|
paramDefName | string | |
|
分類
|
category | AIForged.DAL.ParameterDefinitionCategory |
定義類別 |
|
群組
|
grouping | AIForged.DAL.GroupingType |
欄位分組類型 |
|
valueType
|
valueType | AIForged.DAL.ValueType |
用於規則和設定的值類型 |
|
value
|
value | string | |
|
索引
|
index | integer |
AIForged.ViewModels.DocumentExtraction
結構化文件結果的轉置擷取
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | integer | |
|
parentId
|
parentId | integer | |
|
名稱
|
name | string | |
|
標籤
|
label | string | |
|
分類
|
category | AIForged.DAL.ParameterDefinitionCategory |
定義類別 |
|
群組
|
grouping | AIForged.DAL.GroupingType |
欄位分組類型 |
|
valueType
|
valueType | AIForged.DAL.ValueType |
用於規則和設定的值類型 |
|
索引
|
index | integer | |
|
paramId
|
paramId | integer | |
|
parentParamId
|
parentParamId | integer | |
|
參數索引
|
paramIndex | integer | |
|
參數值
|
paramValue | string | |
|
驗證標識碼
|
verificationId | integer | |
|
userId
|
userId | string | |
|
使用者名稱
|
userName | string | |
|
value
|
value | string | |
|
DT
|
dt | date-time | |
|
信賴度
|
confidence | float | |
|
型別
|
type | AIForged.DAL.VerificationType |
驗證類型 |
|
狀態
|
status | AIForged.DAL.VerificationStatus |
驗證狀態旗標 |
|
費用
|
charge | double | |
|
提供者
|
provider | string | |
|
結果
|
result | string |
AIForged.ViewModels.ProjectViewModel
專案是計費和服務的容器
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | integer | |
|
userId
|
userId | string | |
|
狀態
|
status | AIForged.DAL.ProjectStatus |
用於指示專案的狀態 |
|
名稱
|
name | string | |
|
描述
|
description | string | |
|
留言
|
comment | string | |
|
dtc
|
dtc | date-time | |
|
DTM
|
dtm | date-time | |
|
餘額
|
balance |
專案和服務的會計資訊 |
|
|
總文件計數
|
totalDocsCount | integer | |
|
services
|
services | array of AIForged.ViewModels.ParameterDefViewModel |
AIForged.DAL.專案狀態
AIForged.ViewModels.DataTypeViewModel
用於規則和內部處理的資料類型
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | AIForged.DAL.ValueType |
用於規則和設定的值類型 |
|
名稱
|
name | string | |
|
描述
|
description | string | |
|
分類
|
category | AIForged.DAL.DataTypeCategory |
資料類型的類別 |
|
valueTypeName
|
valueTypeName | string | |
|
defaultValue
|
defaultValue | string | |
|
資料
|
data | string |
AIForged.DAL.DataType類別
AIForged.ViewModels.EnumDataViewModel
系統枚舉清單和基本 UI 資訊
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | integer | |
|
型別
|
type | AIForged.DAL.EnumType |
系統中所有列舉的列舉 |
|
類型名稱
|
typeName | string | |
|
名稱
|
name | string | |
|
value
|
value | integer | |
|
描述
|
description | string | |
|
資訊
|
info | string | |
|
icon
|
icon | string | |
|
color
|
color | string |
AIForged.DAL.列舉類型
AIForged.ViewModels.驗證摘要
文件欄位的系統和使用者驗證資訊
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | integer | |
|
參數標識
|
parameterId | integer | |
|
userId
|
userId | string | |
|
value
|
value | string | |
|
DT
|
dt | date-time | |
|
信賴度
|
confidence | float | |
|
符號信心
|
symbolsConfidence | string | |
|
型別
|
type | AIForged.DAL.VerificationType |
驗證類型 |
|
狀態
|
status | AIForged.DAL.VerificationStatus |
驗證狀態旗標 |
|
結果
|
result | string | |
|
箱
|
box | string | |
|
資訊
|
info | string | |
|
資料
|
data | byte | |
|
使用者名稱
|
userName | string | |
|
serviceId 服務 ID
|
serviceId | integer | |
|
serviceDocId
|
serviceDocId | integer | |
|
提供者
|
provider | string | |
|
設定標識
|
settingId | integer | |
|
工作項目
|
workItem | integer | |
|
交易 ID
|
transactionId | integer | |
|
費用
|
charge | double | |
|
paramDefId
|
paramDefId | integer | |
|
paramDefName
|
paramDefName | string | |
|
projectId
|
projectId | integer | |
|
projectName
|
projectName | string | |
|
docId
|
docId | integer | |
|
docFileName
|
docFileName | string | |
|
docContentType
|
docContentType | string | |
|
doc用法
|
docUsage | AIForged.DAL.UsageType |
我們為什麼要儲存此文件 |
|
文件狀態
|
docStatus | AIForged.DAL.DocumentStatus |
在系統中指出文件的狀態 |
|
類別標識符
|
classId | integer | |
|
className
|
className | string | |
|
年
|
year | integer | |
|
個月
|
month | integer | |
|
天
|
day | integer | |
|
dayOfWeek
|
dayOfWeek | System.DayOfWeek |
一週中的行事曆日 |
|
count
|
count | integer | |
|
平均
|
average | float | |
|
min
|
min | float | |
|
max
|
max | float |
System.DayOfWeek
檔案
這是基本資料類型「檔案」。
字串
這是基本資料類型「string」。
物件
這是類型 'object'。