BaseSearchRequestOptions interface

Paket:

@azure/search-documents

Parameter zum Filtern, Sortieren, Faceting, Paging und anderen Suchabfrageverhalten.

Eigenschaften

facets	Die Liste der Facetausdrü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.
highlightFields	Die durch Trennzeichen getrennte Liste der Feldnamen, die für Trefferhighlights verwendet werden sollen. Nur durchsuchbare Felder können zum Hervorheben von Treffern verwendet werden.
highlightPostTag	Ein Zeichenfolgentag, das an Trefferhighlights angefügt wird. Muss mit highlightPreTag festgelegt werden. Der Standardwert ist </em>.
highlightPreTag	Ein Zeichenfolgentag, das den Trefferhighlights vorangestellt ist. Muss mit highlightPostTag festgelegt werden. Der Standardwert ist <em>.
includeTotalCount	Ein Wert, der angibt, ob die Gesamtanzahl der Ergebnisse abgerufen werden soll. Der Standardwert ist "false". Das Festlegen dieses Werts auf "true" hat möglicherweise auswirkungen auf die Leistung. Beachten Sie, dass die zurückgegebene Anzahl eine Annäherung ist.
minimumCoverage	Eine Zahl zwischen 0 und 100, die den Prozentsatz des Indexes angibt, der von einer Suchabfrage abgedeckt werden muss, damit die Abfrage als Erfolg gemeldet werden kann. Dieser Parameter kann hilfreich sein, um die Suchverfügbarkeit auch für Dienste mit nur einem Replikat sicherzustellen. Der Standardwert ist 100.
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 oder desc anzuzeigen, um absteigend anzugeben. Der Standardwert ist die aufsteigende Reihenfolge. Die Verknüpfungen werden durch die Übereinstimmungsergebnisse von Dokumenten unterbrochen. Wenn keine $orderby angegeben ist, wird die Standardsortierreihenfolge nach Dokumentabgleichsbewertung absteigend ausgeführt. Es können höchstens 32 $orderby Klauseln vorhanden sein.
queryType	Ein Wert, der die Syntax der Suchabfrage angibt. Der Standardwert ist "einfach". Verwenden Sie "vollständig", wenn Ihre Abfrage die Lucene-Abfragesyntax verwendet. Mögliche Werte sind: "simple", "full", "semantic"
scoringParameters	Die Liste der Parameterwerte, die in Bewertungsfunktionen (z. B. referencePointParameter) mit den Formatnamenwerten verwendet werden sollen. Wenn das Bewertungsprofil beispielsweise eine Funktion mit einem Parameter namens "mylocation" definiert, lautet die Parameterzeichenfolge "mylocation--122.2,44.8" (ohne anführungszeichen).
scoringProfile	Der Name eines Bewertungsprofils, um Übereinstimmungsergebnisse für übereinstimmende Dokumente auszuwerten, um die Ergebnisse zu sortieren.
scoringStatistics	Ein Wert, der angibt, ob wir Bewertungsstatistiken (z. B. Dokumenthäufigkeit) global für eine konsistentere Bewertung oder lokal für niedrigere Latenz berechnen möchten. Mögliche Werte sind: "Local", "Global"
searchFields	Die durch Trennzeichen getrennte Liste der Feldnamen, auf die die Volltextsuche angewendet werden soll. Bei Verwendung der feldbezogenen Suche (fieldName:searchExpression) in einer vollständigen Lucene-Abfrage haben die Feldnamen jedes feldbezogenen Suchausdrucks Vorrang vor allen feldnamen, die in diesem Parameter aufgeführt sind.
searchMode	Ein Wert, der angibt, ob eine oder alle Suchbegriffe übereinstimmen müssen, um das Dokument als Übereinstimmung zu zählen. Mögliche Werte sind: "any", "all"
select	Die Liste der abzurufenden Felder. Wenn nicht angegeben, sind alle Felder enthalten, die im Schema als abrufbar gekennzeichnet sind.
sessionId	Ein Wert, der zum Erstellen einer Haftsitzung verwendet werden soll, was dazu beitragen kann, konsistentere Ergebnisse zu erzielen. Solange dieselbe sessionId verwendet wird, wird versucht, denselben Replikatsatz als Ziel zu verwenden. Seien Sie vorsichtig, dass die Wiederverwendung der gleichen SessionID-Werte wiederholt den Lastenausgleich der Anforderungen über Replikate hinweg beeinträchtigen und die Leistung des Suchdiensts beeinträchtigen kann. Der wert, der als sessionId verwendet wird, kann nicht mit einem '_'-Zeichen beginnen.
skip	Die Anzahl der zu überspringenden Suchergebnisse. Dieser Wert darf nicht größer als 100.000 sein. Wenn Sie Dokumente sequenzieren müssen, aber aufgrund dieser Einschränkung nicht überspringen können, sollten Sie stattdessen "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 clientseitige Paging von Suchergebnissen zu implementieren. Wenn Ergebnisse aufgrund der serverseitigen Auslagerung abgeschnitten werden, enthält die Antwort ein Fortsetzungstoken, das verwendet werden kann, um eine andere Suchanforderung für die nächste Seite der Ergebnisse auszuweisen.
vectorSearchOptions	Definiert Optionen für Vektorsuchabfragen

Details zur Eigenschaft

facets

Die Liste der Facetausdrü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 zum Hervorheben von Treffern 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, das den Trefferhighlights vorangestellt ist. 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" hat möglicherweise auswirkungen auf die Leistung. Beachten Sie, dass die zurückgegebene Anzahl eine Annäherung 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 als Erfolg gemeldet werden kann. Dieser Parameter kann hilfreich sein, um die Suchverfügbarkeit auch für Dienste mit nur einem Replikat sicherzustellen. Der Standardwert 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 oder desc anzuzeigen, um absteigend anzugeben. Der Standardwert ist die aufsteigende Reihenfolge. Die Verknüpfungen werden durch die Übereinstimmungsergebnisse von Dokumenten unterbrochen. Wenn keine $orderby angegeben ist, wird die Standardsortierreihenfolge nach Dokumentabgleichsbewertung absteigend ausgeführt. Es können höchstens 32 $orderby Klauseln vorhanden sein.

orderBy?: string[]

Eigenschaftswert

string[]

queryType

Ein Wert, der die Syntax der Suchabfrage angibt. Der Standardwert ist "einfach". Verwenden Sie "vollständig", wenn Ihre Abfrage die Lucene-Abfragesyntax verwendet. Mögliche Werte sind: "simple", "full", "semantic"

queryType?: QueryType

Eigenschaftswert

QueryType

scoringParameters

Die Liste der Parameterwerte, die in Bewertungsfunktionen (z. B. referencePointParameter) mit den Formatnamenwerten verwendet werden sollen. Wenn das Bewertungsprofil beispielsweise eine Funktion mit einem Parameter namens "mylocation" definiert, lautet die Parameterzeichenfolge "mylocation--122.2,44.8" (ohne anführungszeichen).

scoringParameters?: string[]

Eigenschaftswert

string[]

scoringProfile

Der Name eines Bewertungsprofils, um Übereinstimmungsergebnisse für übereinstimmende Dokumente auszuwerten, um die Ergebnisse zu sortieren.

scoringProfile?: string

Eigenschaftswert

string

scoringStatistics

Ein Wert, der angibt, ob wir Bewertungsstatistiken (z. B. Dokumenthäufigkeit) global für eine konsistentere Bewertung oder lokal für niedrigere Latenz berechnen möchten. Mögliche Werte sind: "Local", "Global"

scoringStatistics?: ScoringStatistics

Eigenschaftswert

ScoringStatistics

searchFields

Die durch Trennzeichen getrennte Liste der Feldnamen, auf die die Volltextsuche angewendet werden soll. Bei Verwendung der feldbezogenen Suche (fieldName:searchExpression) in einer vollständigen Lucene-Abfrage haben die Feldnamen jedes feldbezogenen Suchausdrucks Vorrang vor allen feldnamen, die in diesem Parameter aufgeführt sind.

searchFields?: SearchFieldArray<TModel>

Eigenschaftswert

SearchFieldArray<TModel>

searchMode

Ein Wert, der angibt, ob eine oder alle Suchbegriffe übereinstimmen müssen, um das Dokument als Übereinstimmung zu zählen. Mögliche Werte sind: "any", "all"

searchMode?: SearchMode

Eigenschaftswert

SearchMode

select

Die Liste der abzurufenden Felder. Wenn nicht angegeben, sind alle Felder enthalten, die im Schema als abrufbar gekennzeichnet sind.

select?: SelectArray<TFields>

Eigenschaftswert

SelectArray<TFields>

sessionId

Ein Wert, der zum Erstellen einer Haftsitzung verwendet werden soll, was dazu beitragen kann, konsistentere Ergebnisse zu erzielen. Solange dieselbe sessionId verwendet wird, wird versucht, denselben Replikatsatz als Ziel zu verwenden. Seien Sie vorsichtig, dass die Wiederverwendung der gleichen SessionID-Werte wiederholt den Lastenausgleich der Anforderungen über Replikate hinweg beeinträchtigen und die Leistung des Suchdiensts beeinträchtigen kann. Der wert, der als sessionId verwendet wird, kann nicht mit einem '_'-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 sequenzieren müssen, aber aufgrund dieser Einschränkung nicht überspringen können, sollten Sie stattdessen "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 clientseitige Paging von Suchergebnissen zu implementieren. Wenn Ergebnisse aufgrund der serverseitigen Auslagerung abgeschnitten werden, enthält die Antwort ein Fortsetzungstoken, das verwendet werden kann, um eine andere Suchanforderung für die nächste Seite der Ergebnisse auszuweisen.

top?: number

Eigenschaftswert

number

vectorSearchOptions

Definiert Optionen für Vektorsuchabfragen

vectorSearchOptions?: VectorSearchOptions<TModel>

Eigenschaftswert

VectorSearchOptions<TModel>