SuggestRequest interface

Pacote:

@azure/search-documents

Parâmetros para filtragem, ordenaçã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 etiqueta de cadeia de carateres que é anexada para obter destaques. Tem de ser definido com highlightPreTag. Se for omitido, prima o realce das sugestões desativado.
highlightPreTag	Uma etiqueta de cadeia de carateres que está pré-anexada para obter destaques. Tem de ser definido com highlightPostTag. Se for omitido, prima o realce das sugestões desativado.
minimumCoverage	Um número entre 0 e 100 que indica a percentagem do índice que tem de ser abrangido por uma consulta de sugestão para que a consulta seja comunicada com êxito. Este parâmetro pode ser útil para garantir a disponibilidade da pesquisa, mesmo para serviços com apenas uma réplica. A predefinição é 80.
orderBy	A lista de OData $orderby expressões pelas quais ordenar 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. A predefinição é ordem ascendente. Os empates serão quebrados pelas pontuações de correspondência de documentos. Se não for especificada nenhuma $orderby, a sequência de ordenação predefinida é descendente por classificação de correspondência do documento. Pode haver, no máximo, 32 cláusulas de $orderby.
searchFields	A lista separada por vírgulas de nomes de campos para procurar o texto de pesquisa especificado. Os campos de destino têm de ser incluídos no sugeridor especificado.
select	A lista de campos a obter. Se não for especificado, apenas o campo de chave será incluído nos resultados.
top	/** O número de sugestões a obter. Tem de ser um valor entre 1 e 100. A predefinição é
useFuzzyMatching	Um valor que indica se deve utilizar correspondência difusa para a consulta de sugestão. A predefinição é falso. Quando definida como verdadeira, a consulta encontrará sugestões mesmo que exista um caráter substituído ou em falta no texto de pesquisa. Embora isto proporcione uma melhor experiência em alguns cenários, tem um custo de desempenho, uma vez 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 etiqueta de cadeia de carateres que é anexada para obter destaques. Tem de ser definido com highlightPreTag. Se for omitido, prima o realce das sugestões desativado.

highlightPostTag?: string

Valor de Propriedade

string

highlightPreTag

Uma etiqueta de cadeia de carateres que está pré-anexada para obter destaques. Tem de ser definido com highlightPostTag. Se for omitido, prima o realce das sugestões desativado.

highlightPreTag?: string

Valor de Propriedade

string

minimumCoverage

Um número entre 0 e 100 que indica a percentagem do índice que tem de ser abrangido por uma consulta de sugestão para que a consulta seja comunicada com êxito. Este parâmetro pode ser útil para garantir a disponibilidade da pesquisa, mesmo para serviços com apenas uma réplica. A predefinição é 80.

minimumCoverage?: number

Valor de Propriedade

number

orderBy

A lista de OData $orderby expressões pelas quais ordenar 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. A predefinição é ordem ascendente. Os empates serão quebrados pelas pontuações de correspondência de documentos. Se não for especificada nenhuma $orderby, a sequência de ordenação predefinida é descendente por classificação de correspondência do documento. Pode haver, no máximo, 32 cláusulas de $orderby.

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 têm de ser incluídos no sugeridor especificado.

searchFields?: SearchFieldArray<TModel>

Valor de Propriedade

SearchFieldArray<TModel>

select

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

select?: SelectArray<TFields>

Valor de Propriedade

SelectArray<TFields>

top

/**

• O número de sugestões a obter. Tem de ser um valor entre 1 e 100. A predefinição é

top?: number

Valor de Propriedade

number

useFuzzyMatching

Um valor que indica se deve utilizar correspondência difusa para a consulta de sugestão. A predefinição é falso. Quando definida como verdadeira, a consulta encontrará sugestões mesmo que exista um caráter substituído ou em falta no texto de pesquisa. Embora isto proporcione uma melhor experiência em alguns cenários, tem um custo de desempenho, uma vez que as pesquisas de sugestões difusas são mais lentas e consomem mais recursos.

useFuzzyMatching?: boolean

Valor de Propriedade

boolean