Documents - Suggest Get

Referencia

Service:: Search Service

API Version:: 2023-11-01

Sugiere documentos en el índice que coinciden con el texto de consulta parcial especificado.

GET {endpoint}/indexes('{indexName}')/docs/search.suggest?search={search}&suggesterName={suggesterName}&api-version=2023-11-01

With optional parameters:

GET {endpoint}/indexes('{indexName}')/docs/search.suggest?search={search}&suggesterName={suggesterName}&$filter={$filter}&fuzzy={fuzzy}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&$orderby={$orderby}&searchFields={searchFields}&$select={$select}&$top={$top}&api-version=2023-11-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string	Dirección URL del punto de conexión del servicio de búsqueda.
indexName	path	True	string	El nombre del índice.
api-version	query	True	string	Versión de api de cliente.
search	query	True	string	Texto de búsqueda que se va a usar para sugerir documentos. Debe tener 1 carácter como mínimo y no más de 100 caracteres.
suggesterName	query	True	string	Nombre del proveedor de sugerencias tal como se especifica en la colección suggesters que forma parte de la definición de índice.
$filter	query		string	Expresión OData que filtra los documentos que se tienen en cuenta para obtener sugerencias.
$orderby	query		string[]	Lista de expresiones de $orderby de OData por las que se ordenan los resultados. Cada expresión puede ser un nombre de campo o una llamada a las funciones geo.distance() o search.score(). Cada expresión puede ir seguida de asc para indicar ascendente, o desc para indicar descendente. El valor predeterminado es ascendente. Los empates se resolverán por la puntuación de coincidencia de los documentos. Si no se especifica ningún $orderby, el criterio de ordenación predeterminado es descendente por puntuación de coincidencia de documento. Puede haber como máximo 32 cláusulas de $orderby.
$select	query		string[]	Lista de campos que se van a recuperar. Si no se especifica, solo se incluirá el campo clave en los resultados.
$top	query		integer int32	Número de sugerencias que se van a recuperar. El valor debe ser un número entre 1 y 100. El valor predeterminado es 5.
fuzzy	query		boolean	Valor que indica si se va a usar la coincidencia aproximada para la consulta de sugerencias. El valor predeterminado es False. Cuando se establece en true, la consulta encontrará términos incluso si hay un carácter sustituido o ausente en el texto de búsqueda. Aunque esto proporciona una mejor experiencia en algunos escenarios, conlleva un costo de rendimiento, ya que las consultas de sugerencias aproximadas son más lentas y consumen más recursos.
highlightPostTag	query		string	Etiqueta de cadena que se anexa para alcanzar los resaltados. Debe establecerse con highlightPreTag. Si se omite, el resaltado de referencias de sugerencias está deshabilitado.
highlightPreTag	query		string	Etiqueta de cadena que se antepone a los resaltados. Debe establecerse con highlightPostTag. Si se omite, el resaltado de referencias de sugerencias está deshabilitado.
minimumCoverage	query		number double	Número comprendido entre 0 y 100 que indica el porcentaje del índice que debe cubrir una consulta de sugerencias para que la consulta se notifique como correcta. Este parámetro puede ser útil para garantizar la disponibilidad de búsqueda incluso para los servicios con una sola réplica. El valor predeterminado es 80.
searchFields	query		string[]	Lista de nombres de campo que se van a buscar en el texto de búsqueda especificado. Los campos de destino deben incluirse en el proveedor de sugerencias especificado.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
x-ms-client-request-id		string uuid	Identificador de seguimiento enviado con la solicitud para ayudar con la depuración.

Respuestas

Nombre	Tipo	Description
200 OK	SuggestDocumentsResult	Respuesta que contiene documentos sugeridos que coinciden con la entrada parcial.
Other Status Codes	SearchError	Respuesta de error.

Ejemplos

SearchIndexSuggestDocumentsGet

Sample Request

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs/search.suggest?search=hote&suggesterName=sg&$filter=rating gt 10&fuzzy=False&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&$orderby=search.score() desc,rating desc&searchFields=title&$select=docId,title,description&$top=10&api-version=2023-11-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "@search.text": "Nice <em>Hotel</em>",
      "description": "Cheapest hotel in town",
      "docId": "1",
      "title": "Nice Hotel"
    },
    {
      "@search.text": "Fancy <em>Hotel</em>",
      "description": "Best hotel in town",
      "docId": "2",
      "title": "Fancy Hotel"
    }
  ]
}

Definiciones

Nombre	Description
SearchError	Describe una condición de error para la API.
SuggestDocumentsResult	Respuesta que contiene los resultados de la consulta de sugerencias de un índice.
SuggestResult	Resultado que contiene un documento encontrado por una consulta de sugerencia, además de metadatos asociados.

SearchError

Describe una condición de error para la API.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
details	SearchError[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
message	string	Representación legible del error.

SuggestDocumentsResult

Respuesta que contiene los resultados de la consulta de sugerencias de un índice.

Nombre	Tipo	Description
@search.coverage	number	Valor que indica el porcentaje del índice que se incluyó en la consulta, o null si minimumCoverage no se estableció en la solicitud.
value	SuggestResult[]	Secuencia de resultados devueltos por la consulta.

SuggestResult

Resultado que contiene un documento encontrado por una consulta de sugerencia, además de metadatos asociados.

Nombre	Tipo	Description
@search.text	string	Texto del resultado de la sugerencia.