本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
# 使用 API 設定飛輪
您可以使用 Amazon Comprehend API 來建立、更新和刪除飛輪。
當您建立飛輪時，Amazon Comprehend 會建立資料湖來存放飛輪所需的所有資料，例如每個模型版本的訓練資料和測試資料。
當您刪除飛輪時，Amazon Comprehend 不會刪除與飛輪相關聯的資料湖或模型。
如果飛輪正在執行反覆運算或建立資料集，飛輪刪除操作會失敗。
在建立新的飛輪[飛輪建立](flywheels-about.md#flywheels-about-create)之前，請檢閱 區段中的資訊。
## 為現有模型建立飛輪
使用 [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"
}
```
## 為新模型建立飛輪
使用 [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"
}
```
## 描述飛輪
使用 Amazon Comprehend [DescribeFlywheel](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribeFlywheel.html) 操作來擷取有關飛輪的設定資訊。
```
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
}
}
```
## 更新飛輪
使用 [UpdateFlywheel](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_UpdateFlywheel.html) 操作更新飛輪的可修改組態值。
有些組態欄位是具有子欄位的 JSON 結構。若要更新一或多個子欄位，請提供所有子欄位的值 (Amazon Comprehend 會將請求中遺失的任何子欄位的值設定為 null)。
如果您在`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"
}
```
## 刪除飛輪
使用 Amazon Comprehend [DeleteFlywheel](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DeleteFlywheel.html) 操作來刪除飛輪。
```
aws comprehend delete-flywheel \
--flywheel-arn "flywheelArn"
```
成功的 API 回應包含空的回應訊息內文
## 列出飛輪
使用 Amazon Comprehend [ListFlywheels](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_ListFlywheels.html) 操作擷取目前區域中的飛輪清單。
```
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
}
]
}
```