SearchParameters Klasse

Definition

Namespace:

Microsoft.Azure.Search.Models

Assembly:

Microsoft.Azure.Search.Data.dll

Paket:

Microsoft.Azure.Search.Data v10.1.0

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

public class SearchParameters

type SearchParameters = class

Public Class SearchParameters

Vererbung

Object

SearchParameters

Konstruktoren

SearchParameters()	Initialisiert eine neue instance der SearchParameters-Klasse.
SearchParameters(Boolean, IList<String>, String, IList<String>, String, String, Nullable<Double>, IList<String>, QueryType, IList<ScoringParameter>, String, IList<String>, SearchMode, IList<String>, Nullable<Int32>, Nullable<Int32>)	Initialisiert eine neue instance der SearchParameters-Klasse.

Eigenschaften

Facets	Ruft die Liste der Facettenausdrücke ab, die auf die Suchabfrage angewendet werden sollen, oder legt sie fest. Jeder Facetausdruck enthält einen Feldnamen, optional gefolgt von einer durch Trennzeichen getrennten Liste von Name:Wert-Paaren.
Filter	Ruft den OData-$filter-Ausdruck ab, der auf die Suchabfrage angewendet werden soll, oder legt diesen fest.
HighlightFields	Ruft die Liste der Feldnamen ab, die für Trefferhighlights verwendet werden sollen, oder legt sie fest. Nur durchsuchbare Felder können für die Treffermarkierung verwendet werden.
HighlightPostTag	Ruft ein Zeichenfolgentag ab, das an Treffermarkierung angefügt wird, oder legt dieses fest. Muss mit highlightPreTag festgelegt werden. Der Standardwert ist </em>.
HighlightPreTag	Ruft ein Zeichenfolgentag ab, das den Trefferhighlights vorangestellt ist, oder legt dieses fest. Muss mit highlightPostTag festgelegt werden. Der Standardwert ist <em>.
IncludeTotalResultCount	Ruft einen Wert ab, der angibt, ob die Gesamtanzahl der Ergebnisse abgerufen werden soll, oder legt diesen fest. 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.
MinimumCoverage	Ruft eine Zahl zwischen 0 und 100 ab, die den Prozentsatz des Indexes angibt, der von einer Suchabfrage abgedeckt werden muss, damit die Abfrage erfolgreich gemeldet wird, oder legt diese fest. Dieser Parameter kann hilfreich sein, um die Suchverfügbarkeit auch für Dienste mit nur einem Replikat sicherzustellen. Der Standardwert ist 100.
OrderBy	Ruft die Liste der OData-$orderby Ausdrücke ab, nach denen die Ergebnisse sortiert werden sollen, oder legt diese fest. 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, und 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, ist die Standardsortierreihenfolge absteigend nach Dokumentabgleichsbewertung. Es können maximal 32 $orderby-Klauseln vorhanden sein.
QueryType	Ruft einen Wert ab, der die Syntax der Suchabfrage angibt, oder legt diesen fest. Der Standardwert ist "simple". Verwenden Sie "full", wenn Ihre Abfrage die Lucene-Abfragesyntax verwendet. Mögliche Werte: "simple", "full"
ScoringParameters	Ruft die Liste der Parameterwerte ab, die in Bewertungsfunktionen (z. B. referencePointParameter) unter Verwendung des Formats name-values verwendet werden sollen, oder legt diese fest. Wenn das Bewertungsprofil beispielsweise eine Funktion mit einem Parameter namens "mylocation" definiert, lautet die Parameterzeichenfolge "mylocation--122.2,44.8" (ohne die Anführungszeichen).
ScoringProfile	Ruft den Namen eines Bewertungsprofils ab, um Übereinstimmungsergebnisse für übereinstimmende Dokumente auszuwerten, um die Ergebnisse zu sortieren, oder legt diesen fest.
SearchFields	Ruft die Liste der Feldnamen ab, auf die die Volltextsuche festgelegt werden soll, oder legt sie fest. 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.
SearchMode	Ruft einen Wert ab, der angibt, ob ein oder alle Suchbegriffe abgeglichen werden müssen, um das Dokument als Übereinstimmung zu zählen, oder legt diesen fest. Mögliche Werte: "any", "all"
Select	Ruft die Liste der abzurufenden Felder ab oder legt sie fest. Wenn nicht anders angegeben, werden alle im Schema als abrufbar gekennzeichnete Felder einbezogen.
Skip	Ruft die Anzahl der zu überspringenden Suchergebnisse ab oder legt sie fest. Dieser Wert darf nicht größer als 100.000 sein. Wenn Sie Dokumente nacheinander scannen müssen, aber aufgrund dieser Einschränkung nicht $skip verwenden können, sollten Sie $orderby für einen vollständig sortierten Schlüssel verwenden und stattdessen mit einer Bereichsabfrage $filter.
Top	Ruft die Anzahl der abzurufenden Suchergebnisse ab oder legt diese fest. 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.