Documents - Suggest Post

Servicio:: Search Service

Versión de la API:: 2025-09-01

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

POST {endpoint}/indexes('{indexName}')/docs/search.post.suggest?api-version=2025-09-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string	La 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.

Encabezado de la solicitud

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

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
search	True	string	El texto de búsqueda que se utilizará para sugerir documentos. Debe tener al menos 1 carácter y no más de 100 caracteres.
suggesterName	True	string	El nombre del proveedor de sugerencias especificado en la colección de sugerencias que forma parte de la definición del índice.
filter		string	Expresión de OData que filtra los documentos que se tienen en cuenta para las sugerencias.
fuzzy		boolean	Valor que indica si se debe usar la coincidencia aproximada para la consulta de sugerencia. El valor predeterminado es False. Cuando se establece en true, la consulta encontrará sugerencias incluso si hay un carácter sustituido o faltante en el texto de búsqueda. Aunque esto proporciona una mejor experiencia en algunos escenarios, tiene un costo de rendimiento, ya que las búsquedas de sugerencias aproximadas son más lentas y consumen más recursos.
highlightPostTag		string	Una etiqueta de cadena que se anexa a los resaltados de golpes. Debe establecerse con highlightPreTag. Si se omite, el resaltado de sugerencias está desactivado.
highlightPreTag		string	Una etiqueta de cadena que se antepone a los aspectos más destacados. Debe establecerse con highlightPostTag. Si se omite, el resaltado de sugerencias está desactivado.
minimumCoverage		number (double)	Un número entre 0 y 100 que indica el porcentaje del índice que debe cubrir una consulta de sugerencia para que la consulta se notifique como correcta. Este parámetro puede ser útil para garantizar la disponibilidad de búsqueda incluso para servicios con una sola réplica. El valor predeterminado es 80.
orderby		string	La lista separada por comas de OData $orderby expresiones por las que ordenar 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 orden ascendente. Los empates se romperán por los puntajes de los documentos de los partidos. Si no se especifica ninguna $orderby, el criterio de ordenación predeterminado es descendente por puntuación de coincidencia de documento. Puede haber como máximo 32 cláusulas $orderby.
searchFields		string	La lista separada por comas de nombres de campo para buscar el texto de búsqueda especificado. Los campos de destino deben incluirse en el sugeridor especificado.
select		string	La lista separada por comas de campos que se van a recuperar. Si no se especifica, solo se incluirá el campo clave en los resultados.
top		integer (int32)	El número de sugerencias que se van a recuperar. Debe ser un valor entre 1 y 100. El valor predeterminado es 5.

Respuestas

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

Ejemplos

SearchIndexSuggestDocumentsPost

Solicitud de ejemplo

HTTP

POST https://stableexampleservice.search.windows.net/indexes('stable-test')/docs/search.post.suggest?api-version=2025-09-01


{
  "filter": "ownerId eq 'sam' and id lt '15'",
  "fuzzy": true,
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": 80,
  "orderby": "id desc",
  "search": "p",
  "searchFields": "category",
  "select": "id,name,category,ownerId",
  "suggesterName": "sg",
  "top": 10
}

Respuesta de muestra

status code:: 200

{
  "@search.coverage": 100,
  "value": [
    {
      "@search.text": "<em>pu</em>rple",
      "id": "14",
      "name": "test",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.text": "<em>pu</em>rple",
      "id": "13",
      "name": "test",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.text": "<em>pu</em>rple",
      "id": "11",
      "name": "test",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.text": "<em>pu</em>rple",
      "id": "1",
      "name": "test",
      "category": "purple",
      "ownerId": "sam"
    }
  ]
}

Definiciones

Nombre	Description
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
SuggestDocumentsResult	Respuesta que contiene los resultados de la consulta de sugerencias de un índice.
SuggestRequest	Parámetros para filtrar, ordenar, coincidencia aproximada y otros comportamientos de consulta de sugerencias.
SuggestResult	Un resultado que contiene un documento encontrado por una consulta de sugerencia, más metadatos asociados.

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

SuggestDocumentsResult

Object

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

Nombre	Tipo	Description
@search.coverage	number (double)	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[]	La secuencia de resultados devueltos por la consulta.

SuggestRequest

Object

Parámetros para filtrar, ordenar, coincidencia aproximada y otros comportamientos de consulta de sugerencias.

Nombre	Tipo	Description
filter	string	Expresión de OData que filtra los documentos que se tienen en cuenta para las sugerencias.
fuzzy	boolean	Valor que indica si se debe usar la coincidencia aproximada para la consulta de sugerencia. El valor predeterminado es False. Cuando se establece en true, la consulta encontrará sugerencias incluso si hay un carácter sustituido o faltante en el texto de búsqueda. Aunque esto proporciona una mejor experiencia en algunos escenarios, tiene un costo de rendimiento, ya que las búsquedas de sugerencias aproximadas son más lentas y consumen más recursos.
highlightPostTag	string	Una etiqueta de cadena que se anexa a los resaltados de golpes. Debe establecerse con highlightPreTag. Si se omite, el resaltado de sugerencias está desactivado.
highlightPreTag	string	Una etiqueta de cadena que se antepone a los aspectos más destacados. Debe establecerse con highlightPostTag. Si se omite, el resaltado de sugerencias está desactivado.
minimumCoverage	number (double)	Un número entre 0 y 100 que indica el porcentaje del índice que debe cubrir una consulta de sugerencia para que la consulta se notifique como correcta. Este parámetro puede ser útil para garantizar la disponibilidad de búsqueda incluso para servicios con una sola réplica. El valor predeterminado es 80.
orderby	string	La lista separada por comas de OData $orderby expresiones por las que ordenar 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 orden ascendente. Los empates se romperán por los puntajes de los documentos de los partidos. Si no se especifica ninguna $orderby, el criterio de ordenación predeterminado es descendente por puntuación de coincidencia de documento. Puede haber como máximo 32 cláusulas $orderby.
search	string	El texto de búsqueda que se utilizará para sugerir documentos. Debe tener al menos 1 carácter y no más de 100 caracteres.
searchFields	string	La lista separada por comas de nombres de campo para buscar el texto de búsqueda especificado. Los campos de destino deben incluirse en el sugeridor especificado.
select	string	La lista separada por comas de campos que se van a recuperar. Si no se especifica, solo se incluirá el campo clave en los resultados.
suggesterName	string	El nombre del proveedor de sugerencias especificado en la colección de sugerencias que forma parte de la definición del índice.
top	integer (int32)	El número de sugerencias que se van a recuperar. Debe ser un valor entre 1 y 100. El valor predeterminado es 5.

SuggestResult

Object

Un resultado que contiene un documento encontrado por una consulta de sugerencia, más metadatos asociados.

Nombre	Tipo	Description
@search.text	string	El texto de la sugerencia resulta.

Compartir a través de

Documents - Suggest Post

Parámetros de identificador URI

Encabezado de la solicitud

Cuerpo de la solicitud

Respuestas

Ejemplos

SearchIndexSuggestDocumentsPost

Solicitud de ejemplo

Respuesta de muestra

Definiciones

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

SuggestDocumentsResult

SuggestRequest

SuggestResult