Partilhar via

SuggestRequest interface

Pacote:
@azure/search-documents

Parâmetros para filtragem, classificação, correspondência difusa e outros comportamentos de consulta de sugestões.

Propriedades

filter

Uma expressão OData que filtra os documentos considerados para sugestões.
highlightPostTag

Uma tag de cadeia de caracteres que é anexada aos destaques de clique. Deve ser definido com highlightPreTag. Se omitido, o realce de sugestões é desativado.
highlightPreTag

Uma tag de cadeia de caracteres que é preparada para atingir destaques. Deve ser definido com highlightPostTag. Se omitido, o realce de sugestões é desativado.
minimumCoverage

Um número entre 0 e 100 indicando a porcentagem do índice que deve ser coberta por uma consulta de sugestão 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 é 80.
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.
searchFields

A lista separada por vírgulas de nomes de campos para procurar o texto de pesquisa especificado. Os campos de destino devem ser incluídos no sugeridor especificado.
select

A lista de campos a recuperar. Se não for especificado, apenas o campo-chave será incluído nos resultados.
top

/**

  • O número de sugestões a recuperar. Este deve ser um valor entre 1 e 100. O padrão é
useFuzzyMatching

Um valor que indica se a correspondência difusa deve ser usada para a consulta de sugestão. O padrão é false. Quando definida como true, a consulta encontrará sugestões, mesmo que haja um caractere substituído ou ausente no texto da pesquisa. Embora isso proporcione uma experiência melhor em alguns cenários, tem um custo de desempenho, já que as pesquisas de sugestões difusas, são mais lentas e consomem mais recursos.

Detalhes de Propriedade

filter

Uma expressão OData que filtra os documentos considerados para sugestões.

filter?: string

Valor de Propriedade

string

highlightPostTag

Uma tag de cadeia de caracteres que é anexada aos destaques de clique. Deve ser definido com highlightPreTag. Se omitido, o realce de sugestões é desativado.

highlightPostTag?: string

Valor de Propriedade

string

highlightPreTag

Uma tag de cadeia de caracteres que é preparada para atingir destaques. Deve ser definido com highlightPostTag. Se omitido, o realce de sugestões é desativado.

highlightPreTag?: string

Valor de Propriedade

string

minimumCoverage

Um número entre 0 e 100 indicando a porcentagem do índice que deve ser coberta por uma consulta de sugestão 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 é 80.

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[]

searchFields

A lista separada por vírgulas de nomes de campos para procurar o texto de pesquisa especificado. Os campos de destino devem ser incluídos no sugeridor especificado.

searchFields?: SearchFieldArray<TModel>

Valor de Propriedade

SearchFieldArray<TModel>

select

A lista de campos a recuperar. Se não for especificado, apenas o campo-chave será incluído nos resultados.

select?: SelectArray<TFields>

Valor de Propriedade

SelectArray<TFields>

top

/**

  • O número de sugestões a recuperar. Este deve ser um valor entre 1 e 100. O padrão é
top?: number

Valor de Propriedade

number

useFuzzyMatching

Um valor que indica se a correspondência difusa deve ser usada para a consulta de sugestão. O padrão é false. Quando definida como true, a consulta encontrará sugestões, mesmo que haja um caractere substituído ou ausente no texto da pesquisa. Embora isso proporcione uma experiência melhor em alguns cenários, tem um custo de desempenho, já que as pesquisas de sugestões difusas, são mais lentas e consomem mais recursos.

useFuzzyMatching?: boolean

Valor de Propriedade

boolean