Documents - Suggest Post

Referencia

Servicio:: Search Service

Versión de la API:: 2024-07-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=2024-07-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	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	Identificador de seguimiento enviado con la solicitud para ayudar con la depuración.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
search	True	string	Texto de búsqueda que se va a usar para sugerir documentos. Debe tener al menos 1 carácter y no más de 100 caracteres.
suggesterName	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		string	Expresión de OData que filtra los documentos que se consideran para obtener sugerencias.
fuzzy		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á sugerencias incluso si hay un carácter sustituido o que falta en el texto de búsqueda. Aunque esto proporciona una mejor experiencia en algunos escenarios, se produce un costo de rendimiento, ya que las búsquedas de sugerencias aproximadas son más lentas y consumen más recursos.
highlightPostTag		string	Etiqueta de cadena que se anexa a los resaltados de aciertos. Debe establecerse con highlightPreTag. Si se omite, el resaltado de referencias de sugerencias está deshabilitado.
highlightPreTag		string	Etiqueta de cadena que se antepone para alcanzar los resaltados. Debe establecerse con highlightPostTag. Si se omite, el resaltado de referencias de sugerencias está deshabilitado.
minimumCoverage		number	Número comprendido entre 0 y 100 que indica el porcentaje del índice que debe estar cubierto por 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 los servicios con una sola réplica. El valor predeterminado es 80.
orderby		string	Lista separada por comas de expresiones de OData $orderby 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 orden ascendente. Los empates se romperán con las puntuaciones de coincidencia de 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 $orderby cláusulas.
searchFields		string	Lista separada por comas de nombres de campo para buscar el texto de búsqueda especificado. Los campos de destino deben incluirse en el proveedor de sugerencias especificado.
select		string	Lista separada por comas de campos que se van a recuperar. Si no se especifica, solo se incluirá el campo de clave en los resultados.
top		integer	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://myservice.search.windows.net/indexes('myindex')/docs/search.post.suggest?api-version=2024-07-01

{
  "filter": "rating gt 4.0",
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": 80,
  "orderby": "rating desc",
  "search": "hote",
  "searchFields": "title",
  "select": "docId,title,description",
  "suggesterName": "sg",
  "top": 10
}

Respuesta de muestra

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
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	Resultado que contiene un documento encontrado por una consulta de sugerencia, además de metadatos asociados.

ErrorAdditionalInfo

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

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	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de 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.

SuggestRequest

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 consideran para obtener sugerencias.
fuzzy	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á sugerencias incluso si hay un carácter sustituido o que falta en el texto de búsqueda. Aunque esto proporciona una mejor experiencia en algunos escenarios, se produce un costo de rendimiento, ya que las búsquedas de sugerencias aproximadas son más lentas y consumen más recursos.
highlightPostTag	string	Etiqueta de cadena que se anexa a los resaltados de aciertos. Debe establecerse con highlightPreTag. Si se omite, el resaltado de referencias de sugerencias está deshabilitado.
highlightPreTag	string	Etiqueta de cadena que se antepone para alcanzar los resaltados. Debe establecerse con highlightPostTag. Si se omite, el resaltado de referencias de sugerencias está deshabilitado.
minimumCoverage	number	Número comprendido entre 0 y 100 que indica el porcentaje del índice que debe estar cubierto por 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 los servicios con una sola réplica. El valor predeterminado es 80.
orderby	string	Lista separada por comas de expresiones de OData $orderby 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 orden ascendente. Los empates se romperán con las puntuaciones de coincidencia de 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 $orderby cláusulas.
search	string	Texto de búsqueda que se va a usar para sugerir documentos. Debe tener al menos 1 carácter y no más de 100 caracteres.
searchFields	string	Lista separada por comas de nombres de campo para buscar el texto de búsqueda especificado. Los campos de destino deben incluirse en el proveedor de sugerencias especificado.
select	string	Lista separada por comas de campos que se van a recuperar. Si no se especifica, solo se incluirá el campo de clave en los resultados.
suggesterName	string	Nombre del proveedor de sugerencias tal como se especifica en la colección suggesters que forma parte de la definición de índice.
top	integer	Número de sugerencias que se van a recuperar. Debe ser un valor entre 1 y 100. El valor predeterminado es 5.

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.

Compartir a través de