本頁面會簡要介紹資料夾,並說明如何使用資料夾管理文件。
政策引擎和規則
在 Document Warehouse 中,使用者可透過政策引擎在建立或更新文件時,定義及執行文件上的常見作業 (例如驗證或更新)。
規則和規則集
從高階層面來看,規則是指使用者定義的設定,可指定下列項目:
- 觸發規則檢查的條件
- 評估的條件,以及
- 符合條件時執行的動作。
除了這些規格,規則還包含說明、來源、目標和觸發條件的資訊。
規則的邏輯集合稱為「RuleSet」RuleSet。舉例來說,對相同結構定義執行的規則可以分組到單一規則集中。顧客可以定義多個規則集。
規則有助於在建立或更新文件時,自動觸發預先定義的動作。
規則包含三項主要內容:
- TriggerType:應啟動規則檢查的事件。支援的觸發條件類型為「建立」和「更新」。
- 規則條件:系統偵測到特定觸發條件類型後,會評估的條件。條件可以使用一般運算語言 (CEL) 表示。每個條件的評估結果都應為布林值。
- 動作:滿足規則時執行的一組步驟。如果規則條件的評估結果為 true,系統就會執行規則中設定的相應動作。以下是 Document Warehouse 中實作特定動作的概略詳細資料:
- 資料驗證動作:在建立或更新文件時,驗證文件中的特定欄位。
- 資料更新動作:這項動作可在建立或更新文件時,更新文件中的特定欄位。當規則條件符合時,系統就會執行這類更新。
- 刪除文件動作:如果特定欄位符合使用規則條件定義的刪除條件,即可在更新文件時刪除文件。
- 資料夾納入動作:自動將特定資料夾中的新文件 (或更新後的文件) 加入動作。這類資料夾可直接使用名稱指定。
- 從資料夾中移除動作:當滿足規則層級條件時,系統會自動從指定資料夾中移除新文件。
- 存取控管動作:允許在建立文件期間更新存取控管清單 (群組和使用者繫結) 的動作。當規則條件符合時,系統就會執行這類更新。
- 發布動作:當滿足規則層級條件時,將特定訊息發布至使用者 Pub/Sub 通道的動作。
管理規則集
Document Warehouse 提供 API 來管理規則集 (建立、取得、更新、刪除、列出)。本節提供範例,說明如何為規則設定不同類型。
建立規則集
如要建立規則集,請按照下列步驟操作:
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 進行驗證,請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。
列出規則集
如要列出專案下的規則集,請按照下列步驟操作:
REST
要求:
# List all rule-sets for a project.
curl -X GET -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回應
{
"ruleSets": [
{
"description": "W9: Basic validation check rules.",
"rules": [
{
"triggerType": "ON_CREATE",
"condition": "documentType == 'W9' && STATE =='CA'",
"actions": [
{
"actionId": "fcf79ae8-9a1f-4462-9262-eb2e7161350c",
"dataValidation": {
"conditions": {
"NAME": "NAME != ''",
"FILING_COST": "FILING_COST > 10.0"
}
}
}
],
"enabled": true
}
],
"name": "RULE_SET_NAME"
}
]
}取得規則集
如要使用規則集名稱取得規則集,請按照下列步驟操作:
REST
要求: