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.
GetQuerySuggestions
Obtiene las consultas sugeridas a los usuarios.
GetQuerySuggestionsNo se admite actualmente en laAWSRegión GovCloud (EE. UU. Oeste).
Sintaxis de la solicitud
{
"IndexId": "string",
"MaxSuggestionsCount": number,
"QueryText": "string"
}Parámetros de solicitud
Para obtener información sobre parámetros que son comunes a todas las acciones, consulteParámetros comunes.
La solicitud acepta los siguientes datos en formato JSON.
- IndexId
-
Identificador del índice del que desea obtener sugerencias de consulta.
Type: Cadena
Restricciones de longitud: Longitud fija de 36.
Patrón:
[a-zA-Z0-9][a-zA-Z0-9-]*Obligatorio: Sí
- MaxSuggestionsCount
-
El número máximo de sugerencias de consulta que desea mostrar a los usuarios.
Type: Entero
Obligatorio: No
- QueryText
-
Texto de la consulta de un usuario para generar sugerencias de consultas.
Se sugiere una consulta si el prefijo de consulta coincide con lo que un usuario empieza a escribir como consulta.
Amazon Kendra no muestra ninguna sugerencia si un usuario escribe menos de dos caracteres o más de 60 caracteres. Una consulta también debe tener al menos un resultado de búsqueda y contener al menos una palabra de más de cuatro caracteres.
Type: Cadena
Patrón:
^\P{C}*$Obligatorio: Sí
Sintaxis de la respuesta
{
"QuerySuggestionsId": "string",
"Suggestions": [
{
"Id": "string",
"Value": {
"Text": {
"Highlights": [
{
"BeginOffset": number,
"EndOffset": number
}
],
"Text": "string"
}
}
}
]
}Elementos de respuesta
Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.
El servicio devuelve los datos siguientes en formato JSON.
- QuerySuggestionsId
-
Identificador exclusivo de una lista de sugerencias de consulta para un índice.
Type: Cadena
Restricciones de longitud: Longitud mínima de 1. La longitud máxima es de 36 caracteres.
- Suggestions
-
Lista de sugerencias de consulta para un índice.
Type: Matrices deSuggestionobjects
Errores
Para obtener información sobre errores que son comunes a todas las acciones, consulteErrores comunes.
- AccessDeniedException
-
Código de estado HTTP: 400
- ConflictException
-
Código de estado HTTP: 400
- InternalServerException
-
Código de estado HTTP: 500
- ResourceNotFoundException
-
Código de estado HTTP: 400
- ServiceQuotaExceededException
-
Código de estado HTTP: 400
- ThrottlingException
-
Código de estado HTTP: 400
- ValidationException
-
Código de estado HTTP: 400
Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un lenguaje específico, consulte:
