D'autres exemples de AWS SDK sont disponibles dans le référentiel [AWS Doc SDK Examples](https://github.com/awsdocs/aws-doc-sdk-examples) GitHub .
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.
# Exemples d'utilisation d'Amazon Kendra AWS CLI
Les exemples de code suivants vous montrent comment effectuer des actions et implémenter des scénarios courants à l' AWS Command Line Interface aide d'Amazon Kendra.
Les *actions* sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Alors que les actions vous indiquent comment appeler des fonctions de service individuelles, vous pouvez les voir en contexte dans leurs scénarios associés.
Chaque exemple inclut un lien vers le code source complet, où vous trouverez des instructions sur la configuration et l’exécution du code en contexte.
**Topics**
+ [Actions](#actions)
## Actions
### `create-data-source`
L'exemple de code suivant montre comment utiliser`create-data-source`.
**AWS CLI**
**Pour créer un connecteur de source de données Amazon Kendra**
`create-data-source` ci-dessous crée et configure un connecteur de source de données Amazon Kendra. Vous pouvez utiliser `describe-data-source` pour afficher le statut d’un connecteur de source de données et lire tout message d’erreur si le statut indique que la création complète d’un connecteur de source de données a « ÉCHOUÉ ».
```
aws kendra create-data-source \
--name "example data source 1" \
--description "Example data source 1 for example index 1 contains the first set of example documents" \
--tags '{"Key": "test resources", "Value": "kendra"}, {"Key": "test resources", "Value": "aws"}' \
--role-arn "arn:aws:iam::my-account-id:role/KendraRoleForS3TemplateConfigDataSource" \
--index-id exampleindex1 \
--language-code "es" \
--schedule "0 0 18 ? * TUE,MON,WED,THU,FRI,SAT *" \
--configuration '{"TemplateConfiguration": {"Template": file://s3schemaconfig.json}}' \
--type "TEMPLATE" \
--custom-document-enrichment-configuration '{"PostExtractionHookConfiguration": {"LambdaArn": "arn:aws:iam::my-account-id:function/my-function-ocr-docs", "S3Bucket": "s3://amzn-s3-demo-bucket/scanned-image-text-example-docs"}, "RoleArn": "arn:aws:iam:my-account-id:role/KendraRoleForCDE"}' \
--vpc-configuration '{"SecurityGroupIds": ["sg-1234567890abcdef0"], "SubnetIds": ["subnet-1c234","subnet-2b134"]}'
```
Sortie :
```
{
"Id": "exampledatasource1"
}
```
Pour plus d’informations, consultez [Premiers pas avec un index et un connecteur de source de données Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/getting-started.html) dans le *Guide du développeur Amazon Kendra*.
+ Pour plus de détails sur l'API, reportez-vous [CreateDataSource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kendra/create-data-source.html)à la section *Référence des AWS CLI commandes*.
### `create-index`
L'exemple de code suivant montre comment utiliser`create-index`.
**AWS CLI**
**Pour créer un index Amazon Kendra**
`create-index` ci-dessous crée et configure un index Amazon Kendra. Vous pouvez utiliser `describe-index` pour afficher le statut d’un index et lire tout message d’erreur si le statut indique que la création complète d’un index a « ÉCHOUÉ ».
```
aws kendra create-index \
--name "example index 1" \
--description "Example index 1 contains the first set of example documents" \
--tags '{"Key": "test resources", "Value": "kendra"}, {"Key": "test resources", "Value": "aws"}' \
--role-arn "arn:aws:iam::my-account-id:role/KendraRoleForExampleIndex" \
--edition "DEVELOPER_EDITION" \
--server-side-encryption-configuration '{"KmsKeyId": "my-kms-key-id"}' \
--user-context-policy "USER_TOKEN" \
--user-token-configurations '{"JsonTokenTypeConfiguration": {"GroupAttributeField": "groupNameField", "UserNameAttributeField": "userNameField"}}'
```
Sortie :
```
{
"Id": index1
}
```
Pour plus d’informations, consultez [Premiers pas avec un index et un connecteur de source de données Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/getting-started.html) dans le *Guide du développeur Amazon Kendra*.
+ Pour plus de détails sur l'API, reportez-vous [CreateIndex](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kendra/create-index.html)à la section *Référence des AWS CLI commandes*.
### `describe-data-source`
L'exemple de code suivant montre comment utiliser`describe-data-source`.
**AWS CLI**
**Pour obtenir des informations sur un connecteur de source de données Amazon Kendra**
Vous trouverez ci-dessous `describe-data-source` des informations sur un connecteur de source de données Amazon Kendra. Vous pouvez afficher la configuration d’un connecteur de source de données et lire tout message d’erreur si le statut indique que la création complète d’un connecteur de source de données a « ÉCHOUÉ ».
```
aws kendra describe-data-source \
--id exampledatasource1 \
--index-id exampleindex1
```
Sortie :
```
{
"Configuration": {
"TemplateConfiguration": {
"Template": {
"connectionConfiguration": {
"repositoryEndpointMetadata": {
"BucketName": "amzn-s3-demo-bucket"
}
},
"repositoryConfigurations": {
"document":{
"fieldMappings": [
{
"indexFieldName":"_document_title",
"indexFieldType":"STRING",
"dataSourceFieldName": "title"
},
{
"indexFieldName":"_last_updated_at",
"indexFieldType":"DATE",
"dataSourceFieldName": "modified_date"
}
]
}
},
"additionalProperties": {
"inclusionPatterns": [
"*.txt",
"*.doc",
"*.docx"
],
"exclusionPatterns": [
"*.json"
],
"inclusionPrefixes": [
"PublicExampleDocsFolder"
],
"exclusionPrefixes": [
"PrivateDocsFolder/private"
],
"aclConfigurationFilePath": "ExampleDocsFolder/AclConfig.json",
"metadataFilesPrefix": "metadata"
},
"syncMode": "FULL_CRAWL",
"type" : "S3",
"version": "1.0.0"
}
}
},
"CreatedAt": 2024-02-25T13:30:10+00:00,
"CustomDocumentEnrichmentConfiguration": {
"PostExtractionHookConfiguration": {
"LambdaArn": "arn:aws:iam::my-account-id:function/my-function-ocr-docs",
"S3Bucket": "s3://amzn-s3-demo-bucket/scanned-image-text-example-docs/function"
},
"RoleArn": "arn:aws:iam:my-account-id:role/KendraRoleForCDE"
}
"Description": "Example data source 1 for example index 1 contains the first set of example documents",
"Id": exampledatasource1,
"IndexId": exampleindex1,
"LanguageCode": "en",
"Name": "example data source 1",
"RoleArn": "arn:aws:iam::my-account-id:role/KendraRoleForS3TemplateConfigDataSource",
"Schedule": "0 0 18 ? * TUE,MON,WED,THU,FRI,SAT *",
"Status": "ACTIVE",
"Type": "TEMPLATE",
"UpdatedAt": 1709163615,
"VpcConfiguration": {
"SecurityGroupIds": ["sg-1234567890abcdef0"],
"SubnetIds": ["subnet-1c234","subnet-2b134"]
}
}
```
Pour plus d’informations, consultez [Premiers pas avec un index et un connecteur de source de données Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/getting-started.html) dans le *Guide du développeur Amazon Kendra*.
+ Pour plus de détails sur l'API, reportez-vous [DescribeDataSource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kendra/describe-data-source.html)à la section *Référence des AWS CLI commandes*.
### `describe-index`
L'exemple de code suivant montre comment utiliser`describe-index`.
**AWS CLI**
**Pour obtenir les informations sur un index Amazon Kendra**
`describe-index` ci-dessous obtient des informations sur un index Amazon Kendra. Vous pouvez afficher la configuration d’un index et lire tout message d’erreur si le statut indique que la création complète d’un index a « ÉCHOUÉ ».
```
aws kendra describe-index \
--id exampleindex1
```
Sortie :
```
{
"CapacityUnits": {
"QueryCapacityUnits": 0,
"StorageCapacityUnits": 0
},
"CreatedAt": 2024-02-25T12:30:10+00:00,
"Description": "Example index 1 contains the first set of example documents",
"DocumentMetadataConfigurations": [
{
"Name": "_document_title",
"Relevance": {
"Importance": 8
},
"Search": {
"Displayable": true,
"Facetable": false,
"Searchable": true,
"Sortable": false
},
"Type": "STRING_VALUE"
},
{
"Name": "_document_body",
"Relevance": {
"Importance": 5
},
"Search": {
"Displayable": true,
"Facetable": false,
"Searchable": true,
"Sortable": false
},
"Type": "STRING_VALUE"
},
{
"Name": "_last_updated_at",
"Relevance": {
"Importance": 6,
"Duration": "2628000s",
"Freshness": true
},
"Search": {
"Displayable": true,
"Facetable": false,
"Searchable": true,
"Sortable": true
},
"Type": "DATE_VALUE"
},
{
"Name": "department_custom_field",
"Relevance": {
"Importance": 7,
"ValueImportanceMap": {
"Human Resources" : 4,
"Marketing and Sales" : 2,
"Research and innvoation" : 3,
"Admin" : 1
}
},
"Search": {
"Displayable": true,
"Facetable": true,
"Searchable": true,
"Sortable": true
},
"Type": "STRING_VALUE"
}
],
"Edition": "DEVELOPER_EDITION",
"Id": "index1",
"IndexStatistics": {
"FaqStatistics": {
"IndexedQuestionAnswersCount": 10
},
"TextDocumentStatistics": {
"IndexedTextBytes": 1073741824,
"IndexedTextDocumentsCount": 1200
}
},
"Name": "example index 1",
"RoleArn": "arn:aws:iam::my-account-id:role/KendraRoleForExampleIndex",
"ServerSideEncryptionConfiguration": {
"KmsKeyId": "my-kms-key-id"
},
"Status": "ACTIVE",
"UpdatedAt": 1709163615,
"UserContextPolicy": "USER_TOKEN",
"UserTokenConfigurations": [
{
"JsonTokenTypeConfiguration": {
"GroupAttributeField": "groupNameField",
"UserNameAttributeField": "userNameField"
}
}
]
}
```
Pour plus d’informations, consultez [Premiers pas avec un index et un connecteur de source de données Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/getting-started.html) dans le *Guide du développeur Amazon Kendra*.
+ Pour plus de détails sur l'API, reportez-vous [DescribeIndex](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kendra/describe-index.html)à la section *Référence des AWS CLI commandes*.
### `update-data-source`
L'exemple de code suivant montre comment utiliser`update-data-source`.
**AWS CLI**
**Pour mettre à jour un connecteur de source de données Amazon Kendra**
`update-data-source` met à jour la configuration d’un connecteur de source de données Amazon Kendra. Si l'action aboutit, le service ne renvoie aucune sortie, soit le code d'état HTTP 200, soit le code de retour 0 de la AWS CLI. Vous pouvez utiliser `describe-data-source` pour afficher la configuration et le statut d’un connecteur de source de données.
```
aws kendra update-data-source \
--id exampledatasource1 \
--index-id exampleindex1 \
--name "new name for example data source 1" \
--description "new description for example data source 1" \
--role-arn arn:aws:iam::my-account-id:role/KendraNewRoleForExampleDataSource \
--configuration '{"TemplateConfiguration": {"Template": file://s3schemanewconfig.json}}' \
--custom-document-enrichment-configuration '{"PostExtractionHookConfiguration": {"LambdaArn": "arn:aws:iam::my-account-id:function/my-function-ocr-docs", "S3Bucket": "s3://amzn-s3-demo-bucket/scanned-image-text-example-docs"}, "RoleArn": "arn:aws:iam:my-account-id:role/KendraNewRoleForCDE"}' \
--language-code "es" \
--schedule "0 0 18 ? * MON,WED,FRI *" \
--vpc-configuration '{"SecurityGroupIds": ["sg-1234567890abcdef0"], "SubnetIds": ["subnet-1c234","subnet-2b134"]}'
```
Cette commande ne produit aucune sortie.
Pour plus d’informations, consultez [Premiers pas avec un index et un connecteur de source de données Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/getting-started.html) dans le *Guide du développeur Amazon Kendra*.
+ Pour plus de détails sur l'API, reportez-vous [UpdateDataSource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kendra/update-data-source.html)à la section *Référence des AWS CLI commandes*.
### `update-index`
L'exemple de code suivant montre comment utiliser`update-index`.
**AWS CLI**
**Pour mettre à jour un index Amazon Kendra**
`update-index` met à jour la configuration d’un index Amazon Kendra. Si l'action aboutit, le service ne renvoie aucune sortie, soit le code d'état HTTP 200, soit le code de retour 0 de la AWS CLI. Vous pouvez utiliser `describe-index` pour afficher la configuration et le statut d’un index.
```
aws kendra update-index \
--id enterpriseindex1 \
--name "new name for Enterprise Edition index 1" \
--description "new description for Enterprise Edition index 1" \
--role-arn arn:aws:iam::my-account-id:role/KendraNewRoleForEnterpriseIndex \
--capacity-units '{"QueryCapacityUnits": 2, "StorageCapacityUnits": 1}' \
--document-metadata-configuration-updates '{"Name": "_document_title", "Relevance": {"Importance": 6}}, {"Name": "_last_updated_at", "Relevance": {"Importance": 8}}' \
--user-context-policy "USER_TOKEN" \
--user-token-configurations '{"JsonTokenTypeConfiguration": {"GroupAttributeField": "groupNameField", "UserNameAttributeField": "userNameField"}}'
```
Cette commande ne produit aucune sortie.
Pour plus d’informations, consultez [Premiers pas avec un index et un connecteur de source de données Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/getting-started.html) dans le *Guide du développeur Amazon Kendra*.
+ Pour plus de détails sur l'API, reportez-vous [UpdateIndex](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kendra/update-index.html)à la section *Référence des AWS CLI commandes*.