SuggestRequest interface

Paket:

@azure/search-documents

Parameter zum Filtern, Sortieren, Fuzzyabgleich und anderen Vorschlägen zum Abfrageverhalten.

Eigenschaften

filter	Ein OData-Ausdruck, der die Dokumente filtert, die für Vorschläge berücksichtigt werden.
highlightPostTag	Ein Zeichenfolgentag, das an Trefferhighlights angefügt wird. Muss mit highlightPreTag festgelegt werden. Wenn sie nicht angegeben wird, ist die Treffermarkierung von Vorschlägen deaktiviert.
highlightPreTag	Ein Zeichenfolgentag, dem Trefferhighlights vorangestellt sind. Muss mit highlightPostTag festgelegt werden. Wenn sie nicht angegeben wird, ist die Treffermarkierung von Vorschlägen deaktiviert.
minimumCoverage	Eine Zahl zwischen 0 und 100, die den Prozentsatz des Indexes angibt, der von einer Vorschlagsabfrage abgedeckt werden muss, damit die Abfrage als erfolgreich gemeldet wird. Dieser Parameter kann hilfreich sein, um die Suchverfügbarkeit auch für Dienste mit nur einem Replikat sicherzustellen. Der Standardwert beträgt 80.
orderBy	Die Liste der OData-$orderby Ausdrücke, nach denen die Ergebnisse sortiert werden sollen. Jeder Ausdruck kann entweder ein Feldname oder ein Aufruf der Funktionen geo.distance() oder search.score() sein. Jedem Ausdruck kann asc folgen, um aufsteigend anzugeben, oder desc, um absteigend anzugeben. Standardmäßig wird in aufsteigender Reihenfolge sortiert. Verknüpfungen werden durch die Ergebnisstände von Dokumenten getrennt. Wenn kein $orderby angegeben ist, wird die Standardsortierreihenfolge nach Dokumentabgleichsbewertung absteigend ausgeführt. Es können maximal 32 $orderby-Klauseln vorhanden sein.
searchFields	Die durch Trennzeichen getrennte Liste der Feldnamen, die nach dem angegebenen Suchtext gesucht werden sollen. Zielfelder müssen in der angegebenen Vorschlagsfunktion enthalten sein.
select	Die Liste der abzurufenden Felder. Wenn nicht angegeben, wird nur das Schlüsselfeld in die Ergebnisse einbezogen.
top	/** Die Anzahl der abzurufenden Vorschläge. Dies muss ein Wert zwischen 1 und 100 sein. Der Standard ist
useFuzzyMatching	Ein Wert, der angibt, ob der Fuzzyabgleich für die Vorschlagsabfrage verwendet werden soll. Der Standardwert ist "false". Wenn diese Einstellung auf true festgelegt ist, findet die Abfrage Vorschläge, auch wenn im Suchtext ein ersatziertes oder fehlendes Zeichen vorhanden ist. Dies verbessert zwar in einigen Szenarien die Erfahrungen, führt aber zu Leistungseinbußen, da Fuzzysuchvorschläge langsamer sind und mehr Ressourcen verbrauchen.

Details zur Eigenschaft

filter

Ein OData-Ausdruck, der die Dokumente filtert, die für Vorschläge berücksichtigt werden.

filter?: string

Eigenschaftswert

string

highlightPostTag

Ein Zeichenfolgentag, das an Trefferhighlights angefügt wird. Muss mit highlightPreTag festgelegt werden. Wenn sie nicht angegeben wird, ist die Treffermarkierung von Vorschlägen deaktiviert.

highlightPostTag?: string

Eigenschaftswert

string

highlightPreTag

Ein Zeichenfolgentag, dem Trefferhighlights vorangestellt sind. Muss mit highlightPostTag festgelegt werden. Wenn sie nicht angegeben wird, ist die Treffermarkierung von Vorschlägen deaktiviert.

highlightPreTag?: string

Eigenschaftswert

string

minimumCoverage

Eine Zahl zwischen 0 und 100, die den Prozentsatz des Indexes angibt, der von einer Vorschlagsabfrage abgedeckt werden muss, damit die Abfrage als erfolgreich gemeldet wird. Dieser Parameter kann hilfreich sein, um die Suchverfügbarkeit auch für Dienste mit nur einem Replikat sicherzustellen. Der Standardwert beträgt 80.

minimumCoverage?: number

Eigenschaftswert

number

orderBy

Die Liste der OData-$orderby Ausdrücke, nach denen die Ergebnisse sortiert werden sollen. Jeder Ausdruck kann entweder ein Feldname oder ein Aufruf der Funktionen geo.distance() oder search.score() sein. Jedem Ausdruck kann asc folgen, um aufsteigend anzugeben, oder desc, um absteigend anzugeben. Standardmäßig wird in aufsteigender Reihenfolge sortiert. Verknüpfungen werden durch die Ergebnisstände von Dokumenten getrennt. Wenn kein $orderby angegeben ist, wird die Standardsortierreihenfolge nach Dokumentabgleichsbewertung absteigend ausgeführt. Es können maximal 32 $orderby-Klauseln vorhanden sein.

orderBy?: string[]

Eigenschaftswert

string[]

searchFields

Die durch Trennzeichen getrennte Liste der Feldnamen, die nach dem angegebenen Suchtext gesucht werden sollen. Zielfelder müssen in der angegebenen Vorschlagsfunktion enthalten sein.

searchFields?: SearchFieldArray<TModel>

Eigenschaftswert

SearchFieldArray<TModel>

select

Die Liste der abzurufenden Felder. Wenn nicht angegeben, wird nur das Schlüsselfeld in die Ergebnisse einbezogen.

select?: SelectArray<TFields>

Eigenschaftswert

SelectArray<TFields>

top

/**

• Die Anzahl der abzurufenden Vorschläge. Dies muss ein Wert zwischen 1 und 100 sein. Der Standard ist

top?: number

Eigenschaftswert

number

useFuzzyMatching

Ein Wert, der angibt, ob der Fuzzyabgleich für die Vorschlagsabfrage verwendet werden soll. Der Standardwert ist "false". Wenn diese Einstellung auf true festgelegt ist, findet die Abfrage Vorschläge, auch wenn im Suchtext ein ersatziertes oder fehlendes Zeichen vorhanden ist. Dies verbessert zwar in einigen Szenarien die Erfahrungen, führt aber zu Leistungseinbußen, da Fuzzysuchvorschläge langsamer sind und mehr Ressourcen verbrauchen.

useFuzzyMatching?: boolean

Eigenschaftswert

boolean