SuggestRequest interface

Paquete:

@azure/search-documents

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

Propiedades

filter	Expresión de OData que filtra los documentos que se consideran para obtener sugerencias.
highlightPostTag	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	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	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	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 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	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	Lista de campos que se van a recuperar. Si no se especifica, solo se incluirá el campo de clave en los resultados.
top	/** Número de sugerencias que se van a recuperar. Debe ser un valor entre 1 y 100. El valor predeterminado es
useFuzzyMatching	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.

Detalles de las propiedades

filter

Expresión de OData que filtra los documentos que se consideran para obtener sugerencias.

filter?: string

Valor de propiedad

string

highlightPostTag

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.

highlightPostTag?: string

Valor de propiedad

string

highlightPreTag

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.

highlightPreTag?: string

Valor de propiedad

string

minimumCoverage

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.

minimumCoverage?: number

Valor de propiedad

number

orderBy

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 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.

orderBy?: string[]

Valor de propiedad

string[]

searchFields

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.

searchFields?: SearchFieldArray<TModel>

Valor de propiedad

SearchFieldArray<TModel>

select

Lista de campos que se van a recuperar. Si no se especifica, solo se incluirá el campo de clave en los resultados.

select?: SelectArray<TFields>

Valor de propiedad

SelectArray<TFields>

top

/**

• Número de sugerencias que se van a recuperar. Debe ser un valor entre 1 y 100. El valor predeterminado es

top?: number

Valor de propiedad

number

useFuzzyMatching

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.

useFuzzyMatching?: boolean

Valor de propiedad

boolean