Configurar flywheels usando a API

Você pode usar a API do Amazon Comprehend para criar, atualizar e excluir flywheels.

Quando você cria um flywheel, o Amazon Comprehend cria um data lake para armazenar todos os dados de que o flywheel precisa, como dados de treinamento e dados de teste para cada versão do modelo.

Quando você exclui um flywheel, o Amazon Comprehend não exclui o data lake nem o modelo associado ao flywheel.

A operação de exclusão do flywheel falhará se o flywheel estiver executando uma iteração ou criando um conjunto de dados.

Revise as informações na seção Criação do flywheel antes de criar um novo flywheel.

Crie um flywheel para um modelo existente

Use a CreateFlywheeloperação para criar um volante para um modelo existente.

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

Crie um flywheel para um novo modelo

Use a CreateFlywheeloperação para criar um volante para um novo modelo de classificação personalizado.

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

Descreva um flywheel.

Use a operação Amazon DescribeFlywheelComprehend para recuperar informações configuradas sobre um volante.

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

O corpo da resposta da API inclui o conteúdo a seguir.

{
  "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
  }
}    

Atualize um flywheel

Use a UpdateFlywheeloperação para atualizar os valores de configuração modificáveis do volante.

Alguns campos de configuração são estruturas JSON com subcampos. Para atualizar um ou mais subcampos, forneça valores para todos os subcampos (o Amazon Comprehend define o valor como nulo para qualquer subcampo ausente na solicitação).

Se você omitir um parâmetro de nível superior na solicitação UpdateFlywheel, o Amazon Comprehend não irá alterar os valores do parâmetro ou de nenhum de seus subcampos no flywheel.

Para adicionar ou remover etiquetas no volante, use as operações TagResourcee. UntagResource

É possível promover uma versão do modelo definindo o parâmetro ActiveModelArn, conforme mostrado no exemplo a seguir.

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

O corpo da resposta da API inclui o conteúdo a seguir.

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

Exclua um flywheel

Use a operação Amazon DeleteFlywheelComprehend para excluir volantes.

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

Uma resposta de API bem-sucedida contém um de mensagens corpo vazio.

Liste os flywheels

Use a operação Amazon ListFlywheelsComprehend para recuperar uma lista de volantes na região atual.

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

O corpo da resposta da API inclui o conteúdo a seguir.

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