SuggestRequest interface

Pakket:

@azure/search-documents

Parameters voor filteren, sorteren, fuzzy overeenkomsten en andere suggesties voor querygedrag.

Eigenschappen

filter	Een OData-expressie waarmee de documenten worden gefilterd die worden overwogen voor suggesties.
highlightPostTag	Een tekenreekstag die wordt toegevoegd om markeringen te raken. Moet worden ingesteld met highlightPreTag. Als u dit weglaat, wordt het markeren van suggesties uitgeschakeld.
highlightPreTag	Een tekenreekstag die is voorbereid om markeringen te raken. Moet worden ingesteld met highlightPostTag. Als u dit weglaat, wordt 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, zodat de query kan worden gerapporteerd als geslaagd. Deze parameter kan handig zijn voor het garanderen van de beschikbaarheid van zoekopdrachten, 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 of een aanroep zijn van 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 standaardvolgorde is oplopend. Ties worden verbroken door de overeenkomende scores van documenten. Als er geen $orderby is opgegeven, wordt de standaardsorteervolgorde aflopend op de score van de documentovereenkomst. 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 dit niet is opgegeven, wordt alleen het sleutelveld opgenomen in de resultaten.
top	/** Het aantal suggesties dat moet worden opgehaald. Dit moet een waarde tussen 1 en 100 zijn. De standaardwaarde is
useFuzzyMatching	Een waarde die aangeeft of fuzzy overeenkomsten moeten worden gebruikt voor de suggestiequery. De standaardwaarde is onwaar. Als deze optie is ingesteld op waar, vindt de query suggesties, zelfs als er een vervangend of ontbrekend teken in de zoektekst staat. Hoewel dit een betere ervaring biedt in sommige scenario's, worden er prestatiekosten in rekening gebracht omdat zoekopdrachten met fuzzy suggesties langzamer zijn en meer resources verbruiken.

Eigenschapdetails

filter

Een OData-expressie waarmee de documenten worden gefilterd die worden overwogen voor suggesties.

filter?: string

Waarde van eigenschap

string

highlightPostTag

Een tekenreekstag die wordt toegevoegd om markeringen te raken. Moet worden ingesteld met highlightPreTag. Als u dit weglaat, wordt 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, wordt 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, zodat de query kan worden gerapporteerd als geslaagd. Deze parameter kan handig zijn voor het garanderen van de beschikbaarheid van zoekopdrachten, 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 of een aanroep zijn van 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 standaardvolgorde is oplopend. Ties worden verbroken door de overeenkomende scores van documenten. Als er geen $orderby is opgegeven, wordt de standaardsorteervolgorde aflopend op de score van de documentovereenkomst. 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 dit niet is opgegeven, 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 tussen 1 en 100 zijn. De standaardwaarde is

top?: number

Waarde van eigenschap

number

useFuzzyMatching

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

useFuzzyMatching?: boolean

Waarde van eigenschap

boolean