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 marca de cadeia de caracteres que é acrescentada a realces de clique. Deve ser definido com highlightPreTag. Se omitido, o realce de clique das sugestões será desabilitado.
highlightPreTag	Uma marca de cadeia de caracteres que é acrescentada a realces de clique. Deve ser definido com highlightPostTag. Se omitido, o realce de clique das sugestões será desabilitado.
minimumCoverage	Um número entre 0 e 100 que indica o percentual do índice que deve ser coberto 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 de pesquisa mesmo para serviços com apenas uma réplica. O padrão é 80.
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.
searchFields	A lista separada por vírgulas de nomes de campo para pesquisar o texto de pesquisa especificado. Os campos de destino devem ser incluídos no sugestor especificado.
select	A lista de campos a serem recuperados. Se não for especificado, somente o campo de chave será incluído nos resultados.
top	/** O número de sugestões a serem recuperadas. Esse 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 se houver um caractere substituído ou ausente no texto de pesquisa. Embora isso forneça uma experiência melhor em alguns cenários, ele tem um custo de desempenho, pois as pesquisas de sugestões difusas são mais lentas e consomem mais recursos.

Detalhes da propriedade

filter

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

filter?: string

Valor da propriedade

string

highlightPostTag

Uma marca de cadeia de caracteres que é acrescentada a realces de clique. Deve ser definido com highlightPreTag. Se omitido, o realce de clique das sugestões será desabilitado.

highlightPostTag?: string

Valor da propriedade

string

highlightPreTag

Uma marca de cadeia de caracteres que é acrescentada a realces de clique. Deve ser definido com highlightPostTag. Se omitido, o realce de clique das sugestões será desabilitado.

highlightPreTag?: string

Valor da propriedade

string

minimumCoverage

Um número entre 0 e 100 que indica o percentual do índice que deve ser coberto 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 de pesquisa mesmo para serviços com apenas uma réplica. O padrão é 80.

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

searchFields

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

searchFields?: SearchFieldArray<TModel>

Valor da propriedade

SearchFieldArray<TModel>

select

A lista de campos a serem recuperados. Se não for especificado, somente o campo de chave será incluído nos resultados.

select?: SelectArray<TFields>

Valor da propriedade

SelectArray<TFields>

top

/**

• O número de sugestões a serem recuperadas. Esse deve ser um valor entre 1 e 100. O padrão é

top?: number

Valor da 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 se houver um caractere substituído ou ausente no texto de pesquisa. Embora isso forneça uma experiência melhor em alguns cenários, ele tem um custo de desempenho, pois as pesquisas de sugestões difusas são mais lentas e consomem mais recursos.

useFuzzyMatching?: boolean

Valor da propriedade

boolean