Compartilhar via


BaseSearchRequestOptions interface

Parâmetros para filtragem, classificação, faceta, 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

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

highlightFields

A lista separada por vírgulas de nomes de campo a serem usados para realces de ocorrência. Somente campos pesquisáveis podem ser usados para realce de clique.

highlightPostTag

Uma marca de cadeia de caracteres que é acrescentada a realces de clique. Deve ser definido com highlightPreTag. O padrão é </em>.

highlightPreTag

Uma marca de cadeia de caracteres que é acrescentada a realces de clique. 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 o percentual do índice que deve ser coberto por uma consulta de pesquisa para que a consulta seja relatada como um sucesso. Esse parâmetro pode ser útil para garantir a disponibilidade de pesquisa mesmo para serviços com apenas uma réplica. O padrão é 100.

orderBy

A lista de expressões $orderby OData 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 crescente ou desc para indicar decrescente. O padrão é a ordem crescente. Os empates serão interrompidos pelas pontuações de correspondência de documentos. Se nenhuma $orderby for especificada, a ordem de classificação padrão será decrescente por pontuação de correspondência do documento. Pode haver no máximo 32 cláusulas $orderby.

queryType

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

scoringParameters

A lista de valores de parâmetro 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 definir uma função com um parâmetro chamado 'mylocation', a cadeia de caracteres de parâmetro será "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 de documentos correspondentes para classificar os resultados.

scoringStatistics

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

searchFields

A lista separada por vírgulas de nomes de campo 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 todos os nomes de campo listados neste parâmetro.

searchMode

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

select

A lista de campos a serem recuperados. 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 autoadesiva, que pode ajudar a obter resultados mais consistentes. Desde que a mesma sessionId seja usada, uma tentativa de melhor esforço será feita para atingir o mesmo conjunto de réplicas. Tenha cuidado para que a reutilização dos mesmos valores sessionID repetidamente possa 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 serem ignoradas. Esse valor não pode ser maior que 100.000. Se você precisar verificar documentos em sequência, mas não puder usar ignorar 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 de vetor

Detalhes da 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 da propriedade

string[]

filter

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

filter?: string

Valor da propriedade

string

highlightFields

A lista separada por vírgulas de nomes de campo a serem usados para realces de ocorrência. Somente campos pesquisáveis podem ser usados para realce de clique.

highlightFields?: string

Valor da propriedade

string

highlightPostTag

Uma marca de cadeia de caracteres que é acrescentada a realces de clique. Deve ser definido com highlightPreTag. O padrão é </em>.

highlightPostTag?: string

Valor da propriedade

string

highlightPreTag

Uma marca de cadeia de caracteres que é acrescentada a realces de clique. Deve ser definido com highlightPostTag. O padrão é <em>.

highlightPreTag?: string

Valor da 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 da propriedade

boolean

minimumCoverage

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

minimumCoverage?: number

Valor da propriedade

number

orderBy

A lista de expressões $orderby OData 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 crescente ou desc para indicar decrescente. O padrão é a ordem crescente. Os empates serão interrompidos pelas pontuações de correspondência de documentos. Se nenhuma $orderby for especificada, a ordem de classificação padrão será decrescente por pontuação de correspondência do documento. Pode haver no máximo 32 cláusulas $orderby.

orderBy?: string[]

Valor da propriedade

string[]

queryType

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

queryType?: QueryType

Valor da propriedade

scoringParameters

A lista de valores de parâmetro 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 definir uma função com um parâmetro chamado 'mylocation', a cadeia de caracteres de parâmetro será "mylocation--122.2,44.8" (sem as aspas).

scoringParameters?: string[]

Valor da propriedade

string[]

scoringProfile

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

scoringProfile?: string

Valor da propriedade

string

scoringStatistics

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

scoringStatistics?: ScoringStatistics

Valor da propriedade

searchFields

A lista separada por vírgulas de nomes de campo 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 todos os nomes de campo listados neste parâmetro.

searchFields?: SearchFieldArray<TModel>

Valor da propriedade

searchMode

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

searchMode?: SearchMode

Valor da propriedade

select

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

select?: SelectArray<TFields>

Valor da propriedade

SelectArray<TFields>

sessionId

Um valor a ser usado para criar uma sessão autoadesiva, que pode ajudar a obter resultados mais consistentes. Desde que a mesma sessionId seja usada, uma tentativa de melhor esforço será feita para atingir o mesmo conjunto de réplicas. Tenha cuidado para que a reutilização dos mesmos valores sessionID repetidamente possa 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 da propriedade

string

skip

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

skip?: number

Valor da 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 da propriedade

number

vectorSearchOptions

Define opções para consultas de pesquisa de vetor

vectorSearchOptions?: VectorSearchOptions<TModel>

Valor da propriedade