本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
查詢回應和回應類型
Amazon Kendra 支持不同的查詢響應和響應類型。
查詢回應
呼叫查詢 API 會傳回搜尋結果的相關資訊。結果位於QueryResultItem物件 (ResultItems
) 的陣列中。每個都QueryResultItem
包括結果的摘要。包括與查詢結果相關聯的文件屬性。
摘要資訊
摘要資訊會根據結果類型而有所不同。在每種情況下,它都包含符合搜尋字詞的文件文字。它還包括反白顯示資訊,您可以使用這些資訊在應用程式輸出中反白顯示搜尋文字。例如,如果搜索詞是太空針塔的高度是多少? ,摘要資訊包括字詞高度和太空針的文字位置。有關響應類型的更多內容,敬請參閱查詢回應和回應類型。
文件屬性
每個結果都包含符合查詢之文件的文件屬性。某些屬性是預先定義的DocumentId
,例如DocumentTitle
、和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 在回應中偵測到一個或多個問題答案。Factoid 是對誰,什麼,何時或在哪裡問題的回應,如哪裡是最近的服務中心給我? 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?' } }
如需將問題和答案文字新增至索引的詳細資訊,請參閱建立常見問題集。