

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# 使用 API 配置飞轮
<a name="flywheels-config-api"></a>

您可以使用 Amazon Comprehend API 创建、更新和删除飞轮。

当您创建飞轮时，Amazon Comprehend 会创建一个数据湖来存储飞轮所需的所有数据，例如每个版本模型的训练数据和测试数据。

当您删除飞轮时，Amazon Comprehend 不会删除与该飞轮关联的数据湖或模型。

如果飞轮正在运行迭代或创建数据集，则飞轮删除操作将失败。

在创建新的飞轮之前，请查看 [飞轮创建](flywheels-about.md#flywheels-about-create) 部分中的信息。

## 为现有模型创建飞轮
<a name="flywheels-config-api-create-existing"></a>

使用[CreateFlywheel](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_CreateFlywheel.html)操作为现有模型创建飞轮。

**Example**  

```
aws comprehend create-flywheel  \
    --flywheel-name "myFlywheel2"  \
    --active-model-arn  "modelArn"  \
    --data-access-role-arn   arn:aws::iam::111122223333:role/testFlywheelDataAccess \
    --data-lake-s3-uri": "https://s3-bucket-endpoint"   \
```
如果操作成功，则响应将包含飞轮 ARN。  

```
{
  "FlywheelArn": "arn:aws::comprehend:aws-region:111122223333:flywheel/name",
  "ActiveModelArn": "modelArn"
}
```

## 为新模型创建飞轮
<a name="flywheels-config-api-create-new"></a>

使用[CreateFlywheel](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_CreateFlywheel.html)操作为新的自定义分类模型创建飞轮。

**Example**  

```
aws comprehend create-flywheel \
    --flywheel-name "myFlywheel2" \
    --data-access-role-arn  arn:aws::iam::111122223333:role/testFlywheelDataAccess \
    --model-type "DOCUMENT_CLASSIFIER" \
    --data-lake-s3-uri  "s3Uri"  \
    --task-config  file://taskConfig.json
```
taskConfig.json 文件包含以下内容。  

```
{
    "LanguageCode": "en",
    "DocumentClassificationConfig": {
        "Mode": "MULTI_LABEL",
        "Labels": ["optimism", "anger"]
    } 
}
```
API 响应正文包含以下内容。  

```
{
  "FlywheelArn": "arn:aws::comprehend:aws-region:111122223333:flywheel/name",
  "ActiveModelArn": "modelArn"
}
```

## 描述飞轮
<a name="flywheels-config-api-desc"></a>

使用 Amazon Compreh [DescribeFlywheel](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribeFlywheel.html)end 操作检索有关飞轮的配置信息。

```
aws comprehend describe-flywheel \
    --flywheel-arn  "flywheelArn"
```

API 响应正文包含以下内容。

```
{
  "FlywheelProperties": {
      "FlywheelArn": "arn:aws::comprehend:aws-region:111122223333:flywheel/myTestFlywheel",
      "DataAccessRoleArn": "arn:aws::iam::111122223333:role/Admin",
      "TaskConfig": {
          "LanguageCode": "en",
          "DocumentClassificationConfig": {
              "Mode": "MULTI_LABEL"
          }
      },
      "DataLakeS3Uri": "s3://my-test-datalake/flywheelbasictest/myTestFlywheel/schemaVersion=1/20220801T014326Z",
      "Status": "ACTIVE",
      "ModelType":  "DOCUMENT_CLASSIFIER",
      "CreationTime": 1659318206.102,
      "LastModifiedTime": 1659318249.05
  }
}
```

## 更新飞轮
<a name="flywheels-config-api-update"></a>

使用该[UpdateFlywheel](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_UpdateFlywheel.html)操作更新飞轮的可修改配置值。

某些配置字段是带有子字段的 JSON 结构。要更新一个或多个子字段，请为所有子字段提供值（对于请求中缺少的任何子字段，Amazon Comprehend 会将该值设置为空）。

如果您在 `UpdateFlywheel` 请求中省略了顶级参数，则 Amazon Comprehend 不会更改飞轮中该参数或其任何子字段的值。

要在飞轮上添加或删除标签，请使用[TagResource](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_TagResource.html)和[UntagResource](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_UntagResource.html)操作。

您还可以通过设置 `ActiveModelArn` 参数来升级模型版本，如以下示例中所示。

```
aws comprehend update-flywheel \
    --region aws-region \
    --flywheel-arn  "flywheelArn" \
    --active-model-arn  "modelArn" \
```

API 响应正文包含以下内容。

```
{
  "FlywheelArn": "arn:aws::comprehend:aws-region:111122223333:flywheel/name",
  "ActiveModelArn": "modelArn"
}
```

## 删除飞轮
<a name="flywheels-config-api-delete"></a>

使用 Amazon Compreh [DeleteFlywheel](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DeleteFlywheel.html)end 操作删除飞轮。

```
aws comprehend delete-flywheel \
    --flywheel-arn  "flywheelArn"
```

成功的 API 响应包含一个空的响应信息正文

## 列出飞轮
<a name="flywheels-config-api-list"></a>

使用 Amazon Com [ListFlywheels](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_ListFlywheels.html)prehend 操作检索当前区域的飞轮列表。

```
aws comprehend list-flywheel \
    --region aws-region \
    --endpoint-url  "uri"
```

API 响应正文包含以下内容。

```
{
    "FlywheelSummaryList": [
        {
            "FlywheelArn": "arn:aws::comprehend:aws-region:111122223333:flywheel/myTestFlywheel",
            "DataLakeS3Uri": "s3://my-test-datalake/flywheelbasictest/myTestFlywheel/schemaVersion=1/20220801T014326Z",
            "Status": "ACTIVE",
            ""ModelType":  "DOCUMENT_CLASSIFIER",
            "CreationTime": 1659318206.102,
            "LastModifiedTime": 1659318249.05
        }
    ]
}
```