此页面由 Cloud Translation API 翻译。

注册您的客户

本页面将引导您完成以下步骤来注册和取消注册各方，以创建预测结果：

确保您已做好注册派对的准备
准备政党注册表
使用 projects.locations.instances.importRegisteredParties 方法注册或取消注册各方
验证方法响应
（可选）导出已注册方的表格

准备工作

在开始之前，您需要一个 AML AI 实例。

如需使模型能够创建风险得分预测，您必须先注册各方。我们建议您在拥有以下各项时注册各方：

一个或多个数据集
经过调优、训练和回测的模型

何时注册各方

您需要先注册该方，然后才能在某个数据集中为某一方创建预测。训练、调整或回测无需注册。

预测结果用于调查生产阶段或测试/并行阶段的客户是否进行洗钱。

注册方每月会产生每个注册方的额外费用（如需了解详情，请参阅价格页面）。

如何准备政党登记表

如需了解注册方的相关信息，请参阅“价格”页面。

针对您要注册各方的业务线准备一个表。此派对注册表格可以是 Party 表格的子集。

零售派对架构

列	类型	说明
`party_id`	`STRING`	实例的数据集中相关方的唯一标识符
`party_size`	`STRING`	NULL；对于零售方注册，系统会忽略内容

商业方架构

列类型说明

party_id STRING 实例的数据集中相关方的唯一标识符

party_size

STRING

请求的人数。该层级基于该方在过去 365 天内的平均每月交易次数：

SMALL，适用于每月平均交易量低于 500 的小型商业机构
LARGE（适用于平均每月交易次数大于或等于 500 的大型商业方）

所有值均区分大小写。

如何登记参与方

各方需要为每个 AML AI 实例单独注册。注意事项：

零售方和商业方必须分别注册。请使用单独的 API 调用和单独的方注册表。如果任一方同时存在于这两个列表中，它们会被视为单独的注册。
预测要求所有相关方都必须在与所用引擎版本相关联的业务线中注册。如果使用的数据集包含未向同一业务线注册的任何一方，则无法创建预测结果。
提供的方注册表用于附加到实例中的现有注册方列表，或替换实例中提供的业务线的所有注册方。
注册后，某方在一段时间内无法取消注册（请参阅“价格”页面）。因此，您可以将 validateOnly 字段设置为 TRUE。通过此字段，您可以查看该方法的实际效果和响应，而无需更改注册方。验证后，您可以重新运行操作并将 validateOnly 参数设置为 FALSE。
请务必检查注册请求的响应，以确保所有相关方已成功注册，即使之前的 validateOnly 请求成功也是如此。
对于商业方注册，当方注册表中 party_size 字段中的 SMALL 或 LARGE 以外的值会触发错误 (Invalid party_size present in table)。注册方不会更新。
对于零售方注册，系统会忽略 party_size 字段，并注册所提供的方注册表中的所有方。

如需导入已注册的各方，请使用 projects.locations.instances.importRegisteredParties 方法。

（如需了解以下信息，请参阅创建和管理实例。）

在使用任何请求数据之前，请先进行以下替换：

PROJECT_ID：IAM 设置中列出的 Google Cloud 项目 ID
LOCATION：实例的位置；请使用支持的区域之一：
- us-central1
- us-east1
- asia-south1
- europe-west1
- europe-west2
- europe-west4
- northamerica-northeast1
- southamerica-east1
INSTANCE_ID：用户定义的实例标识符
BQ_INPUT_REGISTERED_PARTIES_DATASET_NAME：一个 BigQuery 数据集，其中包含一个描述已注册方的表
REGISTERED_PARTIES_TABLE：列出已注册方的表格
注意：您可以提供多个列出已注册方的表格。对于 partyTables 数组中的每个表，请使用 "bq://{project}.{bqDatasetID}.{bqTableID}" 格式。
UPDATE_MODE：使用 REPLACE 将“已注册方”表中可移除的方替换为新方，或使用 APPEND 将新方添加到“已注册方”表
LINE_OF_BUSINESS：此字段必须与引擎配置所用引擎版本中的 lineOfBusiness 值一致；对于商业银行客户（法律实体和自然实体），请使用 COMMERCIAL；对于零售银行客户，请使用 RETAIL

请求 JSON 正文：

{
  "partyTables": [
     "bq://PROJECT_ID.BQ_INPUT_REGISTERED_PARTIES_DATASET_NAME.REGISTERED_PARTIES_TABLE"
  ],
  "mode": "UPDATE_MODE",
  "lineOfBusiness": "LINE_OF_BUSINESS"
}

如需发送请求，请选择以下方式之一：

curl

注意：以下命令假定您已通过运行 gcloud init 或 gcloud auth login，或使用 Cloud Shell（自动登录到 gcloud CLI）使用您的用户帐号登录了 gcloud CLI。您可以运行 gcloud auth list 来查看当前的活跃帐号。

将请求正文保存在名为 request.json 的文件中。在终端中运行以下命令，在当前目录中创建或覆盖此文件：

cat > request.json << 'EOF'
{
  "partyTables": [
     "bq://PROJECT_ID.BQ_INPUT_REGISTERED_PARTIES_DATASET_NAME.REGISTERED_PARTIES_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

注意：以下命令假定您已通过运行 gcloud init 或 gcloud auth login 使用您的用户帐号登录 gcloud CLI。您可以运行 gcloud auth list 来查看当前的活跃帐号。

将请求正文保存在名为 request.json 的文件中。在终端中运行以下命令，在当前目录中创建或覆盖此文件：

@'
{
  "partyTables": [
     "bq://PROJECT_ID.BQ_INPUT_REGISTERED_PARTIES_DATASET_NAME.REGISTERED_PARTIES_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": CREATE_TIME,
    "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`	此操作未能移除的参与方数量

如何取消注册派对

每个 AML AI 实例使用相同的 projects.locations.instances.importRegisteredParties 方法并替换现有的各方列表，取消注册各方。将 mode 字段设置为 REPLACE。此设置会取消注册不属于所提供的一方注册表的所有当前注册方（针对所提供的业务领域）。

取消注册响应

操作完成后，请检查 API 响应，以根据添加或移除的一方数量和注册方总数检查操作是否带来了预期结果。

API 响应还会返回因限制条件（例如，某一方需要至少提前多少天才能取消注册）而无法移除的参与方的数量。

导出已注册的各方

如需导出已注册的各方，请使用 projects.locations.instances.exportRegisteredParties 方法。

（如需了解以下信息，请参阅创建和管理实例。）

在使用任何请求数据之前，请先进行以下替换：

PROJECT_ID：IAM 设置中列出的 Google Cloud 项目 ID
LOCATION：实例的位置；请使用支持的区域之一：
- us-central1
- us-east1
- asia-south1
- europe-west1
- europe-west2
- europe-west4
- northamerica-northeast1
- southamerica-east1
INSTANCE_ID：用户定义的实例标识符
BQ_OUTPUT_DATASET_NAME：BigQuery 数据集，用于导出描述已注册方的表
REGISTERED_PARTIES_TABLE：用于向其中写入注册方的表
WRITE_DISPOSITION：在目标表已存在时发生的操作；请使用以下某个值：
- WRITE_EMPTY：仅在 BigQuery 表为空时导出数据。
- WRITE_TRUNCATE：先清空 BigQuery 表中的所有现有数据，然后再写入表。
LINE_OF_BUSINESS：对于商业银行客户（法律和自然实体），请使用 COMMERCIAL；对于零售银行客户，请使用 RETAIL

请求 JSON 正文：

{
  "dataset": {
    "tableUri": "bq://PROJECT_ID.BQ_OUTPUT_DATASET_NAME.REGISTERED_PARTIES_TABLE",
    "writeDisposition": "WRITE_DISPOSITION"
  },
  "lineOfBusiness": "LINE_OF_BUSINESS"
}

如需发送请求，请选择以下方式之一：

curl

将请求正文保存在名为 request.json 的文件中。在终端中运行以下命令，在当前目录中创建或覆盖此文件：

cat > request.json << 'EOF'
{
  "dataset": {
    "tableUri": "bq://PROJECT_ID.BQ_OUTPUT_DATASET_NAME.REGISTERED_PARTIES_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

注意：以下命令假定您已通过运行 gcloud init 或 gcloud auth login 使用您的用户帐号登录 gcloud CLI。您可以运行 gcloud auth list 来查看当前的活跃帐号。

将请求正文保存在名为 request.json 的文件中。在终端中运行以下命令，在当前目录中创建或覆盖此文件：

@'
{
  "dataset": {
    "tableUri": "bq://PROJECT_ID.BQ_OUTPUT_DATASET_NAME.REGISTERED_PARTIES_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": CREATE_TIME,
    "target": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID",
    "verb": "exportRegisteredParties",
    "requestedCancellation": false,
    "apiVersion": "v1"
  },
  "done": false
}

如需了解如何获取长时间运行的操作 (LRO) 的结果，请参阅管理长时间运行的操作。

此方法会输出具有以下架构的 BigQuery 表：

列	类型	说明
`party_id`	`STRING`	实例的数据集中相关方的唯一标识符
`party_size`	`STRING`	为商业客户指定层级（大与小）。此字段不适用于零售客户。所有零售客户均可享受 `NULL` `SMALL`，适用于每月平均交易量低于 500 的小型商业机构 `LARGE`（适用于平均每月交易次数大于或等于 500 的大型商业方）所有值均区分大小写。
`earliest_remove_time`	`STRING`	该方可以删除的最早时间
`party_with_prediction_intent`	`STRING`	指示自注册之日起是否预测了任何一方的指标
`registration_or_uptier_time`	`STRING`	派对注册或升级的时间