Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
# Trabajos de análisis asíncrono mediante la API
En los siguientes ejemplos se utiliza el Amazon Comprehend asincrónico APIs para crear y gestionar trabajos de análisis mediante el. AWS CLI
**Topics**
+ [Análisis asincrónico para información de Amazon Comprehend](api-async-insights.md)
+ [Análisis asíncrono para opiniones dirigidas](using-api-targeted-sentiment.md)
+ [Análisis asíncrono para la detección de eventos](get-started-api-events.md)
+ [Análisis asíncrono para el modelado de temas](get-started-topics.md)
# Análisis asincrónico para información de Amazon Comprehend
En las siguientes secciones se utiliza la API de Amazon Comprehend para ejecutar operaciones asíncronas con el fin de analizar la información de Amazon Comprehend.
**Topics**
+ [Requisitos previos](#detect-topics-role-auth)
+ [Inicio de un trabajo de análisis](#how-start-job)
+ [Monitoreo de trabajos de análisis](#how-monitor-progress)
+ [Obtención de resultados del análisis](#how-get-results)
## Requisitos previos
Los documentos deben ser archivos de texto con formato UTF-8. Puede enviar sus documentos en dos formatos. El formato que utilice depende del tipo de documentos que desee analizar, tal como se describe en la tabla siguiente.
| Description (Descripción) | Formato |
| --- | --- |
| Cada archivo contiene un documento de entrada. Esto es lo mejor para colecciones de documentos de gran tamaño. | Un documento por archivo |
| La entrada comprende uno o más archivos. Cada línea de un archivo se considera un documento. Esta opción es la mejor para documentos cortos, como publicaciones en redes sociales. Cada línea debe terminar con un salto de línea (LF,\$1n), un retorno de carro (CR,\$1 r) o ambos (CRLF,\$1 r\$1n). No se puede usar el separador de líneas UTF-8 (u\$12028) para terminar una línea. | Un documento por línea |
Al iniciar un trabajo de análisis, debe especificar la ubicación S3 para los datos de entrada. El URI debe estar en la misma AWS región que el punto final de la API al que está llamando. El URI puede apuntar a un único archivo o puede ser el prefijo de un conjunto de archivos de datos. Para obtener más información, consulta el tipo de datos [InputDataConfig](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_InputDataConfig.html).
Debe conceder a Amazon Comprehend acceso al bucket de Amazon S3 que contiene la colección de documentos y los archivos de salida. Para obtener más información, consulte [Se requieren permisos basados en roles para las operaciones asíncronas](security_iam_id-based-policy-examples.md#auth-role-permissions).
## Inicio de un trabajo de análisis
Para enviar un trabajo de análisis, utilice la consola de Amazon Comprehend o la operación de `Start*` correspondiente:
+ [StartDominantLanguageDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartDominantLanguageDetectionJob.html)— Comience a detectar el idioma dominante en cada documento de la colección. Para obtener más información sobre el idioma predominante de un documento, consulte [Idioma predominante](how-languages.md).
+ [StartEntitiesDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartEntitiesDetectionJob.html)— Iniciar un trabajo para detectar entidades en cada documento de la colección. Para obtener más información sobre entidades, consulte [Entidades](how-entities.md).
+ [StartKeyPhrasesDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartKeyPhrasesDetectionJob.html)— Comience a detectar frases clave en cada documento de la colección. Para obtener más información sobre las frases clave, consulte [Frases clave](how-key-phrases.md).
+ [StartPiiEntitiesDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartPiiEntitiesDetectionJob.html)— Comience a detectar la información de identificación personal (PII) en cada documento de la colección. Para obtener más información acerca de la PII, consulte [Detección de entidades de PII](how-key-phrases.md).
+ [StartSentimentDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartSentimentDetectionJob.html)— Comience a detectar el sentimiento en cada documento de la colección. Para obtener más información sobre las opiniones, consulte [Opiniones](how-sentiment.md).
## Monitoreo de trabajos de análisis
La operación `Start*` devuelve un identificador que puede utilizar para supervisar el progreso del trabajo.
Para supervisar el progreso usando la API, utilice una de estas dos operaciones, en función de si desea supervisar el progreso de un trabajo individual o de varios de ellos.
Para supervisar el progreso de un trabajo de análisis individual, utilice las operaciones de `Describe*`. Debe proporcionar el identificador del trabajo que le ha reportado la operación de `Start*`. La respuesta de la operación de `Describe*` contiene el campo `JobStatus` con el estado del trabajo.
Para supervisar el progreso de varios trabajos de análisis, utilice las operaciones de `List*`. Las operaciones de `List*` reportan una lista de los trabajos que ha enviado a Amazon Comprehend. La respuesta incluye un campo `JobStatus` para cada trabajo en el que se indica el estado de este.
Si el campo de estado está configurado en `COMPLETED` o `FAILED`, el procesamiento del trabajo se ha completado.
Para obtener el estado de un trabajo individual, utilice la operación de `Describe*` para el análisis que esté realizando.
+ [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 obtener el estado de varios trabajos, utilice la operación de `List*` para el análisis que esté realizando.
+ [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 los resultados a trabajos que satisfagan determinados criterios, utilice el parámetro `Filter` de la operación `List*`. Puede filtrar los resultados por el nombre del trabajo, el estado del trabajo o la fecha y hora de envío del trabajo. Para obtener más información, consulte el parámetro `Filter` de cada una de las operaciones de `List*` en la referencia de la API de Amazon Comprehend.
## Obtención de resultados del análisis
Una vez finalizada un trabajo de análisis, utilice una operación de `Describe*` para obtener la ubicación de los resultados. Si el estado del trabajo es `COMPLETED`, la respuesta incluirá un campo `OutputDataConfig` que contiene un campo con la ubicación de Amazon S3 del archivo de salida. El archivo, `output.tar.gz`, es un archivo comprimido que contiene los resultados del análisis.
Si el estado de un trabajo es `FAILED`, la respuesta contendrá un campo `Message` en el que se describe el motivo por el cual el trabajo no se ha completado correctamente.
Para obtener el estado de los trabajos individuales, utilice la operación de `Describe*` pertinente:
+ [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)
Los resultados se reportan en un único archivo con una estructura JSON para cada documento. Cada archivo de respuesta también incluye mensajes de error para cualquier trabajo con el campo de estado configurado en `FAILED`.
En cada una de las siguientes secciones se muestran ejemplos de los resultados para los dos formatos de entrada.
### Obtención de los resultados de la detección del idioma predominante
A continuación se muestra un ejemplo de un archivo de salida de un trabajo de análisis que ha detectado el idioma predominante. El formato de entrada es de un documento por línea. Para obtener más información, consulte la operación [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}
```
A continuación se muestra un ejemplo del resultado de un análisis en el que el formato de entrada es un documento por archivo:
```
{"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}]}
```
### Obtención de los resultados de la detección de entidades
A continuación se muestra un ejemplo de un archivo de salida de un trabajo de análisis que ha detectado entidades en los documentos. El formato de entrada es de un documento por línea. Para obtener más información, consulte la operación [DetectEntities](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DetectEntities.html). El resultado contiene dos mensajes de error, uno para un documento demasiado largo y otro para un documento que no está en 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."}
```
A continuación, se muestra un ejemplo del resultado de un análisis en el que el formato de la entrada es un documento por archivo. El resultado contiene dos mensajes de error, uno para un documento demasiado largo y otro para un documento que no está en 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."}
```
### Obtención de los resultados de la detección de frases clave
A continuación se muestra un ejemplo de un archivo de salida de un trabajo de análisis que ha detectado frases clave en un documento. El formato de entrada es de un documento por línea. Para obtener más información, consulte la operación [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}
```
A continuación se muestra un ejemplo del resultado de un análisis en el que el formato de entrada es un documento por archivo.
```
{"File": "1_doc", "KeyPhrases": [{"BeginOffset": 0, "EndOffset": 22, "Score": 0.8948641419410706, "Text": "Cluj-NapocaCluj-Napoca"}, {"BeginOffset": 45, "EndOffset": 49, "Score": 0.9989854693412781, "Text": "Cluj"}]}
```
### Obtención de resultados de detección de información de identificación personal (PII)
A continuación se muestra un ejemplo de un archivo de salida de un trabajo de análisis que ha detectado entidades de PII en los documentos. El formato de entrada es de un documento por línea.
```
{"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}
```
A continuación, se muestra un ejemplo del resultado de un análisis en el que el formato de la entrada es un documento por archivo.
```
{"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"}
```
### Obtención de resultados de detección de opiniones
A continuación se muestra un ejemplo de un archivo de salida de un análisis que ha detectado la opinión expresada en un documento. Incluye un mensaje de error porque un documento es demasiado largo. El formato de entrada es de un documento por línea. Para obtener más información, consulte la operación [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}}
```
A continuación se muestra un ejemplo del resultado de un análisis en el que el formato de entrada es un documento por archivo.
```
{"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álisis asíncrono para opiniones dirigidas
Para obtener información sobre el análisis en tiempo real de la opinión dirigida, consulte [Análisis en tiempo real de la opinión específica](using-api-sync.md#get-started-api-targeted-sentiment).
Amazon Comprehend proporciona las siguientes operaciones de API para iniciar y gestionar el análisis asíncrono de opiniones dirigidas:
+ [StartTargetedSentimentDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartTargetedSentimentDetectionJob.html)— Inicia un trabajo asíncrono de detección de opiniones específicas para una colección de documentos.
+ [ListTargetedSentimentDetectionJobs](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_ListTargetedSentimentDetectionJobs.html)— Devuelve la lista de trabajos de detección de opiniones segmentados que ha enviado.
+ [DescribeTargetedSentimentDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribeTargetedSentimentDetectionJob.html)— Obtiene las propiedades (incluido el estado) asociadas al trabajo de detección de opiniones objetivo especificado.
+ [StopTargetedSentimentDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StopTargetedSentimentDetectionJob.html)— Detiene el trabajo de opinión objetivo especificado en curso.
**Topics**
+ [Antes de comenzar](#api-targeted-sentiment-before)
+ [Analiza el sentimiento objetivo mediante el AWS CLI](#api-targeted-sentiment-cli)
## Antes de comenzar
Antes de comenzar, asegúrese de que dispone de:
+ **Buckets de entrada y de salida**: identifique los buckets de Amazon S3 que quiere usar para la entrada y la salida. Los buckets deben estar situados en la misma región que la API a la cual está llamando.
+ **Rol de servicio de IAM**: debe tener un rol de servicio de IAM con permiso para acceder a sus buckets de entrada y salida. Para obtener más información, consulte [Se requieren permisos basados en roles para las operaciones asíncronas](security_iam_id-based-policy-examples.md#auth-role-permissions).
## Analiza el sentimiento objetivo mediante el AWS CLI
El siguiente ejemplo muestra el uso de la operación `StartTargetedSentimentDetectionJob` en la AWS CLI. En este ejemplo se especifica el idioma del texto de entrada.
El ejemplo está formateado para Unix, Linux y macOS. Para Windows, sustituya la barra diagonal invertida (\$1) utilizada como carácter de continuación de Unix al final de cada línea por el signo de intercalación (^).
```
aws comprehend start-targeted-sentiment-detection-job \
--job-name "job name" \
--language-code "en" \
--cli-input-json file://path to JSON input file
```
Para el parámetro de `cli-input-json`, debe proporcionar la ruta de un archivo JSON que contiene los datos de solicitud, como se muestra en el siguiente ejemplo.
```
{
"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"
}
```
Si la solicitud para iniciar el trabajo se ha realizado correctamente, recibirá la siguiente respuesta:
```
{
"JobStatus": "SUBMITTED",
"JobArn": "job ARN"
"JobId": "job ID"
}
```
# Análisis asíncrono para la detección de eventos
**Topics**
+ [Antes de comenzar](#events-before)
+ [Detecte eventos mediante el AWS CLI](#events-cli)
+ [Enumere los eventos mediante el AWS CLI](#list-events)
+ [Describa los eventos mediante el AWS CLI](#describe-events)
+ [Cómo obtener los resultados de la detección de eventos](#async-events)
Para detectar eventos en un conjunto de documentos, utilice el [StartEventsDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartEventsDetectionJob.html)para iniciar un trabajo asíncrono.
## Antes de comenzar
Antes de comenzar, asegúrese de que dispone de:
+ **Buckets de entrada y de salida**: identifique los buckets de Amazon S3 que quiere usar para la entrada y la salida. Los buckets deben estar situados en la misma región que la API a la cual está llamando.
+ **Rol de servicio de IAM**: debe tener un rol de servicio de IAM con permiso para acceder a sus buckets de entrada y salida. Para obtener más información, consulte [Se requieren permisos basados en roles para las operaciones asíncronas](security_iam_id-based-policy-examples.md#auth-role-permissions).
## Detecte eventos mediante el AWS CLI
En el siguiente ejemplo, se muestra el uso de la [StartEventsDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartEventsDetectionJob.html)operación con AWS CLI
El ejemplo está formateado para Unix, Linux y macOS. Para Windows, sustituya la barra diagonal invertida (\$1) utilizada como carácter de continuación de Unix al final de cada línea por el signo de intercalación (^).
```
aws comprehend start-events-detection-job \
--region region \
--job-name job name \
--cli-input-json file://path to JSON input file
```
Para el parámetro de `cli-input-json`, debe proporcionar la ruta de un archivo JSON que contiene los datos de solicitud, como se muestra en el siguiente ejemplo.
```
{
"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"
]
}
```
Si la solicitud para iniciar el trabajo de detección de eventos se ha realizado correctamente, recibirá la siguiente respuesta:
```
{
"JobStatus": "SUBMITTED",
"JobId": "job ID"
}
```
## Enumere los eventos mediante el AWS CLI
Utilice la [ListEventsDetectionJobs](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_ListEventsDetectionJobs.html)operación para ver una lista de los trabajos de detección de eventos que ha enviado. La lista incluye información sobre las ubicaciones de entrada y salida que utilizó y el estado de cada uno de los trabajos de detección. El ejemplo está formateado para Unix, Linux y macOS. Para Windows, sustituya la barra diagonal invertida (\$1) utilizada como carácter de continuación de Unix al final de cada línea por el signo de intercalación (^).
```
aws comprehend list-events-detection-jobs --region region
```
Obtendrá una respuesta JSON similar a la siguiente en respuesta 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"
}
```
## Describa los eventos mediante el AWS CLI
Puede utilizar la [DescribeEventsDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribeEventsDetectionJob.html)operación para obtener el estado de un trabajo existente. El ejemplo está formateado para Unix, Linux y macOS. Para Windows, sustituya la barra diagonal invertida (\$1) utilizada como carácter de continuación de Unix al final de cada línea por el signo de intercalación (^).
```
aws comprehend describe-events-detection-job \
--region region \
--job-id job ID
```
Obtendrá el siguiente JSON similar en respuesta a:
```
{
"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"
]
}
}
```
## Cómo obtener los resultados de la detección de eventos
A continuación se muestra un ejemplo de un archivo de salida de un trabajo de análisis que detectó eventos en los documentos. El formato de entrada es de un documento por línea.
```
{"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 obtener más información sobre la estructura de los archivos de salida de los eventos y los tipos de evento admitidos, consulte [Events](how-events.md).
# Análisis asíncrono para el modelado de temas
Para determinar los temas de un conjunto de documentos, utilice el [StartTopicsDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartTopicsDetectionJob.html)para iniciar un trabajo asíncrono. Puede supervisar los temas de los documentos escritos en inglés o español.
**Topics**
+ [Antes de comenzar](#topics-before)
+ [Utilización del AWS Command Line Interface](#topics-cli)
+ [Uso del SDK para Python o SDK para .NET](#topic-java)
## Antes de comenzar
Antes de comenzar, asegúrese de que dispone de:
+ **Buckets de entrada y de salida**: identifique los buckets de Amazon S3 que quiere usar para la entrada y la salida. Los buckets deben estar situados en la misma región que la API a la cual está llamando.
+ **Rol de servicio de IAM**: debe tener un rol de servicio de IAM con permiso para acceder a sus buckets de entrada y salida. Para obtener más información, consulte [Se requieren permisos basados en roles para las operaciones asíncronas](security_iam_id-based-policy-examples.md#auth-role-permissions).
## Utilización del AWS Command Line Interface
En el siguiente ejemplo se muestra el uso de la `StartTopicsDetectionJob` operación con AWS CLI
El ejemplo está formateado para Unix, Linux y macOS. Para Windows, sustituya la barra diagonal invertida (\$1) utilizada como carácter de continuación de Unix al final de cada línea por el signo de intercalación (^).
```
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 el parámetro de `cli-input-json`, debe proporcionar la ruta de un archivo JSON que contiene los datos de solicitud, como se muestra en el siguiente ejemplo.
```
{
"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"
}
```
Si la solicitud para iniciar el trabajo de detección de eventos se ha realizado correctamente, recibirá la siguiente respuesta:
```
{
"JobStatus": "SUBMITTED",
"JobId": "job ID"
}
```
Utilice la [ListTopicsDetectionJobs](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_ListTopicsDetectionJobs.html)operación para ver una lista de los trabajos de detección de temas que ha enviado. La lista incluye información sobre las ubicaciones de entrada y salida que utilizó y el estado de cada uno de los trabajos de detección. El ejemplo está formateado para Unix, Linux y macOS. Para Windows, sustituya la barra diagonal invertida (\$1) utilizada como carácter de continuación de Unix al final de cada línea por el signo de intercalación (^).
```
aws comprehend list-topics-detection-jobs \-- region
```
Obtendrá una respuesta JSON similar a la siguiente en respuesta 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"
}
}
]
}
```
Puede utilizar la [DescribeTopicsDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribeTopicsDetectionJob.html)operación para obtener el estado de un trabajo existente. El ejemplo está formateado para Unix, Linux y macOS. Para Windows, sustituya la barra diagonal invertida (\$1) utilizada como carácter de continuación de Unix al final de cada línea por el signo de intercalación (^).
```
aws comprehend describe-topics-detection-job --job-id job ID
```
Obtendrá el siguiente JSON similar en respuesta a:
```
{
"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
}
}
```
## Uso del SDK para Python o SDK para .NET
Para ver ejemplos del SDK sobre cómo iniciar un trabajo de modelado de temas, consulte [Úselo `StartTopicsDetectionJob` con un AWS SDK o CLI](example_comprehend_StartTopicsDetectionJob_section.md).