AIForged (プレビュー)
AIForged は、複雑な問題に対するインテリジェントなドキュメント処理ソリューションです。 AIForged は、非構造化画像からの構造化データの処理と抽出を自動化できます。 コネクタは、AIForged とのインテリジェントなドキュメント抽出の統合と自動化を提供します
このコネクタは、次の製品および地域で利用可能です:
| Service | クラス | 地域 |
|---|---|---|
| Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure 中国の地域 - 国防総省 (DoD) |
| Power Automate | プレミアム | 以下を除くすべての Power Automate 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 国防総省 (DoD) |
| Power Apps | プレミアム | 以下を除くすべての Power Apps 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21 Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
| お問い合わせ先 | |
|---|---|
| 件名 | AIForged |
| [URL] | https://www.aiforged.com |
| メール | support@aiforged.com |
| Connector Metadata | |
|---|---|
| 発行者 | Larc AI (PTY) Ltd |
| Web サイト | https://www.aiforged.com |
| プライバシー ポリシー | https://portal.aiforged.com/privacypolicy.html |
| カテゴリー | AI、コンテンツとファイル |
AIForged は、複雑なドキュメント抽出の問題を解決するためのクラウド ベースのインテリジェントなドキュメント処理ソリューションです。 AIForged プラットフォームは、Microsoft、Google、Amazon、ABBYY などの業界をリードする AI サービスからの複数のサービスを 1 つのモデルにシームレスに統合し、これらのサービスを併用することで、最適な結果を得ることができます。 AIForged のインテリジェントなドキュメント処理により、企業は低コストでより高い精度と速度で、生産量を増やすことができます。
前提条件
次のものが必要です :
Microsoft Power Apps または Power Automate プラン
Microsoft 365 アカウント、Power Automate プランと AIForged アカウント / サービスが必要です。
AIForged のアカウントとサービス
このコネクタを使用するには、AIForged アカウントが必要です。 正確な結果を得るには、AIForged サービスを構成してトレーニングする必要もあります。 詳細な手順については、プロジェクトの作成で定義されている手順に従って、AIForged に登録し、AIForged プロジェクトとサービスを設定します。
ここでは、社会保障カードから情報を抽出する方法の実際の例を示します 実践例 - 社会保障。
与信申請から情報を抽出するための実際の例も参照してください 実践例 - 与信申請。
資格情報の入手方法
AIForged を使用するには、AIForged アカウントが必要です。 Microsoft Store または Microsoft Store Web サイト から AIForged アプリをインストールすることで登録できます。
アプリをインストールしたら、簡単な登録手順 登録 を使用して登録できます。
アカウントをアクティブ化するには、アクティブ化リンクが記載されたメールを受信する必要があります。 アクティブ化リンクをクリックすると、AIForged がアクティベーション情報とともに開きます。 アカウントがアクティブ化されると、資格情報を使用してログインし、コネクタで資格情報を使用できます。
AIForged サービスを作成してトレーニングする方法
最初に、課金用のプロジェクト コンテナを作成する必要があります。 プロジェクトが作成されたら、AIForged アプリケーションでウィザードの手順に従ってインテリジェント サービスを追加できます。
ここでは、ドキュメントから情報を抽出するための実際の例を示します
コネクタの使用を開始する
開始方法の詳細については、次の Power Automate - はじめに のガイドを参照してください
認証
このコネクタは OAuth2 認証を使用します (取得方法については、上記の手順を参照してください)。 新しいコネクタを作成するとき (Power Apps/Logic Apps で)、登録時に認証情報を入力する必要があります。
既知の問題と制限事項
コネクタで使用する資格情報に対して MFA/2FA を有効にすることはできません。
一般的なエラーと解決策
サポートまたは支援については、AIForged サポートでサポート チケットを作成するか、support@aiforged.com にメールを送信してください
よくあるご質問
詳細および FAQ については、AIForged ドキュメント を参照してください。
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| BLOB キーで BLOB を取得 |
BLOB キーで BLOB を取得 |
| id でサービスの取得 |
id でサービスの取得 |
| id でドキュメントの削除 |
id でドキュメントの削除 |
| Id でドキュメントの取得 |
Id でドキュメントの取得 |
| Id でパラメーター定義の親サービスを取得 |
Id でパラメーター定義の親サービスを取得 |
| Id で定義を取得 |
Id で定義を取得 |
| id で検証を取得 |
id で検証を取得 |
| サービスのフィールド階層の取得 |
サービスのフィールド階層の取得 |
| サービスのプレビュー ドキュメントと画像を取得 |
サービスのプレビュー ドキュメントと画像を取得 |
| システムとアプリケーションの情報の取得 |
システムとアプリケーションの情報の取得 |
| システム列挙値を取得 |
システム列挙値を取得 |
| データ型の取得 |
データ型の取得 |
| ドキュメント BLOB の削除 |
ドキュメント BLOB の削除 |
| ドキュメント パラメーターの抽出 |
ドキュメント パラメーターの抽出 |
| ドキュメントと関連ドキュメントの取得 |
ドキュメントと関連ドキュメントの取得 |
| ドキュメントのアップロードと分類 |
ドキュメントのアップロードと分類 |
| ドキュメント分類のアップロードと取得 |
ドキュメント分類のアップロードと取得 |
| ドキュメント画像の取得 |
ドキュメント画像の取得 |
| ドキュメント画像の取得 |
ドキュメント画像の取得 |
| パラメータに関する検証を取得 |
パラメータに関する検証を取得 |
| パラメーターに関する最新の検証を取得 |
パラメーターに関する最新の検証を取得 |
| パラメーターの削除 |
パラメーターの削除 |
| パラメーター値の取得 |
パラメーター値の取得 |
| パラメーター階層の取得 |
パラメーター階層の取得 |
| プロジェクトにあるすべてのサービスのフィールド階層を取得 |
プロジェクトにあるすべてのサービスのフィールド階層を取得 |
| プロジェクトに関連するサービスを取得 |
プロジェクトに関連するサービスを取得 |
| プロジェクト別にすべてのカテゴリの取得 |
プロジェクト別にすべてのカテゴリの取得 |
| ユーザーおよびプロジェクト別に取得 |
ユーザーおよびプロジェクト別に取得 |
| ユーザーにリンクされたプロジェクトとサービスを取得 |
ユーザーにリンクされたプロジェクトとサービスを取得 |
| ユーザーの api key を取得 |
ユーザーの api key を取得 |
| 分類情報の取得 |
分類情報の取得 |
| 名前でプロジェクトの検索 |
名前でプロジェクトの検索 |
| 検証 id でパラメーターの取得 |
検証 id でパラメーターの取得 |
| 検証のための情報のアップロードと抽出 |
検証のための情報のアップロードと抽出 |
| 検証分析の取得 |
検証分析の取得 |
| 検証概要の取得 |
検証概要の取得 |
| 検証概要の取得 |
検証概要の取得 |
| 構造化された検索条件を使用したドキュメントの検索。 結果のページングが可能 |
構造化された検索条件を使用したドキュメントの検索。 結果のページングが可能 |
| 特定プロジェクトの取得 |
特定プロジェクトの取得 |
| 現在のサービスのデータと時刻の取得 |
現在のサービスのデータと時刻の取得 |
| 現在ログインしているユーザーの取得 |
現在ログインしているユーザーの取得 |
| 画像タイプ別にドキュメント id のデータ BLOB を取得 |
画像タイプ別にドキュメント id のデータ BLOB を取得 |
| 認証画像 shred の取得 |
認証画像 shred の取得 |
BLOB キーで BLOB を取得
BLOB キーで BLOB を取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
BLOB id
|
id | integer |
BLOB id |
|
|
API バージョン ヘッダー
|
X-Api-Version | True | string |
API バージョン ヘッダー |
戻り値
- 返答
- file
id でサービスの取得
id でサービスの取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
The service id
|
stpdId | integer |
The service id |
|
|
API バージョン ヘッダー
|
X-Api-Version | True | string |
API バージョン ヘッダー |
戻り値
サービス、設定およびルール定義
id でドキュメントの削除
id でドキュメントの削除
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
削除するドキュメント id
|
id | integer |
削除するドキュメント id |
|
|
API バージョン ヘッダー
|
X-Api-Version | True | string |
API バージョン ヘッダー |
戻り値
ドキュメント メタデータ情報
Id でドキュメントの取得
Id でドキュメントの取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ドキュメント ID
|
id | integer |
ドキュメント ID |
|
|
API バージョン ヘッダー
|
X-Api-Version | True | string |
API バージョン ヘッダー |
戻り値
ドキュメント メタデータ情報
Id でパラメーター定義の親サービスを取得
Id でパラメーター定義の親サービスを取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
The parameter definition id
|
id | integer |
The parameter definition id |
|
|
API バージョン ヘッダー
|
X-Api-Version | True | string |
API バージョン ヘッダー |
戻り値
サービス、設定およびルール定義
Id で定義を取得
Id で定義を取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
The definition id
|
id | integer |
The definition id |
|
|
API バージョン ヘッダー
|
X-Api-Version | True | string |
API バージョン ヘッダー |
戻り値
サービス、設定およびルール定義
id で検証を取得
id で検証を取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Verification id
|
verificationId | integer |
検証 id |
|
|
API バージョン ヘッダー
|
X-Api-Version | True | string |
API バージョン ヘッダー |
戻り値
ドキュメント上のフィールドに対するシステムおよびユーザーの検証情報
サービスのフィールド階層の取得
サービスのフィールド階層の取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
The project id
|
projectId | integer |
The project id |
|
|
The service id
|
stpdId | integer |
The service id |
|
|
Include counter stats
|
includeCount | boolean |
Include counter stats |
|
|
Include settings
|
includeSettings | boolean |
設定を含む |
|
|
Include child definiitions
|
includeChildren | boolean |
Include child definiitions |
|
|
API バージョン ヘッダー
|
X-Api-Version | True | string |
API バージョン ヘッダー |
戻り値
サービス、設定およびルール定義
サービスのプレビュー ドキュメントと画像を取得
サービスのプレビュー ドキュメントと画像を取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
The user that owns the service
|
userId | string |
The user that owns the service |
|
|
The project id
|
projectId | integer |
The project id |
|
|
The service id
|
stpdId | integer |
The service id |
|
|
API バージョン ヘッダー
|
X-Api-Version | True | string |
API バージョン ヘッダー |
戻り値
システムとアプリケーションの情報の取得
システムとアプリケーションの情報の取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
API バージョン ヘッダー
|
X-Api-Version | True | string |
API バージョン ヘッダー |
戻り値
- 返答
- object
システム列挙値を取得
システム列挙値を取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
API バージョン ヘッダー
|
X-Api-Version | True | string |
API バージョン ヘッダー |
戻り値
データ型の取得
データ型の取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
API バージョン ヘッダー
|
X-Api-Version | True | string |
API バージョン ヘッダー |
戻り値
ドキュメント BLOB の削除
ドキュメント BLOB の削除
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
BLOB id
|
id | integer |
BLOB id |
|
|
API バージョン ヘッダー
|
X-Api-Version | True | string |
API バージョン ヘッダー |
戻り値
- 返答
- file
ドキュメント パラメーターの抽出
ドキュメント パラメーターの抽出
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ドキュメント ID
|
docid | integer |
ドキュメント ID |
|
|
API バージョン ヘッダー
|
X-Api-Version | True | string |
API バージョン ヘッダー |
戻り値
ドキュメントと関連ドキュメントの取得
ドキュメントと関連ドキュメントの取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ドキュメント ID
|
id | integer |
ドキュメント ID |
|
|
API バージョン ヘッダー
|
X-Api-Version | True | string |
API バージョン ヘッダー |
戻り値
ドキュメント メタデータ情報
ドキュメントのアップロードと分類
ドキュメントのアップロードと分類
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
The service id
|
stpdId | integer |
The service id |
|
|
プロジェクト ID
|
projectId | integer |
プロジェクト ID |
|
|
The file data
|
file | file |
The file data |
|
|
API バージョン ヘッダー
|
X-Api-Version | True | string |
API バージョン ヘッダー |
戻り値
ドキュメント メタデータ情報
ドキュメント分類のアップロードと取得
ドキュメント分類のアップロードと取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
The service id
|
stpdId | integer |
The service id |
|
|
The project id
|
projectId | integer |
The project id |
|
|
ドキュメント ID
|
docId | integer |
ドキュメント ID |
|
|
API バージョン ヘッダー
|
X-Api-Version | True | string |
API バージョン ヘッダー |
戻り値
トレーニングと分類のためのカテゴリ/クラス
ドキュメント画像の取得
ドキュメント画像の取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ドキュメント ID
|
id | integer |
ドキュメント ID |
|
|
Service id
|
stpdId | integer |
サービス id |
|
|
API バージョン ヘッダー
|
X-Api-Version | True | string |
API バージョン ヘッダー |
戻り値
ドキュメント画像の取得
ドキュメント画像の取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ドキュメント ID
|
id | integer |
ドキュメント ID |
|
|
画像の種類
|
type | integer |
画像の種類 |
|
|
Image content type
|
contentType | string |
Image content type |
|
|
A test filter
|
text | string |
A test filter |
|
|
The related blob id
|
blobid | integer |
The related blob id |
|
|
The page index
|
pageindex | integer |
The page index |
|
|
Number of images to return
|
imagesCount | integer |
Number of images to return |
|
|
API バージョン ヘッダー
|
X-Api-Version | True | string |
API バージョン ヘッダー |
戻り値
パラメータに関する検証を取得
パラメータに関する検証を取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ドキュメント ID
|
docId | integer |
ドキュメント ID |
|
|
Parameter id
|
parameterId | integer |
パラメーター id |
|
|
API バージョン ヘッダー
|
X-Api-Version | True | string |
API バージョン ヘッダー |
戻り値
パラメーターに関する最新の検証を取得
パラメーターに関する最新の検証を取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ドキュメント ID
|
docId | integer |
ドキュメント ID |
|
|
Parameter id
|
parameterId | integer |
パラメーター id |
|
|
定義 ID
|
pdId | integer |
定義 ID |
|
|
API バージョン ヘッダー
|
X-Api-Version | True | string |
API バージョン ヘッダー |
戻り値
ドキュメント上のフィールドに対するシステムおよびユーザーの検証情報
パラメーターの削除
パラメーターの削除
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
パラメーター id
|
paramid | integer |
パラメーター id |
|
|
API バージョン ヘッダー
|
X-Api-Version | True | string |
API バージョン ヘッダー |
戻り値
ドキュメントからリンクまたは抽出されたフィールド値
パラメーター値の取得
パラメーター値の取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ドキュメント ID
|
docId | integer |
ドキュメント ID |
|
|
The service id
|
stpdId | integer |
The service id |
|
|
Parameter category
|
category | integer |
パラメーター カテゴリ |
|
|
Parameter grouping
|
grouping | integer |
パラメーター グループ |
|
|
Include verification data
|
includeverification | boolean |
Include verification data |
|
|
API バージョン ヘッダー
|
X-Api-Version | True | string |
API バージョン ヘッダー |
戻り値
パラメーター階層の取得
パラメーター階層の取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ドキュメント ID
|
docId | integer |
ドキュメント ID |
|
|
The service id
|
stpdId | integer |
The service id |
|
|
Include verification data
|
includeverification | boolean |
Include verification data |
|
|
API バージョン ヘッダー
|
X-Api-Version | True | string |
API バージョン ヘッダー |
戻り値
プロジェクトにあるすべてのサービスのフィールド階層を取得
プロジェクトにあるすべてのサービスのフィールド階層を取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー ID
|
userId | string |
ユーザー ID |
|
|
The project id
|
projectId | integer |
The project id |
|
|
The service id
|
stpdId | integer |
The service id |
|
|
The group id
|
groupId | integer |
The group id |
|
|
Include counter stats
|
includeCount | boolean |
Include counter stats |
|
|
Only include services
|
onlyServices | boolean |
Only include services |
|
|
Include settings
|
includeSettings | boolean |
設定を含む |
|
|
Include children
|
includeChildren | boolean |
子を含む |
|
|
API バージョン ヘッダー
|
X-Api-Version | True | string |
API バージョン ヘッダー |
戻り値
プロジェクトに関連するサービスを取得
プロジェクトに関連するサービスを取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー ID
|
userId | string |
ユーザー ID |
|
|
The project id
|
projectId | integer |
The project id |
|
|
Service type filter
|
stlfilter | integer |
Service type filter |
|
|
Filter by engine
|
enginefilter | string |
Filter by engine |
|
|
API バージョン ヘッダー
|
X-Api-Version | True | string |
API バージョン ヘッダー |
戻り値
プロジェクト別にすべてのカテゴリの取得
プロジェクト別にすべてのカテゴリの取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
The ptoject id
|
projectId | integer |
The ptoject id |
|
|
API バージョン ヘッダー
|
X-Api-Version | True | string |
API バージョン ヘッダー |
戻り値
ユーザーおよびプロジェクト別に取得
ユーザーおよびプロジェクト別に取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー ID
|
userId | string |
ユーザー ID |
|
|
The project id
|
projectId | integer |
The project id |
|
|
API バージョン ヘッダー
|
X-Api-Version | True | string |
API バージョン ヘッダー |
戻り値
ユーザーにリンクされたプロジェクトとサービスを取得
ユーザーにリンクされたプロジェクトとサービスを取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー ID
|
userId | string |
ユーザー ID |
|
|
API バージョン ヘッダー
|
X-Api-Version | True | string |
API バージョン ヘッダー |
戻り値
ユーザーの api key を取得
ユーザーの api key を取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー ID
|
userId | string |
ユーザー ID |
|
|
API バージョン ヘッダー
|
X-Api-Version | True | string |
API バージョン ヘッダー |
戻り値
- 返答
- string
分類情報の取得
分類情報の取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
The id of the classification
|
Id | integer |
The id of the classification |
|
|
API バージョン ヘッダー
|
X-Api-Version | True | string |
API バージョン ヘッダー |
戻り値
トレーニングと分類のためのカテゴリ/クラス
名前でプロジェクトの検索
名前でプロジェクトの検索
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー ID
|
userId | string |
ユーザー ID |
|
|
プロジェクト名
|
projectName | string |
プロジェクト名 |
|
|
API バージョン ヘッダー
|
X-Api-Version | True | string |
API バージョン ヘッダー |
戻り値
プロジェクトは課金とサービス用のコンテナです
検証 id でパラメーターの取得
検証 id でパラメーターの取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
The verification id
|
verificationId | integer |
The verification id |
|
|
API バージョン ヘッダー
|
X-Api-Version | True | string |
API バージョン ヘッダー |
戻り値
ドキュメントからリンクまたは抽出されたフィールド値
検証のための情報のアップロードと抽出
検証のための情報のアップロードと抽出
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
The service id
|
stpdId | integer |
The service id |
|
|
The project id
|
projectId | integer |
The project id |
|
|
The file
|
file | file |
ファイル |
|
|
API バージョン ヘッダー
|
X-Api-Version | True | string |
API バージョン ヘッダー |
戻り値
ドキュメント メタデータ情報
検証分析の取得
検証分析の取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
The project id
|
projectId | integer |
The project id |
|
|
Service id
|
stpdId | integer |
サービス id |
|
|
Only the latest
|
latestOnly | boolean |
Only the latest |
|
|
API バージョン ヘッダー
|
X-Api-Version | True | string |
API バージョン ヘッダー |
戻り値
検証概要の取得
検証概要の取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
The project id
|
projectId | integer |
The project id |
|
|
API バージョン ヘッダー
|
X-Api-Version | True | string |
API バージョン ヘッダー |
戻り値
検証概要の取得
検証概要の取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
プロジェクト ID
|
projectId | integer |
プロジェクト ID |
|
|
Service id
|
stpdId | integer |
サービス id |
|
|
定義 ID
|
pdId | integer |
定義 ID |
|
|
Only latest or history
|
latestOnly | boolean |
Only latest or history |
|
|
API バージョン ヘッダー
|
X-Api-Version | True | string |
API バージョン ヘッダー |
戻り値
構造化された検索条件を使用したドキュメントの検索。 結果のページングが可能
構造化された検索条件を使用したドキュメントの検索。 結果のページングが可能
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Owner of the document
|
userId | string |
Owner of the document |
|
|
The project id
|
projectId | integer |
The project id |
|
|
The service id
|
stpdId | integer |
The service id |
|
|
The folder or usage
|
usage | integer |
The folder or usage |
|
|
The status
|
status | integer |
ステータス |
|
|
A class name filter
|
classname | string |
A class name filter |
|
|
Filename filter
|
filename | string |
ファイル名のフィルター |
|
|
File type filter
|
filetype | string |
File type filter |
|
|
Start date range for documents
|
start | date-time |
Start date range for documents |
|
|
End date range for documents
|
end | date-time |
End date range for documents |
|
|
Master or parent of the document
|
masterid | integer |
Master or parent of the document |
|
|
ページ番号
|
pageNo | integer |
ページ番号 |
|
|
Size of a page
|
pageSize | integer |
Size of a page |
|
|
Sort by field
|
sortField | integer |
Sort by field |
|
|
Sort direction based on the sortfield
|
sortDirection | integer |
Sort direction based on the sortfield |
|
|
Filter for comments
|
comment | string |
Filter for comments |
|
|
Filter for results
|
result | string |
Filter for results |
|
|
Filter for a result id
|
resultId | string |
Filter for a result id |
|
|
Filter for result index
|
resultIndex | integer |
Filter for result index |
|
|
Filter for external ids
|
externalId | string |
Filter for external ids |
|
|
Filter for doc guids
|
docGuid | string |
Filter for doc guids |
|
|
API バージョン ヘッダー
|
X-Api-Version | True | string |
API バージョン ヘッダー |
戻り値
特定プロジェクトの取得
特定プロジェクトの取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー ID
|
userId | string |
ユーザー ID |
|
|
The project id
|
projectId | integer |
The project id |
|
|
API バージョン ヘッダー
|
X-Api-Version | True | string |
API バージョン ヘッダー |
戻り値
プロジェクトは課金とサービス用のコンテナです
現在のサービスのデータと時刻の取得
現在のサービスのデータと時刻の取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
API バージョン ヘッダー
|
X-Api-Version | True | string |
API バージョン ヘッダー |
戻り値
- 返答
- date-time
現在ログインしているユーザーの取得
現在ログインしているユーザーの取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
API バージョン ヘッダー
|
X-Api-Version | True | string |
API バージョン ヘッダー |
戻り値
ユーザー情報
画像タイプ別にドキュメント id のデータ BLOB を取得
画像タイプ別にドキュメント id のデータ BLOB を取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
User id that owns the document
|
userId | string |
User id that owns the document |
|
|
Blob id
|
id | integer |
Blob id |
|
|
The blob type
|
type | integer |
The blob type |
|
|
API バージョン ヘッダー
|
X-Api-Version | True | string |
API バージョン ヘッダー |
戻り値
- 返答
- file
認証画像 shred の取得
認証画像 shred の取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
User for the shred
|
userId | string |
User for the shred |
|
|
ドキュメント ID
|
docId | integer |
ドキュメント ID |
|
|
Parameter id
|
parId | integer |
パラメーター id |
|
|
Verification id
|
verificationId | integer |
認証 id |
|
|
Should the image be inline
|
inline | boolean |
Should the image be inline |
|
|
API バージョン ヘッダー
|
X-Api-Version | True | string |
API バージョン ヘッダー |
戻り値
- 返答
- file
定義
AIForged.ViewModels.UserViewModel
ユーザー情報
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | string | |
|
userName
|
userName | string | |
|
fullName
|
fullName | string | |
|
メールアドレス
|
|||
|
役職
|
jobTitle | string | |
|
phoneNumber
|
phoneNumber | phone | |
|
構成
|
configuration | string | |
|
isEnabled
|
isEnabled | boolean | |
|
isLockedOut
|
isLockedOut | boolean | |
|
friendlyName
|
friendlyName | string | |
|
createdBy
|
createdBy | string | |
|
updatedBy
|
updatedBy | string | |
|
createdDate
|
createdDate | date-time | |
|
updatedDate
|
updatedDate | date-time | |
|
roles
|
roles | array of string |
AIForged.ViewModels.ClassesViewModel
トレーニングと分類のためのカテゴリ/クラス
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer | |
|
userId
|
userId | string | |
|
projectId
|
projectId | integer | |
|
名称
|
name | string | |
|
description
|
description | string | |
|
コメント
|
comment | string | |
|
dtc
|
dtc | date-time | |
|
dtm
|
dtm | date-time | |
|
タイプ
|
type | AIForged.DAL.ClassType |
システム カテゴリ タイプ |
|
関連
|
related | integer |
AIForged.DAL.ClassType
AIForged.ViewModels.DocumentViewModel
ドキュメント メタデータ情報
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer | |
|
userId
|
userId | string | |
|
projectId
|
projectId | integer | |
|
serviceId
|
serviceId | integer | |
|
ステータス
|
status | AIForged.DAL.DocumentStatus |
システム内のドキュメントのステータスを示します |
|
使用状況
|
usage | AIForged.DAL.UsageType |
このドキュメントを保存する理由 |
|
classId
|
classId | integer | |
|
contentType
|
contentType | string | |
|
ファイル名
|
filename | string | |
|
fileType
|
fileType | string | |
|
dtc
|
dtc | date-time | |
|
dtm
|
dtm | date-time | |
|
documentId
|
documentId | guid | |
|
externalId
|
externalId | string | |
|
masterId
|
masterId | integer | |
|
result
|
result | string | |
|
resultId
|
resultId | string | |
|
resultIndex
|
resultIndex | integer | |
|
コメント
|
comment | string | |
|
空き時間
|
availability | AIForged.DAL.Availability |
レコードの可用性 |
|
resultParameters
|
resultParameters | array of AIForged.ViewModels.DocumentParameterViewModel | |
|
データ
|
data | array of AIForged.ViewModels.DocumentDataViewModel | |
|
documents
|
documents | array of AIForged.ViewModels.DocumentViewModel | |
|
originId
|
originId | integer | |
|
canVerify
|
canVerify | boolean | |
|
canClassify
|
canClassify | boolean | |
|
canTrain
|
canTrain | boolean | |
|
trained
|
trained | boolean | |
|
linkedDocsCount
|
linkedDocsCount | integer | |
|
trainingFieldCount
|
trainingFieldCount | integer | |
|
trainedParametersCount
|
trainedParametersCount | integer |
AIForged.DAL.DocumentStatus
AIForged.DAL.UsageType
AIForged.DAL.Availability
AIForged.ViewModels.DocumentParameterViewModel
ドキュメントからリンクまたは抽出されたフィールド値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer | |
|
documentId
|
documentId | integer | |
|
paramDefId
|
paramDefId | integer | |
|
parentId
|
parentId | integer | |
|
sourceId
|
sourceId | integer | |
|
価値
|
value | string | |
|
データ
|
data | byte | |
|
index
|
index | integer | |
|
colIndex
|
colIndex | integer | |
|
colSpan
|
colSpan | integer | |
|
rowIndex
|
rowIndex | integer | |
|
rowSpan
|
rowSpan | integer | |
|
空き時間
|
availability | AIForged.DAL.Availability |
レコードの可用性 |
|
paramDef
|
paramDef |
サービス、設定およびルール定義 |
|
|
子
|
children | array of AIForged.ViewModels.DocumentParameterViewModel | |
|
verifications
|
verifications | array of AIForged.ViewModels.VerificationViewModel |
AIForged.ViewModels.ParameterDefViewModel
サービス、設定およびルール定義
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer | |
|
projectId
|
projectId | integer | |
|
serviceTypeId
|
serviceTypeId | integer | |
|
serviceId
|
serviceId | integer | |
|
classId
|
classId | integer | |
|
parentId
|
parentId | integer | |
|
名称
|
name | string | |
|
label
|
label | string | |
|
tags
|
tags | string | |
|
description
|
description | string | |
|
dtc
|
dtc | date-time | |
|
dtm
|
dtm | date-time | |
|
ステータス
|
status | AIForged.DAL.ParameterDefinitionStatus |
定義のステータス |
|
category
|
category | AIForged.DAL.ParameterDefinitionCategory |
定義のカテゴリ |
|
grouping
|
grouping | AIForged.DAL.GroupingType |
フィールド グループのタイプ |
|
valueType
|
valueType | AIForged.DAL.ValueType |
ルールと設定に使用される値のタイプ |
|
valueTypeName
|
valueTypeName | string | |
|
defaultValue
|
defaultValue | string | |
|
required
|
required | AIForged.DAL.RequiredOption |
オプションが必要かどうかを示します |
|
index
|
index | integer | |
|
情報
|
info | string | |
|
reference
|
reference | string | |
|
rating
|
rating | float | |
|
空き時間
|
availability | AIForged.DAL.Availability |
レコードの可用性 |
|
子
|
children | array of AIForged.ViewModels.ParameterDefViewModel | |
|
設定
|
settings | array of AIForged.DAL.Models.ParameterDefSettingViewModel | |
|
totalCharge
|
totalCharge | double | |
|
userCount
|
userCount | integer | |
|
parameterCount
|
parameterCount | integer | |
|
documentCount
|
documentCount | integer | |
|
検証
|
validation | string |
AIForged.DAL.ParameterDefinitionStatus
AIForged.DAL.ParameterDefinitionCategory
AIForged.DAL.GroupingType
AIForged.DAL.ValueType
AIForged.DAL.RequiredOption
AIForged.DAL.Models.ParameterDefSettingViewModel
ルールや設定の詳細設定
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer | |
|
parameterDefId
|
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
|
minValue | string | |
|
maxValue
|
maxValue | string | |
|
信頼度
|
confidence | float | |
|
minConfidence
|
minConfidence | float | |
|
maxConfidence
|
maxConfidence | float | |
|
isCaseSensative
|
isCaseSensative | boolean | |
|
invert
|
invert | boolean | |
|
oneLine
|
oneLine | boolean | |
|
oneWord
|
oneWord | boolean | |
|
isHandwriting
|
isHandwriting | boolean | |
|
orientation
|
orientation | AIForged.DAL.Orientation |
フィールドのテキストの向き |
|
marking
|
marking | AIForged.DAL.MarkingType |
テキストのマーク タイプ |
|
セル
|
cells | integer | |
|
clearBefore
|
clearBefore | AIForged.DAL.OptionStatusFlags |
オプションのステータス フラグ |
|
clearAfter
|
clearAfter | AIForged.DAL.OptionStatusFlags |
オプションのステータス フラグ |
|
cleanupValuesBefore
|
cleanupValuesBefore | boolean | |
|
cleanupValuesAfter
|
cleanupValuesAfter | boolean | |
|
validateValuesBefore
|
validateValuesBefore | boolean | |
|
validateValuesAfter
|
validateValuesAfter | boolean | |
|
abortOnValidationError
|
abortOnValidationError | boolean | |
|
isReplacementCaseSensative
|
isReplacementCaseSensative | boolean | |
|
compileResults
|
compileResults | string | |
|
maxRetry
|
maxRetry | integer | |
|
タイムアウト
|
timeout | string | |
|
userId
|
userId | string |
AIForged.DAL.SettingType
AIForged.DAL.SettingStatus
AIForged.DAL.Orientation
AIForged.DAL.MarkingType
AIForged.DAL.OptionStatusFlags
AIForged.ViewModels.VerificationViewModel
ドキュメント上のフィールドに対するシステムおよびユーザーの検証情報
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer | |
|
parameterId
|
parameterId | integer | |
|
userId
|
userId | string | |
|
価値
|
value | string | |
|
dt
|
dt | date-time | |
|
信頼度
|
confidence | float | |
|
symbolsConfidence
|
symbolsConfidence | string | |
|
タイプ
|
type | AIForged.DAL.VerificationType |
検証のタイプ |
|
ステータス
|
status | AIForged.DAL.VerificationStatus |
検証のステータス フラグ |
|
result
|
result | string | |
|
box
|
box | string | |
|
情報
|
info | string | |
|
データ
|
data | byte | |
|
userName
|
userName | string | |
|
serviceId
|
serviceId | integer | |
|
serviceDocId
|
serviceDocId | integer | |
|
provider
|
provider | string | |
|
settingId
|
settingId | integer | |
|
workItem
|
workItem | integer | |
|
transactionId
|
transactionId | integer | |
|
charge
|
charge | double |
AIForged.DAL.VerificationType
AIForged.DAL.VerificationStatus
AIForged.ViewModels.DocumentDataViewModel
ドキュメント BLOB データ
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer | |
|
documentId
|
documentId | integer | |
|
blobId
|
blobId | integer | |
|
タイプ
|
type | AIForged.DAL.DocumentDataType |
ドキュメントに関連するデータの種類を示します |
|
データ
|
data | byte | |
|
プレビュー
|
preview | byte | |
|
text
|
text | string | |
|
情報
|
info | string | |
|
contentType
|
contentType | string | |
|
resultId
|
resultId | string | |
|
index
|
index | integer | |
|
幅
|
width | double | |
|
高さ
|
height | double | |
|
resolution
|
resolution | double | |
|
空き時間
|
availability | AIForged.DAL.Availability |
レコードの可用性 |
AIForged.DAL.DocumentDataType
AIForged.ViewModels.DocParamSummary
パラメーター情報を含む統計のドキュメント概要
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
projectId
|
projectId | integer | |
|
serviceType
|
serviceType | integer | |
|
serviceId
|
serviceId | integer | |
|
使用状況
|
usage | AIForged.DAL.UsageType |
このドキュメントを保存する理由 |
|
ステータス
|
status | AIForged.DAL.DocumentStatus |
システム内のドキュメントのステータスを示します |
|
名称
|
name | string | |
|
classId
|
classId | integer | |
|
className
|
className | string | |
|
serviceName
|
serviceName | string | |
|
fileType
|
fileType | string | |
|
dt
|
dt | date-time | |
|
COUNT
|
count | integer | |
|
labelledCount
|
labelledCount | integer | |
|
pdId
|
pdId | integer | |
|
paramDefName
|
paramDefName | string | |
|
category
|
category | AIForged.DAL.ParameterDefinitionCategory |
定義のカテゴリ |
|
grouping
|
grouping | AIForged.DAL.GroupingType |
フィールド グループのタイプ |
|
valueType
|
valueType | AIForged.DAL.ValueType |
ルールと設定に使用される値のタイプ |
|
価値
|
value | string | |
|
index
|
index | integer |
AIForged.ViewModels.DocumentExtraction
構造化ドキュメント結果の転置抽出
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer | |
|
parentId
|
parentId | integer | |
|
名称
|
name | string | |
|
label
|
label | string | |
|
category
|
category | AIForged.DAL.ParameterDefinitionCategory |
定義のカテゴリ |
|
grouping
|
grouping | AIForged.DAL.GroupingType |
フィールド グループのタイプ |
|
valueType
|
valueType | AIForged.DAL.ValueType |
ルールと設定に使用される値のタイプ |
|
index
|
index | integer | |
|
paramId
|
paramId | integer | |
|
parentParamId
|
parentParamId | integer | |
|
paramIndex
|
paramIndex | integer | |
|
paramValue
|
paramValue | string | |
|
verificationId
|
verificationId | integer | |
|
userId
|
userId | string | |
|
userName
|
userName | string | |
|
価値
|
value | string | |
|
dt
|
dt | date-time | |
|
信頼度
|
confidence | float | |
|
タイプ
|
type | AIForged.DAL.VerificationType |
検証のタイプ |
|
ステータス
|
status | AIForged.DAL.VerificationStatus |
検証のステータス フラグ |
|
charge
|
charge | double | |
|
provider
|
provider | string | |
|
result
|
result | string |
AIForged.ViewModels.ProjectViewModel
プロジェクトは課金とサービス用のコンテナです
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer | |
|
userId
|
userId | string | |
|
ステータス
|
status | AIForged.DAL.ProjectStatus |
プロジェクトのステータスを示すために使用する |
|
名称
|
name | string | |
|
description
|
description | string | |
|
コメント
|
comment | string | |
|
dtc
|
dtc | date-time | |
|
dtm
|
dtm | date-time | |
|
残高
|
balance |
プロジェクトとサービスの会計情報 |
|
|
totalDocsCount
|
totalDocsCount | integer | |
|
サービス
|
services | array of AIForged.ViewModels.ParameterDefViewModel |
AIForged.DAL.ProjectStatus
AIForged.ViewModels.DataTypeViewModel
ルールと内部処理に使用されるデータ型
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | AIForged.DAL.ValueType |
ルールと設定に使用される値のタイプ |
|
名称
|
name | string | |
|
description
|
description | string | |
|
category
|
category | AIForged.DAL.DataTypeCategory |
データ型のカテゴリ |
|
valueTypeName
|
valueTypeName | string | |
|
defaultValue
|
defaultValue | string | |
|
データ
|
data | string |
AIForged.DAL.DataTypeCategory
AIForged.ViewModels.EnumDataViewModel
システム列挙と基本的な UI 情報のリスト
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer | |
|
タイプ
|
type | AIForged.DAL.EnumType |
システム内のすべての列挙型の列挙 |
|
typeName
|
typeName | string | |
|
名称
|
name | string | |
|
価値
|
value | integer | |
|
description
|
description | string | |
|
情報
|
info | string | |
|
アイコン
|
icon | string | |
|
color
|
color | string |
AIForged.DAL.EnumType
AIForged.ViewModels.VerificationSummary
ドキュメント上のフィールドに対するシステムおよびユーザーの検証情報
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | integer | |
|
parameterId
|
parameterId | integer | |
|
userId
|
userId | string | |
|
価値
|
value | string | |
|
dt
|
dt | date-time | |
|
信頼度
|
confidence | float | |
|
symbolsConfidence
|
symbolsConfidence | string | |
|
タイプ
|
type | AIForged.DAL.VerificationType |
検証のタイプ |
|
ステータス
|
status | AIForged.DAL.VerificationStatus |
検証のステータス フラグ |
|
result
|
result | string | |
|
box
|
box | string | |
|
情報
|
info | string | |
|
データ
|
data | byte | |
|
userName
|
userName | string | |
|
serviceId
|
serviceId | integer | |
|
serviceDocId
|
serviceDocId | integer | |
|
provider
|
provider | string | |
|
settingId
|
settingId | integer | |
|
workItem
|
workItem | integer | |
|
transactionId
|
transactionId | integer | |
|
charge
|
charge | double | |
|
paramDefId
|
paramDefId | integer | |
|
paramDefName
|
paramDefName | string | |
|
projectId
|
projectId | integer | |
|
projectName
|
projectName | string | |
|
docId
|
docId | integer | |
|
docFileName
|
docFileName | string | |
|
docContentType
|
docContentType | string | |
|
docUsage
|
docUsage | AIForged.DAL.UsageType |
このドキュメントを保存する理由 |
|
docStatus
|
docStatus | AIForged.DAL.DocumentStatus |
システム内のドキュメントのステータスを示します |
|
classId
|
classId | integer | |
|
className
|
className | string | |
|
year
|
year | integer | |
|
month
|
month | integer | |
|
day
|
day | integer | |
|
dayOfWeek
|
dayOfWeek | System.DayOfWeek |
週のカレンダー日 |
|
COUNT
|
count | integer | |
|
平均
|
average | float | |
|
分
|
min | float | |
|
max
|
max | float |
System.DayOfWeek
file
これは基本的なデータ型 'ファイル' です。
string
これは基本的なデータ型 '文字列' です。
オブジェクト
’オブジェクト’ 型です。