Documents - Suggest Get

Referenz

Dienst:: Search Service

API-Version:: 2023-10-01-Preview

Schlägt Dokumente im Index vor, die dem angegebenen Teilabfragetext entsprechen.

GET {endpoint}/indexes('{indexName}')/docs/search.suggest?search={search}&suggesterName={suggesterName}&api-version=2023-10-01-Preview

Mit optionalen Parametern:

GET {endpoint}/indexes('{indexName}')/docs/search.suggest?search={search}&suggesterName={suggesterName}&$filter={$filter}&fuzzy={fuzzy}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&$orderby={$orderby}&searchFields={searchFields}&$select={$select}&$top={$top}&api-version=2023-10-01-Preview

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	Die Endpunkt-URL des Suchdiensts.
indexName	path	True	string	Der Name des Index.
api-version	query	True	string	Client-API-Version.
search	query	True	string	Der Suchtext, der zum Vorschlagen von Dokumenten verwendet werden soll. Er muss zwischen 1 und 100 Zeichen lang sein.
suggesterName	query	True	string	Der Name der Vorschlagsfunktion, wie in der Suggesters-Auflistung angegeben, die Teil der Indexdefinition ist.
$filter	query		string	Ein OData-Ausdruck, der die Dokumente filtert, die für Vorschläge berücksichtigt werden.
$orderby	query		string[]	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.
$select	query		string[]	Die Liste der abzurufenden Felder. Wenn nicht angegeben, wird nur das Schlüsselfeld in die Ergebnisse einbezogen.
$top	query		integer int32	Die Anzahl der abzurufenden Vorschläge. Der Wert muss eine Zahl zwischen 1 und 100 sein. Der Standardwert ist 5.
fuzzy	query		boolean	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 Begriffe, auch wenn im Suchtext ein ersatziertes oder fehlendes Zeichen vorhanden ist. Dies bietet zwar in einigen Szenarien eine bessere Erfahrung, hat aber Leistungskosten, da Fuzzyvorschläge abfragen langsamer sind und mehr Ressourcen verbrauchen.
highlightPostTag	query		string	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	query		string	Ein Zeichenfolgentag, dem Trefferhighlights vorangestellt sind. Muss mit highlightPostTag festgelegt werden. Wenn sie nicht angegeben wird, ist die Treffermarkierung von Vorschlägen deaktiviert.
minimumCoverage	query		number double	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.
searchFields	query		string[]	Die Liste der Feldnamen, die nach dem angegebenen Suchtext gesucht werden sollen. Zielfelder müssen in der angegebenen Vorschlagsfunktion enthalten sein.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-request-id		string uuid	Die Verfolgungs-ID, die mit der Anforderung gesendet wurde, um beim Debuggen zu helfen.

Antworten

Name	Typ	Beschreibung
200 OK	SuggestDocumentsResult	Antwort mit vorgeschlagenen Dokumenten, die mit der Teileingabe übereinstimmen.
Other Status Codes	SearchError	Fehlerantwort.

Beispiele

SearchIndexSuggestDocumentsGet

Beispielanforderung

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs/search.suggest?search=hote&suggesterName=sg&$filter=rating gt 10&fuzzy=False&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&$orderby=search.score() desc,rating desc&searchFields=title&$select=docId,title,description&$top=10&api-version=2023-10-01-Preview

Beispiel für eine Antwort

Statuscode:: 200

{
  "value": [
    {
      "@search.text": "Nice <em>Hotel</em>",
      "description": "Cheapest hotel in town",
      "docId": "1",
      "title": "Nice Hotel"
    },
    {
      "@search.text": "Fancy <em>Hotel</em>",
      "description": "Best hotel in town",
      "docId": "2",
      "title": "Fancy Hotel"
    }
  ]
}

Definitionen

Name	Beschreibung
SearchError	Beschreibt eine Fehlerbedingung für die API.
SuggestDocumentsResult	Antwort mit Den Ergebnissen der Vorschlagsabfrage aus einem Index.
SuggestResult	Ein Ergebnis, das ein dokument enthält, das von einer Vorschlagsabfrage gefunden wurde, sowie zugeordnete Metadaten.

SearchError

Beschreibt eine Fehlerbedingung für die API.

Name	Typ	Beschreibung
code	string	Einer von einem serverdefiniertem Satz von Fehlercodes.
details	SearchError[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
message	string	Eine lesbare Darstellung des Fehlers.

SuggestDocumentsResult

Antwort mit Den Ergebnissen der Vorschlagsabfrage aus einem Index.

Name	Typ	Beschreibung
@search.coverage	number	Ein Wert, der den Prozentsatz des Indexes angibt, der in der Abfrage enthalten war, oder NULL, wenn minimumCoverage in der Anforderung nicht festgelegt wurde.
value	SuggestResult[]	Die Sequenz der von der Abfrage zurückgegebenen Ergebnisse.

SuggestResult

Ein Ergebnis, das ein dokument enthält, das von einer Vorschlagsabfrage gefunden wurde, sowie zugeordnete Metadaten.

Name	Typ	Beschreibung
@search.text	string	Der Text des Vorschlagsergebnisses.

Freigeben über