注册您的派对

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

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

准备工作

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

如需让模型能够创建风险评分预测，您必须先注册当事方。我们建议您在已具备以下条件时注册当事方：

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

何时登记派对

在为数据集中的方创建预测之前，您需要注册该方。训练、调优或回测不需要注册。

预测结果用于在生产或测试（并行）阶段调查客户是否涉嫌洗钱。您可能还需要围绕从预测中获得的结果构建自己的治理和模型分析流程。

注册方需为每位注册方支付额外的月度费用（如需了解详情，请参阅价格页面）。

如何准备政党注册表格

如需了解有关注册方的更多信息，请参阅价格页面。

为要注册当事方的业务线准备表格。如果您已注册一些当事人，则此当事人注册表可能包含您想要用于预测结果的当事人表中的部分当事人。

零售方架构

列	类型	说明
`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 方法。

（以下信息也可在创建和管理实例中找到。）

执行此任务所需的权限

如需执行此任务，您必须已获得以下权限：

权限

financialservices.v1instances.importRegisteredParties

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

PROJECT_ID：IAM 设置中列出的 Google Cloud 项目 ID
LOCATION：实例的位置；请使用其中一个受支持的区域
显示位置
- us-central1
- us-east1
- asia-south1
- europe-west1
- europe-west2
- europe-west4
- northamerica-northeast1
- southamerica-east1
- australia-southeast1
INSTANCE_ID：用户定义的实例标识符
BQ_INPUT_REGISTERED_PARTIES_DATASET_NAME：包含描述已注册方的表的 BigQuery 数据集
PARTY_REGISTRATION_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.PARTY_REGISTRATION_TABLE"
  ],
  "mode": "UPDATE_MODE",
  "lineOfBusiness": "LINE_OF_BUSINESS"
}

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

curl

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

将请求正文保存在名为 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

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

将请求正文保存在名为 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.importRegisteredParties 方法并替换现有参与方列表，即可针对每个 AML AI 实例取消注册参与方。将 mode 字段设置为 REPLACE。此设置会取消注册任何已注册但未包含在所提供的当事方注册表中的当事方（针对所提供的业务线）。

取消注册响应

操作完成后，检查 API 响应，以查看操作是否实现了预期结果，即添加或移除的参与方数量以及注册的参与方总数。

API 响应还会返回因限制而无法移除的当事人数量；例如，在达到最少天数之前，无法注销客户。

导出已注册的当事方

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

（以下信息也可在创建和管理实例中找到。）

执行此任务所需的权限

如需执行此任务，您必须已获得以下权限：

权限

financialservices.v1instances.exportRegisteredParties

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

PROJECT_ID：IAM 设置中列出的 Google Cloud 项目 ID
LOCATION：实例的位置；请使用其中一个受支持的区域
显示位置
- us-central1
- us-east1
- asia-south1
- europe-west1
- europe-west2
- europe-west4
- northamerica-northeast1
- southamerica-east1
- australia-southeast1
INSTANCE_ID：用户定义的实例标识符
BQ_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`	实例数据集中的当事方的唯一标识符
`party_size`	`STRING`	指定商业客户的层级（大型与小型）。此字段不适用于零售客户。面向所有零售客户：`NULL` `SMALL`，适用于平均每月交易次数少于 500 次的小型商业方 `LARGE` 适用于平均每月交易次数不低于 500 次的大型商业方所有值都区分大小写。
`earliest_remove_time`	`STRING`	可以移除当事方的最早时间
`party_with_prediction_intent`	`STRING`	指示自注册以来是否已预测过某个当事人的指示器
`registration_or_uptier_time`	`STRING`	当事方注册或升级的时间

注册您的派对 使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

准备工作

何时登记派对

如何准备政党注册表格

零售方架构

商业方架构

如何注册政党

执行此任务所需的权限

curl

PowerShell

注册响应

如何取消登记当事人

取消注册响应

导出已注册的当事方

执行此任务所需的权限

curl

PowerShell

注册您的派对