本頁面說明如何建立及管理 AML AI 執行個體,可做為快速參考指南。
事前準備
-
如要取得建立及管理執行個體所需的權限,請要求管理員為您授予專案的 Financial Services 管理員 (
financialservices.admin
) 身分與存取權管理角色。如要進一步瞭解如何授予角色,請參閱「管理專案、資料夾和機構的存取權」。 - 建立加密金鑰並授予金鑰存取權
建立執行個體
部分 API 方法會傳回長時間執行的作業 (LRO)。這些方法是以非同步方式執行,並會傳回 Operation 物件。詳情請參閱「REST 參考資料」。方法傳回回應時,作業可能尚未完成。對於這些方法,請先傳送要求,然後檢查結果。一般來說,所有 POST、PUT、UPDATE 和 DELETE 作業都是長時間執行的作業。
傳送要求
如要建立執行個體,請使用 projects.locations.instances.create
方法。
使用任何要求資料之前,請先替換以下項目:
PROJECT_ID
: Google Cloud 「身分與存取權管理設定」中列出的專案 IDLOCATION
:金鑰環和執行個體的位置;請使用其中一個支援的區域顯示地區us-central1
us-east1
asia-south1
europe-west1
europe-west2
europe-west4
northamerica-northeast1
southamerica-east1
australia-southeast1
INSTANCE_ID
:使用者定義的執行個體 IDKMS_PROJECT_ID
:包含金鑰環的專案 ID Google CloudKEY_RING_ID
:使用者定義的金鑰環 IDKEY_ID
:金鑰的使用者定義 ID
JSON 要求主體:
{ "kmsKey": "projects/KMS_PROJECT_ID/locations/LOCATION/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID" }
如要傳送要求,請選擇以下其中一個選項:
curl
將要求主體儲存在名為 request.json
的檔案中。
在終端機中執行下列指令,在目前目錄中建立或覆寫這個檔案:
cat > request.json << 'EOF' { "kmsKey": "projects/KMS_PROJECT_ID/locations/LOCATION/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID" } EOF
接著,請執行下列指令來傳送 REST 要求:
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
"https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/instances?instance_id=INSTANCE_ID"
PowerShell
將要求主體儲存在名為 request.json
的檔案中。
在終端機中執行下列指令,在目前目錄中建立或覆寫這個檔案:
@' { "kmsKey": "projects/KMS_PROJECT_ID/locations/LOCATION/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID" } '@ | Out-File -FilePath request.json -Encoding utf8
接著,請執行下列指令來傳送 REST 要求:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method POST `
-Headers $headers `
-ContentType: "application/json; charset=utf-8" `
-InFile request.json `
-Uri "https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/instances?instance_id=INSTANCE_ID" | Select-Object -Expand Content
您應該會收到如下的 JSON 回應:
{ "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID", "metadata": { "@type": "type.googleapis.com/google.cloud.financialservices.v1.OperationMetadata", "createTime": "2023-03-14T15:52:55.358979323Z", "target": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID", "verb": "create", "requestedCancellation": false, "apiVersion": "v1" }, "done": false }
查看結果
使用 projects.locations.operations.get
方法檢查執行個體是否已建立。如果回應包含 "done": false
,請重複執行指令,直到回應包含 "done": true
為止。這項作業可能需要幾分鐘才能完成。
使用任何要求資料之前,請先替換以下項目:
PROJECT_ID
: Google Cloud 「身分與存取權管理設定」中列出的專案 IDLOCATION
:執行個體的位置;請使用其中一個 支援的區域顯示地區us-central1
us-east1
asia-south1
europe-west1
europe-west2
europe-west4
northamerica-northeast1
southamerica-east1
australia-southeast1
OPERATION_ID
:作業的 ID
如要傳送要求,請選擇以下其中一個選項:
curl
執行下列指令:
curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID"
PowerShell
執行下列指令:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method GET `
-Headers $headers `
-Uri "https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID" | Select-Object -Expand Content
您應該會收到如下的 JSON 回應:
{ "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID", "metadata": { "@type": "type.googleapis.com/google.cloud.financialservices.v1.OperationMetadata", "createTime": "2023-03-14T15:52:55.358979323Z", "endTime": "2023-03-14T16:52:55.358979323Z", "target": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID", "verb": "create", "requestedCancellation": false, "apiVersion": "v1" }, "done": true, "response": { "@type": "type.googleapis.com/google.cloud.financialservices.v1.Instance", "name": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID", "createTime": CREATE_TIME, "updateTime": UPDATE_TIME, "state": "ACTIVE", "kmsKey": "projects/KMS_PROJECT_ID/locations/LOCATION/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID" } }
取得執行個體
如要取得執行個體,請使用 projects.locations.instances.get
方法。
使用任何要求資料之前,請先替換以下項目:
PROJECT_ID
: Google Cloud 「身分與存取權管理設定」中列出的專案 IDLOCATION
:執行個體的位置;請使用其中一個 支援的區域顯示地區us-central1
us-east1
asia-south1
europe-west1
europe-west2
europe-west4
northamerica-northeast1
southamerica-east1
australia-southeast1
INSTANCE_ID
:使用者定義的執行個體 ID
如要傳送要求,請選擇以下其中一個選項:
curl
執行下列指令:
curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID"
PowerShell
執行下列指令:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method GET `
-Headers $headers `
-Uri "https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID" | Select-Object -Expand Content
您應該會收到如下的 JSON 回應:
{ "name": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID", "createTime": "2023-03-14T15:52:55.358979323Z", "updateTime": "2023-03-15T15:52:55.358979323Z", "kmsKey": "projects/KMS_PROJECT_ID/locations/LOCATION/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID", "state": "ACTIVE" }
更新執行個體
如要更新執行個體,請使用 projects.locations.instances.patch
方法。
並非執行個體中的所有欄位都能更新。以下範例會更新與執行個體相關聯的使用者標籤鍵/值組合。
使用任何要求資料之前,請先替換以下項目:
PROJECT_ID
: Google Cloud 「身分與存取權管理設定」中列出的專案 IDLOCATION
:執行個體的位置;請使用其中一個 支援的區域顯示地區us-central1
us-east1
asia-south1
europe-west1
europe-west2
europe-west4
northamerica-northeast1
southamerica-east1
australia-southeast1
INSTANCE_ID
:使用者定義的執行個體 IDKEY
:鍵/值組合中的鍵,用於整理執行個體。詳情請參閱labels
。VALUE
:鍵/值組合中的值,用於整理執行個體。詳情請參閱labels
。
JSON 要求主體:
{ "labels": { "KEY": "VALUE" } }
如要傳送要求,請選擇以下其中一個選項:
curl
將要求主體儲存在名為 request.json
的檔案中。
在終端機中執行下列指令,在目前目錄中建立或覆寫這個檔案:
cat > request.json << 'EOF' { "labels": { "KEY": "VALUE" } } EOF
接著,請執行下列指令來傳送 REST 要求:
curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
"https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID?updateMask=labels"
PowerShell
將要求主體儲存在名為 request.json
的檔案中。
在終端機中執行下列指令,在目前目錄中建立或覆寫這個檔案:
@' { "labels": { "KEY": "VALUE" } } '@ | Out-File -FilePath request.json -Encoding utf8
接著,請執行下列指令來傳送 REST 要求:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method PATCH `
-Headers $headers `
-ContentType: "application/json; charset=utf-8" `
-InFile request.json `
-Uri "https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID?updateMask=labels" | Select-Object -Expand Content
您應該會收到如下的 JSON 回應:
{ "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID", "metadata": { "@type": "type.googleapis.com/google.cloud.financialservices.v1.OperationMetadata", "createTime": "2023-03-14T15:52:55.358979323Z", "target": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID", "verb": "update", "requestedCancellation": false, "apiVersion": "v1" }, "done": false }
如要進一步瞭解如何取得長時間執行的作業 (LRO) 結果,請參閱「檢查結果」。
列出執行個體
如要列出特定執行個體的執行個體,請使用 projects.locations.instances.list
方法。
使用任何要求資料之前,請先替換以下項目:
PROJECT_ID
: Google Cloud 「身分與存取權管理設定」中列出的專案 IDLOCATION
:執行個體的位置;請使用其中一個支援的區域顯示地區us-central1
us-east1
asia-south1
europe-west1
europe-west2
europe-west4
northamerica-northeast1
southamerica-east1
australia-southeast1
如要傳送要求,請選擇以下其中一個選項:
curl
執行下列指令:
curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/instances"
PowerShell
執行下列指令:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method GET `
-Headers $headers `
-Uri "https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/instances" | Select-Object -Expand Content
您應該會收到如下的 JSON 回應:
{ "instances": [ { "name": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID", "createTime": "2023-03-14T15:52:55.358979323Z", "updateTime": "2023-03-15T15:52:55.358979323Z", "kmsKey": "projects/KMS_PROJECT_ID/locations/LOCATION/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID", "state": "ACTIVE" } ] }
匯入已註冊的當事人
如要匯入已註冊的當事人,請先為要註冊當事人的業務線準備 BigQuery 資料表。詳情請參閱「註冊客戶」。請使用下列其中一個結構定義:
零售當事人結構定義
欄 類型 說明 party_id
STRING
執行個體資料集中的當事人專屬 ID party_size
STRING
NULL;系統會忽略零售派對註冊的內容 商業當事人結構定義
欄 類型 說明 party_id
STRING
執行個體資料集中的當事人專屬 ID party_size
STRING
要求的預約人數。等級是根據當事人在前 365 天內的平均每月交易次數而定: SMALL
適用於每月平均交易次數少於 500 次的小型商業機構LARGE
適用於每月平均交易次數大於或等於 500 次的大型商業機構
所有值都區分大小寫。
如要匯入已註冊的當事人,請使用 projects.locations.instances.importRegisteredParties
方法。
使用任何要求資料之前,請先替換以下項目:
PROJECT_ID
: Google Cloud 「身分與存取權管理設定」中列出的專案 IDLOCATION
:執行個體的位置;請使用其中一個 支援的區域顯示地區us-central1
us-east1
asia-south1
europe-west1
europe-west2
europe-west4
northamerica-northeast1
southamerica-east1
australia-southeast1
INSTANCE_ID
:使用者定義的執行個體 IDBQ_INPUT_REGISTERED_PARTIES_DATASET_NAME
:BigQuery 資料集,內含描述已註冊當事人的資料表PARTY_REGISTRATION_TABLE
:列出已註冊當事人的表格UPDATE_MODE
:使用REPLACE
將可移除的當事人取代為新當事人,或使用APPEND
將新當事人新增至已登記當事人資料表- :這個欄位必須與引擎版本中
lineOfBusiness
的值相符,引擎設定會使用該版本;商業銀行客戶 (法人和自然人) 請使用COMMERCIAL
,零售銀行客戶請使用RETAIL
LINE_OF_BUSINESS
JSON 要求主體:
{ "partyTables": [ "bq://PROJECT_ID.BQ_INPUT_REGISTERED_PARTIES_DATASET_NAME.PARTY_REGISTRATION_TABLE" ], "mode": "UPDATE_MODE", "lineOfBusiness": "LINE_OF_BUSINESS" }
如要傳送要求,請選擇以下其中一個選項:
curl
將要求主體儲存在名為 request.json
的檔案中。
在終端機中執行下列指令,在目前目錄中建立或覆寫這個檔案:
cat > request.json << 'EOF' { "partyTables": [ "bq://PROJECT_ID.BQ_INPUT_REGISTERED_PARTIES_DATASET_NAME.PARTY_REGISTRATION_TABLE" ], "mode": "UPDATE_MODE", "lineOfBusiness": "LINE_OF_BUSINESS" } EOF
接著,請執行下列指令來傳送 REST 要求:
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
"https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID:importRegisteredParties"
PowerShell
將要求主體儲存在名為 request.json
的檔案中。
在終端機中執行下列指令,在目前目錄中建立或覆寫這個檔案:
@' { "partyTables": [ "bq://PROJECT_ID.BQ_INPUT_REGISTERED_PARTIES_DATASET_NAME.PARTY_REGISTRATION_TABLE" ], "mode": "UPDATE_MODE", "lineOfBusiness": "LINE_OF_BUSINESS" } '@ | Out-File -FilePath request.json -Encoding utf8
接著,請執行下列指令來傳送 REST 要求:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method POST `
-Headers $headers `
-ContentType: "application/json; charset=utf-8" `
-InFile request.json `
-Uri "https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID:importRegisteredParties" | Select-Object -Expand Content
您應該會收到如下的 JSON 回應:
{ "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID", "metadata": { "@type": "type.googleapis.com/google.cloud.financialservices.v1.OperationMetadata", "createTime": "2023-03-14T15:52:55.358979323Z", "target": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID", "verb": "importRegisteredParties", "requestedCancellation": false, "apiVersion": "v1" }, "done": false }
如要進一步瞭解如何取得長時間執行的作業 (LRO) 結果,請參閱「檢查結果」。
LRO 完成後,回應會指出作業新增、移除或更新的當事人數量。
回覆欄位 | 類型 | 說明 |
---|---|---|
partiesAdded | integer |
這項作業新增的參與者人數 |
partiesRemoved | integer |
這項作業移除的當事人人數 |
partiesTotal | integer |
更新作業完成後,在此執行個體中註冊的當事人總數 |
partiesUptiered | integer |
從小型升級為大型的商業當事人總數 |
partiesDowntiered | integer |
從大型降級為小型商業派對的總數 |
partiesFailedToDowntier | integer |
從大型降級至小型失敗的商業機構總數 |
partiesFailedToRemove | integer |
這項作業無法移除的當事人數量 |
匯出已註冊的當事人
如要匯出已註冊的當事人,請使用 projects.locations.instances.exportRegisteredParties
方法。
使用任何要求資料之前,請先替換以下項目:
PROJECT_ID
: Google Cloud 「身分與存取權管理設定」中列出的專案 IDLOCATION
:執行個體的位置;請使用其中一個 支援的區域顯示地區us-central1
us-east1
asia-south1
europe-west1
europe-west2
europe-west4
northamerica-northeast1
southamerica-east1
australia-southeast1
INSTANCE_ID
:使用者定義的執行個體 IDBQ_OUTPUT_DATASET_NAME
:要匯出資料表的 BigQuery 資料集,該資料表會說明已註冊的當事人PARTY_REGISTRATION_TABLE
:要將已註冊的當事人寫入的資料表WRITE_DISPOSITION
:如果目標資料表已存在,則會執行的動作;請使用下列其中一個值:-
WRITE_EMPTY
:只有在 BigQuery 資料表為空時,才能匯出資料。 -
WRITE_TRUNCATE
:先清除 BigQuery 資料表中的所有現有資料,再寫入資料表。
-
LINE_OF_BUSINESS
:商業銀行客戶 (法人和自然人) 請使用COMMERCIAL
,零售銀行客戶請使用RETAIL
JSON 要求主體:
{ "dataset": { "tableUri": "bq://PROJECT_ID.BQ_OUTPUT_DATASET_NAME.PARTY_REGISTRATION_TABLE", "writeDisposition": "WRITE_DISPOSITION" }, "lineOfBusiness": "LINE_OF_BUSINESS" }
如要傳送要求,請選擇以下其中一個選項:
curl
將要求主體儲存在名為 request.json
的檔案中。
在終端機中執行下列指令,在目前目錄中建立或覆寫這個檔案:
cat > request.json << 'EOF' { "dataset": { "tableUri": "bq://PROJECT_ID.BQ_OUTPUT_DATASET_NAME.PARTY_REGISTRATION_TABLE", "writeDisposition": "WRITE_DISPOSITION" }, "lineOfBusiness": "LINE_OF_BUSINESS" } EOF
接著,請執行下列指令來傳送 REST 要求:
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
"https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID:exportRegisteredParties"
PowerShell
將要求主體儲存在名為 request.json
的檔案中。
在終端機中執行下列指令,在目前目錄中建立或覆寫這個檔案:
@' { "dataset": { "tableUri": "bq://PROJECT_ID.BQ_OUTPUT_DATASET_NAME.PARTY_REGISTRATION_TABLE", "writeDisposition": "WRITE_DISPOSITION" }, "lineOfBusiness": "LINE_OF_BUSINESS" } '@ | Out-File -FilePath request.json -Encoding utf8
接著,請執行下列指令來傳送 REST 要求:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method POST `
-Headers $headers `
-ContentType: "application/json; charset=utf-8" `
-InFile request.json `
-Uri "https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID:exportRegisteredParties" | Select-Object -Expand Content
您應該會收到如下的 JSON 回應:
{ "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID", "metadata": { "@type": "type.googleapis.com/google.cloud.financialservices.v1.OperationMetadata", "createTime": "2023-03-14T15:52:55.358979323Z", "target": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID", "verb": "exportRegisteredParties", "requestedCancellation": false, "apiVersion": "v1" }, "done": false }
如要進一步瞭解如何取得長時間執行的作業 (LRO) 結果,請參閱「檢查結果」。
這個方法會輸出具有下列結構定義的 BigQuery 資料表:
欄 | 類型 | 說明 |
---|---|---|
party_id | STRING | 執行個體資料集中的當事人專屬 ID |
party_size | STRING |
指定商業客戶的層級 (大型與小型)。這個欄位不適用於零售客戶。
所有值都區分大小寫。 |
earliest_remove_time | STRING | 最早可移除派對的時間 |
party_with_prediction_intent | STRING | 指標:建議是否已預測自註冊以來某一方的結果 |
registration_or_uptier_time | STRING | 合作夥伴的註冊或升級時間 |
詳情請參閱「註冊客戶」。
刪除執行個體
如要刪除執行個體,請使用 projects.locations.instances.delete
方法。
使用任何要求資料之前,請先替換以下項目:
PROJECT_ID
: Google Cloud 「身分與存取權管理設定」中列出的專案 IDLOCATION
:執行個體的位置;請使用其中一個 支援的區域顯示地區us-central1
us-east1
asia-south1
europe-west1
europe-west2
europe-west4
northamerica-northeast1
southamerica-east1
australia-southeast1
INSTANCE_ID
:使用者定義的執行個體 ID
如要傳送要求,請選擇以下其中一個選項:
curl
執行下列指令:
curl -X DELETE \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID"
PowerShell
執行下列指令:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method DELETE `
-Headers $headers `
-Uri "https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID" | Select-Object -Expand Content
您應該會收到如下的 JSON 回應:
{ "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID", "metadata": { "@type": "type.googleapis.com/google.cloud.financialservices.v1.OperationMetadata", "createTime": "2023-03-14T15:52:55.358979323Z", "target": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID", "verb": "delete", "requestedCancellation": false, "apiVersion": "v1" }, "done": false }
如要進一步瞭解如何取得長時間執行的作業 (LRO) 結果,請參閱「檢查結果」。