Réponses aux requêtes et types de réponses

Amazon Kendra prend en charge différentes réponses aux requêtes et types de réponses.

Réponses aux requêtes

Un appel à l'API Query renvoie des informations sur les résultats d'une recherche. Les résultats se trouvent dans un tableau d'QueryResultItemobjets (ResultItems). Chacune QueryResultItem inclut un résumé du résultat. Les attributs de document associés au résultat de la requête sont inclus.

Informations récapitulatives

Les informations récapitulatives varient en fonction du type de résultat. Dans chaque cas, il inclut le texte du document qui correspond au terme de recherche. Il inclut également des informations de surlignage que vous pouvez utiliser pour surligner le texte de recherche dans la sortie de votre application. Par exemple, si le terme de recherche est quelle est la hauteur de la Space Needle ? , les informations récapitulatives incluent l'emplacement du texte pour les mots hauteur et aiguille spatiale. Pour plus d'informations sur les types de réponse, consultezRéponses aux requêtes et types de réponses.

Attributs du document

Chaque résultat contient les attributs du document correspondant à une requête. Certains attributs sont prédéfinis, tels que DocumentIdDocumentTitle, etDocumentUri. Les autres sont des attributs personnalisés que vous définissez. Vous pouvez utiliser les attributs du document pour filtrer la réponse de l'QueryAPI. Par exemple, il se peut que vous souhaitiez uniquement les documents rédigés par un auteur spécifique ou une version spécifique d'un document. Pour plus d’informations, consultez Filtrage et recherche par facettes. Vous spécifiez les attributs du document lorsque vous ajoutez des documents à un index. Pour plus d'informations, consultez la section Champs ou attributs personnalisés.

Voici un exemple de code JSON pour le résultat d'une requête. Notez les attributs du document dans DocumentAttributes etAdditionalAttributes.

{
    "QueryId": "query-id",
    "ResultItems": [
        {
            "Id": "result-id",
            "Type": "ANSWER",
            "AdditionalAttributes": [
                {
                    "Key": "AnswerText",
                    "ValueType": "TEXT_WITH_HIGHLIGHTS_VALUE",
                    "Value": {
                        "TextWithHighlightsValue": {
                            "Text": "text",
                            "Highlights": [
                                {
                                    "BeginOffset": 55,
                                    "EndOffset": 90,
                                    "TopAnswer": false
                                }
                            ]
                        }
                    }
                }
            ],
            "DocumentId": "document-id",
            "DocumentTitle": {
                "Text": "title"
            },
            "DocumentExcerpt": {
                "Text": "text",
                "Highlights": [
                    {
                        "BeginOffset": 0,
                        "EndOffset": 300,
                        "TopAnswer": false
                    }
                ]
            },
            "DocumentURI": "uri",
            "DocumentAttributes": [],
            "ScoreAttributes": "score",
            "FeedbackToken": "token"
        },
        {
            "Id": "result-id",
            "Type": "ANSWER",
            "Format": "TABLE",
            "DocumentId": "document-id",
            "DocumentTitle": {
                "Text": "title"
            },
            "TableExcerpt": {
                "Rows": [{
                    "Cells": [{
                        "Header": true,
                        "Highlighted": false,
                        "TopAnswer": false,
                        "Value": "value"
                    }, {
                        "Header": true,
                        "Highlighted": false,
                        "TopAnswer": false,
                        "Value": "value"
                    }, {
                        "Header": true,
                        "Highlighted": false,
                        "TopAnswer": false,
                        "Value": "value"
                    }, {
                        "Header": true,
                        "Highlighted": false,
                        "TopAnswer": false,
                        "Value": "value"
                    }]
                }, {
                    "Cells": [{
                        "Header": false,
                        "Highlighted": false,
                        "TopAnswer": false,
                        "Value": "value"
                    }, {
                        "Header": false,
                        "Highlighted": false,
                        "TopAnswer": false,
                        "Value": "value"
                    }, {
                        "Header": false,
                        "Highlighted": true,
                        "TopAnswer": true,
                        "Value": "value"
                    }, {
                        "Header": false,
                        "Highlighted": false,
                        "TopAnswer": false,
                        "Value": "value"
                    ]}
                  }],
                    "TotalNumberofRows": number
			},
            "DocumentURI": "uri",
            "ScoreAttributes": "score",
            "FeedbackToken": "token"
        },
        {
            "Id": "result-id",
            "Type": "DOCUMENT",
            "AdditionalAttributes": [],
            "DocumentId": "document-id",
            "DocumentTitle": {
                "Text": "title",
                "Highlights": []
            },
            "DocumentExcerpt": {
                "Text": "text",
                "Highlights": [
                    {
                        "BeginOffset": 74,
                        "EndOffset": 77,
                        "TopAnswer": false
                    }
                ]
            },
            "DocumentURI": "uri",
            "DocumentAttributes": [
                {
                    "Key": "_source_uri",
                    "Value": {
                        "StringValue": "uri"
                    }
                }
            ],
            "ScoreAttributes": "score",
            "FeedbackToken": "token",
        }
    ],
    "FacetResults": [],
    "TotalNumberOfResults": number
}

Types de réponses

Amazon Kendra renvoie trois types de réponses à une requête.

• Réponse (inclut la réponse sous forme de tableau)

• Document

• Question/réponse

Le type de réponse est renvoyé dans le champ de Type réponse de l'QueryResultItemobjet.

Réponse

Amazon Kendra a détecté une ou plusieurs réponses à une question dans la réponse. Un factoïde est la réponse à une question qui, quoi, quand ou où, telle que Où se trouve le centre de service le plus proche de chez moi ? Amazon Kendra renvoie le texte dans l'index qui correspond le mieux à la requête. Le texte se trouve dans le AnswerText champ et contient des informations surlignées pour le terme de recherche dans le texte de réponse. AnswerTextinclut l'extrait complet du document avec le texte surligné, tandis qu'DocumentExcerptinclut l'extrait tronqué (290 caractères) avec le texte surligné.

Amazon Kendra ne renvoie qu'une seule réponse par document, et c'est la réponse la plus fiable. Pour renvoyer plusieurs réponses à partir d'un document, vous devez diviser le document en plusieurs documents.

{
    'AnswerText': {
        'TextWithHighlights': [
            {
                'BeginOffset': 271,
                'EndOffset': 279,
                'TopAnswer': False
            },
            {
                'BeginOffset': 481,
                'EndOffset': 489,
                'TopAnswer': False
            },
            {
                'BeginOffset': 547,
                'EndOffset': 555,
                'TopAnswer': False
            },
            {
                'BeginOffset': 764,
                'EndOffset': 772,
                'TopAnswer': False
            }
        ],
        'Text': 'Asynchronousoperationscan\n''alsoprocess\n''documentsthatareinPDF''format.UsingPDFformatfilesallowsyoutoprocess''multi-page\n''documents.\n''Forinformationabouthow''AmazonTextractrepresents\n''documentsasBlockobjects,
        ''seeDocumentsandBlockObjects.\n''\n''\n''\n''Forinformationaboutdocument''limits,
        seeLimitsinAmazonTextract.\n''\n''\n''\n''TheAmazonTextractsynchronous''operationscanprocessdocumentsstoredinanAmazon\n''S3Bucketoryoucanpass''base64encodedimagebytes.\n''Formoreinformation,
        see''CallingAmazonTextractSynchronousOperations.''Asynchronousoperationsrequireinputdocuments\n''tobesuppliedinanAmazon''S3Bucket.'
    },
    'DocumentExcerpt': {
        'Highlights': [
            {
                'BeginOffset': 0,
                'EndOffset': 300,
                'TopAnswer': False
            }
        ],
        'Text': 'Asynchronousoperationscan\n''alsoprocess\n''documentsthatareinPDF''format.UsingPDFformatfilesallowsyoutoprocess''multi-page\n''documents.\n''ForinformationabouthowAmazon''Textractrepresents\n'''
    },
    'Type': 'ANSWER'
}

Document

Amazon Kendra renvoie les documents classés pour ceux qui correspondent au terme de recherche. Le classement est basé sur la confiance accordée Amazon Kendra à l'exactitude des résultats de recherche. Les informations relatives au document correspondant sont renvoyées dans le QueryResultItem. Il inclut le titre du document. L'extrait inclut des informations de surlignage pour le texte de recherche et la section du texte correspondant dans le document. L'URI pour les documents correspondants se trouve dans l'attribut SourceURI document. L'exemple de code JSON suivant montre le résumé d'un document correspondant.

{
    'DocumentTitle': {
        'Highlights': [
            {
                'BeginOffset': 7,
                'EndOffset': 15,
                'TopAnswer': False
            },
            {
                'BeginOffset': 97,
                'EndOffset': 105,
                'TopAnswer': False
            }
        ],
        'Text': 'AmazonTextractAPIPermissions: Actions,
        \n''Permissions,
        andResourcesReference-''AmazonTextract'
    },
    'DocumentExcerpt': {
        'Highlights': [
            {
                'BeginOffset': 68,
                'EndOffset': 76,
                'TopAnswer': False
            },
            {
                'BeginOffset': 121,
                'EndOffset': 129,
                'TopAnswer': False
            }
        ],
        'Text': '...LoggingandMonitoring\tMonitoring\n''\tCloudWatchMetricsforAmazonTextract\n''\tLoggingAmazonTextractAPICallswithAWSCloudTrail\n''\tAPIReference\tActions\tAnalyzeDocument\n''\tDetectDocumentText\n''\tGetDocumentAnalysis...'
    },
    'Type': 'DOCUMENT'
}

Question/réponse

Une réponse aux questions et réponses est renvoyée lorsqu'une question Amazon Kendra correspond à l'une des questions fréquemment posées de votre index. La réponse inclut la question et la réponse correspondantes dans le QueryResultItemchamp. Il inclut également des informations de surlignage pour les termes de requête détectés dans la chaîne de requête. Le JSON suivant montre une réponse à une question et à une réponse. Notez que la réponse inclut le texte de la question.

{
    'AnswerText': {
        'TextWithHighlights': [
            
        ],
        'Text': '605feet'
    },
    'DocumentExcerpt': {
        'Highlights': [
            {
                'BeginOffset': 0,
                'EndOffset': 8,
                'TopAnswer': False
            }
        ],
        'Text': '605feet'
    },
    'Type': 'QUESTION_ANSWER',
    'QuestionText': {
        'Highlights': [
            {
                'BeginOffset': 12,
                'EndOffset': 18,
                'TopAnswer': False
            },
            {
                'BeginOffset': 26,
                'EndOffset': 31,
                'TopAnswer': False
            },
            {
                'BeginOffset': 32,
                'EndOffset': 38,
                'TopAnswer': False
            }
        ],
        'Text': 'whatistheheightoftheSpaceNeedle?'
    }
}

Pour plus d'informations sur l'ajout de texte de question et de réponse à un index, consultez la section Création d'une FAQ.