使用 API 設定飛輪

您可以使用 Amazon Comprehend API 來建立、更新和刪除飛輪。

當您建立飛輪時，Amazon Comprehend 會建立一個資料湖來存放飛輪所需的所有資料，例如每個模型版本的訓練資料和測試資料。

刪除飛輪時，Amazon Comprehend 不會刪除資料湖或與飛輪關聯的模型。

如果飛輪正在運行迭代或創建數據集，飛輪刪除操作失敗。

在建立新飛輪創建飛輪之前，請先檢閱一節中的資訊。

為現有模型建立飛輪

使用此CreateFlywheel作業為現有模型建立飛輪。

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"   \ 

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

為新模型建立飛輪

使用此CreateFlywheel作業為新自訂分類模型建立飛輪。

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         

{
    "LanguageCode": "en",
    "DocumentClassificationConfig": {
        "Mode": "MULTI_LABEL",
        "Labels": ["optimism", "anger"]
    } 
}       

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

描述一個飛輪

使用 Amazon Comprehend DescribeFlywheel操作來擷取有關飛輪的已設定資訊。

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作業更新飛輪的可修改組態值。

一些配置字段是帶有子字段的 JSON 結構。若要更新一個或多個子欄位，請提供所有子欄位的值 (Amazon Comprehend 會將要求中遺漏的任何分欄的值設定為空值)。

如果您在UpdateFlywheel請求中省略頂層參數，Amazon Comprehend 不會變更飛輪中的參數或其任何子欄位的值。

若要在飛輪上新增或移除標籤，請使用TagResource和UntagResource操作。

您可以透過設定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操作刪除飛輪。

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

成功的 API 響應包含一個空的響應消息正文

列出飛輪

使用 Amazon Comprehend ListFlywheels作業擷取目前區域中的飛輪清單。

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
        }
    ]
}