BaseSearchRequestOptions interface

Paquete:

@azure/search-documents

Parámetros para filtrar, ordenar, facetar, paginar y otros comportamientos de consulta de búsqueda.

Propiedades

facets	Lista de expresiones de faceta que se van a aplicar a la consulta de búsqueda. Cada expresión de faceta contiene un nombre de campo, seguido opcionalmente de una lista separada por comas de pares nombre:valor.
filter	OData $filter expresión que se va a aplicar a la consulta de búsqueda.
highlightFields	Lista separada por comas de nombres de campo que se van a usar para los resaltados de aciertos. Solo se pueden usar campos que se pueden buscar para el resaltado de aciertos.
highlightPostTag	Etiqueta de cadena que se anexa a los resaltados de aciertos. Debe establecerse con highlightPreTag. El valor predeterminado es </em>.
highlightPreTag	Una etiqueta de cadena que se antepone para alcanzar los resaltados. Debe establecerse con highlightPostTag. El valor predeterminado es <em>.
includeTotalCount	Valor que especifica si se va a capturar el recuento total de resultados. El valor predeterminado es False. Establecer este valor en true puede tener un impacto en el rendimiento. Tenga en cuenta que el número devuelto será una aproximación.
minimumCoverage	Número comprendido entre 0 y 100 que indica el porcentaje del índice que debe estar cubierto por una consulta de búsqueda 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 100.
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 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 $orderby cláusulas.
queryType	Valor que especifica la sintaxis de la consulta de búsqueda. El valor predeterminado es "simple". Use "full" si la consulta usa la sintaxis de consulta de Lucene. Entre los valores posibles se incluyen: "simple", "full", "semantic"
scoringParameters	Lista de valores de parámetro que se van a usar en las funciones de puntuación (por ejemplo, referencePointParameter) mediante el formato name-values. Por ejemplo, si el perfil de puntuación define una función con un parámetro denominado "mylocation", la cadena de parámetro sería "mylocation--122.2,44.8" (sin las comillas).
scoringProfile	El nombre de un perfil de puntuación para evaluar puntuaciones de coincidencia para documentos coincidentes a fin de ordenar los resultados.
scoringStatistics	Valor que especifica si queremos calcular las estadísticas de puntuación (como la frecuencia del documento) globalmente para obtener una puntuación más coherente o localmente para reducir la latencia. Entre los valores posibles se incluyen: "Local", "Global"
searchFields	Lista separada por comas de nombres de campo a los que se va a definir el ámbito de la búsqueda de texto completo. Cuando se usa la búsqueda por campos (fieldName:searchExpression) en una consulta completa de Lucene, los nombres de campo de cada expresión de búsqueda con campos tienen prioridad sobre los nombres de campo enumerados en este parámetro.
searchMode	Valor que especifica si alguno o todos los términos de búsqueda deben coincidir para contar el documento como una coincidencia. Entre los valores posibles se incluyen: "any", "all"
select	Lista de campos que se van a recuperar. Si no se especifica nada, se incluirán todos los campos marcados como recuperables en el esquema.
sessionId	Valor que se va a usar para crear una sesión permanente, que puede ayudar a obtener resultados más coherentes. Siempre que se use el mismo sessionId, se realizará un intento de mejor esfuerzo para tener como destino el mismo conjunto de réplicas. Tenga cuidado de que reutilizar los mismos valores de sessionID repetidamente puede interferir con el equilibrio de carga de las solicitudes entre réplicas y afectar negativamente al rendimiento del servicio de búsqueda. El valor utilizado como sessionId no puede empezar con el carácter "_".
skip	El número de resultados de búsqueda que se van a omitir. Este valor no puede ser mayor que 100 000. Si necesita examinar documentos en secuencia, pero no puede usar skip debido a esta limitación, considere la posibilidad de usar orderby en una clave totalmente ordenada y filtrar con una consulta de rango en su lugar.
top	El número de resultados de búsqueda que se van a recuperar. Esto se puede usar junto con $skip para implementar la paginación del lado cliente de los resultados de búsqueda. Si los resultados se truncan debido a la paginación del lado servidor, la respuesta incluirá un token de continuación que se puede usar para emitir otra solicitud de búsqueda para la página siguiente de resultados.
vectorSearchOptions	Define las opciones para las consultas de búsqueda vectorial.

Detalles de las propiedades

facets

Lista de expresiones de faceta que se van a aplicar a la consulta de búsqueda. Cada expresión de faceta contiene un nombre de campo, seguido opcionalmente de una lista separada por comas de pares nombre:valor.

facets?: string[]

Valor de propiedad

string[]

filter

OData $filter expresión que se va a aplicar a la consulta de búsqueda.

filter?: string

Valor de propiedad

string

highlightFields

Lista separada por comas de nombres de campo que se van a usar para los resaltados de aciertos. Solo se pueden usar campos que se pueden buscar para el resaltado de aciertos.

highlightFields?: string

Valor de propiedad

string

highlightPostTag

Etiqueta de cadena que se anexa a los resaltados de aciertos. Debe establecerse con highlightPreTag. El valor predeterminado es </em>.

highlightPostTag?: string

Valor de propiedad

string

highlightPreTag

Una etiqueta de cadena que se antepone para alcanzar los resaltados. Debe establecerse con highlightPostTag. El valor predeterminado es <em>.

highlightPreTag?: string

Valor de propiedad

string

includeTotalCount

Valor que especifica si se va a capturar el recuento total de resultados. El valor predeterminado es False. Establecer este valor en true puede tener un impacto en el rendimiento. Tenga en cuenta que el número devuelto será una aproximación.

includeTotalCount?: boolean

Valor de propiedad

boolean

minimumCoverage

Número comprendido entre 0 y 100 que indica el porcentaje del índice que debe estar cubierto por una consulta de búsqueda 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 100.

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 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 $orderby cláusulas.

orderBy?: string[]

Valor de propiedad

string[]

queryType

Valor que especifica la sintaxis de la consulta de búsqueda. El valor predeterminado es "simple". Use "full" si la consulta usa la sintaxis de consulta de Lucene. Entre los valores posibles se incluyen: "simple", "full", "semantic"

queryType?: QueryType

Valor de propiedad

QueryType

scoringParameters

Lista de valores de parámetro que se van a usar en las funciones de puntuación (por ejemplo, referencePointParameter) mediante el formato name-values. Por ejemplo, si el perfil de puntuación define una función con un parámetro denominado "mylocation", la cadena de parámetro sería "mylocation--122.2,44.8" (sin las comillas).

scoringParameters?: string[]

Valor de propiedad

string[]

scoringProfile

El nombre de un perfil de puntuación para evaluar puntuaciones de coincidencia para documentos coincidentes a fin de ordenar los resultados.

scoringProfile?: string

Valor de propiedad

string

scoringStatistics

Valor que especifica si queremos calcular las estadísticas de puntuación (como la frecuencia del documento) globalmente para obtener una puntuación más coherente o localmente para reducir la latencia. Entre los valores posibles se incluyen: "Local", "Global"

scoringStatistics?: ScoringStatistics

Valor de propiedad

ScoringStatistics

searchFields

Lista separada por comas de nombres de campo a los que se va a definir el ámbito de la búsqueda de texto completo. Cuando se usa la búsqueda por campos (fieldName:searchExpression) en una consulta completa de Lucene, los nombres de campo de cada expresión de búsqueda con campos tienen prioridad sobre los nombres de campo enumerados en este parámetro.

searchFields?: SearchFieldArray<TModel>

Valor de propiedad

SearchFieldArray<TModel>

searchMode

Valor que especifica si alguno o todos los términos de búsqueda deben coincidir para contar el documento como una coincidencia. Entre los valores posibles se incluyen: "any", "all"

searchMode?: SearchMode

Valor de propiedad

SearchMode

select

Lista de campos que se van a recuperar. Si no se especifica nada, se incluirán todos los campos marcados como recuperables en el esquema.

select?: SelectArray<TFields>

Valor de propiedad

SelectArray<TFields>

sessionId

Valor que se va a usar para crear una sesión permanente, que puede ayudar a obtener resultados más coherentes. Siempre que se use el mismo sessionId, se realizará un intento de mejor esfuerzo para tener como destino el mismo conjunto de réplicas. Tenga cuidado de que reutilizar los mismos valores de sessionID repetidamente puede interferir con el equilibrio de carga de las solicitudes entre réplicas y afectar negativamente al rendimiento del servicio de búsqueda. El valor utilizado como sessionId no puede empezar con el carácter "_".

sessionId?: string

Valor de propiedad

string

skip

El número de resultados de búsqueda que se van a omitir. Este valor no puede ser mayor que 100 000. Si necesita examinar documentos en secuencia, pero no puede usar skip debido a esta limitación, considere la posibilidad de usar orderby en una clave totalmente ordenada y filtrar con una consulta de rango en su lugar.

skip?: number

Valor de propiedad

number

top

El número de resultados de búsqueda que se van a recuperar. Esto se puede usar junto con $skip para implementar la paginación del lado cliente de los resultados de búsqueda. Si los resultados se truncan debido a la paginación del lado servidor, la respuesta incluirá un token de continuación que se puede usar para emitir otra solicitud de búsqueda para la página siguiente de resultados.

top?: number

Valor de propiedad

number

vectorSearchOptions

Define las opciones para las consultas de búsqueda vectorial.

vectorSearchOptions?: VectorSearchOptions<TModel>

Valor de propiedad

VectorSearchOptions<TModel>