BaseSearchRequestOptions interface
Parameter zum Filtern, Sortieren, Faceting, Paging und anderen Suchabfrageverhalten.
Eigenschaften
facets | Die Liste der Facettenausdrücke, die auf die Suchabfrage angewendet werden sollen. Jeder Facetausdruck enthält einen Feldnamen, optional gefolgt von einer durch Trennzeichen getrennten Liste von Name:Wert-Paaren. |
filter | Der OData-$filter Ausdruck, der auf die Suchabfrage angewendet werden soll. |
highlight |
Die durch Trennzeichen getrennte Liste der Feldnamen, die für Trefferhighlights verwendet werden sollen. Nur durchsuchbare Felder können für die Trefferherhebung verwendet werden. |
highlight |
Ein Zeichenfolgentag, das an Trefferhighlights angefügt wird. Muss mit highlightPreTag festgelegt werden. Der Standardwert ist </em>. |
highlight |
Ein Zeichenfolgentag, dem Trefferhighlights vorangestellt sind. Muss mit highlightPostTag festgelegt werden. Der Standardwert ist <em>. |
include |
Ein -Wert, der angibt, ob die Gesamtanzahl der Ergebnisse abgerufen werden soll. Der Standardwert ist "false". Das Festlegen dieses Werts auf true kann sich auf die Leistung auswirken. Beachten Sie, dass die zurückgegebene Anzahl ein Näherungswert ist. |
minimum |
Eine Zahl zwischen 0 und 100, die den Prozentsatz des Indexes angibt, der von einer Suchabfrage abgedeckt werden muss, damit die Abfrage erfolgreich gemeldet wird. Dieser Parameter kann hilfreich sein, um die Suchverfügbarkeit auch für Dienste mit nur einem Replikat sicherzustellen. Der Standard ist 100. |
order |
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. |
query |
Ein -Wert, der die Syntax der Suchabfrage angibt. Der Standardwert ist "simple". Verwenden Sie "full", wenn Ihre Abfrage die Lucene-Abfragesyntax verwendet. Mögliche Werte: "simple", "full", "semantic" |
scoring |
Die Liste der Parameterwerte, die in Bewertungsfunktionen (z. B. referencePointParameter) mit dem Format name-values verwendet werden sollen. Wenn das Bewertungsprofil beispielsweise eine Funktion mit einem Parameter namens "mylocation" definiert, lautet die Parameterzeichenfolge "mylocation--122.2,44.8" (ohne die Anführungszeichen). |
scoring |
Der Name eines Bewertungsprofils zum Auswerten von Übereinstimmungsbewertungen für den Vergleich von Dokumenten, um die Ergebnisse zu sortieren. |
scoring |
Ein -Wert, der angibt, ob Bewertungsstatistiken (z. B. Dokumenthäufigkeit) global für eine konsistentere Bewertung oder lokal für eine geringere Latenz berechnet werden sollen. Mögliche Werte: "Lokal", "Global" |
search |
Die durch Trennzeichen getrennte Liste der Feldnamen, auf die die Volltextsuche ausgerichtet werden soll. Wenn Sie die feldierte Suche (fieldName:searchExpression) in einer vollständigen Lucene-Abfrage verwenden, haben die Feldnamen jedes feldierten Suchausdrucks Vorrang vor allen feldnamen, die in diesem Parameter aufgeführt sind. |
search |
Ein -Wert, der angibt, ob ein oder alle Suchbegriffe abgeglichen werden müssen, um das Dokument als Übereinstimmung zu zählen. Mögliche Werte: "any", "all" |
select | Die Liste der abzurufenden Felder. Wenn nicht anders angegeben, werden alle im Schema als abrufbar gekennzeichnete Felder einbezogen. |
session |
Ein Wert, der zum Erstellen einer dauerhaften Sitzung verwendet werden soll, wodurch konsistentere Ergebnisse erzielt werden können. Solange dieselbe sessionId verwendet wird, wird versucht, denselben Replikatsatz als Ziel zu verwenden. Seien Sie vorsichtig, dass die wiederholte Wiederverwendung der gleichen sessionID-Werte den Lastenausgleich der Anforderungen über Replikate hinweg beeinträchtigen und die Leistung des Suchdiensts beeinträchtigen kann. Der als „sessionId“ verwendete Wert darf nicht mit dem Zeichen „_“ beginnen. |
skip | Die Anzahl der zu überspringenden Suchergebnisse. Dieser Wert darf nicht größer als 100.000 sein. Wenn Sie Dokumente nacheinander scannen müssen, aber aufgrund dieser Einschränkung skip nicht verwenden können, sollten Sie orderby für einen vollständig sortierten Schlüssel verwenden und stattdessen mit einer Bereichsabfrage filtern. |
top | Die Anzahl der abzurufenden Suchergebnisse. Dies kann in Verbindung mit $skip verwendet werden, um das clientseitige Paging von Suchergebnissen zu implementieren. Wenn ergebnisse aufgrund von serverseitigem Paging abgeschnitten werden, enthält die Antwort ein Fortsetzungstoken, das verwendet werden kann, um eine weitere Suchanforderung für die nächste Ergebnisseite auszugeben. |
vector |
Definiert Optionen für Vektorsuchabfragen. |
Details zur Eigenschaft
facets
Die Liste der Facettenausdrücke, die auf die Suchabfrage angewendet werden sollen. Jeder Facetausdruck enthält einen Feldnamen, optional gefolgt von einer durch Trennzeichen getrennten Liste von Name:Wert-Paaren.
facets?: string[]
Eigenschaftswert
string[]
filter
Der OData-$filter Ausdruck, der auf die Suchabfrage angewendet werden soll.
filter?: string
Eigenschaftswert
string
highlightFields
Die durch Trennzeichen getrennte Liste der Feldnamen, die für Trefferhighlights verwendet werden sollen. Nur durchsuchbare Felder können für die Trefferherhebung verwendet werden.
highlightFields?: string
Eigenschaftswert
string
highlightPostTag
Ein Zeichenfolgentag, das an Trefferhighlights angefügt wird. Muss mit highlightPreTag festgelegt werden. Der Standardwert ist </em>.
highlightPostTag?: string
Eigenschaftswert
string
highlightPreTag
Ein Zeichenfolgentag, dem Trefferhighlights vorangestellt sind. Muss mit highlightPostTag festgelegt werden. Der Standardwert ist <em>.
highlightPreTag?: string
Eigenschaftswert
string
includeTotalCount
Ein -Wert, der angibt, ob die Gesamtanzahl der Ergebnisse abgerufen werden soll. Der Standardwert ist "false". Das Festlegen dieses Werts auf true kann sich auf die Leistung auswirken. Beachten Sie, dass die zurückgegebene Anzahl ein Näherungswert ist.
includeTotalCount?: boolean
Eigenschaftswert
boolean
minimumCoverage
Eine Zahl zwischen 0 und 100, die den Prozentsatz des Indexes angibt, der von einer Suchabfrage abgedeckt werden muss, damit die Abfrage erfolgreich gemeldet wird. Dieser Parameter kann hilfreich sein, um die Suchverfügbarkeit auch für Dienste mit nur einem Replikat sicherzustellen. Der Standard ist 100.
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[]
queryType
Ein -Wert, der die Syntax der Suchabfrage angibt. Der Standardwert ist "simple". Verwenden Sie "full", wenn Ihre Abfrage die Lucene-Abfragesyntax verwendet. Mögliche Werte: "simple", "full", "semantic"
queryType?: QueryType
Eigenschaftswert
scoringParameters
Die Liste der Parameterwerte, die in Bewertungsfunktionen (z. B. referencePointParameter) mit dem Format name-values verwendet werden sollen. Wenn das Bewertungsprofil beispielsweise eine Funktion mit einem Parameter namens "mylocation" definiert, lautet die Parameterzeichenfolge "mylocation--122.2,44.8" (ohne die Anführungszeichen).
scoringParameters?: string[]
Eigenschaftswert
string[]
scoringProfile
Der Name eines Bewertungsprofils zum Auswerten von Übereinstimmungsbewertungen für den Vergleich von Dokumenten, um die Ergebnisse zu sortieren.
scoringProfile?: string
Eigenschaftswert
string
scoringStatistics
Ein -Wert, der angibt, ob Bewertungsstatistiken (z. B. Dokumenthäufigkeit) global für eine konsistentere Bewertung oder lokal für eine geringere Latenz berechnet werden sollen. Mögliche Werte: "Lokal", "Global"
scoringStatistics?: ScoringStatistics
Eigenschaftswert
searchFields
Die durch Trennzeichen getrennte Liste der Feldnamen, auf die die Volltextsuche ausgerichtet werden soll. Wenn Sie die feldierte Suche (fieldName:searchExpression) in einer vollständigen Lucene-Abfrage verwenden, haben die Feldnamen jedes feldierten Suchausdrucks Vorrang vor allen feldnamen, die in diesem Parameter aufgeführt sind.
searchFields?: SearchFieldArray<TModel>
Eigenschaftswert
SearchFieldArray<TModel>
searchMode
Ein -Wert, der angibt, ob ein oder alle Suchbegriffe abgeglichen werden müssen, um das Dokument als Übereinstimmung zu zählen. Mögliche Werte: "any", "all"
searchMode?: SearchMode
Eigenschaftswert
select
Die Liste der abzurufenden Felder. Wenn nicht anders angegeben, werden alle im Schema als abrufbar gekennzeichnete Felder einbezogen.
select?: SelectArray<TFields>
Eigenschaftswert
SelectArray<TFields>
sessionId
Ein Wert, der zum Erstellen einer dauerhaften Sitzung verwendet werden soll, wodurch konsistentere Ergebnisse erzielt werden können. Solange dieselbe sessionId verwendet wird, wird versucht, denselben Replikatsatz als Ziel zu verwenden. Seien Sie vorsichtig, dass die wiederholte Wiederverwendung der gleichen sessionID-Werte den Lastenausgleich der Anforderungen über Replikate hinweg beeinträchtigen und die Leistung des Suchdiensts beeinträchtigen kann. Der als „sessionId“ verwendete Wert darf nicht mit dem Zeichen „_“ beginnen.
sessionId?: string
Eigenschaftswert
string
skip
Die Anzahl der zu überspringenden Suchergebnisse. Dieser Wert darf nicht größer als 100.000 sein. Wenn Sie Dokumente nacheinander scannen müssen, aber aufgrund dieser Einschränkung skip nicht verwenden können, sollten Sie orderby für einen vollständig sortierten Schlüssel verwenden und stattdessen mit einer Bereichsabfrage filtern.
skip?: number
Eigenschaftswert
number
top
Die Anzahl der abzurufenden Suchergebnisse. Dies kann in Verbindung mit $skip verwendet werden, um das clientseitige Paging von Suchergebnissen zu implementieren. Wenn ergebnisse aufgrund von serverseitigem Paging abgeschnitten werden, enthält die Antwort ein Fortsetzungstoken, das verwendet werden kann, um eine weitere Suchanforderung für die nächste Ergebnisseite auszugeben.
top?: number
Eigenschaftswert
number
vectorSearchOptions
Definiert Optionen für Vektorsuchabfragen.
vectorSearchOptions?: VectorSearchOptions<TModel>
Eigenschaftswert
VectorSearchOptions<TModel>