BaseSearchRequestOptions interface
Parâmetros para filtrar, ordenar, encarar, paginar e outros comportamentos de consulta de pesquisa.
Propriedades
facets | A lista de expressões de facetas a aplicar à consulta de pesquisa. Cada expressão de faceta contém um nome de campo, opcionalmente seguido por uma lista separada por vírgulas de pares name:value. |
filter | O OData $filter expressão a aplicar à consulta de pesquisa. |
highlight |
A lista separada por vírgulas de nomes de campos a utilizar para os destaques de êxito. Apenas os campos pesquisáveis podem ser utilizados para realce de acesso. |
highlight |
Uma etiqueta de cadeia que é anexada aos destaques de acesso. Tem de ser definido com highlightPreTag. A predefinição é </em>. |
highlight |
Uma etiqueta de cadeia que está pré-anexada para atingir destaques. Tem de ser definido com highlightPostTag. A predefinição é <em>. |
include |
Um valor que especifica se pretende obter a contagem total de resultados. A predefinição é falso. Definir este valor como verdadeiro pode ter um impacto no desempenho. Tenha em atenção que a contagem devolvida é uma aproximação. |
minimum |
Um número entre 0 e 100 que indica a percentagem do índice que tem de ser abrangida por uma consulta de pesquisa para que a consulta seja comunicada com êxito. Este parâmetro pode ser útil para garantir a disponibilidade da pesquisa, mesmo para serviços com apenas uma réplica. A predefinição é 100. |
order |
A lista de expressões OData $orderby através das quais pretende ordenar os resultados. Cada expressão pode ser um nome de campo ou uma chamada para as funções geo.distance() ou search.score(). Cada expressão pode ser seguida por asc para indicar ascendente ou desc para indicar descendente. A predefinição é ordem ascendente. Os laços serão quebrados pelas pontuações de correspondência de documentos. Se não for especificado nenhum $orderby, a sequência de ordenação predefinida é descendente pela classificação de correspondência do documento. Pode haver, no máximo, 32 cláusulas de $orderby. |
query |
Um valor que especifica a sintaxe da consulta de pesquisa. A predefinição é "simples". Utilize "full" se a consulta utilizar a sintaxe da consulta Lucene. Os valores possíveis incluem: "simples", "completo", "semântico" |
scoring |
A lista de valores de parâmetros a utilizar nas funções de classificação (por exemplo, referencePointParameter) com o formato name-values. Por exemplo, se o perfil de classificação definir uma função com um parâmetro chamado "mylocation", a cadeia de parâmetros será "mylocation--122.2,44.8" (sem as aspas). |
scoring |
O nome de um perfil de classificação para avaliar pontuações de correspondência para documentos correspondentes para ordenar os resultados. |
scoring |
Um valor que especifica se queremos calcular as estatísticas de classificação (como a frequência do documento) globalmente para uma classificação mais consistente, ou localmente, para uma menor latência. Os valores possíveis incluem: "Local", "Global" |
search |
A lista de nomes de campos separados por vírgulas para definir o âmbito da pesquisa em texto completo. Ao utilizar a pesquisa em campo (fieldName:searchExpression) numa consulta Lucene completa, os nomes de campo de cada expressão de pesquisa em campo têm precedência sobre os nomes de campo listados neste parâmetro. |
search |
Um valor que especifica se algum ou todos os termos de pesquisa têm de ser correspondidos para contar o documento como uma correspondência. Os valores possíveis incluem: "any", "all" |
select | A lista de campos a obter. Se não for especificado, todos os campos marcados como recuperáveis no esquema serão incluídos. |
session |
Um valor a ser utilizado para criar uma sessão autocolante, o que pode ajudar a obter resultados mais consistentes. Desde que o mesmo sessionId seja utilizado, será feita uma tentativa de melhor esforço para direcionar o mesmo conjunto de réplicas. Tenha em atenção que reutilizar os mesmos valores sessionID repetidamente pode interferir com o balanceamento de carga dos pedidos entre réplicas e afetar negativamente o desempenho do serviço de pesquisa. O valor utilizado como sessionId não pode começar com um caráter "_". |
skip | O número de resultados da pesquisa a ignorar. Este valor não pode ser superior a 100 000. Se precisar de digitalizar documentos em sequência, mas não puder utilizar ignorar devido a esta limitação, considere utilizar orderby numa chave totalmente ordenada e filtre com uma consulta de intervalo. |
top | O número de resultados de pesquisa a obter. Isto pode ser utilizado em conjunto com $skip para implementar a paginação do lado do cliente dos resultados da pesquisa. Se os resultados forem truncados devido à paginação do lado do servidor, a resposta incluirá um token de continuação que pode ser utilizado para emitir outro pedido de Pesquisa para a próxima página de resultados. |
vector |
Define opções para consultas de pesquisa de vetores |
Detalhes de Propriedade
facets
A lista de expressões de facetas a aplicar à consulta de pesquisa. Cada expressão de faceta contém um nome de campo, opcionalmente seguido por uma lista separada por vírgulas de pares name:value.
facets?: string[]
Valor de Propriedade
string[]
filter
O OData $filter expressão a aplicar à consulta de pesquisa.
filter?: string
Valor de Propriedade
string
highlightFields
A lista separada por vírgulas de nomes de campos a utilizar para os destaques de êxito. Apenas os campos pesquisáveis podem ser utilizados para realce de acesso.
highlightFields?: string
Valor de Propriedade
string
highlightPostTag
Uma etiqueta de cadeia que é anexada aos destaques de acesso. Tem de ser definido com highlightPreTag. A predefinição é </em>.
highlightPostTag?: string
Valor de Propriedade
string
highlightPreTag
Uma etiqueta de cadeia que está pré-anexada para atingir destaques. Tem de ser definido com highlightPostTag. A predefinição é <em>.
highlightPreTag?: string
Valor de Propriedade
string
includeTotalCount
Um valor que especifica se pretende obter a contagem total de resultados. A predefinição é falso. Definir este valor como verdadeiro pode ter um impacto no desempenho. Tenha em atenção que a contagem devolvida é uma aproximação.
includeTotalCount?: boolean
Valor de Propriedade
boolean
minimumCoverage
Um número entre 0 e 100 que indica a percentagem do índice que tem de ser abrangida por uma consulta de pesquisa para que a consulta seja comunicada com êxito. Este parâmetro pode ser útil para garantir a disponibilidade da pesquisa, mesmo para serviços com apenas uma réplica. A predefinição é 100.
minimumCoverage?: number
Valor de Propriedade
number
orderBy
A lista de expressões OData $orderby através das quais pretende ordenar os resultados. Cada expressão pode ser um nome de campo ou uma chamada para as funções geo.distance() ou search.score(). Cada expressão pode ser seguida por asc para indicar ascendente ou desc para indicar descendente. A predefinição é ordem ascendente. Os laços serão quebrados pelas pontuações de correspondência de documentos. Se não for especificado nenhum $orderby, a sequência de ordenação predefinida é descendente pela classificação de correspondência do documento. Pode haver, no máximo, 32 cláusulas de $orderby.
orderBy?: string[]
Valor de Propriedade
string[]
queryType
Um valor que especifica a sintaxe da consulta de pesquisa. A predefinição é "simples". Utilize "full" se a consulta utilizar a sintaxe da consulta Lucene. Os valores possíveis incluem: "simples", "completo", "semântico"
queryType?: QueryType
Valor de Propriedade
scoringParameters
A lista de valores de parâmetros a utilizar nas funções de classificação (por exemplo, referencePointParameter) com o formato name-values. Por exemplo, se o perfil de classificação definir uma função com um parâmetro chamado "mylocation", a cadeia de parâmetros será "mylocation--122.2,44.8" (sem as aspas).
scoringParameters?: string[]
Valor de Propriedade
string[]
scoringProfile
O nome de um perfil de classificação para avaliar pontuações de correspondência para documentos correspondentes para ordenar os resultados.
scoringProfile?: string
Valor de Propriedade
string
scoringStatistics
Um valor que especifica se queremos calcular as estatísticas de classificação (como a frequência do documento) globalmente para uma classificação mais consistente, ou localmente, para uma menor latência. Os valores possíveis incluem: "Local", "Global"
scoringStatistics?: ScoringStatistics
Valor de Propriedade
searchFields
A lista de nomes de campos separados por vírgulas para definir o âmbito da pesquisa em texto completo. Ao utilizar a pesquisa em campo (fieldName:searchExpression) numa consulta Lucene completa, os nomes de campo de cada expressão de pesquisa em campo têm precedência sobre os nomes de campo listados neste parâmetro.
searchFields?: SearchFieldArray<TModel>
Valor de Propriedade
SearchFieldArray<TModel>
searchMode
Um valor que especifica se algum ou todos os termos de pesquisa têm de ser correspondidos para contar o documento como uma correspondência. Os valores possíveis incluem: "any", "all"
searchMode?: SearchMode
Valor de Propriedade
select
A lista de campos a obter. Se não for especificado, todos os campos marcados como recuperáveis no esquema serão incluídos.
select?: SelectArray<TFields>
Valor de Propriedade
SelectArray<TFields>
sessionId
Um valor a ser utilizado para criar uma sessão autocolante, o que pode ajudar a obter resultados mais consistentes. Desde que o mesmo sessionId seja utilizado, será feita uma tentativa de melhor esforço para direcionar o mesmo conjunto de réplicas. Tenha em atenção que reutilizar os mesmos valores sessionID repetidamente pode interferir com o balanceamento de carga dos pedidos entre réplicas e afetar negativamente o desempenho do serviço de pesquisa. O valor utilizado como sessionId não pode começar com um caráter "_".
sessionId?: string
Valor de Propriedade
string
skip
O número de resultados da pesquisa a ignorar. Este valor não pode ser superior a 100 000. Se precisar de digitalizar documentos em sequência, mas não puder utilizar ignorar devido a esta limitação, considere utilizar orderby numa chave totalmente ordenada e filtre com uma consulta de intervalo.
skip?: number
Valor de Propriedade
number
top
O número de resultados de pesquisa a obter. Isto pode ser utilizado em conjunto com $skip para implementar a paginação do lado do cliente dos resultados da pesquisa. Se os resultados forem truncados devido à paginação do lado do servidor, a resposta incluirá um token de continuação que pode ser utilizado para emitir outro pedido de Pesquisa para a próxima página de resultados.
top?: number
Valor de Propriedade
number
vectorSearchOptions
Define opções para consultas de pesquisa de vetores
vectorSearchOptions?: VectorSearchOptions<TModel>
Valor de Propriedade
VectorSearchOptions<TModel>