SuggestRequest interface

Pakket:

@azure/search-documents

Parameters voor het filteren, sorteren, fuzzy matching en andere suggesties voor querygedrag.

Eigenschappen

filter	Een OData-expressie waarmee de documenten worden gefilterd die in aanmerking komen voor suggesties.
highlightPostTag	Een tekenreekstag die wordt toegevoegd aan hit-markeringen. Moet worden ingesteld met highlightPreTag. Als u dit weglaat, is het markeren van suggesties uitgeschakeld.
highlightPreTag	Een tekenreekstag die is voorbereid om markeringen te raken. Moet worden ingesteld met highlightPostTag. Als u dit weglaat, is het markeren van suggesties uitgeschakeld.
minimumCoverage	Een getal tussen 0 en 100 dat het percentage van de index aangeeft dat moet worden gedekt door een suggestiequery om de query als geslaagd te kunnen rapporteren. Deze parameter kan nuttig zijn om de beschikbaarheid van zoekopdrachten te garanderen, zelfs voor services met slechts één replica. De standaardwaarde is 80.
orderBy	De lijst met OData-$orderby expressies waarop de resultaten moeten worden gesorteerd. Elke expressie kan een veldnaam zijn of een aanroep naar de functies geo.distance() of search.score(). Elke expressie kan worden gevolgd door asc om oplopend aan te geven, of desc om aflopend aan te geven. De standaardwaarde is oplopende volgorde. Bindingen worden verbroken door de matchscores van documenten. Als er geen $orderby is opgegeven, is de standaardsorteervolgorde aflopend op documentmatchscore. Er kunnen maximaal 32 $orderby componenten zijn.
searchFields	De door komma's gescheiden lijst met veldnamen om te zoeken naar de opgegeven zoektekst. Doelvelden moeten worden opgenomen in de opgegeven suggestiefunctie.
select	De lijst met velden die moeten worden opgehaald. Als u dit niet opgeeft, wordt alleen het sleutelveld opgenomen in de resultaten.
top	/** Het aantal suggesties dat moet worden opgehaald. Dit moet een waarde zijn tussen 1 en 100. De standaardwaarde is
useFuzzyMatching	Een waarde die aangeeft of fuzzy overeenkomsten moeten worden gebruikt voor de suggestiequery. De standaardinstelling is onwaar. Als deze optie is ingesteld op true, vindt de query suggesties, zelfs als er een vervangend of ontbrekend teken in de zoektekst staat. Hoewel dit in sommige scenario's een betere ervaring biedt, gaat dit gepaard met prestatiekosten omdat zoekopdrachten met fuzzy suggesties langzamer zijn en meer resources verbruiken.

Eigenschapdetails

filter

Een OData-expressie waarmee de documenten worden gefilterd die in aanmerking komen voor suggesties.

filter?: string

Waarde van eigenschap

string

highlightPostTag

Een tekenreekstag die wordt toegevoegd aan hit-markeringen. Moet worden ingesteld met highlightPreTag. Als u dit weglaat, is het markeren van suggesties uitgeschakeld.

highlightPostTag?: string

Waarde van eigenschap

string

highlightPreTag

Een tekenreekstag die is voorbereid om markeringen te raken. Moet worden ingesteld met highlightPostTag. Als u dit weglaat, is het markeren van suggesties uitgeschakeld.

highlightPreTag?: string

Waarde van eigenschap

string

minimumCoverage

Een getal tussen 0 en 100 dat het percentage van de index aangeeft dat moet worden gedekt door een suggestiequery om de query als geslaagd te kunnen rapporteren. Deze parameter kan nuttig zijn om de beschikbaarheid van zoekopdrachten te garanderen, zelfs voor services met slechts één replica. De standaardwaarde is 80.

minimumCoverage?: number

Waarde van eigenschap

number

orderBy

De lijst met OData-$orderby expressies waarop de resultaten moeten worden gesorteerd. Elke expressie kan een veldnaam zijn of een aanroep naar de functies geo.distance() of search.score(). Elke expressie kan worden gevolgd door asc om oplopend aan te geven, of desc om aflopend aan te geven. De standaardwaarde is oplopende volgorde. Bindingen worden verbroken door de matchscores van documenten. Als er geen $orderby is opgegeven, is de standaardsorteervolgorde aflopend op documentmatchscore. Er kunnen maximaal 32 $orderby componenten zijn.

orderBy?: string[]

Waarde van eigenschap

string[]

searchFields

De door komma's gescheiden lijst met veldnamen om te zoeken naar de opgegeven zoektekst. Doelvelden moeten worden opgenomen in de opgegeven suggestiefunctie.

searchFields?: SearchFieldArray<TModel>

Waarde van eigenschap

SearchFieldArray<TModel>

select

De lijst met velden die moeten worden opgehaald. Als u dit niet opgeeft, wordt alleen het sleutelveld opgenomen in de resultaten.

select?: SelectArray<TFields>

Waarde van eigenschap

SelectArray<TFields>

top

/**

• Het aantal suggesties dat moet worden opgehaald. Dit moet een waarde zijn tussen 1 en 100. De standaardwaarde is

top?: number

Waarde van eigenschap

number

useFuzzyMatching

Een waarde die aangeeft of fuzzy overeenkomsten moeten worden gebruikt voor de suggestiequery. De standaardinstelling is onwaar. Als deze optie is ingesteld op true, vindt de query suggesties, zelfs als er een vervangend of ontbrekend teken in de zoektekst staat. Hoewel dit in sommige scenario's een betere ervaring biedt, gaat dit gepaard met prestatiekosten omdat zoekopdrachten met fuzzy suggesties langzamer zijn en meer resources verbruiken.

useFuzzyMatching?: boolean

Waarde van eigenschap

boolean