このページでは、フォルダの概要と、フォルダを使用してドキュメントを管理する方法について説明します。
ポリシー エンジンとルール
Document Warehouse のポリシー エンジンを使用すると、ドキュメントの作成または更新時に、ドキュメントに対する一般的なオペレーション（検証や更新など）を定義して実行できます。
ルールとルールセット
ルールは、次の内容を指定するユーザー定義の構成を指します。
- ルールのチェックをトリガーする条件、
- どの条件が評価されるか、
- 条件が満たされたときに実行されるアクション。
これらの仕様に加えて、ルールには説明、ソース、ターゲット、トリガー条件の情報が含まれます。
ルールの論理的なコレクションは RuleSet と呼ばれます。RuleSetたとえば、同じスキーマで動作するルールを 1 つの RuleSet にグループ化できます。複数の RuleSet を定義できます。
ルールは、ドキュメントの作成または更新時に事前定義されたアクションを自動的にトリガーする場合に便利です。
ルールは主に次の 3 つで構成されます。
- TriggerType: ルールチェックを開始するイベント。サポートされているトリガータイプは、Create と Update です。
- ルール条件: 特定のトリガー タイプが検出された後に評価される条件。条件は Common Expression Language（CEL）を使用して表現できます。各条件はブール値の出力に評価される必要があります。
- アクション: ルールが満たされたときに実行される一連のステップ。ルール条件が true と評価されると、対応するアクション（ルールで構成されている）が実行されます。Document Warehouse で実装される特定のアクションの概要は次のとおりです。
- データ検証アクション: ドキュメントの作成または更新時にドキュメント内の特定のフィールドを検証できるようにするアクション。
- データ更新アクション: ドキュメントの作成または更新時に、ドキュメント内の特定のフィールドを更新できるアクション。このような更新は、ルールの条件が満たされたときに実行されます。
- ドキュメント削除アクション: 特定のフィールドがルール条件で定義された削除条件を満たした場合に、ドキュメントの更新中にドキュメントを削除できるアクション。
- フォルダの追加アクション: 特定のフォルダに新しいドキュメント（または更新されたドキュメント）を自動的に追加するアクション。このようなフォルダは、名前を使用して直接指定できます。
- フォルダから削除アクション: ルールレベルの条件が満たされたときに、指定されたフォルダから新しいドキュメントを自動的に削除するアクション。
- アクセス制御アクション: ドキュメントの作成時にアクセス制御リスト（グループとユーザー バインディング）の更新を許可するアクション。このような更新は、ルールの条件が満たされたときに実行されます。
- パブリッシュ アクション: ルールレベルの条件が満たされたときに、特定のメッセージをユーザーの Pub/Sub チャネルにパブリッシュするアクション。
ルールセットを管理する
Document Warehouse には、RuleSet を管理するための API（作成、取得、更新、削除、一覧表示）が用意されています。このセクションでは、ルールのさまざまなタイプを構成するサンプルを示します。
RuleSet を作成する
ルールセットを作成する手順は次のとおりです。
REST
リクエスト:
# Create a RuleSet for data validation.
curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
https://contentwarehouse.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION/ruleSets \
-d '{
"rules": [
{
"trigger_type": "ON_CREATE",
"condition": "documentType == \'W9\' && STATE ==\'CA\'",
"actions": {
"data_validation": {
"conditions": {
"NAME": "NAME != \'\'",
"FILING_COST": "FILING_COST > 10.0"
}
}
},
"enabled": true
}
],
"description": "W9: Basic validation check rules."
}'レスポンス
{
"description": "W9: Basic validation check rules.",
"name": "RULE_SET_NAME",
"rules": [
{
"actions": [
{
"actionId": "de0e6b84-106b-44ba-b1c4-0b3ad6ddc719",
"dataValidation": {
"conditions": {
"FILING_COST": "FILING_COST > 10.0",
"NAME": "NAME != ''"
}
}
}
],
"condition": "documentType == 'W9' && STATE =='CA'",
"enabled": true,
"triggerType": "ON_CREATE"
}
]
}
Python
詳細については、Document AI Warehouse Python API リファレンス ドキュメントをご覧ください。
Document AI Warehouse に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。
Java
詳細については、Document AI Warehouse Java API リファレンス ドキュメントをご覧ください。
Document AI Warehouse に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。