DescribeQuerySuggestionsConfig - Amazon Kendra

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.

DescribeQuerySuggestionsConfig

Obtiene información sobre la configuración de las sugerencias de consultas de un índice.

Se utiliza para comprobar la configuración actual aplicada a las sugerencias de consultas.

DescribeQuerySuggestionsConfigno se admite actualmente en laAWS GovCloud (EE.UU. Oeste).

Sintaxis de la solicitud

{ "IndexId": "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 con sugerencias de consultas para las que desea obtener información.

Type: Cadena

Restricciones de longitud Longitud fija de 36.

Patrón: [a-zA-Z0-9][a-zA-Z0-9-]*

Obligatorio: Sí

Sintaxis de la respuesta

{ "IncludeQueriesWithoutUserInformation": boolean, "LastClearTime": number, "LastSuggestionsBuildTime": number, "MinimumNumberOfQueryingUsers": number, "MinimumQueryCount": number, "Mode": "string", "QueryLogLookBackWindowInDays": number, "Status": "string", "TotalSuggestionsCount": number }

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.

IncludeQueriesWithoutUserInformation

TRUEpara usar todas las consultas; de lo contrario, utilice solo consultas que incluyan información del usuario para generar las sugerencias de consultas.

Type: Booleano

LastClearTime

Las sugerencias de consulta de fecha y hora para un índice se borraron por última vez.

Después de borrar las sugerencias, Amazon Kendra aprende nuevas sugerencias en función de las nuevas consultas agregadas al registro de consultas desde el momento en que se eliminaron las sugerencias. Amazon Kendra solo tiene en cuenta las repeticiones de una consulta desde el momento en que se eliminaron las sugerencias.

Type: Marca temporal

LastSuggestionsBuildTime

Las sugerencias de consulta de fecha y hora para un índice se actualizaron por última vez.

Type: Marca temporal

MinimumNumberOfQueryingUsers

El número mínimo de usuarios únicos que deben buscar una consulta para que la consulta sea apta para sugerirla a los usuarios.

Type: Entero

Rango válido: Valor mínimo de 1. Valor máximo de 10000.

MinimumQueryCount

El número mínimo de veces que se debe buscar una consulta para que la consulta sea apta para sugerirla a los usuarios.

Type: Entero

Rango válido: Valor mínimo de 1. Valor máximo de 10000.

Mode

Si las sugerencias de consultas están actualmente enENABLEDmodo oLEARN_ONLYmodo.

De forma predeterminada, Amazon Kendra habilita las sugerencias de consultas.LEARN_ONLYdesactiva las sugerencias de consultas para los usuarios. Puede cambiar el modo mediante el comandoUpdateQuerySuggestionsConfigAPI.

Type: Cadena

Valores válidos: ENABLED | LEARN_ONLY

QueryLogLookBackWindowInDays

Qué tan recientes son las consultas en la ventana de tiempo de registro de consultas (en días).

Type: Entero

Status

Si el estado de la configuración de sugerencias de consultas está actualmenteACTIVEoUPDATING.

Activo significa que se aplica la configuración actual y Actualización significa que la configuración modificada está en proceso de aplicación.

Type: Cadena

Valores válidos: ACTIVE | UPDATING

TotalSuggestionsCount

El recuento total actual de sugerencias de consultas para un índice.

Este recuento puede cambiar cuando actualiza la configuración de sugerencias de consultas, si filtra ciertas consultas de las sugerencias mediante una lista de bloqueo y cuando el registro de consultas acumula más consultas para que Amazon Kendra aprenda de ellas.

Type: Entero

Errores

Para obtener información sobre errores que son comunes a todas las acciones, consulteErrores comunes.

AccessDeniedException

Código de estado HTTP: 400

InternalServerException

Código de estado HTTP: 500

ResourceNotFoundException

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: