Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
# Respuestas a las consultas y tipos de respuestas
**nota**
La compatibilidad de características varía según el tipo de índice y la API de búsqueda que se use. Para comprobar si esta característica es compatible con el tipo de índice y la API de búsqueda que usa, consulte [Tipos de índices](https://docs.aws.amazon.com/kendra/latest/dg/hiw-index-types.html).
Amazon Kendra admite diferentes respuestas a consultas y tipos de respuesta.
## Respuestas a las consultas
Llamar a la API de [consulta](https://docs.aws.amazon.com/kendra/latest/APIReference/API_Query.html) devuelve información sobre los resultados de una búsqueda. Los resultados se encuentran en una matriz de [QueryResultItem](https://docs.aws.amazon.com/kendra/latest/APIReference/API_QueryResultItem.html)objetos (`ResultItems`). Cada `QueryResultItem` incluye un resumen del resultado. También incluye los atributos del documento asociados al resultado de la consulta.
**Información del resumen**
La información del resumen varía según el tipo de resultado. En cada caso, incluye el texto del documento que coincide con el término de búsqueda. También incluye información resaltada que puede usar para resaltar el texto de la búsqueda en el resultado de la aplicación. Por ejemplo, si la búsqueda es *¿Cuál es la altura de la Space Needle?*, la información del resumen incluye la ubicación en el texto de las palabras *altura* y *space needle*. Para obtener más información sobre los tipos de respuestas, consulte [Respuestas a las consultas y tipos de respuestas](#query-responses-types).
**Atributos del documento**
Cada resultado contiene los atributos del documento que coincide con una consulta. Algunos de los atributos están predefinidos como `DocumentId`, `DocumentTitle`, y `DocumentUri`. Otros son atributos personalizados que puede definir. Puede usar los atributos del documento para filtrar la respuesta de la API `Query`. Por ejemplo, es posible que solo desee los documentos escritos por un autor específico o la versión específica de un documento. Para obtener más información, consulte [Filtrado y búsqueda por facetas](filtering.md). Debe especificar los atributos del documento al añadir documentos a un índice. Para obtener más información, consulte [Campos o atributos personalizados](https://docs.aws.amazon.com/kendra/latest/dg/custom-attributes.html).
El siguiente ejemplo muestra un código JSON para el resultado de una consulta. Observe los atributos del documento en `DocumentAttributes` y`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 respuestas
Amazon Kendra devuelve tres tipos de respuesta a la consulta.
+ Respuesta (incluye respuestas de tabla)
+ Documento
+ Pregunta y respuesta
El tipo de respuesta se devuelve en el campo de `Type` respuesta del [QueryResultItem](https://docs.aws.amazon.com/kendra/latest/APIReference/API_QueryResultItem.html)objeto.
### Respuesta
Amazon Kendra detectó una o más respuestas a una pregunta en la respuesta. Una trivialidad es la respuesta a una pregunta sobre quién, qué, cuándo o dónde. Por ejemplo: *¿Dónde está el centro de servicios más cercano a mi ubicación?* Amazon Kendra devuelve el texto del índice que mejor coincide con la consulta. El texto está en el campo `AnswerText` y contiene información destacada sobre el término de búsqueda en el texto de la respuesta. `AnswerText` incluye el extracto completo del documento con el texto resaltado, mientras que `DocumentExcerpt` incluye el extracto del documento truncado (290 caracteres) con el texto resaltado.
Amazon Kendra solo devuelve una respuesta por documento, y esa es la respuesta con mayor confianza. Para obtener varias respuestas de un documento, debe dividir el documento en varios 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 devuelve los documentos clasificados de los que coinciden con el término de búsqueda. La clasificación se basa en la confianza que Amazon Kendra se deposita en la precisión del resultado de la búsqueda. La información sobre el documento coincidente se devuelve en el [QueryResultItem](https://docs.aws.amazon.com/kendra/latest/APIReference/API_QueryResultItem.html). Incluye el título del documento. El extracto incluye información destacada para el texto de búsqueda y la sección de texto coincidente del documento. El URI de los documentos coincidentes se encuentra en el atributo del documento `SourceURI`. En el siguiente ejemplo de JSON se muestra el resumen de un documento coincidente.
```
{
'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'
}
```
### Pregunta y respuesta
Se devuelve una respuesta de pregunta y respuesta cuando se hace Amazon Kendra coincidir una pregunta con una de las preguntas frecuentes del índice. La respuesta incluye la pregunta y la respuesta coincidentes en el [QueryResultItem](https://docs.aws.amazon.com/kendra/latest/APIReference/API_QueryResultItem.html)campo. También incluye información destacada sobre los términos de consulta detectados en la cadena de la consulta. El siguiente ejemplo de JSON muestra una respuesta de pregunta y respuesta. Observe que la respuesta incluye el texto de la pregunta.
```
{
'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 obtener información sobre cómo añadir el texto de una pregunta y una respuesta a un índice, consulte [Añadir preguntas frecuentes a un índice](https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html).