Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
# Utilisation de l'API Amazon Comprehend
L'API Amazon Comprehend prend en charge les opérations d'analyse en temps réel (synchrone) et les opérations de démarrage et de gestion des tâches d'analyse asynchrones.
Vous pouvez utiliser directement les opérateurs d'API Amazon Comprehend, ou vous pouvez utiliser la CLI ou l'un des. SDKs Les exemples présentés dans ce chapitre utilisent la CLI, le SDK Python et le SDK Java.
Pour exécuter les exemples AWS CLI et Python, vous devez installer le AWS CLI. Pour de plus amples informations, veuillez consulter [Configurez le AWS Command Line Interface (AWS CLI)](setting-up.md#setup-awscli).
Pour exécuter les exemples Java, vous devez installer le AWS SDK pour Java. Pour obtenir des instructions relatives à l'installation du SDK pour Java, [consultez la section Configurer AWS le SDK](https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/setup.html) pour Java.
**Topics**
+ [Utilisation d'Amazon Comprehend avec un SDK AWS](sdk-general-information-section.md)
+ [Analyse en temps réel à l'aide de l'API](using-api-sync.md)
+ [Tâches d'analyse asynchrones à l'aide de l'API](api-async.md)
# Utilisation d'Amazon Comprehend avec un SDK AWS
AWS des kits de développement logiciel (SDKs) sont disponibles pour de nombreux langages de programmation courants. Chaque kit SDK fournit une API, des exemples de code et de la documentation qui facilitent la création d’applications par les développeurs dans leur langage préféré.
| Documentation SDK | Exemples de code |
| --- | --- |
| [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/sdk-for-cpp) | [AWS SDK pour C\$1\$1 exemples de code](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp) |
| [AWS CLI](https://docs.aws.amazon.com/cli) | [AWS CLI exemples de code](https://docs.aws.amazon.com/code-library/latest/ug/cli_2_code_examples.html) |
| [AWS SDK pour Go](https://docs.aws.amazon.com/sdk-for-go) | [AWS SDK pour Go exemples de code](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/gov2) |
| [AWS SDK pour Java](https://docs.aws.amazon.com/sdk-for-java) | [AWS SDK pour Java exemples de code](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2) |
| [AWS SDK pour JavaScript](https://docs.aws.amazon.com/sdk-for-javascript) | [AWS SDK pour JavaScript exemples de code](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3) |
| [AWS SDK pour Kotlin](https://docs.aws.amazon.com/sdk-for-kotlin) | [AWS SDK pour Kotlin exemples de code](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin) |
| [AWS SDK pour .NET](https://docs.aws.amazon.com/sdk-for-net) | [AWS SDK pour .NET exemples de code](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3) |
| [AWS SDK pour PHP](https://docs.aws.amazon.com/sdk-for-php) | [AWS SDK pour PHP exemples de code](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php) |
| [Outils AWS pour PowerShell](https://docs.aws.amazon.com/powershell) | [Outils AWS pour PowerShell exemples de code](https://docs.aws.amazon.com/code-library/latest/ug/powershell_5_code_examples.html) |
| [AWS SDK pour Python (Boto3)](https://docs.aws.amazon.com/pythonsdk) | [AWS SDK pour Python (Boto3) exemples de code](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python) |
| [AWS SDK pour Ruby](https://docs.aws.amazon.com/sdk-for-ruby) | [AWS SDK pour Ruby exemples de code](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/ruby) |
| [AWS SDK pour Rust](https://docs.aws.amazon.com/sdk-for-rust) | [AWS SDK pour Rust exemples de code](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1) |
| [AWS SDK pour SAP ABAP](https://docs.aws.amazon.com/sdk-for-sapabap) | [AWS SDK pour SAP ABAP exemples de code](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap) |
| [AWS SDK pour Swift](https://docs.aws.amazon.com/sdk-for-swift) | [AWS SDK pour Swift exemples de code](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/swift) |
**Exemple de disponibilité**
Vous n’avez pas trouvé ce dont vous avez besoin ? Demandez un exemple de code en utilisant le lien **Provide feedback (Fournir un commentaire)** en bas de cette page.
# Analyse en temps réel à l'aide de l'API
Les exemples suivants montrent comment utiliser l'API Amazon Comprehend pour une analyse en temps réel AWS CLI, en utilisant et AWS SDKs pour .NET, Java et Python. Utilisez les exemples pour en savoir plus sur les opérations synchrones d'Amazon Comprehend et comme éléments de base pour vos propres applications.
Les exemples .NET présentés dans cette section utilisent le kit [AWS SDK pour .NET](https://docs.aws.amazon.com/sdk-for-net/latest/developer-guide/welcome.html). Vous pouvez utiliser le [AWS Toolkit for Visual Studio](https://docs.aws.amazon.com/AWSToolkitVS/latest/UserGuide/welcome.html)pour développer des AWS applications à l'aide de .NET. Il inclut des modèles utiles et l' AWS explorateur pour le déploiement d'applications et la gestion des services. Pour connaître le point de vue des développeurs .NET AWS, consultez le [AWS guide destiné aux développeurs .NET](https://docs.aws.amazon.com/sdk-for-net/latest/developer-guide/welcome.html).
**Topics**
+ [Détecter la langue dominante](#get-started-api-dominant-language)
+ [Détection des entités nommées](#get-started-api-entities)
+ [Détecter les phrases clés](#get-started-api-key-phrases)
+ [Déterminer le sentiment](#get-started-api-sentiment)
+ [Analyse en temps réel pour un sentiment ciblé](#get-started-api-targeted-sentiment)
+ [Détection de la syntaxe](#get-started-api-syntax)
+ [Lot en temps réel APIs](#get-started-batch)
## Détecter la langue dominante
Pour déterminer la langue dominante utilisée dans le texte, utilisez l'[DetectDominantLanguage](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DetectDominantLanguage.html)opération. Pour détecter la langue dominante dans un maximum de 25 documents par lot, utilisez l'[BatchDetectDominantLanguage](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_BatchDetectDominantLanguage.html)opération. Pour de plus amples informations, veuillez consulter [Lot en temps réel APIs](#get-started-batch).
**Topics**
+ [À l'aide du AWS Command Line Interface](#get-started-api-dominant-language-cli)
+ [À l'aide du AWS SDK pour Java SDK pour Python, ou SDK pour .NET](#get-started-api-dominant-language-java)
### À l'aide du AWS Command Line Interface
L'exemple suivant montre comment utiliser l'`DetectDominantLanguage`opération avec le AWS CLI.
L'exemple est mis en forme pour Unix, Linux et macOS. Pour Windows, remplacez le caractère de continuation Unix, à savoir la barre oblique inversée (\$1), à la fin de chaque ligne par un accent circonflexe (^).
```
aws comprehend detect-dominant-language \
--region region \
--text "It is raining today in Seattle."
```
Amazon Comprehend répond comme suit :
```
{
"Languages": [
{
"LanguageCode": "en",
"Score": 0.9793661236763
}
]
}
```
### À l'aide du AWS SDK pour Java SDK pour Python, ou SDK pour .NET
Pour des exemples de SDK expliquant comment déterminer la langue dominante, consultez[Utilisation `DetectDominantLanguage` avec un AWS SDK ou une CLI](example_comprehend_DetectDominantLanguage_section.md).
## Détection des entités nommées
Pour déterminer les entités nommées dans un document, utilisez l'[DetectEntities](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DetectEntities.html)opération. Pour détecter des entités dans un maximum de 25 documents par lot, utilisez l'[BatchDetectEntities](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_BatchDetectEntities.html)opération. Pour de plus amples informations, veuillez consulter [Lot en temps réel APIs](#get-started-batch).
**Topics**
+ [À l'aide du AWS Command Line Interface](#get-started-api-entities-cli)
+ [À l'aide du AWS SDK pour Java SDK pour Python, ou SDK pour .NET](#get-started-api-entities-java)
### À l'aide du AWS Command Line Interface
L'exemple suivant illustre l'utilisation de l'`DetectEntities`opération à l'aide du AWS CLI. Vous devez spécifier la langue du texte saisi.
L'exemple est mis en forme pour Unix, Linux et macOS. Pour Windows, remplacez le caractère de continuation Unix, à savoir la barre oblique inversée (\$1), à la fin de chaque ligne par un accent circonflexe (^).
```
aws comprehend detect-entities \
--region region \
--language-code "en" \
--text "It is raining today in Seattle."
```
Amazon Comprehend répond comme suit :
```
{
"Entities": [
{
"Text": "today",
"Score": 0.97,
"Type": "DATE",
"BeginOffset": 14,
"EndOffset": 19
},
{
"Text": "Seattle",
"Score": 0.95,
"Type": "LOCATION",
"BeginOffset": 23,
"EndOffset": 30
}
],
"LanguageCode": "en"
}
```
### À l'aide du AWS SDK pour Java SDK pour Python, ou SDK pour .NET
Pour des exemples de SDK expliquant comment déterminer la langue dominante, consultez[Utilisation `DetectEntities` avec un AWS SDK ou une CLI](example_comprehend_DetectEntities_section.md).
## Détecter les phrases clés
Pour déterminer les phrases nominales clés utilisées dans le texte, utilisez l'[DetectKeyPhrases](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DetectKeyPhrases.html)opération. Pour détecter les phrases nominales clés dans un maximum de 25 documents par lot, utilisez cette [BatchDetectKeyPhrases](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_BatchDetectKeyPhrases.html)opération. Pour de plus amples informations, veuillez consulter [Lot en temps réel APIs](#get-started-batch).
**Topics**
+ [À l'aide du AWS Command Line Interface](#get-started-api-key-phrases-cli)
+ [À l'aide du AWS SDK pour Java SDK pour Python, ou SDK pour .NET](#get-started-api-key-phrases-java)
### À l'aide du AWS Command Line Interface
L'exemple suivant montre comment utiliser l'`DetectKeyPhrases`opération avec le AWS CLI. Vous devez spécifier la langue du texte saisi.
L'exemple est mis en forme pour Unix, Linux et macOS. Pour Windows, remplacez le caractère de continuation Unix, à savoir la barre oblique inversée (\$1), à la fin de chaque ligne par un accent circonflexe (^).
```
aws comprehend detect-key-phrases \
--region region \
--language-code "en" \
--text "It is raining today in Seattle."
```
Amazon Comprehend répond comme suit :
```
{
"LanguageCode": "en",
"KeyPhrases": [
{
"Text": "today",
"Score": 0.89,
"BeginOffset": 14,
"EndOffset": 19
},
{
"Text": "Seattle",
"Score": 0.91,
"BeginOffset": 23,
"EndOffset": 30
}
]
}
```
### À l'aide du AWS SDK pour Java SDK pour Python, ou SDK pour .NET
Pour des exemples de SDK qui détectent des phrases clés, consultez[Utilisation `DetectKeyPhrases` avec un AWS SDK ou une CLI](example_comprehend_DetectKeyPhrases_section.md).
## Déterminer le sentiment
Amazon Comprehend fournit les opérations d'API suivantes pour analyser les sentiments :
+ [DetectSentiment](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DetectSentiment.html)— Détermine le sentiment émotionnel général d'un document.
+ [BatchDetectSentiment](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_BatchDetectSentiment.html)— Déterminez le sentiment général d'un maximum de 25 documents par lot. Pour de plus amples informations, consultez [Lot en temps réel APIs](#get-started-batch).
+ [StartSentimentDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartSentimentDetectionJob.html)— Démarre une tâche de détection des sentiments asynchrone pour un ensemble de documents.
+ [ListSentimentDetectionJobs](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_ListSentimentDetectionJobs.html)— Renvoie la liste des tâches de détection des sentiments que vous avez soumises.
+ [DescribeSentimentDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribeSentimentDetectionJob.html)— Obtient les propriétés (y compris le statut) associées à la tâche de détection des sentiments spécifiée.
+ [StopSentimentDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StopSentimentDetectionJob.html)— Arrête la tâche d'évaluation des sentiments en cours spécifiée.
**Topics**
+ [À l'aide du AWS Command Line Interface](#get-started-api-sentiment-cli)
+ [À l'aide du AWS SDK pour Java SDK pour Python, ou SDK pour .NET](#get-started-api-sentiment-java)
### À l'aide du AWS Command Line Interface
L'exemple suivant montre comment utiliser l'`DetectSentiment`opération avec le AWS CLI. Cet exemple indique la langue du texte saisi.
L'exemple est mis en forme pour Unix, Linux et macOS. Pour Windows, remplacez le caractère de continuation Unix, à savoir la barre oblique inversée (\$1), à la fin de chaque ligne par un accent circonflexe (^).
```
aws comprehend detect-sentiment \
--region region \
--language-code "en" \
--text "It is raining today in Seattle."
```
Amazon Comprehend répond comme suit :
```
{
"SentimentScore": {
"Mixed": 0.014585512690246105,
"Positive": 0.31592071056365967,
"Neutral": 0.5985543131828308,
"Negative": 0.07093945890665054
},
"Sentiment": "NEUTRAL",
"LanguageCode": "en"
}
```
### À l'aide du AWS SDK pour Java SDK pour Python, ou SDK pour .NET
Pour des exemples de SDK qui déterminent le sentiment du texte saisi, voir[Utilisation `DetectSentiment` avec un AWS SDK ou une CLI](example_comprehend_DetectSentiment_section.md).
## Analyse en temps réel pour un sentiment ciblé
Amazon Comprehend fournit les opérations d'API suivantes pour une analyse ciblée des sentiments en temps réel :
+ [DetectTargetedSentiment](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DetectTargetedSentiment.html)— Analyse le sentiment des entités mentionnées dans un document.
+ [BatchDetectTargetedSentiment](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_BatchDetectTargetedSentiment.html)— Analyse le sentiment ciblé pour un maximum de 25 documents par lot. Pour de plus amples informations, consultez [Lot en temps réel APIs](#get-started-batch).
Si le texte que vous analysez n'inclut aucun sentiment ciblé[Types d’entités](how-targeted-sentiment.md#how-targeted-sentiment-entities), l'API renvoie un tableau d'entités vide.
### À l'aide du AWS Command Line Interface
L'exemple suivant montre comment utiliser l'`DetectTargetedSentiment`opération avec le AWS CLI. Cet exemple indique la langue du texte saisi.
L'exemple est mis en forme pour Unix, Linux et macOS. Pour Windows, remplacez le caractère de continuation Unix, à savoir la barre oblique inversée (\$1), à la fin de chaque ligne par un accent circonflexe (^).
```
aws comprehend detect-targeted-sentiment \
--region region \
--language-code "en" \
--text "The burger was cooked perfectly but it was cold. The service was OK."
```
Amazon Comprehend répond comme suit :
```
{
"Entities": [
{
"DescriptiveMentionIndex": [
0
],
"Mentions": [
{
"BeginOffset": 4,
"EndOffset": 10,
"Score": 1,
"GroupScore": 1,
"Text": "burger",
"Type": "OTHER",
"MentionSentiment": {
"Sentiment": "POSITIVE",
"SentimentScore": {
"Mixed": 0.001515,
"Negative": 0.000822,
"Neutral": 0.000243,
"Positive": 0.99742
}
}
},
{
"BeginOffset": 36,
"EndOffset": 38,
"Score": 0.999843,
"GroupScore": 0.999661,
"Text": "it",
"Type": "OTHER",
"MentionSentiment": {
"Sentiment": "NEGATIVE",
"SentimentScore": {
"Mixed": 0,
"Negative": 0.999996,
"Neutral": 0.000004,
"Positive": 0
}
}
}
]
},
{
"DescriptiveMentionIndex": [
0
],
"Mentions": [
{
"BeginOffset": 53,
"EndOffset": 60,
"Score": 1,
"GroupScore": 1,
"Text": "service",
"Type": "ATTRIBUTE",
"MentionSentiment": {
"Sentiment": "NEUTRAL",
"SentimentScore": {
"Mixed": 0.000033,
"Negative": 0.000089,
"Neutral": 0.993325,
"Positive": 0.006553
}
}
}
]
}
]
}
```
## Détection de la syntaxe
Pour analyser le texte afin d'extraire les mots individuels et de déterminer les parties du discours pour chaque mot, utilisez l'[DetectSyntax](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DetectSyntax.html)opération. Pour analyser la syntaxe d'un maximum de 25 documents par lot, utilisez l'[BatchDetectSyntax](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_BatchDetectSyntax.html)opération. Pour de plus amples informations, veuillez consulter [Lot en temps réel APIs](#get-started-batch).
**Topics**
+ [En utilisant le AWS Command Line Interface.](#get-started-api-syntax-cli)
+ [À l'aide du AWS SDK pour Java SDK pour Python, ou SDK pour .NET](#get-started-api-syntax-java)
### En utilisant le AWS Command Line Interface.
L'exemple suivant montre comment utiliser l'`DetectSyntax`opération avec le AWS CLI. Cet exemple indique la langue du texte saisi.
L'exemple est mis en forme pour Unix, Linux et macOS. Pour Windows, remplacez le caractère de continuation Unix, à savoir la barre oblique inversée (\$1), à la fin de chaque ligne par un accent circonflexe (^).
```
aws comprehend detect-syntax \
--region region \
--language-code "en" \
--text "It is raining today in Seattle."
```
Amazon Comprehend répond comme suit :
```
{
"SyntaxTokens": [
{
"Text": "It",
"EndOffset": 2,
"BeginOffset": 0,
"PartOfSpeech": {
"Tag": "PRON",
"Score": 0.8389829397201538
},
"TokenId": 1
},
{
"Text": "is",
"EndOffset": 5,
"BeginOffset": 3,
"PartOfSpeech": {
"Tag": "AUX",
"Score": 0.9189288020133972
},
"TokenId": 2
},
{
"Text": "raining",
"EndOffset": 13,
"BeginOffset": 6,
"PartOfSpeech": {
"Tag": "VERB",
"Score": 0.9977611303329468
},
"TokenId": 3
},
{
"Text": "today",
"EndOffset": 19,
"BeginOffset": 14,
"PartOfSpeech": {
"Tag": "NOUN",
"Score": 0.9993606209754944
},
"TokenId": 4
},
{
"Text": "in",
"EndOffset": 22,
"BeginOffset": 20,
"PartOfSpeech": {
"Tag": "ADP",
"Score": 0.9999061822891235
},
"TokenId": 5
},
{
"Text": "Seattle",
"EndOffset": 30,
"BeginOffset": 23,
"PartOfSpeech": {
"Tag": "PROPN",
"Score": 0.9940338730812073
},
"TokenId": 6
},
{
"Text": ".",
"EndOffset": 31,
"BeginOffset": 30,
"PartOfSpeech": {
"Tag": "PUNCT",
"Score": 0.9999997615814209
},
"TokenId": 7
}
]
}
```
### À l'aide du AWS SDK pour Java SDK pour Python, ou SDK pour .NET
Pour des exemples de SDK qui détectent la syntaxe du texte saisi, consultez[Utilisation `DetectSyntax` avec un AWS SDK ou une CLI](example_comprehend_DetectSyntax_section.md).
## Lot en temps réel APIs
Pour envoyer des lots contenant jusqu'à 25 documents, vous pouvez utiliser les opérations par lots en temps réel d'Amazon Comprehend. L'appel d'une opération par lots est identique à l'appel d'un seul document APIs pour chaque document de la demande. L'utilisation du lot APIs peut améliorer les performances de vos applications. Pour de plus amples informations, veuillez consulter [Traitement synchrone de plusieurs documents](concepts-processing-modes.md#how-batch).
**Topics**
+ [Traitement par lots avec AWS CLI](#batch-cli)
+ [Traitement par lots avec AWS SDK pour .NET](#batch-csharp)
### Traitement par lots avec AWS CLI
Ces exemples montrent comment utiliser les opérations d'API par lots à l'aide du AWS Command Line Interface. Toutes les opérations sauf l'`BatchDetectDominantLanguage`utilisation du fichier JSON suivant `process.json` appelé en entrée. Pour cette opération, l'`LanguageCode`entité n'est pas incluse.
Le troisième document du fichier JSON (`"$$$$$$$$"`) provoquera une erreur lors du traitement par lots. Il est inclus afin que les opérations incluent un [BatchItemError](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_BatchItemError.html)dans la réponse.
```
{
"LanguageCode": "en",
"TextList": [
"I have been living in Seattle for almost 4 years",
"It is raining today in Seattle",
"$$$$$$$$"
]
}
```
Les exemples sont formatés pour Unix, Linux et macOS. Pour Windows, remplacez le caractère de continuation Unix, à savoir la barre oblique inversée (\$1), à la fin de chaque ligne par un accent circonflexe (^).
**Topics**
+ [Détecter la langue dominante à l'aide d'un batch (AWS CLI)](#batch-dominant-language)
+ [Détecter les entités à l'aide d'un lot (AWS CLI)](#batch-entities)
+ [Détecter les phrases clés à l'aide d'un batch (AWS CLI)](#batch-key-phrase)
+ [Détectez les sentiments à l'aide d'un batch (AWS CLI)](#batch-sentiment)
#### Détecter la langue dominante à l'aide d'un batch (AWS CLI)
L'[BatchDetectDominantLanguage](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_BatchDetectDominantLanguage.html)opération détermine la langue dominante de chaque document d'un lot. Pour obtenir la liste des langues qu'Amazon Comprehend peut détecter, consultez. [Langue dominante](how-languages.md) La AWS CLI commande suivante lance l'`BatchDetectDominantLanguage`opération.
```
aws comprehend batch-detect-dominant-language \
--endpoint endpoint \
--region region \
--cli-input-json file://path to input file/process.json
```
Voici la réponse de l'`BatchDetectDominantLanguage`opération :
```
{
"ResultList": [
{
"Index": 0,
"Languages":[
{
"LanguageCode":"en",
"Score": 0.99
}
]
},
{
"Index": 1
"Languages":[
{
"LanguageCode":"en",
"Score": 0.82
}
]
}
],
"ErrorList": [
{
"Index": 2,
"ErrorCode": "InternalServerException",
"ErrorMessage": "Unexpected Server Error. Please try again."
}
]
}
```
#### Détecter les entités à l'aide d'un lot (AWS CLI)
Utilisez cette [BatchDetectEntities](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_BatchDetectEntities.html)opération pour rechercher les entités présentes dans un lot de documents. Pour plus d'informations sur les entités, consultez [Entités](how-entities.md). La AWS CLI commande suivante lance l'`BatchDetectEntities`opération.
```
aws comprehend batch-detect-entities \
--endpoint endpoint \
--region region \
--cli-input-json file://path to input file/process.json
```
#### Détecter les phrases clés à l'aide d'un batch (AWS CLI)
L'[BatchDetectKeyPhrases](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_BatchDetectKeyPhrases.html)opération renvoie les phrases nominales clés d'un lot de documents. La AWS CLI commande suivante lance l'`BatchDetectKeyNounPhrases`opération.
```
aws comprehend batch-detect-key-phrases
--endpoint endpoint
--region region
--cli-input-json file://path to input file/process.json
```
#### Détectez les sentiments à l'aide d'un batch (AWS CLI)
Détectez l'impression générale d'un lot de documents à l'aide de cette [BatchDetectSentiment](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_BatchDetectSentiment.html)opération. La AWS CLI commande suivante lance l'`BatchDetectSentiment`opération.
```
aws comprehend batch-detect-sentiment \
--endpoint endpoint \
--region region \
--cli-input-json file://path to input file/process.json
```
### Traitement par lots avec AWS SDK pour .NET
L'exemple de programme suivant montre comment utiliser l'[BatchDetectEntities](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_BatchDetectEntities.html)opération avec le SDK pour .NET. La réponse du serveur contient un [BatchDetectEntitiesItemResult](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_BatchDetectEntitiesItemResult.html)objet pour chaque document traité avec succès. En cas d'erreur lors du traitement d'un document, un enregistrement figurera dans la liste des erreurs de la réponse. L'exemple récupère chacun des documents contenant une erreur et les renvoie.
L'exemple .NET présenté dans cette section utilise le [AWS SDK pour .NET](https://docs.aws.amazon.com/sdk-for-net/latest/developer-guide/welcome.html). Vous pouvez utiliser le [AWS Toolkit for Visual Studio](https://docs.aws.amazon.com/AWSToolkitVS/latest/UserGuide/welcome.html)pour développer des AWS applications à l'aide de .NET. Il inclut des modèles utiles et l' AWS explorateur pour le déploiement d'applications et la gestion des services. Pour connaître le point de vue des développeurs .NET AWS, consultez le [AWS guide destiné aux développeurs .NET](https://docs.aws.amazon.com/sdk-for-net/latest/developer-guide/welcome.html).
```
using System;
using System.Collections.Generic;
using Amazon.Comprehend;
using Amazon.Comprehend.Model;
namespace Comprehend
{
class Program
{
// Helper method for printing properties
static private void PrintEntity(Entity entity)
{
Console.WriteLine(" Text: {0}, Type: {1}, Score: {2}, BeginOffset: {3} EndOffset: {4}",
entity.Text, entity.Type, entity.Score, entity.BeginOffset, entity.EndOffset);
}
static void Main(string[] args)
{
AmazonComprehendClient comprehendClient = new AmazonComprehendClient(Amazon.RegionEndpoint.USWest2);
List textList = new List()
{
{ "I love Seattle" },
{ "Today is Sunday" },
{ "Tomorrow is Monday" },
{ "I love Seattle" }
};
// Call detectEntities API
Console.WriteLine("Calling BatchDetectEntities");
BatchDetectEntitiesRequest batchDetectEntitiesRequest = new BatchDetectEntitiesRequest()
{
TextList = textList,
LanguageCode = "en"
};
BatchDetectEntitiesResponse batchDetectEntitiesResponse = comprehendClient.BatchDetectEntities(batchDetectEntitiesRequest);
foreach (BatchDetectEntitiesItemResult item in batchDetectEntitiesResponse.ResultList)
{
Console.WriteLine("Entities in {0}:", textList[item.Index]);
foreach (Entity entity in item.Entities)
PrintEntity(entity);
}
// check if we need to retry failed requests
if (batchDetectEntitiesResponse.ErrorList.Count != 0)
{
Console.WriteLine("Retrying Failed Requests");
List textToRetry = new List();
foreach(BatchItemError errorItem in batchDetectEntitiesResponse.ErrorList)
textToRetry.Add(textList[errorItem.Index]);
batchDetectEntitiesRequest = new BatchDetectEntitiesRequest()
{
TextList = textToRetry,
LanguageCode = "en"
};
batchDetectEntitiesResponse = comprehendClient.BatchDetectEntities(batchDetectEntitiesRequest);
foreach(BatchDetectEntitiesItemResult item in batchDetectEntitiesResponse.ResultList)
{
Console.WriteLine("Entities in {0}:", textList[item.Index]);
foreach (Entity entity in item.Entities)
PrintEntity(entity);
}
}
Console.WriteLine("End of DetectEntities");
}
}
}
```
# Tâches d'analyse asynchrones à l'aide de l'API
Les exemples suivants utilisent le système asynchrone Amazon Comprehend APIs pour créer et gérer des tâches d'analyse à l'aide du. AWS CLI
**Topics**
+ [Analyse asynchrone pour Amazon Comprehend Insights](api-async-insights.md)
+ [Analyse asynchrone pour un sentiment ciblé](using-api-targeted-sentiment.md)
+ [Analyse asynchrone pour la détection d'événements](get-started-api-events.md)
+ [Analyse asynchrone pour la modélisation de sujets](get-started-topics.md)
# Analyse asynchrone pour Amazon Comprehend Insights
Les sections suivantes utilisent l'API Amazon Comprehend pour exécuter des opérations asynchrones afin d'analyser les informations d'Amazon Comprehend.
**Topics**
+ [Conditions préalables](#detect-topics-role-auth)
+ [Démarrage d'une tâche d'analyse](#how-start-job)
+ [Tâches d'analyse de surveillance](#how-monitor-progress)
+ [Obtenir des résultats d'analyse](#how-get-results)
## Conditions préalables
Les documents doivent être dans des fichiers texte au format UTF-8. Vous pouvez soumettre vos documents dans deux formats. Le format que vous utilisez dépend du type de document que vous souhaitez analyser, comme décrit dans le tableau suivant.
| Description | Format |
| --- | --- |
| Chaque fichier contient un document d'entrée. C'est la meilleure solution pour les collections de documents volumineux. | Un document par fichier |
| L'entrée est un ou plusieurs fichiers. Chaque ligne d'un fichier est considérée comme un document. C'est la meilleure solution pour les documents courts, tels que les publications sur les réseaux sociaux. Chaque ligne doit se terminer par une ligne d'alimentation (LF,\$1n), un retour en chariot (CR, \$1 r), ou les deux (CRLF, \$1 r\$1n). Vous ne pouvez pas utiliser le séparateur de ligne UTF-8 (u\$12028) pour terminer une ligne. | Un document par ligne |
Lorsque vous démarrez une tâche d'analyse, vous spécifiez l'emplacement S3 de vos données d'entrée. L'URI doit se trouver dans la même AWS région que le point de terminaison de l'API que vous appelez. L'URI peut pointer vers un seul fichier ou être le préfixe d'un ensemble de fichiers de données. Pour plus d'informations, consultez le type de données [InputDataConfig](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_InputDataConfig.html).
Vous devez accorder à Amazon Comprehend l'accès au compartiment Amazon S3 qui contient votre collection de documents et vos fichiers de sortie. Pour de plus amples informations, veuillez consulter [Autorisations basées sur les rôles requises pour les opérations asynchrones](security_iam_id-based-policy-examples.md#auth-role-permissions).
## Démarrage d'une tâche d'analyse
Pour soumettre une tâche d'analyse, utilisez la console Amazon Comprehend ou l'opération appropriée `Start*` :
+ [StartDominantLanguageDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartDominantLanguageDetectionJob.html)— Lancez une tâche pour détecter la langue dominante dans chaque document de la collection. Pour plus d'informations sur la langue dominante d'un document, consultez[Langue dominante](how-languages.md).
+ [StartEntitiesDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartEntitiesDetectionJob.html)— Lancez une tâche pour détecter les entités dans chaque document de la collection. Pour plus d'informations sur les entités, consultez [Entités](how-entities.md).
+ [StartKeyPhrasesDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartKeyPhrasesDetectionJob.html)— Lancez une tâche pour détecter les phrases clés dans chaque document de la collection. Pour plus d'informations sur les phrases clés, voir[Phrases clés](how-key-phrases.md).
+ [StartPiiEntitiesDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartPiiEntitiesDetectionJob.html)— Commencez une tâche pour détecter les informations personnelles identifiables (PII) dans chaque document de la collection. Pour plus d'informations sur les informations personnelles, consultez[Détection des entités PII](how-key-phrases.md).
+ [StartSentimentDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartSentimentDetectionJob.html)— Lancez une tâche pour détecter le sentiment qui se dégage de chaque document de la collection. Pour plus d'informations sur les sentiments, voir[Sentiment](how-sentiment.md).
## Tâches d'analyse de surveillance
L'`Start*`opération renvoie un identifiant que vous pouvez utiliser pour suivre la progression de la tâche.
Pour suivre la progression à l'aide de l'API, vous pouvez effectuer l'une des deux opérations suivantes, selon que vous souhaitez suivre la progression d'une tâche individuelle ou de plusieurs tâches.
Pour suivre la progression d'une tâche d'analyse individuelle, utilisez les `Describe*` opérations. Vous fournissez l'ID de tâche renvoyé par l'`Start*`opération. La réponse de l'`Describe*`opération contient le `JobStatus` champ indiquant le statut de la tâche.
Pour suivre la progression de plusieurs tâches d'analyse, utilisez les `List*` opérations. `List*`les opérations renvoient une liste des tâches que vous avez soumises à Amazon Comprehend. La réponse inclut un `JobStatus` champ pour chaque tâche qui indique le statut de la tâche.
Si le champ d'état est défini sur `COMPLETED` ou`FAILED`, le traitement de la tâche est terminé.
Pour obtenir le statut de tâches individuelles, utilisez l'`Describe*`opération correspondant à l'analyse que vous effectuez.
+ [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)
Pour obtenir le statut de plusieurs tâches, utilisez l'`List*`opération correspondant à l'analyse que vous effectuez.
+ [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)
Pour limiter les résultats aux tâches qui répondent à certains critères, utilisez le `Filter` paramètre `List*` des opérations. Vous pouvez filtrer en fonction du nom de la tâche, de son statut, ainsi que de la date et de l'heure de soumission de la tâche. Pour plus d'informations, consultez le `Filter` paramètre de chacune des `List*` opérations dans la référence de l'API Amazon Comprehend.
## Obtenir des résultats d'analyse
Une fois le travail d'analyse terminé, utilisez une `Describe*` opération pour obtenir l'emplacement des résultats. Si le statut de la tâche est le suivant`COMPLETED`, la réponse inclut un `OutputDataConfig` champ contenant l'emplacement du fichier de sortie sur Amazon S3. Le fichier est une archive compressée qui contient les résultats de l'analyse. `output.tar.gz`
Si le statut d'une tâche est`FAILED`, la réponse contient un `Message` champ qui décrit la raison pour laquelle la tâche d'analyse ne s'est pas terminée correctement.
Pour obtenir le statut de chaque tâche, utilisez l'`Describe*`opération appropriée :
+ [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)
Les résultats sont renvoyés dans un seul fichier, avec une structure JSON pour chaque document. Chaque fichier de réponse inclut également des messages d'erreur pour toute tâche dont le champ d'état est défini sur`FAILED`.
Chacune des sections suivantes présente des exemples de sortie pour les deux formats d'entrée.
### Obtenir des résultats de détection de la langue dominante
Voici un exemple de fichier de sortie issu d'une analyse qui a détecté la langue dominante. Le format de l'entrée est d'un document par ligne. Pour plus d'informations, consultez l'[DetectDominantLanguage](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DetectDominantLanguage.html)opération.
```
{"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}
```
Voici un exemple de sortie d'une analyse où le format de l'entrée est d'un document par fichier :
```
{"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}]}
```
### Obtenir les résultats de détection des entités
Voici un exemple de fichier de sortie issu d'une analyse qui a détecté des entités dans des documents. Le format de l'entrée est d'un document par ligne. Pour plus d'informations, consultez l'[DetectEntities](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DetectEntities.html)opération. La sortie contient deux messages d'erreur, l'un pour un document trop long et l'autre pour un document qui n'est pas au format 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."}
```
Voici un exemple de sortie d'une analyse où le format de l'entrée est d'un document par fichier. La sortie contient deux messages d'erreur, l'un pour un document trop long et l'autre pour un document qui n'est pas au format 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."}
```
### Obtenir les résultats de détection des phrases clés
Voici un exemple de fichier de sortie issu d'une analyse qui a détecté des phrases clés dans un document. Le format de l'entrée est d'un document par ligne. Pour plus d'informations, consultez l'[DetectKeyPhrases](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DetectKeyPhrases.html)opération.
```
{"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}
```
Voici un exemple de sortie d'une analyse où le format de l'entrée est d'un document par fichier.
```
{"File": "1_doc", "KeyPhrases": [{"BeginOffset": 0, "EndOffset": 22, "Score": 0.8948641419410706, "Text": "Cluj-NapocaCluj-Napoca"}, {"BeginOffset": 45, "EndOffset": 49, "Score": 0.9989854693412781, "Text": "Cluj"}]}
```
### Obtenir les résultats de détection des informations personnelles identifiables (PII)
Voici un exemple de fichier de sortie issu d'une tâche d'analyse qui a détecté des entités PII dans des documents. Le format de l'entrée est d'un document par ligne.
```
{"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}
```
Voici un exemple de sortie d'une analyse où le format de l'entrée est d'un document par fichier.
```
{"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"}
```
### Obtenir des résultats de détection des sentiments
Voici un exemple de fichier de sortie issu d'une analyse qui a détecté le sentiment exprimé dans un document. Il inclut un message d'erreur car un document est trop long. Le format de l'entrée est d'un document par ligne. Pour plus d'informations, consultez l'[DetectSentiment](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DetectSentiment.html)opération.
```
{"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}}
```
Voici un exemple de sortie d'une analyse où le format de l'entrée est d'un document par fichier.
```
{"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."}
```
# Analyse asynchrone pour un sentiment ciblé
Pour plus d'informations sur l'analyse en temps réel du sentiment ciblé, consultez[Analyse en temps réel pour un sentiment ciblé](using-api-sync.md#get-started-api-targeted-sentiment).
Amazon Comprehend fournit les opérations d'API suivantes pour démarrer et gérer une analyse ciblée asynchrone des sentiments :
+ [StartTargetedSentimentDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartTargetedSentimentDetectionJob.html)— Démarre une tâche de détection ciblée asynchrone des sentiments pour un ensemble de documents.
+ [ListTargetedSentimentDetectionJobs](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_ListTargetedSentimentDetectionJobs.html)— Renvoie la liste des tâches de détection de sentiments ciblées que vous avez soumises.
+ [DescribeTargetedSentimentDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribeTargetedSentimentDetectionJob.html)— Obtient les propriétés (y compris le statut) associées à la tâche de détection de sentiments ciblée spécifiée.
+ [StopTargetedSentimentDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StopTargetedSentimentDetectionJob.html)— Arrête la tâche de sentiment ciblée en cours spécifiée.
**Topics**
+ [Avant de commencer](#api-targeted-sentiment-before)
+ [Analyser le sentiment ciblé à l'aide du AWS CLI](#api-targeted-sentiment-cli)
## Avant de commencer
Avant de commencer, assurez-vous que vous disposez des éléments suivants :
+ **Compartiments d'entrée et de sortie** : identifiez les compartiments Amazon S3 que vous souhaitez utiliser pour les entrées et les sorties. Les buckets doivent se trouver dans la même région que l'API que vous appelez.
+ **Rôle de service IAM** : vous devez disposer d'un rôle de service IAM autorisé à accéder à vos compartiments d'entrée et de sortie. Pour de plus amples informations, veuillez consulter [Autorisations basées sur les rôles requises pour les opérations asynchrones](security_iam_id-based-policy-examples.md#auth-role-permissions).
## Analyser le sentiment ciblé à l'aide du AWS CLI
L'exemple suivant montre comment utiliser l'`StartTargetedSentimentDetectionJob`opération avec le AWS CLI. Cet exemple indique la langue du texte saisi.
L'exemple est mis en forme pour Unix, Linux et macOS. Pour Windows, remplacez le caractère de continuation Unix, à savoir la barre oblique inversée (\$1), à la fin de chaque ligne par un accent circonflexe (^).
```
aws comprehend start-targeted-sentiment-detection-job \
--job-name "job name" \
--language-code "en" \
--cli-input-json file://path to JSON input file
```
Pour le `cli-input-json` paramètre, vous fournissez le chemin d'accès à un fichier JSON contenant les données de demande, comme illustré dans l'exemple suivant.
```
{
"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 demande de démarrage de la tâche a été acceptée, vous recevrez la réponse suivante :
```
{
"JobStatus": "SUBMITTED",
"JobArn": "job ARN"
"JobId": "job ID"
}
```
# Analyse asynchrone pour la détection d'événements
**Topics**
+ [Avant de commencer](#events-before)
+ [Détectez les événements à l'aide du AWS CLI](#events-cli)
+ [Répertoriez les événements en utilisant le AWS CLI](#list-events)
+ [Décrivez les événements à l'aide du AWS CLI](#describe-events)
+ [Obtenez les résultats de détection des événements](#async-events)
Pour détecter des événements dans un ensemble de documents, utilisez le [StartEventsDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartEventsDetectionJob.html)pour démarrer une tâche asynchrone.
## Avant de commencer
Avant de commencer, assurez-vous que vous disposez des éléments suivants :
+ **Compartiments d'entrée et de sortie** : identifiez les compartiments Amazon S3 que vous souhaitez utiliser pour les entrées et les sorties. Les buckets doivent se trouver dans la même région que l'API que vous appelez.
+ **Rôle de service IAM** : vous devez disposer d'un rôle de service IAM autorisé à accéder à vos compartiments d'entrée et de sortie. Pour de plus amples informations, veuillez consulter [Autorisations basées sur les rôles requises pour les opérations asynchrones](security_iam_id-based-policy-examples.md#auth-role-permissions).
## Détectez les événements à l'aide du AWS CLI
L'exemple suivant illustre l'utilisation de l'[StartEventsDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartEventsDetectionJob.html)opération avec AWS CLI
L'exemple est mis en forme pour Unix, Linux et macOS. Pour Windows, remplacez le caractère de continuation Unix, à savoir la barre oblique inversée (\$1), à la fin de chaque ligne par un accent circonflexe (^).
```
aws comprehend start-events-detection-job \
--region region \
--job-name job name \
--cli-input-json file://path to JSON input file
```
Pour le `cli-input-json` paramètre, vous fournissez le chemin d'accès à un fichier JSON contenant les données de demande, comme illustré dans l'exemple suivant.
```
{
"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 demande de démarrage de la tâche de détection des événements est réussie, vous recevrez la réponse suivante :
```
{
"JobStatus": "SUBMITTED",
"JobId": "job ID"
}
```
## Répertoriez les événements en utilisant le AWS CLI
Utilisez cette [ListEventsDetectionJobs](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_ListEventsDetectionJobs.html)opération pour voir la liste des tâches de détection d'événements que vous avez soumises. La liste inclut des informations sur les emplacements d'entrée et de sortie que vous avez utilisés et sur l'état de chacune des tâches de détection. L'exemple est mis en forme pour Unix, Linux et macOS. Pour Windows, remplacez le caractère de continuation Unix, à savoir la barre oblique inversée (\$1), à la fin de chaque ligne par un accent circonflexe (^).
```
aws comprehend list-events-detection-jobs --region region
```
Vous obtiendrez un JSON similaire à ce qui suit en réponse :
```
{
"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"
}
```
## Décrivez les événements à l'aide du AWS CLI
Vous pouvez utiliser cette [DescribeEventsDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribeEventsDetectionJob.html)opération pour obtenir le statut d'une tâche existante. L'exemple est mis en forme pour Unix, Linux et macOS. Pour Windows, remplacez le caractère de continuation Unix, à savoir la barre oblique inversée (\$1), à la fin de chaque ligne par un accent circonflexe (^).
```
aws comprehend describe-events-detection-job \
--region region \
--job-id job ID
```
Vous obtiendrez le JSON suivant en réponse :
```
{
"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"
]
}
}
```
## Obtenez les résultats de détection des événements
Voici un exemple de fichier de sortie issu d'une tâche d'analyse qui a détecté des événements dans des documents. Le format de l'entrée est d'un document par ligne.
```
{"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}
```
Pour plus d'informations sur la structure du fichier de sortie des événements et les types d'événements pris en charge, consultez[Événements](how-events.md).
# Analyse asynchrone pour la modélisation de sujets
Pour déterminer les sujets d'un ensemble de documents, utilisez le [StartTopicsDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_StartTopicsDetectionJob.html)pour démarrer une tâche asynchrone. Vous pouvez suivre des sujets dans des documents rédigés en anglais ou en espagnol.
**Topics**
+ [Avant de commencer](#topics-before)
+ [À l'aide du AWS Command Line Interface](#topics-cli)
+ [À l'aide du SDK pour Python ou SDK pour .NET](#topic-java)
## Avant de commencer
Avant de commencer, assurez-vous que vous disposez des éléments suivants :
+ **Compartiments d'entrée et de sortie** : identifiez les compartiments Amazon S3 que vous souhaitez utiliser pour les entrées et les sorties. Les buckets doivent se trouver dans la même région que l'API que vous appelez.
+ **Rôle de service IAM** : vous devez disposer d'un rôle de service IAM autorisé à accéder à vos compartiments d'entrée et de sortie. Pour de plus amples informations, veuillez consulter [Autorisations basées sur les rôles requises pour les opérations asynchrones](security_iam_id-based-policy-examples.md#auth-role-permissions).
## À l'aide du AWS Command Line Interface
L'exemple suivant illustre l'utilisation de l'`StartTopicsDetectionJob`opération avec AWS CLI
L'exemple est mis en forme pour Unix, Linux et macOS. Pour Windows, remplacez le caractère de continuation Unix, à savoir la barre oblique inversée (\$1), à la fin de chaque ligne par un accent circonflexe (^).
```
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
```
Pour le `cli-input-json` paramètre, vous fournissez le chemin d'accès à un fichier JSON contenant les données de demande, comme illustré dans l'exemple suivant.
```
{
"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 demande de démarrage de la tâche de détection de sujets aboutit, vous recevrez la réponse suivante :
```
{
"JobStatus": "SUBMITTED",
"JobId": "job ID"
}
```
Utilisez cette [ListTopicsDetectionJobs](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_ListTopicsDetectionJobs.html)opération pour afficher la liste des tâches de détection de sujets que vous avez soumises. La liste inclut des informations sur les emplacements d'entrée et de sortie que vous avez utilisés et sur l'état de chacune des tâches de détection. L'exemple est mis en forme pour Unix, Linux et macOS. Pour Windows, remplacez le caractère de continuation Unix, à savoir la barre oblique inversée (\$1), à la fin de chaque ligne par un accent circonflexe (^).
```
aws comprehend list-topics-detection-jobs \-- region
```
Vous obtiendrez un JSON similaire à ce qui suit en réponse :
```
{
"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"
}
}
]
}
```
Vous pouvez utiliser cette [DescribeTopicsDetectionJob](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribeTopicsDetectionJob.html)opération pour obtenir le statut d'une tâche existante. L'exemple est mis en forme pour Unix, Linux et macOS. Pour Windows, remplacez le caractère de continuation Unix, à savoir la barre oblique inversée (\$1), à la fin de chaque ligne par un accent circonflexe (^).
```
aws comprehend describe-topics-detection-job --job-id job ID
```
Vous obtiendrez le JSON suivant en réponse :
```
{
"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
}
}
```
## À l'aide du SDK pour Python ou SDK pour .NET
Pour obtenir des exemples de SDK expliquant comment démarrer une tâche de modélisation de rubriques, consultez[Utilisation `StartTopicsDetectionJob` avec un AWS SDK ou une CLI](example_comprehend_StartTopicsDetectionJob_section.md).