Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.
# Esempi di utilizzo di Amazon Kendra AWS CLI
I seguenti esempi di codice mostrano come eseguire azioni e implementare scenari comuni utilizzando Amazon Kendra. AWS Command Line Interface
Le *azioni* sono estratti di codice da programmi più grandi e devono essere eseguite nel contesto. Sebbene le azioni mostrino come richiamare le singole funzioni del servizio, è possibile visualizzarle contestualizzate negli scenari correlati.
Ogni esempio include un link al codice sorgente completo, in cui vengono fornite le istruzioni su come configurare ed eseguire il codice nel contesto.
**Topics**
+ [Azioni](#actions)
## Azioni
### `create-data-source`
Il seguente esempio di codice mostra come usare. `create-data-source`
**AWS CLI**
**Come creare un connettore di origine dati Amazon Kendra**
L’esempio `create-data-source` seguente crea e configura un connettore di origine dati di Amazon Kendra. Puoi utilizzare `describe-data-source` per visualizzare lo stato di un connettore di origine dati e leggere eventuali messaggi di errore se lo stato indica che la creazione completa di un connettore di origine dati è “FAILED”.
```
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"]}'
```
Output:
```
{
"Id": "exampledatasource1"
}
```
Per ulteriori informazioni, consulta [Nozioni di base su un indice e un connettore dell’origine dati di Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/getting-started.html) nella *Guida per gli sviluppatori di Amazon Kendra*.
+ Per i dettagli sull'API, consulta [CreateDataSource AWS CLI](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kendra/create-data-source.html)*Command Reference*.
### `create-index`
Il seguente esempio di codice mostra come utilizzare`create-index`.
**AWS CLI**
**Come creare un indice Amazon Kendra**
Il comando `create-index` seguente crea e configura un indice di Amazon Kendra. Puoi utilizzare `describe-index` per visualizzare lo stato di un indice e leggere eventuali messaggi di errore se lo stato indica che la creazione completa di un indice è “FAILED”.
```
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"}}'
```
Output:
```
{
"Id": index1
}
```
Per ulteriori informazioni, consulta [Nozioni di base su un indice e un connettore dell’origine dati di Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/getting-started.html) nella *Guida per gli sviluppatori di Amazon Kendra*.
+ Per i dettagli sull'API, consulta [CreateIndex AWS CLI](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kendra/create-index.html)*Command Reference*.
### `describe-data-source`
Il seguente esempio di codice mostra come utilizzare`describe-data-source`.
**AWS CLI**
**Come ottenere informazioni su un connettore di origine dati Amazon Kendra**
Di seguito `describe-data-source` vengono fornite informazioni su un connettore di origine dati Amazon Kendra. Puoi visualizzare la configurazione di un connettore di origine dati e leggere eventuali messaggi di errore se lo stato indica che la creazione completa di un connettore di origine dati è “FAILED”.
```
aws kendra describe-data-source \
--id exampledatasource1 \
--index-id exampleindex1
```
Output:
```
{
"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"]
}
}
```
Per ulteriori informazioni, consulta [Nozioni di base su un indice e un connettore dell’origine dati di Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/getting-started.html) nella *Guida per gli sviluppatori di Amazon Kendra*.
+ Per i dettagli sull'API, consulta *AWS CLI Command [DescribeDataSource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kendra/describe-data-source.html)Reference*.
### `describe-index`
Il seguente esempio di codice mostra come utilizzare`describe-index`.
**AWS CLI**
**Come ottenere informazioni su un indice Amazon Kendra**
Il comando `describe-index` seguente fornisce informazioni su un indice Amazon Kendra. Puoi visualizzare la configurazione di un indice e leggere eventuali messaggi di errore se lo stato indica che la creazione completa di un indice è “FAILED”.
```
aws kendra describe-index \
--id exampleindex1
```
Output:
```
{
"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"
}
}
]
}
```
Per ulteriori informazioni, consulta [Nozioni di base su un indice e un connettore dell’origine dati di Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/getting-started.html) nella *Guida per gli sviluppatori di Amazon Kendra*.
+ Per i dettagli sull'API, consulta [DescribeIndex AWS CLI](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kendra/describe-index.html)*Command Reference*.
### `update-data-source`
Il seguente esempio di codice mostra come utilizzare`update-data-source`.
**AWS CLI**
**Come aggiornare un connettore di origine dati Amazon Kendra**
Il comando `update-data-source` seguente aggiorna la configurazione di un connettore di origine dati di Amazon Kendra. Se l'azione ha esito positivo, il servizio non restituisce alcun output, il codice di stato HTTP 200 o il codice restituito AWS CLI 0. È possibile utilizzare `describe-data-source` per visualizzare la configurazione e lo stato di un connettore di origine dati.
```
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"]}'
```
Questo comando non produce alcun output.
Per ulteriori informazioni, consulta [Nozioni di base su un indice e un connettore dell’origine dati di Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/getting-started.html) nella *Guida per gli sviluppatori di Amazon Kendra*.
+ Per i dettagli sull'API, consulta [UpdateDataSource AWS CLI](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kendra/update-data-source.html)*Command Reference.*
### `update-index`
Il seguente esempio di codice mostra come utilizzare`update-index`.
**AWS CLI**
**Come aggiornare un indice Amazon Kendra**
Il comando `update-index` seguente aggiorna la configurazione di un indice Amazon Kendra. Se l'azione ha esito positivo, il servizio non restituisce alcun output, il codice di stato HTTP 200 o il codice restituito AWS CLI 0. È possibile utilizzare `describe-index` per visualizzare la configurazione e lo stato di un indice.
```
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"}}'
```
Questo comando non produce alcun output.
Per ulteriori informazioni, consulta [Nozioni di base su un indice e un connettore dell’origine dati di Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/getting-started.html) nella *Guida per gli sviluppatori di Amazon Kendra*.
+ Per i dettagli sull'API, consulta [UpdateIndex AWS CLI](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kendra/update-index.html)*Command Reference.*