Todos los productos
Search
Centro de documentos

OpenSearch:Sugerencias desplegables

Última actualización: Sep 09, 2026

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

appName

Nombre de su aplicación de OpenSearch

suggestName

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

query

STRING

Sí

—

—

Texto ingresado en el cuadro de búsqueda. Codifique el valor con URL si contiene caracteres chinos.

hit

INT

No

1–10

10

Número de sugerencias que se devuelven.

user_id

STRING

No

—

—

Identificador del usuario que envía la solicitud. Codifique el valor con URL. Le recomendamos usar el mismo user_id que utiliza en sus solicitudes de búsqueda de datos.

re_search

STRING

No

disable

Enabled

Indica si se recuperan documentos al reemplazar términos de las consultas de búsqueda por homófonos. Establezca este parámetro en disable para deshabilitar esta función.

Nota: El parámetro query de esta sección difiere del parámetro query de las solicitudes de búsqueda de datos. En las solicitudes de sugerencias desplegables, query corresponde 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

request_id

STRING

Identificador de la solicitud. Se usa para solucionar problemas.

searchtime

FLOAT

Tiempo que tarda el motor en completar la consulta, en segundos.

suggestions

ARRAY

Sugerencias coincidentes. Cada elemento es un objeto que contiene una cadena de sugerencia.

errors

ARRAY

Detalles del error. El campo message contiene la descripción del error. Consulte Error codes.

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