Respostas de consulta e tipos de resposta

Amazon Kendra oferece suporte a diferentes respostas de consulta e tipos de resposta.

Respostas de consulta

Uma chamada para a API de consulta retorna informações sobre os resultados de uma pesquisa. Os resultados estão em uma matriz de QueryResultItemobjetos (ResultItems). Cada um do QueryResultItem inclui um resumo do resultado. Os atributos do documento associados ao resultado da consulta estão incluídos.

Informações resumidas

As informações de resumo variam de acordo com o tipo de resultado. Em cada caso, ele inclui o texto do documento que corresponde ao termo de pesquisa. Também inclui informações de destaque que você poderá usar para destacar o texto de pesquisa na saída do seu aplicativo. Por exemplo, se o termo de pesquisa for qual é a altura do Space Needle? , as informações resumidas incluem a localização do texto para as palavras altura e agulha de espaço. Para obter mais informações sobre tipos de resposta, consulte Respostas de consulta e tipos de resposta.

Atributos do documento

Cada resultado contém atributos de documento para o documento que correspondem a uma consulta. Alguns dos atributos são predefinidos, como DocumentId, DocumentTitle e DocumentUri. Outros são atributos personalizados que você define. Use os atributos do documento para filtrar a resposta da API de Query. Por exemplo, talvez você queira somente os documentos escritos por um autor específico ou por uma versão específica de um documento. Para ter mais informações, consulte Filtragem e pesquisa de facetas. Você especifica os atributos do documento ao adicionar documentos a um índice. Para obter mais informações, consulte Campos ou atributos personalizados.

Veja a seguir um exemplo de código JSON para o resultado de uma consulta. Observe os atributos do documento em DocumentAttributes e AdditionalAttributes.

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

Tipos de resposta

Amazon Kendra retorna três tipos de resposta de consulta.

• Resposta (inclui resposta da tabela)

• Documento

• Perguntas e respostas

O tipo da resposta é retornado no campo de Type resposta do QueryResultItemobjeto.

Resposta

Amazon Kendra detectou uma ou mais respostas de pergunta na resposta. Um factóide é a resposta a uma pergunta sobre quem, o quê, quando ou onde, como Onde fica o centro de serviço mais próximo de mim?, o Amazon Kendra retorna o texto no índice que melhor corresponde à consulta. O texto está no campo AnswerText e contém informações de destaque para o termo de pesquisa no texto da resposta. A AnswerText inclui o trecho completo do documento com texto destacado, enquanto o DocumentExcerpt inclui o trecho do documento truncado (290 caracteres) com texto destacado.

Amazon Kendra retorna apenas uma resposta por documento, e essa é a resposta com a maior confiança. Para retornar várias respostas de um documento, divida o documento em vários documentos.

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

Documento

Amazon Kendra retorna documentos classificados para aqueles que correspondem ao termo de pesquisa. A classificação é baseada na confiança que Amazon Kendra se tem na precisão do resultado da pesquisa. As informações sobre o documento correspondente são retornadas no QueryResultItem. Inclui o título do documento. O trecho inclui informações de destaque para o texto de pesquisa e a seção de texto correspondente no documento. O URI para documentos correspondentes está no atributo SourceURI do documento. O exemplo de JSON a seguir mostra o resumo do documento correspondente.

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

Perguntas e respostas

Uma resposta de pergunta e resposta é retornada quando uma pergunta Amazon Kendra corresponde a uma das perguntas mais frequentes em seu índice. A resposta inclui a pergunta e a resposta correspondentes no QueryResultItemcampo. Também inclui informações de destaque para termos de consulta detectados na sequência de caracteres de consulta. O JSON a seguir mostra uma resposta de pergunta e resposta. Observe que a resposta inclui o texto da pergunta.

{
    '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?'
    }
}

Para obter informações sobre como adicionar texto de perguntas e respostas a um índice, consulte Criação de perguntas frequentes.