查询响应和响应类型 - Amazon Kendra

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

查询响应和响应类型

Amazon Kendra 支持不同的查询响应和响应类型。

查询响应

调用 Query API 会返回有关搜索结果的信息。结果以QueryResultItem对象数组 (ResultItems) 的形式出现。每QueryResultItem份都包含结果摘要。包括与查询结果关联的文档属性。

摘要信息

摘要信息因结果类型而异。在每种情况下,它都包含与搜索词匹配的文档文本。它还包括突出显示信息,可用于突出显示应用程序输出中的搜索文本。例如,如果搜索词是太空针塔的高度是多少? ,摘要信息包括高度和太空针塔这两个词的文本位置。有关响应卡的信息,请参阅 查询响应和响应类型

文档属性

每个结果都包含与查询相匹配的文档的文档属性。有些属性是预定义的,例如DocumentIdDocumentTitle、和DocumentUri。其他属性是您定义的自定义属性。您可以使用文档属性来筛选来自 Query API 的响应。例如,您可能只需要由特定作者撰写的文档或文档的特定版本。有关更多信息,请参阅 筛选和分面搜索。在向索引中添加文档时,可以指定文档属性。有关更多信息,请参阅自定义字段和属性

以下是查询结果的 JSON 代码示例。请注意DocumentAttributes和中的文档属性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 }

响应时间

Amazon Kendra 返回三种类型的查询响应。

  • 答案(包括表格答案)

  • 文档

  • 问答

响应的类型将在QueryResultItem对象的Type响应字段中返回。

回答

Amazon Kendra 在响应中检测到一个或多个问题答案。事实是对谁、什么、何时或何地问题的回应,例如离我最近的服务中心在哪里? Amazon Kendra 返回索引中与查询最匹配的文本。文本位于AnswerText字段中,并在响应文本中包含搜索词的突出显示信息。 AnswerText包括带有突出显示文本的完整文档摘录,同时DocumentExcerpt包括带有突出显示文本的截断(290 个字符)文档摘录。

Amazon Kendra 每个文档只返回一个答案,这是可信度最高的答案。要从一个文档返回多个答案,必须将该文档拆分为多个文档。

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

文档

Amazon Kendra 返回与搜索词匹配的文档的排名文档。排名基于对搜索结果准确性的 Amazon Kendra 置信度。有关匹配文档的信息将在中返回QueryResultItem。它包括文档标题。摘录包括搜索文本的突出显示信息以及文档中匹配文本的部分。匹配文档的 URI 位于SourceURI文档属性中。以下示例 JSON 显示了匹配文档的文档摘要。

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

问答

当一个问题与索引中的一个常见问题 Amazon Kendra 匹配时,将返回问答响应。答案包括QueryResultItem字段中匹配的问题和答案。它还包括查询字符串中检测到的查询词的突出显示信息。以下 JSON 显示了问题和答案的回答。请注意,答案中包含问题文本。

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

有关向索引添加问题和答案文本的信息,请参阅创建常见问题解答