SuggestRequest interface

Pacchetto:

@azure/search-documents

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 aggiunto per l'evidenziazione dei riscontri. Deve essere impostato con highlightPreTag. Se omesso, l'evidenziazione dei suggerimenti è disabilitata.
highlightPreTag	Tag stringa anteporto all'evidenziazione dei riscontri. 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 riuscita. Questo parametro può essere utile per garantire la disponibilità della ricerca anche per i servizi con una sola replica. Il valore predefinito è 80.
orderBy	Elenco di espressioni OData $orderby 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 un valore crescente o desc per indicare la decrescente. Il valore predefinito è crescente. I legami verranno interrotti dai punteggi di corrispondenza dei documenti. Se non viene specificato alcun $orderby, l'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 in cui 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, nei risultati verrà incluso solo il campo chiave.
top	/** Numero di suggerimenti da recuperare. Deve essere un valore compreso tra 1 e 100. Il valore predefinito è
useFuzzyMatching	Valore che indica se utilizzare la corrispondenza fuzzy per la query di suggerimento. Il valore predefinito è false. Se impostato su true, la query troverà suggerimenti anche se nel testo di ricerca è presente un carattere sostituito o mancante. Anche se questo offre un'esperienza migliore in alcuni scenari, comporta un costo delle prestazioni perché le ricerche di suggerimenti fuzzy sono più lente e consumano più risorse.

Dettagli proprietà

filter

Espressione OData che filtra i documenti considerati per i suggerimenti.

filter?: string

Valore della proprietà

string

highlightPostTag

Tag stringa aggiunto per l'evidenziazione dei riscontri. Deve essere impostato con highlightPreTag. Se omesso, l'evidenziazione dei suggerimenti è disabilitata.

highlightPostTag?: string

Valore della proprietà

string

highlightPreTag

Tag stringa anteporto all'evidenziazione dei riscontri. 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 riuscita. Questo parametro può essere utile per garantire la disponibilità della ricerca anche per i servizi con una sola replica. Il valore predefinito è 80.

minimumCoverage?: number

Valore della proprietà

number

orderBy

Elenco di espressioni OData $orderby 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 un valore crescente o desc per indicare la decrescente. Il valore predefinito è crescente. I legami verranno interrotti dai punteggi di corrispondenza dei documenti. Se non viene specificato alcun $orderby, l'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 in cui cercare il testo di ricerca specificato. I campi di destinazione devono essere inclusi nel suggerimento specificato.

searchFields?: SearchFieldArray<TModel>

Valore della proprietà

SearchFieldArray<TModel>

select

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

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 utilizzare la corrispondenza fuzzy per la query di suggerimento. Il valore predefinito è false. Se impostato su true, la query troverà suggerimenti anche se nel testo di ricerca è presente un carattere sostituito o mancante. Anche se questo offre un'esperienza migliore in alcuni scenari, comporta un costo delle prestazioni perché le ricerche di suggerimenti fuzzy sono più lente e consumano più risorse.

useFuzzyMatching?: boolean

Valore della proprietà

boolean