本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# 查詢回應和回應類型
<a name="query-responses-types"></a>

**注意**  
功能支援會因索引類型和正在使用的搜尋 API 而有所不同。若要查看您正在使用的索引類型和搜尋 API 是否支援此功能，請參閱[索引類型](https://docs.aws.amazon.com/kendra/latest/dg/hiw-index-types.html)。

Amazon Kendra 支援不同的查詢回應和回應類型。

## 查詢回應
<a name="query-responses"></a>

對[查詢](https://docs.aws.amazon.com/kendra/latest/APIReference/API_Query.html) API 的呼叫會傳回有關搜尋結果的資訊。結果位於 [QueryResultItem](https://docs.aws.amazon.com/kendra/latest/APIReference/API_QueryResultItem.html) 物件的陣列中 (`ResultItems`)。每個 都`QueryResultItem`包含結果的摘要。包含與查詢結果相關聯的文件屬性。

**摘要資訊**  
摘要資訊會根據結果類型而有所不同。在每個案例中，都包含符合搜尋詞彙的文件文字。它還包含反白資訊，您可以用來反白應用程式輸出中的搜尋文字。例如，如果搜尋詞*是 Space Needle 的高度？*，則摘要資訊會包含文字*高度*和*空格針*的文字位置。如需回應類型的資訊，請參閱 [查詢回應和回應類型](#query-responses-types)。

**文件屬性**  
每個結果都包含符合查詢之文件的文件屬性。某些屬性是預先定義的，例如 `DocumentId`、 `DocumentTitle`和 `DocumentUri`。其他則是您定義的自訂屬性。您可以使用文件屬性來篩選`Query`來自 API 的回應。例如，您可能只想要特定作者撰寫的文件或特定版本的文件。如需詳細資訊，請參閱[篩選和面向搜尋](filtering.md)。將文件新增至索引時，您可以指定文件屬性。如需詳細資訊，請參閱[自訂欄位或屬性](https://docs.aws.amazon.com/kendra/latest/dg/custom-attributes.html)。

以下是查詢結果的範例 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
}
```

## 回應類型
<a name="response-types"></a>

Amazon Kendra 傳回三種類型的查詢回應。
+ 答案 （包括資料表答案）
+ 文件
+ 問題和解答

回應的類型會在 [QueryResultItem](https://docs.aws.amazon.com/kendra/latest/APIReference/API_QueryResultItem.html) 物件的`Type`回應欄位中傳回。

### 答案
<a name="query-answer"></a>

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

### 文件
<a name="query-document"></a>

Amazon Kendra 會傳回符合搜尋詞彙的排名文件。排名是根據對搜尋結果 Amazon Kendra 準確性的可信度。[QueryResultItem](https://docs.aws.amazon.com/kendra/latest/APIReference/API_QueryResultItem.html) 中會傳回相符文件的相關資訊。它包含文件的標題。摘錄包含搜尋文字的反白資訊，以及文件中相符文字的區段。相符文件的 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'
}
```

### 問題和解答
<a name="query-question-answer"></a>

當 Amazon Kendra 符合您索引中其中一個常見問題的問題時，會傳回問題和答案回應。回應包含 [QueryResultItem](https://docs.aws.amazon.com/kendra/latest/APIReference/API_QueryResultItem.html) 欄位中相符的問題和答案。它還包含查詢字串中偵測到的查詢詞彙反白資訊。下列 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?'
    }
}
```

如需將問題和答案文字新增至索引的詳細資訊，請參閱[建立常見問答集](https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html)。