Share via


SuggestRequest interface

Parametri per il filtro, l'ordinamento, la corrispondenza fuzzy e altri comportamenti di query di suggerimenti.

Proprietà

filter

Espressione OData che filtra i documenti considerati per i suggerimenti.

highlightPostTag

Tag stringa accodato alle evidenziazioni di hit. Deve essere impostato con highlightPreTag. Se omesso, l'evidenziazione dei suggerimenti è disabilitata.

highlightPreTag

Tag stringa prependato per l'evidenziazione. Deve essere impostato con highlightPostTag. Se omesso, l'evidenziazione dei suggerimenti è disabilitata.

minimumCoverage

Numero compreso tra 0 e 100 che indica la percentuale dell'indice che deve essere coperta da una query di suggerimento affinché la query venga segnalata come esito positivo. Questo parametro può essere utile per garantire la disponibilità di ricerca anche per i servizi con una sola replica. Il valore predefinito è 80.

orderBy

Elenco di espressioni di $orderby OData in base al quale ordinare i risultati. Ogni espressione può essere un nome di campo o una chiamata alle funzioni geo.distance() o search.score(). Ogni espressione può essere seguita da asc per indicare l'crescente o il desc per indicare la decrescente. Per impostazione predefinita, l'ordinamento è crescente. Le situazioni di parità di priorità vengono risolte in base ai punteggi di corrispondenza dei documenti. Se non viene specificata alcuna $orderby, l'ordine di ordinamento predefinito è decrescente in base al punteggio di corrispondenza del documento. Possono essere presenti al massimo 32 clausole $orderby.

searchFields

Elenco delimitato da virgole di nomi di campo per cercare il testo di ricerca specificato. I campi di destinazione devono essere inclusi nel suggerimento specificato.

select

Elenco di campi da recuperare. Se non specificato, solo il campo chiave verrà incluso nei risultati.

top

/**

  • Numero di suggerimenti da recuperare. Deve essere un valore compreso tra 1 e 100. Il valore predefinito è
useFuzzyMatching

Valore che indica se usare la corrispondenza fuzzy per la query di suggerimento. L'impostazione predefinita è false. Se impostato su true, la query troverà suggerimenti anche se nel testo di ricerca è presente un carattere sostituito o mancante. Sebbene offra un'esperienza migliore in alcuni scenari, influisce sulle prestazioni in quanto le ricerche con suggerimenti fuzzy sono più lente e utilizzano più risorse.

Dettagli proprietà

filter

Espressione OData che filtra i documenti considerati per i suggerimenti.

filter?: string

Valore della proprietà

string

highlightPostTag

Tag stringa accodato alle evidenziazioni di hit. Deve essere impostato con highlightPreTag. Se omesso, l'evidenziazione dei suggerimenti è disabilitata.

highlightPostTag?: string

Valore della proprietà

string

highlightPreTag

Tag stringa prependato per l'evidenziazione. Deve essere impostato con highlightPostTag. Se omesso, l'evidenziazione dei suggerimenti è disabilitata.

highlightPreTag?: string

Valore della proprietà

string

minimumCoverage

Numero compreso tra 0 e 100 che indica la percentuale dell'indice che deve essere coperta da una query di suggerimento affinché la query venga segnalata come esito positivo. Questo parametro può essere utile per garantire la disponibilità di ricerca anche per i servizi con una sola replica. Il valore predefinito è 80.

minimumCoverage?: number

Valore della proprietà

number

orderBy

Elenco di espressioni di $orderby OData in base al quale ordinare i risultati. Ogni espressione può essere un nome di campo o una chiamata alle funzioni geo.distance() o search.score(). Ogni espressione può essere seguita da asc per indicare l'crescente o il desc per indicare la decrescente. Per impostazione predefinita, l'ordinamento è crescente. Le situazioni di parità di priorità vengono risolte in base ai punteggi di corrispondenza dei documenti. Se non viene specificata alcuna $orderby, l'ordine di ordinamento predefinito è decrescente in base al punteggio di corrispondenza del documento. Possono essere presenti al massimo 32 clausole $orderby.

orderBy?: string[]

Valore della proprietà

string[]

searchFields

Elenco delimitato da virgole di nomi di campo per cercare il testo di ricerca specificato. I campi di destinazione devono essere inclusi nel suggerimento specificato.

searchFields?: SearchFieldArray<TModel>

Valore della proprietà

select

Elenco di campi da recuperare. Se non specificato, solo il campo chiave verrà incluso nei risultati.

select?: SelectArray<TFields>

Valore della proprietà

SelectArray<TFields>

top

/**

  • Numero di suggerimenti da recuperare. Deve essere un valore compreso tra 1 e 100. Il valore predefinito è
top?: number

Valore della proprietà

number

useFuzzyMatching

Valore che indica se usare la corrispondenza fuzzy per la query di suggerimento. L'impostazione predefinita è false. Se impostato su true, la query troverà suggerimenti anche se nel testo di ricerca è presente un carattere sostituito o mancante. Sebbene offra un'esperienza migliore in alcuni scenari, influisce sulle prestazioni in quanto le ricerche con suggerimenti fuzzy sono più lente e utilizzano più risorse.

useFuzzyMatching?: boolean

Valore della proprietà

boolean