SearchParameters Classe

Definição

Namespace:

Microsoft.Azure.Search.Models

Assembly:

Microsoft.Azure.Search.Data.dll

Pacote:

Microsoft.Azure.Search.Data v10.1.0

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

public class SearchParameters

type SearchParameters = class

Public Class SearchParameters

Herança

Object

SearchParameters

Construtores

SearchParameters()	Inicializa uma nova instância da classe SearchParameters.
SearchParameters(Boolean, IList<String>, String, IList<String>, String, String, Nullable<Double>, IList<String>, QueryType, IList<ScoringParameter>, String, IList<String>, SearchMode, IList<String>, Nullable<Int32>, Nullable<Int32>)	Inicializa uma nova instância da classe SearchParameters.

Propriedades

Facets	Obtém ou define 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	Obtém ou define a expressão OData $filter a ser aplicada à consulta de pesquisa.
HighlightFields	Obtém ou define a lista de nomes de campo a serem usados para realces de ocorrência. Somente campos pesquisáveis podem ser usados para realce de clique.
HighlightPostTag	Obtém ou define uma marca de cadeia de caracteres que é acrescentada para atingir realces. Deve ser definido com highlightPreTag. O padrão é </em>.
HighlightPreTag	Obtém ou define uma marca de cadeia de caracteres que é prefixada para atingir os realces. Deve ser definido com highlightPostTag. O padrão é <em>.
IncludeTotalResultCount	Obtém ou define 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	Obtém ou define um número entre 0 e 100 indicando 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 um réplica. O padrão é 100.
OrderBy	Obtém ou define a lista de expressões de $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 e desc para indicar decrescente. O padrão é a ordem crescente. Os empates serão resolvidos pelas pontuações de correspondência de documentos. Se nenhum OrderBy for especificado, a ordem de classificação padrão será decrescente pela pontuação de correspondência do documento. Pode haver no máximo 32 cláusulas $orderby.
QueryType	Obtém ou define 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: 'simple', 'full'
ScoringParameters	Obtém ou define 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	Obtém ou define o nome de um perfil de pontuação para avaliar as pontuações de correspondência de documentos correspondentes para classificar os resultados.
SearchFields	Obtém ou define a lista 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 quaisquer nomes de campo listados nesse parâmetro.
SearchMode	Obtém ou define um valor que especifica se qualquer 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	Obtém ou define 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.
Skip	Obtém ou define o número de resultados da pesquisa a serem ignoradas. Esse valor não deve ser maior que 100.000. Se você precisar examinar documentos em sequência, mas não puder usar $skip devido a essa limitação, considere usar $orderby em uma chave totalmente ordenada e $filter com uma consulta de intervalo.
Top	Obtém ou define 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.