Respons kueri dan jenis respons

Amazon Kendra mendukung respons kueri dan jenis respons yang berbeda.

Jawaban kueri

Panggilan ke Query API mengembalikan informasi tentang hasil pencarian. Hasilnya dalam array QueryResultItemobjek (ResultItems). Setiap QueryResultItem menyertakan ringkasan hasilnya. Atribut dokumen yang terkait dengan hasil kueri juga disertakan.

Informasi ringkasan

Ringkasan informasi bervariasi tergantung pada jenis hasil. Dalam setiap kasus, itu termasuk teks dokumen yang cocok dengan istilah pencarian. Hal ini juga termasuk menyoroti informasi yang dapat Anda gunakan untuk menyoroti teks pencarian dalam output aplikasi Anda. Misalnya, jika istilah pencarian adalah berapa tinggi Space Needle?, informasi ringkasan mencakup lokasi teks untuk kata-kata tinggi dan space needle. Untuk informasi selengkapnya tentang respons, lihat Respons kueri dan jenis respons.

Atribut dokumen

Setiap hasil berisi atribut dokumen untuk dokumen yang cocok dengan kueri. Beberapa atribut telah ditetapkan, seperti DocumentId, DocumentTitle, dan DocumentUri. Lainnya adalah atribut kustom yang Anda tetapkan. Anda dapat menggunakan atribut dokumen untuk memfilter respons dari Query API. Misalnya, Anda mungkin hanya ingin dokumen yang ditulis oleh penulis tertentu atau versi tertentu dari dokumen. Untuk informasi selengkapnya, lihat Penyaringan dan pencarian faset. Anda menentukan atribut dokumen saat Anda menambahkan dokumen ke indeks. Untuk informasi selengkapnya, lihat Bidang atau atribut khusus.

Berikut ini adalah contoh kode JSON untuk hasil kueri. Perhatikan atribut dokumen di DocumentAttributes dan 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
}

Jenis respons

Amazon Kendra mengembalikan tiga jenis respon query.

• Jawaban (termasuk jawaban tabel)

• Dokumen

• Pertanyaan dan jawaban

Jenis respons dikembalikan di bidang Type respons QueryResultItemobjek.

Jawaban

Amazon Kendra mendeteksi satu atau lebih jawaban pertanyaan dalam tanggapan. Factoid adalah respons terhadap pertanyaan siapa, apa, kapan, atau di mana seperti Di mana pusat layanan terdekat dengan saya? Amazon Kendra mengembalikan teks dalam indeks yang paling cocok dengan query. Teks ada dalam bidang AnswerText dan berisi informasi sorotan untuk istilah pencarian dalam teks respons.AnswerText termasuk kutipan dokumen lengkap dengan teks yang disorot, sementara DocumentExcerpt termasuk kutipan dokumen terpotong (290 karakter) dengan teks yang disorot.

Amazon Kendra hanya mengembalikan satu jawaban per dokumen, dan itu adalah jawaban dengan keyakinan tertinggi. Untuk mengembalikan beberapa jawaban dari dokumen, Anda harus membagi dokumen menjadi beberapa dokumen.

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

Dokumen

Amazon Kendra mengembalikan dokumen peringkat untuk mereka yang cocok dengan istilah pencarian. Peringkat didasarkan pada keyakinan yang Amazon Kendra memiliki keakuratan hasil pencarian. Informasi tentang dokumen yang cocok dikembalikan di QueryResultItem. Ini mencakup judul dokumen. Kutipan mencakup informasi sorotan untuk teks pencarian dan bagian teks yang cocok dalam dokumen. URI untuk dokumen yang cocok adalah di atribut dokumen SourceURI. Contoh JSON berikut menunjukkan ringkasan dokumen untuk dokumen yang cocok.

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

Pertanyaan dan jawaban

Respons pertanyaan dan jawaban dikembalikan ketika Amazon Kendra mencocokkan pertanyaan dengan salah satu pertanyaan yang sering diajukan dalam indeks Anda. Jawabannya mencakup pertanyaan dan jawaban yang cocok di QueryResultItemlapangan. Ini juga mencakup informasi sorotan untuk istilah kueri yang terdeteksi dalam string kueri. JSON berikut menunjukkan respons tanya jawab. Perhatikan bahwa respons mencakup teks pertanyaan.

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

Untuk informasi tentang menambahkan teks tanya jawab ke indeks, lihat Membuat FAQ.