Documents - Suggest Get

Dienst:: Search Service

API-Version:: 2026-04-01

Schlägt Dokumente im Index vor, die mit dem angegebenen Teilabfragetext übereinstimmen.

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string (uri)	Die Endpunkt-URL des Suchdiensts.
indexName	path	True	string	Der Name des Indexes.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.
search	query	True	string	Der Suchtext, der zum Vorschlagen von Dokumenten verwendet werden soll. Darf mindestens 1 Zeichen und maximal 100 Zeichen lang sein.
suggesterName	query	True	string	Der Name des Suggesters, 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 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.
$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 Vorschläge, die abgerufen werden sollen. Der Wert muss eine Zahl zwischen 1 und 100 sein. Der Standardwert ist 5.
fuzzy	query		boolean	Ein Wert, der angibt, ob für die Vorschlagsabfrage der Fuzzyabgleich verwendet werden soll. Die Standardeinstellung ist "false". Wenn diese Option auf true festgelegt ist, findet die Abfrage auch dann Begriffe, wenn der Suchtext ein ersetztes oder fehlendes Zeichen enthält. Dies bietet zwar in einigen Szenarien eine bessere Erfahrung, geht jedoch zu Leistungseinbußen, da Abfragen mit Fuzzyvorschlägen langsamer sind und mehr Ressourcen verbrauchen.
highlightPostTag	query		string	Ein Zeichenfolgentag, das an Trefferhighlights angefügt wird. Muss mit highlightPreTag festgelegt werden. Wenn diese Option nicht angegeben wird, ist die Trefferhervorhebung von Vorschlägen deaktiviert.
highlightPreTag	query		string	Ein Zeichenfolgentag, das den Trefferhighlights vorangestellt ist. Muss mit highlightPostTag festgelegt werden. Wenn diese Option nicht angegeben wird, ist die Trefferhervorhebung 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 ist 80.
searchFields	query		string[]	Die Liste der Feldnamen, nach denen nach dem angegebenen Suchtext gesucht werden soll. Zielfelder müssen in der angegebenen Vorschlagsfunktion enthalten sein.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Accept		Accept	Die Überschrift "Annehmen".
x-ms-client-request-id		string (uuid)	Ein undurchsichtiger, global eindeutiger, clientgenerierter Zeichenfolgenbezeichner für die Anforderung.

Antworten

Name	Typ	Beschreibung
200 OK	SuggestDocumentsResult	Die Anforderung ist erfolgreich.
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

api-key

Typ: apiKey
In: header

OAuth2Auth

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiche

Name	Beschreibung
https://search.azure.com/.default

Beispiele

SearchIndexSuggestDocumentsGet

Beispielanforderung

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs/search.suggest?api-version=2026-04-01&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

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
Accept	Die Überschrift "Annehmen".
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Übliche Fehlerantwort für alle Azure Resource Manager APIs, um Fehlerdetails bei fehlgeschlagenen Operationen zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)
SuggestDocumentsResult	Antwort, die Vorschlagsabfrageergebnisse aus einem Index enthält.
SuggestResult	Ein Ergebnis, das ein Dokument enthält, das von einer Vorschlagsabfrage gefunden wurde, sowie zugeordnete Metadaten.

Accept

Enumeration

Die Überschrift "Annehmen".

Wert	Beschreibung
application/json;odata.metadata=none

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info		Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Übliche Fehlerantwort für alle Azure Resource Manager APIs, um Fehlerdetails bei fehlgeschlagenen Operationen zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

SuggestDocumentsResult

Objekt

Antwort, die Vorschlagsabfrageergebnisse aus einem Index enthält.

Name	Typ	Beschreibung
@search.coverage	number (double)	Ein Wert, der den Prozentsatz des Indexes angibt, der in die Abfrage eingeschlossen wurde, oder NULL, wenn minimumCoverage in der Anforderung nicht festgelegt wurde.
value	SuggestResult[]	Die Abfolge der ergebnisse, die von der Abfrage zurückgegeben werden.

SuggestResult

Objekt

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.