Las sugerencias desplegables completan la consulta de búsqueda del usuario mientras escribe. Muestran hasta 10 sugerencias coincidentes antes de que se ingrese la consulta completa. OpenSearch admite prefijos de caracteres chinos, escritura pinyin completa y entrada pinyin abreviada (primera letra) para habilitar el autocompletado inteligente.
Para configurar un modelo de sugerencias desplegables, establecer listas de bloqueados y agregar consultas promocionadas, consulte Sugerencias desplegables.
Consultar sugerencias desplegables
Endpoint
GET /v3/openapi/apps/{appName}/suggest/{suggestName}/search
|
Parámetro de ruta |
Descripción |
|
|
Nombre de su aplicación de OpenSearch |
|
|
Nombre de su modelo de sugerencias desplegables |
El endpoint omite los detalles del host, los encabezados de solicitud y la codificación. Para conocer el formato de conexión completo, consulte Iniciar solicitudes de búsqueda.
Formato compatible: JSON
Parámetros de solicitud
|
Parámetro |
Tipo |
Obligatorio |
Valores válidos |
Predeterminado |
Descripción |
|
|
STRING |
Sí |
— |
— |
Texto ingresado en el cuadro de búsqueda. Codifique el valor con URL si contiene caracteres chinos. |
|
|
INT |
No |
1–10 |
10 |
Número de sugerencias que se devuelven. |
|
|
STRING |
No |
— |
— |
Identificador del usuario que envía la solicitud. Codifique el valor con URL. Le recomendamos usar el mismo |
|
|
STRING |
No |
|
Enabled |
Indica si se recuperan documentos al reemplazar términos de las consultas de búsqueda por homófonos. Establezca este parámetro en |
Nota: El parámetroqueryde esta sección difiere del parámetroqueryde las solicitudes de búsqueda de datos. En las solicitudes de sugerencias desplegables,querycorresponde al texto sin procesar que el usuario escribe en el cuadro de búsqueda. No es necesario que sea el nombre de un campo de índice.
Parámetros de respuesta
|
Parámetro |
Tipo |
Descripción |
|
|
STRING |
Identificador de la solicitud. Se usa para solucionar problemas. |
|
|
FLOAT |
Tiempo que tarda el motor en completar la consulta, en segundos. |
|
|
ARRAY |
Sugerencias coincidentes. Cada elemento es un objeto que contiene una cadena de sugerencia. |
|
|
ARRAY |
Detalles del error. El campo |
Ejemplos
Solicitud
http://$host/v3/openapi/apps/app_demo/suggest/suggest_demo/search?hit=10&query=One-piece dress&user_id=xxx
app_demo: nombre de la aplicación.suggest_demo: nombre del modelo de sugerencias.hit=10: devuelve hasta 10 sugerencias.query=One-piece dress: texto escrito en el cuadro de búsqueda.
Respuesta exitosa
{
"request_id": "150116615820104116121674",
"searchtime": 0.002654,
"suggestions": [
{"suggestion": "One-piece dress"},
{"suggestion": "One-piece dress for Spring"},
{"suggestion": "One-piece dress for art enthusiasts"}
]
}
Respuesta de error
{
"request_id": "150116635320104116122572",
"searchtime": 0.037484,
"suggestions": [],
"errors": [
{
"code": 2551,
"message": "suggester not found"
}
]
}
Para consultar la lista completa de códigos de error, consulte Error codes.
Pasos siguientes
Sugerencias desplegables: configure modelos de sugerencias, listas de bloqueados y consultas promocionadas en la consola.
Iniciar solicitudes de búsqueda: utilice el mismo
user_iden las solicitudes de sugerencias y de búsqueda.