

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

# Trabalhos de análise assíncrona usando a API
<a name="api-async"></a>

Os exemplos a seguir usam o Amazon Comprehend APIs Asynchronous para criar e gerenciar trabalhos de análise, usando o. AWS CLI

**Topics**
+ [Análise assíncrona para insights do Amazon Comprehend](api-async-insights.md)
+ [Análise assíncrona para sentimento direcionado](using-api-targeted-sentiment.md)
+ [Análise assíncrona para detecção de eventos](get-started-api-events.md)
+ [Análise assíncrona para modelagem de tópicos](get-started-topics.md)

# Análise assíncrona para insights do Amazon Comprehend
<a name="api-async-insights"></a>

As seções a seguir usam a API do Amazon Comprehend para executar operações assíncronas que analisam os insights do Amazon Comprehend.

**Topics**
+ [Pré-requisitos](#detect-topics-role-auth)
+ [Iniciar uma tarefa de análise](#how-start-job)
+ [Monitorar tarefas de análise](#how-monitor-progress)
+ [Obter os resultados da análise](#how-get-results)

## Pré-requisitos
<a name="detect-topics-role-auth"></a>

Os documentos devem arquivos de texto no formato UTF-8. Você pode enviar seus documentos em dois formatos. O formato usado depende do tipo de documento que deseja analisar, conforme descrito na tabela a seguir.


| Description | Formato | 
| --- | --- | 
| Cada arquivo contém um documento de entrada. Essa opção é melhor para coleções de documentos grandes. | Um documento por arquivo | 
|  A entrada é um ou mais arquivos. Cada linha em um arquivo é considerada um documento. Essa opção é melhor para documentos curtos, como publicações em mídias sociais. Cada linha deve terminar com uma alimentação de linha (LF, \$1n), um retorno de carro (CR, \$1r) ou ambos (CRLF, \$1r\$1n). Você não pode usar o separador de linha UTF-8 (u\$12028) para finalizar uma linha.  | Um documento por linha | 

Ao iniciar uma tarefa de análise, especifique a localização do S3 para seus dados de entrada. O URI deve estar na mesma AWS região do endpoint da API que você está chamando. O URI pode apontar para um único arquivo ou pode ser o prefixo de uma coleção de arquivos de dados. Para obter mais informações, consulte o tipo de dados [InputDataConfig](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_InputDataConfig.html).

É preciso conceder ao Amazon Comprehend acesso ao bucket do Amazon S3 contendo sua coleção de documentos e arquivos de saída. Para obter mais informações, consulte [Permissões baseadas em perfis necessárias para operações assíncronas](security_iam_id-based-policy-examples.md#auth-role-permissions).

## Iniciar uma tarefa de análise
<a name="how-start-job"></a>

Para enviar uma tarefa de análise, use o console do Amazon Comprehend ou a operação de `Start*` apropriada:
+  [StartDominantLanguageDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartDominantLanguageDetectionJob.html)— Comece um trabalho para detectar o idioma dominante em cada documento da coleção. Para mais informações sobre o idioma dominante em um documento, consulte [Idioma dominante](how-languages.md).
+  [StartEntitiesDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartEntitiesDetectionJob.html)— Inicie um trabalho para detectar entidades em cada documento da coleção. Para obter mais informações sobre entidades, consulte [Entidades](how-entities.md).
+  [StartKeyPhrasesDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartKeyPhrasesDetectionJob.html)— Inicie um trabalho para detectar frases-chave em cada documento da coleção. Para mais informações sobre nomes de chave, consulte [Frases chave](how-key-phrases.md).
+  [StartPiiEntitiesDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartPiiEntitiesDetectionJob.html)— Inicie um trabalho para detectar informações de identificação pessoal (PII) em cada documento da coleção. Para mais informações sobre PII, consulte [Detectar entidades de PII](how-key-phrases.md).
+  [StartSentimentDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartSentimentDetectionJob.html)— Inicie um trabalho para detectar o sentimento em cada documento da coleção. Para mais informações sobre sentimentos, consulte [Sentimento](how-sentiment.md).

## Monitorar tarefas de análise
<a name="how-monitor-progress"></a>

A operação de `Start*` retorna um ID que pode ser usado para monitorar o progresso da tarefa. 

Para monitorar o progresso usando a API, use uma das duas operações, dependendo se deseja monitorar o progresso de uma tarefa individual ou de várias tarefas. 

Para monitorar o progresso de uma tarefa de análise individual, use as operações de `Describe*`. Você fornece o ID da tarefa retornada pela operação de `Start*`. A resposta da operação de `Describe*` contém o campo de `JobStatus` com o status da tarefa.

Para monitorar o progresso de várias tarefas de análise, use a as operações de `List*`. Operações de `List*` retornam uma lista de tarefas que você enviou para o Amazon Comprehend. A resposta inclui um campo de `JobStatus` para cada tarefa que informa o seu status.

Se o campo de status estiver definido como `COMPLETED` ou `FAILED`, o processamento da tarefa foi concluído.

Para obter o status de tarefas individuais, use a operação `Describe*` para a análise que está executando.
+  [DescribeDominantLanguageDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribeDominantLanguageDetectionJob.html)
+  [DescribeEntitiesDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribeEntitiesDetectionJob.html)
+  [DescribeKeyPhrasesDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribeKeyPhrasesDetectionJob.html)
+  [DescribePiiEntitiesDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribePiiEntitiesDetectionJob.html)
+  [DescribeSentimentDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribeSentimentDetectionJob.html)

Para obter o status de tarefas múltiplas, use a operação `List*` para a análise que está executando.
+  [ListDominantLanguageDetectionJobs](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_ListDominantLanguageDetectionJobs.html)
+  [ListEntitiesDetectionJobs](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_ListEntitiesDetectionJobs.html)
+  [ListKeyPhrasesDetectionJobs](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_ListKeyPhrasesDetectionJobs.html)
+  [ListPiiEntitiesDetectionJobs](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_ListPiiEntitiesDetectionJobs.html)
+  [ListSentimentDetectionJobs](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_ListSentimentDetectionJobs.html)

Para restringir resultados a tarefas que correspondam a determinados critérios, use o parâmetro `Filter` das operações de `List*`. É possível filtrar os resultados por nome, status da tarefa ou data e hora em que ela foi enviada. Para obter mais informações, consulte o parâmetro `Filter` para cada uma das operações de `List*` na referência de API do Amazon Comprehend.

## Obter os resultados da análise
<a name="how-get-results"></a>

Depois que uma tarefa de análise for concluída, use uma operação `Describe*` para obter a localização dos resultados. Se o status da tarefa for `COMPLETED`, a resposta incluirá um campo `OutputDataConfig` contendo um outro campo com a localização do arquivo de saída no Amazon S3. O arquivo de saída, `output.tar.gz`, é um arquivo compactado contendo os resultados da análise.

Se o status de uma tarefa for `FAILED`, a resposta conterá um campo de `Message` descrevendo o motivo pelo qual a tarefa de análise não foi concluída com êxito.

Para obter o status de tarefas individuais, use a operação `Describe*` apropriada:
+  [DescribeDominantLanguageDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribeDominantLanguageDetectionJob.html)
+  [DescribeEntitiesDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribeEntitiesDetectionJob.html)
+  [DescribeKeyPhrasesDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribeKeyPhrasesDetectionJob.html)
+  [DescribeSentimentDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribeSentimentDetectionJob.html)

Os resultados são retornados em um único arquivo, com uma estrutura JSON para cada documento. Cada arquivo de resposta também inclui mensagens de erro para qualquer tarefa com o campo de status definido como `FAILED`.

Cada uma das seções a seguir mostra exemplos de saída para os dois formatos de entrada.

### Obter resultados de detecção de linguagem dominante
<a name="async-dominant-language"></a>

Veja a seguir um exemplo de um arquivo de saída de uma análise que detectou o idioma dominante. O formato da entrada é um documento por linha. Para obter mais informações, consulte a operação [DetectDominantLanguage](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DetectDominantLanguage.html).

```
{"File": "0_doc", "Languages": [{"LanguageCode": "en", "Score": 0.9514502286911011}, {"LanguageCode": "de", "Score": 0.02374090999364853}, {"LanguageCode": "nl", "Score": 0.003208699868991971}, "Line": 0}
{"File": "1_doc", "Languages": [{"LanguageCode": "en", "Score": 0.9822712540626526}, {"LanguageCode": "de", "Score": 0.002621392020955682}, {"LanguageCode": "es", "Score": 0.002386554144322872}], "Line": 1}
```

Veja a seguir um exemplo de saída de uma análise em que o formato da entrada é um documento por arquivo:

```
{"File": "small_doc", "Languages": [{"LanguageCode": "en", "Score": 0.9728053212165833}, {"LanguageCode": "de", "Score": 0.007670710328966379}, {"LanguageCode": "es", "Score": 0.0028472368139773607}]}
{"File": "huge_doc", "Languages": [{"LanguageCode": "en", "Score": 0.984955906867981}, {"LanguageCode": "de", "Score": 0.0026436643674969673}, {"LanguageCode": "fr", "Score": 0.0014206881169229746}]}
```

### Obter resultados de detecção de entidades
<a name="async-entities"></a>

Veja a seguir um exemplo de um arquivo de saída de uma análise que detectou entidades em documentos. O formato da entrada é um documento por linha. Para obter mais informações, consulte a operação [DetectEntities](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DetectEntities.html). A saída contém duas mensagens de erro, uma para um documento muito longo e outra para um documento que não está no formato UTF-8.

```
{"File": "50_docs", "Line": 0, "Entities": [{"BeginOffset": 0, "EndOffset": 22, "Score": 0.9763959646224976, "Text": "Cluj-NapocaCluj-Napoca", "Type": "LOCATION"}"]}
{"File": "50_docs", "Line": 1, "Entities": [{"BeginOffset": 11, "EndOffset": 15, "Score": 0.9615424871444702, "Text": "Maat", "Type": "PERSON"}}]}
{"File": "50_docs", "Line": 2, "ErrorCode": "DOCUMENT_SIZE_EXCEEDED", "ErrorMessage": "Document size exceeds maximum size limit 102400 bytes."}
{"File": "50_docs", "Line": 3, "ErrorCode": "UNSUPPORTED_ENCODING", "ErrorMessage": "Document is not in UTF-8 format and all subsequent lines are ignored."}
```

Veja a seguir um exemplo de saída de uma análise em que o formato da entrada é um documento por arquivo. A saída contém duas mensagens de erro, uma para um documento muito longo e outra para um documento que não está no formato UTF-8. 

```
{"File": "non_utf8.txt", "ErrorCode": "UNSUPPORTED_ENCODING", "ErrorMessage": "Document is not in UTF-8 format and all subsequent line are ignored."}
{"File": "small_doc", "Entities": [{"BeginOffset": 0, "EndOffset": 4, "Score": 0.645766019821167, "Text": "Maat", "Type": "PERSON"}]}
{"File": "huge_doc", "ErrorCode": "DOCUMENT_SIZE_EXCEEDED", "ErrorMessage": "Document size exceeds size limit 102400 bytes."}
```

### Obter resultados de detecção de frases-chave
<a name="async-key-phrases"></a>

Veja a seguir um exemplo de um arquivo de saída de uma análise que detectou frases-chave em um documento. O formato da entrada é um documento por linha. Para obter mais informações, consulte a operação [DetectKeyPhrases](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DetectKeyPhrases.html).

```
{"File": "50_docs", "KeyPhrases": [{"BeginOffset": 0, "EndOffset": 22, "Score": 0.8948641419410706, "Text": "Cluj-NapocaCluj-Napoca"}, {"BeginOffset": 45, "EndOffset": 49, "Score": 0.9989854693412781, "Text": "Cluj"}], "Line": 0}            
```

Veja a seguir um exemplo da saída de uma análise em que o formato da entrada é um documento por arquivo.

```
{"File": "1_doc", "KeyPhrases": [{"BeginOffset": 0, "EndOffset": 22, "Score": 0.8948641419410706, "Text": "Cluj-NapocaCluj-Napoca"}, {"BeginOffset": 45, "EndOffset": 49, "Score": 0.9989854693412781, "Text": "Cluj"}]}            
```

### Obter resultados de detecção de informações de identificação pessoal (PII)
<a name="async-pii"></a>

Veja a seguir um exemplo de arquivo de saída de uma tarefa de análise que detectou entidades de PII em documentos. O formato da entrada é um documento por linha. 

```
{"Entities":[{"Type":"NAME","BeginOffset":40,"EndOffset":69,"Score":0.999995},{"Type":"ADDRESS","BeginOffset":247,"EndOffset":253,"Score":0.998828},{"Type":"BANK_ACCOUNT_NUMBER","BeginOffset":406,"EndOffset":411,"Score":0.693283}],"File":"doc.txt","Line":0}
{"Entities":[{"Type":"SSN","BeginOffset":1114,"EndOffset":1124,"Score":0.999999},{"Type":"EMAIL","BeginOffset":3742,"EndOffset":3775,"Score":0.999993},{"Type":"PIN","BeginOffset":4098,"EndOffset":4102,"Score":0.999995}],"File":"doc.txt","Line":1}
```

Veja a seguir um exemplo de saída de uma análise em que o formato da entrada é um documento por arquivo.

```
{"Entities":[{"Type":"NAME","BeginOffset":40,"EndOffset":69,"Score":0.999995},{"Type":"ADDRESS","BeginOffset":247,"EndOffset":253,"Score":0.998828},{"Type":"BANK_ROUTING","BeginOffset":279,"EndOffset":289,"Score":0.999999}],"File":"doc.txt"}
```

### Obter resultados de detecção de sentimento
<a name="async-sentiment"></a>

Veja a seguir um exemplo de um arquivo de saída de uma análise que detectou o sentimento expresso em um documento. Inclui uma mensagem de erro porque um documento é muito longo. O formato da entrada é um documento por linha. Para obter mais informações, consulte a operação [DetectSentiment](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DetectSentiment.html).

```
{"File": "50_docs", "Line": 0, "Sentiment": "NEUTRAL", "SentimentScore": {"Mixed": 0.002734508365392685, "Negative": 0.008935936726629734, "Neutral": 0.9841893315315247, "Positive": 0.004140198230743408}}
{"File": "50_docs", "Line": 1, "ErrorCode": "DOCUMENT_SIZE_EXCEEDED", "ErrorMessage": "Document size is exceeded maximum size limit 5120 bytes."}
{"File": "50_docs", "Line": 2, "Sentiment": "NEUTRAL", "SentimentScore": {"Mixed": 0.0023119584657251835, "Negative": 0.0029857370536774397, "Neutral": 0.9866572022438049, "Positive": 0.008045154623687267}}
```

Veja a seguir um exemplo da saída de uma análise em que o formato da entrada é um documento por arquivo.

```
{"File": "small_doc", "Sentiment": "NEUTRAL", "SentimentScore": {"Mixed": 0.0023450672160834074, "Negative": 0.0009663937962614, "Neutral": 0.9795311689376831, "Positive": 0.017157377675175667}}
{"File": "huge_doc", "ErrorCode": "DOCUMENT_SIZE_EXCEEDED", "ErrorMessage": "Document size is exceeds the limit of 5120 bytes."}
```

# Análise assíncrona para sentimento direcionado
<a name="using-api-targeted-sentiment"></a>

Para obter informações sobre a análise de sentimento direcionado em tempo real, consulte [Análise em tempo real de um sentimento direcionado](using-api-sync.md#get-started-api-targeted-sentiment).

O Amazon Comprehend fornece as seguintes operações de API para iniciar e gerenciar a análise assíncrona de sentimentos direcionados:
+  [StartTargetedSentimentDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartTargetedSentimentDetectionJob.html)— inicia um trabalho assíncrono de detecção de sentimentos direcionados para uma coleção de documentos.
+  [ListTargetedSentimentDetectionJobs](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_ListTargetedSentimentDetectionJobs.html)— Retorna a lista de trabalhos direcionados de detecção de sentimentos que você enviou.
+  [DescribeTargetedSentimentDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribeTargetedSentimentDetectionJob.html)— Obtém as propriedades (incluindo status) associadas ao trabalho de detecção de sentimentos direcionado especificado.
+  [StopTargetedSentimentDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StopTargetedSentimentDetectionJob.html)— Interrompe o trabalho de sentimento direcionado especificado em andamento.

**Topics**
+ [Antes de começar](#api-targeted-sentiment-before)
+ [Analisando o sentimento direcionado usando o AWS CLI](#api-targeted-sentiment-cli)

## Antes de começar
<a name="api-targeted-sentiment-before"></a>

Antes de começar, garanta que você tenha:
+ **Buckets de entrada e saída**: identifique os buckets do Amazon S3 que você deseja usar para entrada e saída. O buckets devem estar na mesma região que o API que você está chamando.
+ **Perfil de serviço do IAM**: você deve ter um perfil de serviço do IAM com permissão para acessar seus buckets de entrada e saída. Para obter mais informações, consulte [Permissões baseadas em perfis necessárias para operações assíncronas](security_iam_id-based-policy-examples.md#auth-role-permissions).

## Analisando o sentimento direcionado usando o AWS CLI
<a name="api-targeted-sentiment-cli"></a>

O exemplo a seguir demonstra como usar a operação `StartTargetedSentimentDetectionJob` com o AWS CLI. Este exemplo especifica o idioma do texto de entrada.

O exemplo é formatado para Unix, Linux e macOS. Para Windows, substitua o caractere de continuação Unix de barra invertida (\$1) no final de cada linha por um circunflexo (^).

```
aws comprehend start-targeted-sentiment-detection-job \
       --job-name "job name" \
       --language-code "en" \
       --cli-input-json file://path to JSON input file
```

Para o parâmetro `cli-input-json`, você fornece um caminho para um arquivo JSON que contém os dados da solicitação, conforme exibido no exemplo a seguir.

```
{
    "InputDataConfig": {
        "S3Uri": "s3://input bucket/input path",
        "InputFormat": "ONE_DOC_PER_FILE"
    },
    "OutputDataConfig": {
        "S3Uri": "s3://output bucket/output path"
    },
    "DataAccessRoleArn": "arn:aws:iam::account ID:role/data access role"
}
```

Se a solicitação para iniciar o trabalho for bem-sucedida, você receberá a seguinte resposta:

```
{
    "JobStatus": "SUBMITTED",
    "JobArn": "job ARN"
    "JobId": "job ID"
}
```

# Análise assíncrona para detecção de eventos
<a name="get-started-api-events"></a>

**Topics**
+ [Antes de começar](#events-before)
+ [Detecte eventos usando o AWS CLI](#events-cli)
+ [Listar eventos usando o AWS CLI](#list-events)
+ [Descreva eventos usando o AWS CLI](#describe-events)
+ [Obter resultados de detecção de eventos](#async-events)

Para detectar eventos em um conjunto de documentos, use o [StartEventsDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartEventsDetectionJob.html)para iniciar um trabalho assíncrono.

## Antes de começar
<a name="events-before"></a>

Antes de começar, garanta que você tenha:
+ **Buckets de entrada e saída**: identifique os buckets do Amazon S3 que você deseja usar para entrada e saída. O buckets devem estar na mesma região que o API que você está chamando.
+ **Perfil de serviço do IAM**: você deve ter um perfil de serviço do IAM com permissão para acessar seus buckets de entrada e saída. Para obter mais informações, consulte [Permissões baseadas em perfis necessárias para operações assíncronas](security_iam_id-based-policy-examples.md#auth-role-permissions).

## Detecte eventos usando o AWS CLI
<a name="events-cli"></a>

O exemplo a seguir demonstra o uso da [StartEventsDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartEventsDetectionJob.html)operação com o AWS CLI

O exemplo é formatado para Unix, Linux e macOS. Para Windows, substitua o caractere de continuação Unix de barra invertida (\$1) no final de cada linha por um circunflexo (^).

```
aws comprehend start-events-detection-job \
  --region region \
  --job-name job name \
  --cli-input-json file://path to JSON input file
```

Para o parâmetro `cli-input-json`, você fornece um caminho para um arquivo JSON que contém os dados da solicitação, conforme exibido no exemplo a seguir.

```
{
  "InputDataConfig": {
      "S3Uri": "s3://input bucket/input path",
      "InputFormat": "ONE_DOC_PER_LINE"
  },
  "OutputDataConfig": {
      "S3Uri": "s3://output bucket/output path"
  },
  "DataAccessRoleArn": "arn:aws:iam::account ID:role/data access role"
  "LanguageCode": "en",
  "TargetEventTypes": [
      "BANKRUPTCY",
      "EMPLOYMENT",
      "CORPORATE_ACQUISITION",
      "INVESTMENT_GENERAL",
      "CORPORATE_MERGER",
      "IPO",
      "RIGHTS_ISSUE",
      "SECONDARY_OFFERING",
      "SHELF_OFFERING",
      "TENDER_OFFERING",
      "STOCK_SPLIT"
  ]
}
```

Se a solicitação para iniciar o trabalho de detecção de eventos for bem-sucedida, você receberá a seguinte resposta:

```
{
  "JobStatus": "SUBMITTED",
  "JobId": "job ID"
}
```

## Listar eventos usando o AWS CLI
<a name="list-events"></a>

Use a [ListEventsDetectionJobs](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_ListEventsDetectionJobs.html)operação para ver uma lista dos trabalhos de detecção de eventos que você enviou. A lista inclui informações sobre os locais de entrada e saída que você usou, além do status de cada um dos trabalhos de detecção. O exemplo é formatado para Unix, Linux e macOS. Para Windows, substitua o caractere de continuação Unix de barra invertida (\$1) no final de cada linha por um circunflexo (^).

```
aws comprehend list-events-detection-jobs --region region 
```

Em resposta, você verá um JSON semelhante a:

```
{
 "EventsDetectionJobPropertiesList": [
    {
       "DataAccessRoleArn": "arn:aws:iam::account ID:role/data access role",
       "EndTime": timestamp,
       "InputDataConfig": {
          "InputFormat": "ONE_DOC_PER_LINE",
          "S3Uri": "s3://input bucket/input path"
       },
       "JobId": "job ID",
       "JobName": "job name",
       "JobStatus": "COMPLETED",
       "LanguageCode": "en",
       "Message": "message",
       "OutputDataConfig": {
          "S3Uri": "s3://output bucket/ouput path"
       },
       "SubmitTime": timestamp,
       "TargetEventTypes": [
         "BANKRUPTCY",
         "EMPLOYMENT",
         "CORPORATE_ACQUISITION",
         "INVESTMENT_GENERAL",
         "CORPORATE_MERGER",
         "IPO",
         "RIGHTS_ISSUE",
         "SECONDARY_OFFERING",
         "SHELF_OFFERING",
         "TENDER_OFFERING",
         "STOCK_SPLIT"
  ]
    }
 ],
 "NextToken": "next token"
}
```

## Descreva eventos usando o AWS CLI
<a name="describe-events"></a>

Você pode usar a [DescribeEventsDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribeEventsDetectionJob.html)operação para obter o status de um trabalho existente. O exemplo é formatado para Unix, Linux e macOS. Para Windows, substitua o caractere de continuação Unix de barra invertida (\$1) no final de cada linha por um circunflexo (^).

```
aws comprehend describe-events-detection-job \
  --region region \
  --job-id job ID
```

Em resposta, você verá o seguinte JSON:

```
{
 "EventsDetectionJobProperties": {
    "DataAccessRoleArn": "arn:aws:iam::account ID:role/data access role",
    "EndTime": timestamp,
    "InputDataConfig": {
       "InputFormat": "ONE_DOC_PER_LINE",
       "S3Uri": "S3Uri": "s3://input bucket/input path"
    },
    "JobId": "job ID",
    "JobName": "job name",
    "JobStatus": "job status",
    "LanguageCode": "en",
    "Message": "message",
    "OutputDataConfig": {
       "S3Uri": "s3://output bucket/output path"
    },
    "SubmitTime": timestamp,
    "TargetEventTypes": [
      "BANKRUPTCY",
      "EMPLOYMENT",
      "CORPORATE_ACQUISITION",
      "INVESTMENT_GENERAL",
      "CORPORATE_MERGER",
      "IPO",
      "RIGHTS_ISSUE",
      "SECONDARY_OFFERING",
      "SHELF_OFFERING",
      "TENDER_OFFERING",
      "STOCK_SPLIT"
  ]
 }
}
```

## Obter resultados de detecção de eventos
<a name="async-events"></a>

Veja a seguir um exemplo de arquivo de saída de um trabalho de análise que detectou eventos em documentos. O formato da entrada é um documento por linha. 

```
{"Entities": [{"Mentions": [{"BeginOffset": 12, "EndOffset": 27, "GroupScore": 1.0, "Score": 0.916355, "Text": "over a year ago", "Type": "DATE"}]}, {"Mentions": [{"BeginOffset": 33, "EndOffset": 39, "GroupScore": 1.0, "Score": 0.996603, "Text": "Amazon", "Type": "ORGANIZATION"}]}, {"Mentions": [{"BeginOffset": 66, "EndOffset": 77, "GroupScore": 1.0, "Score": 0.999283, "Text": "Whole Foods", "Type": "ORGANIZATION"}]}], "Events": [{"Arguments": [{"EntityIndex": 2, "Role": "INVESTEE", "Score": 0.999283}, {"EntityIndex": 0, "Role": "DATE", "Score": 0.916355}, {"EntityIndex": 1, "Role": "INVESTOR", "Score": 0.996603}], "Triggers": [{"BeginOffset": 373, "EndOffset": 380, "GroupScore": 0.999984, "Score": 0.999955, "Text": "acquire", "Type": "CORPORATE_ACQUISITION"}], "Type": "CORPORATE_ACQUISITION"}, {"Arguments": [{"EntityIndex": 2, "Role": "PARTICIPANT", "Score": 0.999283}], "Triggers": [{"BeginOffset": 115, "EndOffset": 123, "GroupScore": 1.0, "Score": 0.999967, "Text": "combined", "Type": "CORPORATE_MERGER"}], "Type": "CORPORATE_MERGER"}], "File": "doc.txt", "Line": 0}
```

Para obter mais informações sobre a estrutura do arquivo de saída de eventos e os tipos de evento compatíveis, consulte [Eventos](how-events.md).

# Análise assíncrona para modelagem de tópicos
<a name="get-started-topics"></a>

 Para determinar os tópicos em um conjunto de documentos, use o [StartTopicsDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartTopicsDetectionJob.html)para iniciar um trabalho assíncrono. Você pode monitorar tópicos em documentos escritos em inglês ou espanhol.

**Topics**
+ [Antes de começar](#topics-before)
+ [Usando o AWS Command Line Interface](#topics-cli)
+ [Usando o SDK para Python ou SDK para .NET](#topic-java)

## Antes de começar
<a name="topics-before"></a>

Antes de começar, garanta que você tenha:
+ **Buckets de entrada e saída**: identifique os buckets do Amazon S3 que você deseja usar para entrada e saída. O buckets devem estar na mesma região que o API que você está chamando.
+ **Perfil de serviço do IAM**: você deve ter um perfil de serviço do IAM com permissão para acessar seus buckets de entrada e saída. Para obter mais informações, consulte [Permissões baseadas em perfis necessárias para operações assíncronas](security_iam_id-based-policy-examples.md#auth-role-permissions).

## Usando o AWS Command Line Interface
<a name="topics-cli"></a>

O exemplo a seguir demonstra o uso da `StartTopicsDetectionJob` operação com o AWS CLI

O exemplo é formatado para Unix, Linux e macOS. Para Windows, substitua o caractere de continuação Unix de barra invertida (\$1) no final de cada linha por um circunflexo (^).

```
aws comprehend start-topics-detection-job \
                --number-of-topics topics to return \
                --job-name "job name" \
                --region region \
                --cli-input-json file://path to JSON input file
```

Para o parâmetro `cli-input-json`, você fornece um caminho para um arquivo JSON que contém os dados da solicitação, conforme exibido no exemplo a seguir.

```
{
    "InputDataConfig": {
        "S3Uri": "s3://input bucket/input path",
        "InputFormat": "ONE_DOC_PER_FILE"
    },
    "OutputDataConfig": {
        "S3Uri": "s3://output bucket/output path"
    },
    "DataAccessRoleArn": "arn:aws:iam::account ID:role/data access role"
}
```

Se a solicitação para iniciar o trabalho de detecção de tópicos for bem-sucedida, você receberá a seguinte resposta:

```
{
    "JobStatus": "SUBMITTED",
    "JobId": "job ID"
}
```

Use a [ListTopicsDetectionJobs](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_ListTopicsDetectionJobs.html)operação para ver uma lista dos trabalhos de detecção de tópicos que você enviou. A lista inclui informações sobre os locais de entrada e saída que você usou, além do status de cada um dos trabalhos de detecção. O exemplo é formatado para Unix, Linux e macOS. Para Windows, substitua o caractere de continuação Unix de barra invertida (\$1) no final de cada linha por um circunflexo (^).

```
aws comprehend list-topics-detection-jobs \-- region
```

Em resposta, você verá um JSON semelhante a:

```
{
    "TopicsDetectionJobPropertiesList": [
        {
            "InputDataConfig": {
                "S3Uri": "s3://input bucket/input path",
                "InputFormat": "ONE_DOC_PER_LINE"
            },
            "NumberOfTopics": topics to return,
            "JobId": "job ID",
            "JobStatus": "COMPLETED",
            "JobName": "job name",
            "SubmitTime": timestamp,
            "OutputDataConfig": {
                "S3Uri": "s3://output bucket/output path"
            },
            "EndTime": timestamp
        },
        {
            "InputDataConfig": {
                "S3Uri": "s3://input bucket/input path",
                "InputFormat": "ONE_DOC_PER_LINE"
            },
            "NumberOfTopics": topics to return,
            "JobId": "job ID",
            "JobStatus": "RUNNING",
            "JobName": "job name",
            "SubmitTime": timestamp,
            "OutputDataConfig": {
                "S3Uri": "s3://output bucket/output path"
            }
        }
    ]
}
```

Você pode usar a [DescribeTopicsDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribeTopicsDetectionJob.html)operação para obter o status de um trabalho existente. O exemplo é formatado para Unix, Linux e macOS. Para Windows, substitua o caractere de continuação Unix de barra invertida (\$1) no final de cada linha por um circunflexo (^).

```
aws comprehend describe-topics-detection-job --job-id job ID 
```

Em resposta, você verá o seguinte JSON:

```
{
    "TopicsDetectionJobProperties": {
        "InputDataConfig": {
            "S3Uri": "s3://input bucket/input path",
            "InputFormat": "ONE_DOC_PER_LINE"
        },
        "NumberOfTopics": topics to return,
        "JobId": "job ID",
        "JobStatus": "COMPLETED",
        "JobName": "job name",
        "SubmitTime": timestamp,
        "OutputDataConfig": {
            "S3Uri": "s3://output bucket/ouput path"
        },
        "EndTime": timestamp
    }
}
```

## Usando o SDK para Python ou SDK para .NET
<a name="topic-java"></a>

Para exemplos de SDK de como iniciar um trabalho de modelagem de tópicos, consulte [Use `StartTopicsDetectionJob` com um AWS SDK ou CLI](example_comprehend_StartTopicsDetectionJob_section.md).