Beispiele für die Verwendung der AWS CLI mit Amazon Kendra

Die folgenden Codebeispiele zeigen, wie Sie Aktionen durchführen und gängige Szenarien implementieren, indem Sie das AWS Command Line Interface mit Amazon Kendra nutzen.

Aktionen sind Codeauszüge aus größeren Programmen und müssen im Kontext ausgeführt werden. Während Aktionen Ihnen zeigen, wie Sie einzelne Service-Funktionen aufrufen, können Sie Aktionen im Kontext der zugehörigen Szenarien anzeigen.

Jedes Beispiel enthält einen Link zum vollständigen Quellcode, wo Sie Anleitungen zum Einrichten und Ausführen des Codes im Kontext finden.

Themen

Aktionen

Aktionen

Das folgende Codebeispiel zeigt, wie create-data-source verwendet wird.

AWS CLI

So erstellen Sie einen Amazon-Kendra-Datenquellen-Konnektor

Mit dem folgenden create-data-source wird ein Amazon-Kendra-Datenquellen-Konnektor erstellt und konfiguriert. Mit describe-data-source können Sie den Status eines Datenquellen-Konnektors anzeigen und alle Fehlermeldungen lesen, wenn der Status anzeigt, dass ein Datenquellen-Konnektor nicht vollständig erstellt werden konnte („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"]}'

Ausgabe:


{
    "Id": "exampledatasource1"
}

Weitere Informationen finden Sie unter Erste Schritte mit einem Amazon-Kendra-Index und -Datenquellen-Konnektor im Entwicklerhandbuch zu Amazon Kendra.

API-Details finden Sie unter CreateDataSource in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie create-index verwendet wird.

AWS CLI

So erstellen Sie einen Amazon-Kendra-Index

Mit dem folgenden create-index wird ein Amazon-Kendra-Index konfiguriert. Mit describe-index können Sie den Status eines Indexes anzeigen und alle Fehlermeldungen lesen, wenn der Status anzeigt, dass ein Index nicht vollständig erstellt werden konnte („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"}}'

Ausgabe:


{
   "Id": index1
}

Weitere Informationen finden Sie unter Erste Schritte mit einem Amazon-Kendra-Index und -Datenquellen-Konnektor im Entwicklerhandbuch zu Amazon Kendra.

API-Details finden Sie unter CreateIndex in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie describe-data-source verwendet wird.

AWS CLI

So rufen Sie Informationen über einen Amazon Kendra-Datenquellen-Konnektor ab

Der folgende describe-data-source ruft Informationen zu einem Amazon Kendra-Datenquellen-Konnektor ab. Sie können die Konfiguration eines Datenquellen-Konnektors anzeigen und alle Fehlermeldungen lesen, wenn der Status anzeigt, dass ein Datenquellen-Konnektor nicht vollständig erstellt werden konnte („FAILED“).


aws kendra describe-data-source \
    --id exampledatasource1 \
    --index-id exampleindex1

Ausgabe:


{
    "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"]
    }
}

Weitere Informationen finden Sie unter Erste Schritte mit einem Amazon-Kendra-Index und -Datenquellen-Konnektor im Entwicklerhandbuch zu Amazon Kendra.

API-Details finden Sie unter DescribeDataSource in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie describe-index verwendet wird.

AWS CLI

So rufen Sie Informationen zu einem Amazon-Kendra-Index ab

Der folgende describe-index ruft Informationen zu einem Amazon-Kendra-Index ab. Sie können die Konfiguration eines Indexes anzeigen und alle Fehlermeldungen lesen, wenn der Status anzeigt, dass ein Index nicht vollständig erstellt werden konnte („FAILED“).


aws kendra describe-index \
    --id exampleindex1

Ausgabe:


{
    "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"
            }
        }
    ]
}

Weitere Informationen finden Sie unter Erste Schritte mit einem Amazon-Kendra-Index und -Datenquellen-Konnektor im Entwicklerhandbuch zu Amazon Kendra.

API-Details finden Sie unter DescribeIndex in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie update-data-source verwendet wird.

AWS CLI

So aktualisieren Sie einen Amazon-Kendra-Datenquellen-Konnektor

Mit dem folgenden update-data-source wird die Konfiguration eines Amazon-Kendra-Datenquellen-Konnektors aktualisiert. Wenn die Aktion erfolgreich ist, sendet der Service entweder keine Ausgabe, den HTTP-Statuscode 200 oder den AWS-CLI-Rückgabecode 0 zurück. Mit describe-data-source können Sie die Konfiguration und den Status eines Datenquellen-Konnektors anzeigen.


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"]}'

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Erste Schritte mit einem Amazon-Kendra-Index und -Datenquellen-Konnektor im Entwicklerhandbuch zu Amazon Kendra.

API-Details finden Sie unter UpdateDataSource in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie update-index verwendet wird.

AWS CLI

So aktualisieren Sie einen Amazon-Kendra-Index

Mit dem folgenden update-index wird die Konfiguration eines Amazon-Kendra-Index aktualisiert. Wenn die Aktion erfolgreich ist, sendet der Service entweder keine Ausgabe, den HTTP-Statuscode 200 oder den AWS-CLI-Rückgabecode 0 zurück. Mit describe-index können Sie die Konfiguration und den Status eines Indexes anzeigen.


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"}}'

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Erste Schritte mit einem Amazon-Kendra-Index und -Datenquellen-Konnektor im Entwicklerhandbuch zu Amazon Kendra.

API-Details finden Sie unter UpdateIndex in der AWS CLI-Befehlsreferenz.

Warnung JavaScript ist in Ihrem Browser nicht verfügbar oder deaktiviert.

Zur Nutzung der AWS-Dokumentation muss JavaScript aktiviert sein. Weitere Informationen finden auf den Hilfe-Seiten Ihres Browsers.

Dokumentkonventionen

Amazon-IVS-Streaming in Echtzeit

Kinesis