Partilhar via


BaseSearchRequestOptions interface

Parâmetros para filtragem, classificação, facetagem, paginação e outros comportamentos de consulta de pesquisa.

Propriedades

facets

A lista de expressões de faceta a serem aplicadas à 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 nome:valor.

filter

O OData $filter expressão a ser aplicada à consulta de pesquisa.

highlightFields

A lista separada por vírgulas de nomes de campos a serem usados para destaques de cliques. Apenas os campos pesquisáveis podem ser usados para realce de cliques.

highlightPostTag

Uma tag de cadeia de caracteres que é anexada aos destaques de clique. Deve ser definido com highlightPreTag. O padrão é </em>.

highlightPreTag

Uma tag de cadeia de caracteres que é preparada para atingir destaques. Deve ser definido com highlightPostTag. O padrão é <em>.

includeTotalCount

Um valor que especifica se a contagem total de resultados deve ser buscada. O padrão é false. Definir esse valor como true pode ter um impacto no desempenho. Observe que a contagem retornada é uma aproximação.

minimumCoverage

Um número entre 0 e 100 que indica a porcentagem do índice que deve ser coberta por uma consulta de pesquisa para que a consulta seja relatada como um sucesso. Esse parâmetro pode ser útil para garantir a disponibilidade da pesquisa, mesmo para serviços com apenas uma réplica. O padrão é 100.

orderBy

A lista de OData $orderby expressões pelas quais classificar 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. O padrão é ordem crescente. Os empates serão quebrados pelas pontuações dos documentos. Se nenhum $orderby for especificado, a ordem de classificação padrão será decrescente por pontuação de correspondência de documento. Pode haver no máximo 32 $orderby cláusulas.

queryType

Um valor que especifica a sintaxe da consulta de pesquisa. O padrão é 'simples'. Use 'full' se sua consulta usar a sintaxe de consulta Lucene. Os valores possíveis incluem: 'simples', 'completo', 'semântico'

scoringParameters

A lista de valores de parâmetros a serem usados em funções de pontuação (por exemplo, referencePointParameter) usando o formato name-values. Por exemplo, se o perfil de pontuação define uma função com um parâmetro chamado 'mylocation', a string do parâmetro seria "mylocation--122.2,44.8" (sem as aspas).

scoringProfile

O nome de um perfil de pontuação para avaliar as pontuações de correspondência para documentos correspondentes, a fim de classificar os resultados.

scoringStatistics

Um valor que especifica se queremos calcular estatísticas de pontuação (como frequência de documentos) globalmente para uma pontuação mais consistente ou localmente para uma latência mais baixa. Os valores possíveis incluem: 'Local', 'Global'

searchFields

A lista separada por vírgulas de nomes de campos para os quais definir o escopo da pesquisa de texto completo. Ao usar a pesquisa em campo (fieldName:searchExpression) em uma consulta Lucene completa, os nomes de campo de cada expressão de pesquisa em campo têm precedência sobre quaisquer nomes de campo listados neste parâmetro.

searchMode

Um valor que especifica se algum ou todos os termos de pesquisa devem ser correspondidos para contar o documento como uma correspondência. Os valores possíveis incluem: 'qualquer', 'todos'

select

A lista de campos a recuperar. Se não for especificado, todos os campos marcados como recuperáveis no esquema serão incluídos.

sessionId

Um valor a ser usado para criar uma sessão pegajosa, que pode ajudar a obter resultados mais consistentes. Contanto que o mesmo sessionId seja usado, uma tentativa de melhor esforço será feita para direcionar o mesmo conjunto de réplicas. Desconfie de que a reutilização repetida dos mesmos valores de sessionID pode interferir no balanceamento de carga das solicitações entre réplicas e afetar negativamente o desempenho do serviço de pesquisa. O valor usado como sessionId não pode começar com um caractere '_'.

skip

O número de resultados da pesquisa a ignorar. Este valor não pode ser superior a 100.000. Se você precisar digitalizar documentos em sequência, mas não puder usar skip devido a essa limitação, considere usar orderby em uma chave totalmente ordenada e filtrar com uma consulta de intervalo.

top

O número de resultados da pesquisa a serem recuperados. Isso pode ser usado 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 usado para emitir outra solicitação de Pesquisa para a próxima página de resultados.

vectorSearchOptions

Define opções para consultas de pesquisa vetorial

Detalhes de Propriedade

facets

A lista de expressões de faceta a serem aplicadas à 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 nome:valor.

facets?: string[]

Valor de Propriedade

string[]

filter

O OData $filter expressão a ser aplicada à consulta de pesquisa.

filter?: string

Valor de Propriedade

string

highlightFields

A lista separada por vírgulas de nomes de campos a serem usados para destaques de cliques. Apenas os campos pesquisáveis podem ser usados para realce de cliques.

highlightFields?: string

Valor de Propriedade

string

highlightPostTag

Uma tag de cadeia de caracteres que é anexada aos destaques de clique. Deve ser definido com highlightPreTag. O padrão é </em>.

highlightPostTag?: string

Valor de Propriedade

string

highlightPreTag

Uma tag de cadeia de caracteres que é preparada para atingir destaques. Deve ser definido com highlightPostTag. O padrão é <em>.

highlightPreTag?: string

Valor de Propriedade

string

includeTotalCount

Um valor que especifica se a contagem total de resultados deve ser buscada. O padrão é false. Definir esse valor como true pode ter um impacto no desempenho. Observe que a contagem retornada é uma aproximação.

includeTotalCount?: boolean

Valor de Propriedade

boolean

minimumCoverage

Um número entre 0 e 100 que indica a porcentagem do índice que deve ser coberta por uma consulta de pesquisa para que a consulta seja relatada como um sucesso. Esse parâmetro pode ser útil para garantir a disponibilidade da pesquisa, mesmo para serviços com apenas uma réplica. O padrão é 100.

minimumCoverage?: number

Valor de Propriedade

number

orderBy

A lista de OData $orderby expressões pelas quais classificar 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. O padrão é ordem crescente. Os empates serão quebrados pelas pontuações dos documentos. Se nenhum $orderby for especificado, a ordem de classificação padrão será decrescente por pontuação de correspondência de documento. Pode haver no máximo 32 $orderby cláusulas.

orderBy?: string[]

Valor de Propriedade

string[]

queryType

Um valor que especifica a sintaxe da consulta de pesquisa. O padrão é 'simples'. Use 'full' se sua consulta usar a sintaxe de 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 serem usados em funções de pontuação (por exemplo, referencePointParameter) usando o formato name-values. Por exemplo, se o perfil de pontuação define uma função com um parâmetro chamado 'mylocation', a string do parâmetro seria "mylocation--122.2,44.8" (sem as aspas).

scoringParameters?: string[]

Valor de Propriedade

string[]

scoringProfile

O nome de um perfil de pontuação para avaliar as pontuações de correspondência para documentos correspondentes, a fim de classificar os resultados.

scoringProfile?: string

Valor de Propriedade

string

scoringStatistics

Um valor que especifica se queremos calcular estatísticas de pontuação (como frequência de documentos) globalmente para uma pontuação mais consistente ou localmente para uma latência mais baixa. Os valores possíveis incluem: 'Local', 'Global'

scoringStatistics?: ScoringStatistics

Valor de Propriedade

searchFields

A lista separada por vírgulas de nomes de campos para os quais definir o escopo da pesquisa de texto completo. Ao usar a pesquisa em campo (fieldName:searchExpression) em uma consulta Lucene completa, os nomes de campo de cada expressão de pesquisa em campo têm precedência sobre quaisquer nomes de campo listados neste parâmetro.

searchFields?: SearchFieldArray<TModel>

Valor de Propriedade

searchMode

Um valor que especifica se algum ou todos os termos de pesquisa devem ser correspondidos para contar o documento como uma correspondência. Os valores possíveis incluem: 'qualquer', 'todos'

searchMode?: SearchMode

Valor de Propriedade

select

A lista de campos a recuperar. 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 usado para criar uma sessão pegajosa, que pode ajudar a obter resultados mais consistentes. Contanto que o mesmo sessionId seja usado, uma tentativa de melhor esforço será feita para direcionar o mesmo conjunto de réplicas. Desconfie de que a reutilização repetida dos mesmos valores de sessionID pode interferir no balanceamento de carga das solicitações entre réplicas e afetar negativamente o desempenho do serviço de pesquisa. O valor usado como sessionId não pode começar com um caractere '_'.

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 você precisar digitalizar documentos em sequência, mas não puder usar skip devido a essa limitação, considere usar orderby em uma chave totalmente ordenada e filtrar com uma consulta de intervalo.

skip?: number

Valor de Propriedade

number

top

O número de resultados da pesquisa a serem recuperados. Isso pode ser usado 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 usado para emitir outra solicitação de Pesquisa para a próxima página de resultados.

top?: number

Valor de Propriedade

number

vectorSearchOptions

Define opções para consultas de pesquisa vetorial

vectorSearchOptions?: VectorSearchOptions<TModel>

Valor de Propriedade