Alkymi
Alkymi は、機械学習と自動化技術ーをビジネス ユーザーに提供することで、企業のワークフローを変革し、運用データの問題を効率化の源に変えます。 Alkymi のコア製品である Data Inbox と Patterns を使用すると、企業はメールやドキュメント内の重要なビジネス データを抽出、分析、処理できます。Alkymi コネクタを使用すると、Alkymi アプリによって処理された非構造化ドキュメントから抽出されたデータに簡単にアクセスできます。
このコネクタは、次の製品および地域で利用可能です:
| Service | クラス | 地域 |
|---|---|---|
| Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure 中国の地域 - 国防総省 (DoD) |
| Power Automate | プレミアム | 以下を除くすべての Power Automate 地域 : - US Government (GCC) - US Government (GCC High) - 21 Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
| Power Apps | プレミアム | 以下を除くすべての Power Apps 地域 : - US Government (GCC) - US Government (GCC High) - 21 Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
| お問い合わせ先 | |
|---|---|
| 件名 | Alkymi Support |
| [URL] | https://www.alkymi.io/contact |
| メール | tori@alkymi.io |
| Connector Metadata | |
|---|---|
| 発行者 | Alkymi |
| Web サイト | https://alkymi.io |
| プライバシー ポリシー | https://www.alkymi.io/privacy-policy |
| カテゴリ | コンテンツとファイル |
接続の作成
コネクタは、次の認証タイプをサポートしています:
| 既定 | 接続を作成するためのパラメーター。 | すべての地域 | 共有不可 |
既定
適用できるもの: すべての領域
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 パワー アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 件名 | タイプ | 説明 | 必須 |
|---|---|---|---|
| API Key | securestring | この API の API キー | はい |
| Host Name | 文字列 | テナントのホスト名 | はい |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
すべてのパターンを一覧表示
テナントで使用可能なすべてのパターンを一覧表示します。 https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/O_NVlCnEFDOAQPWev_rdb
戻り値
パイプライン構成リスト
- PaginatedPipelineConfigurationList
- PaginatedPipelineConfigurationList
すべての実行を一覧表示
テナントで使用可能なすべての実行を一覧表示します。 https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/7qd1-PJ-P40RFf7ocIK5g
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Document Status
|
document_status | array |
ドキュメントの状態 |
戻り値
実行リスト
- PaginatedExecutionList
- PaginatedExecutionList
データセット情報の取得
特定のデータセット インスタンスを取得します。 返されたデータセット レコードは、ワークフローでダウンストリームを使用する前に追加の解析が必要になる場合があります。 https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/dowMAn1aXoA6vyOj24fOr
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Dataset UUID
|
uuid | True | uuid |
データセット uuid |
戻り値
データセット リスト
- PaginatedDatasetList
- PaginatedDatasetList
ドキュメント ファイルの取得 (PDF 形式)
Data Inbox に投稿されたドキュメント ファイルのコピーを PDF 形式に変換してダウンロードします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Document UUID
|
uuid | True | uuid |
ドキュメントの uuid |
戻り値
- 応答
- binary
ドキュメント ファイルの取得 (元の形式)
Data Inbox に投稿されたドキュメント ファイルのコピーを元の形式でダウンロードします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Document UUID
|
uuid | True | uuid |
ドキュメントの uuid |
戻り値
- 応答
- binary
ドキュメント ファイルをアップロード
処理のためにファイルを Data Inbox テナントにアップロードします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Removed Boolean
|
removed | boolean |
削除済み |
|
|
Dataset UUID
|
dataset | string |
データセット uuid |
|
|
Subject
|
subject | string |
件名 |
|
|
Sender
|
sender | string |
センダー |
|
|
Folder
|
folder | string |
フォルダー |
|
|
File Name
|
file | True | file |
ファイル名 |
|
Targeted Patterns
|
targets | array |
対象パターン名 |
ドキュメント情報の取得
特定のドキュメント インスタンスを取得します。 https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/IEdTOtMaW23SQFRPhkDXh
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Document UUID
|
uuid | True | uuid |
ドキュメントの uuid |
戻り値
ドキュメント
- Document
- Document
パターン情報の取得
特定のパターン インスタンスを取得します。 返されたパターン レコードは、ワークフローでダウンストリームを使用する前に追加の解析が必要になる場合があります。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Pattern Name
|
name | True | string |
パターン名 |
戻り値
パターン
- PipelineConfiguration
- PipelineConfiguration
レコード情報の取得
特定のレコード インスタンスを取得します。 返されたレコード オブジェクトは、ワークフローでダウンストリームを使用する前に追加の解析が必要になる場合があります。 https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/HEVS5cHZTtViD4_F6BLlM
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Record UUID
|
uuid | True | uuid |
レコード uuid |
戻り値
レコード
- Record
- Record
全データセットの一覧表示
テナントで使用可能なすべてのデータセットを一覧表示します。 https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/6VcSt63koHgyePk72r0pR
戻り値
データセット リスト
- PaginatedDatasetList
- PaginatedDatasetList
全ドキュメントの一覧表示
テナントで使用可能なすべてのドキュメントを一覧表示します。 https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/7DOwvq52yx9eVF2KFpkQH
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
件数
|
count | integer |
件数 |
|
next
|
next | string |
次へ |
|
前へ
|
previous | string |
前へ |
|
結果
|
results | array of Document |
全レコードを一覧表示
テナントで使用可能なすべてのレコードを一覧表示します。 たとえば、テナントが複数のパターンで構成されている場合、特定のパターンのすべてのレコードを返すことができます。 https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/AxGvA5pWxls9DWOMUE1qs
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Dataset UUID
|
dataset | uuid |
データセット uuid |
|
|
Processing Status
|
document_status | array |
処理状態 |
|
|
Pattern
|
pipeline | string |
パターン名 |
|
|
Removed Status
|
removed | boolean |
削除済みの状態 |
|
|
Reviewed Status
|
reviewed | boolean |
確認済みの状態 |
|
|
Schema
|
schema | string |
スキーマ |
戻り値
レコード リスト
- PaginatedRecordList
- PaginatedRecordList
実行情報の取得
特定の実行インスタンスを取得します。 https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/sugkRPXlX9jwR3dDbmrdX
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Execution UUID
|
uuid | True | uuid |
実行 uuid |
戻り値
実行
- Execution
- Execution
トリガー
| Alkymi イベントがトリガーされたとき |
このトリガーは、選択した Alkymi イベントのいずれかが発生したときに実行されます。 |
Alkymi イベントがトリガーされたとき
このトリガーは、選択した Alkymi イベントのいずれかが発生したときに実行されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
display_name
|
display_name | string |
表示名 |
|
|
Events
|
events | array of string |
webhook イベント |
戻り値
Webhook イベント
- WebhookEvent
- WebHookEvent
定義
Dataset
dataset
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
uuid
|
uuid | uuid | |
|
名称
|
name | string | |
|
pipeline
|
pipeline | string | |
|
ドキュメント
|
documents | string | |
|
レコード
|
records | string |
Document
ドキュメント
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
uuid
|
uuid | string |
uuid |
|
作成済み
|
created | string |
作成済み |
|
modified
|
modified | string |
更新済み |
|
status
|
status | string |
状態 |
|
archived
|
archived | boolean |
アーカイブ済み |
|
削除済み
|
removed | boolean |
削除済み |
|
file_name
|
file_name | string |
ファイル名 |
|
page_count
|
page_count | integer |
ページ数 |
|
pages
|
pages | array of object |
ページ |
|
数値
|
pages.number | integer |
数値 |
|
width
|
pages.width | integer |
幅 |
|
height
|
pages.height | integer |
高さ |
|
dataset
|
dataset | string |
データセット |
|
レコード
|
records | array of |
レコード |
|
pipeline_records
|
pipeline_records | object |
パイプライン レコード |
|
_s3_key
|
_s3_key | string |
s3 キー |
|
_replaced_by
|
_replaced_by | string |
置き換え |
|
subject
|
subject | string |
件名 |
|
sender
|
sender | string |
センダー |
|
folder
|
folder | string |
フォルダー |
|
watermark_removed
|
watermark_removed | boolean |
ウォーターマーク除去 |
Execution
実行
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
uuid
|
uuid | uuid | |
|
作成済み
|
created | date-time | |
|
レビュー済み
|
reviewed | boolean | |
|
archived
|
archived | boolean | |
|
status
|
status | string | |
|
レコード
|
records | array of string | |
|
pipeline_records
|
pipeline_records | object | |
|
file_name
|
file_name | string | |
|
ドキュメント
|
documents | array of string |
PaginatedDatasetList
データセット リスト
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
件数
|
count | integer | |
|
next
|
next | string | |
|
前へ
|
previous | string | |
|
結果
|
results | array of Dataset |
PaginatedExecutionList
実行リスト
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
件数
|
count | integer | |
|
next
|
next | string | |
|
前へ
|
previous | string | |
|
結果
|
results | array of Execution |
PaginatedPipelineConfigurationList
パイプライン構成リスト
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
件数
|
count | integer | |
|
next
|
next | string | |
|
前へ
|
previous | string | |
|
結果
|
results | array of PipelineConfiguration |
PaginatedRecordList
レコード リスト
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
件数
|
count | integer | |
|
next
|
next | string | |
|
前へ
|
previous | string | |
|
結果
|
results | array of Record |
PipelineConfiguration
パターン
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
名前
|
name | string | |
|
レコード
|
records | string | |
|
スキーマ
|
schemas | array of Schema |
Record
レコード
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
uuid
|
uuid | uuid | |
|
作成済み
|
created | date-time | |
|
modified
|
modified | date-time | |
|
document_uuid
|
document_uuid | string | |
|
document
|
document | string | |
|
dataset
|
dataset | string | |
|
pipeline
|
pipeline | string | |
|
schema_name
|
schema_name | string | |
|
status
|
status | string | |
|
データ
|
data | object |
Schema
スキーマ
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
名前
|
name | string | |
|
プライマリ
|
primary | boolean | |
|
フィールド
|
fields | array of SchemaField |
SchemaField
スキーマ フィールド
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
名前
|
name | string | |
|
field_type
|
field_type | string | |
|
sub_schema
|
sub_schema | string |
WebHookEvent
Webhook イベント
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
uuid
|
uuid | string |
uuid |
|
status
|
status | string |
状態 |
|
作成済み
|
created | string |
作成済 |
|
レコード
|
records | array of string |
レコード |
|
archived
|
archived | boolean |
アーカイブ済み |
|
レビュー済み
|
reviewed | boolean |
確認済み |
|
ドキュメント
|
documents | array of string |
ドキュメント |
|
file_name
|
file_name | string |
ファイル名 |
|
pipeline_records
|
pipeline_records | object |
パイプライン レコード |
|
trigger_event_list
|
trigger_event_list | array of string |
トリガー イベント リスト |
binary
これは基本的なデータ型 'バイナリ' です。