Documents - Suggest Post

Dienst:: Search Service

API-Version:: 2025-09-01

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

POST {endpoint}/indexes('{indexName}')/docs/search.post.suggest?api-version=2025-09-01

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.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-request-id		string (uuid)	Die Nachverfolgungs-ID, die mit der Anforderung gesendet wird, um das Debuggen zu unterstützen.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
search	True	string	Der Suchtext, der zum Vorschlagen von Dokumenten verwendet werden soll. Muss mindestens 1 Zeichen und darf nicht mehr als 100 Zeichen enthalten.
suggesterName	True	string	Der Name der Vorschlagsinstanz, wie er in der Vorschlagsauflistung angegeben ist, die Teil der Indexdefinition ist.
filter		string	Ein OData-Ausdruck, der die Dokumente filtert, die für Vorschläge berücksichtigt werden.
fuzzy		boolean	Ein Wert, der angibt, ob für die Vorschlagsabfrage der Fuzzyabgleich verwendet werden soll. Der Standardwert ist "false". Wenn diese Option auf true festgelegt ist, findet die Abfrage auch dann Vorschläge, wenn der Suchtext ein ersetztes oder fehlendes Zeichen enthält. Dies bietet zwar in einigen Szenarien eine bessere Erfahrung, ist jedoch mit Leistungseinbußen verbunden, da die Suche nach unscharfen Vorschlägen langsamer ist und mehr Ressourcen verbraucht.
highlightPostTag		string	Ein Zeichenfolgen-Tag, das an Treffermarkierungen angehängt wird. Muss mit highlightPreTag gesetzt werden. Wenn diese Option nicht angegeben wird, ist die Trefferhervorhebung von Vorschlägen deaktiviert.
highlightPreTag		string	Ein Zeichenfolgen-Tag, dem das Erreichen von Highlights vorangestellt wird. Muss mit highlightPostTag gesetzt werden. Wenn diese Option nicht angegeben wird, ist die Trefferhervorhebung von Vorschlägen deaktiviert.
minimumCoverage		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 nützlich sein, um die Verfügbarkeit der Suche auch für Dienste mit nur einem Replikat sicherzustellen. Der Standardwert ist 80.
orderby		string	Die durch Trennzeichen getrennte 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. Auf jeden Ausdruck kann asc folgen, um aufsteigend anzugeben, oder desc, um absteigend anzugeben. Die Standardeinstellung ist aufsteigend. Unentschieden werden durch die Spielergebnisse der Dokumente aufgelöst. Wenn keine $orderby angegeben ist, ist die Standardsortierreihenfolge absteigend nach Dokumentabgleichsbewertung. Es können höchstens 32 $orderby Klauseln bestehen.
searchFields		string	Die durch Kommas getrennte Liste von Feldnamen, nach denen nach dem angegebenen Suchtext gesucht werden soll. Zielfelder müssen in der angegebenen Vorschlagsfunktion enthalten sein.
select		string	Die durch Kommas getrennte Liste der abzurufenden Felder. Wenn nicht angegeben, wird nur das Schlüsselfeld in die Ergebnisse einbezogen.
top		integer (int32)	Die Anzahl der Vorschläge, die abgerufen werden sollen. Dies muss ein Wert zwischen 1 und 100 sein. Der Standardwert ist 5.

Antworten

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

Beispiele

SearchIndexSuggestDocumentsPost

Beispielanforderung

HTTP

POST https://stableexampleservice.search.windows.net/indexes('stable-test')/docs/search.post.suggest?api-version=2025-09-01


{
  "filter": "ownerId eq 'sam' and id lt '15'",
  "fuzzy": true,
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": 80,
  "orderby": "id desc",
  "search": "p",
  "searchFields": "category",
  "select": "id,name,category,ownerId",
  "suggesterName": "sg",
  "top": 10
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "@search.coverage": 100,
  "value": [
    {
      "@search.text": "<em>pu</em>rple",
      "id": "14",
      "name": "test",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.text": "<em>pu</em>rple",
      "id": "13",
      "name": "test",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.text": "<em>pu</em>rple",
      "id": "11",
      "name": "test",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.text": "<em>pu</em>rple",
      "id": "1",
      "name": "test",
      "category": "purple",
      "ownerId": "sam"
    }
  ]
}

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
SuggestDocumentsResult	Antwort, die eine Vorschlagsabfrage enthält, die aus einem Index resultiert.
SuggestRequest	Parameter für das Filtern, Sortieren, Fuzzy-Matching und andere Abfrageverhalten von Vorschlägen.
SuggestResult	Ein Ergebnis, das ein Dokument enthält, das von einer Vorschlagsabfrage gefunden wurde, sowie die zugehörigen Metadaten.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	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

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

SuggestDocumentsResult

Objekt

Antwort, die eine Vorschlagsabfrage enthält, die aus einem Index resultiert.

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.

SuggestRequest

Objekt

Parameter für das Filtern, Sortieren, Fuzzy-Matching und andere Abfrageverhalten von Vorschlägen.

Name	Typ	Beschreibung
filter	string	Ein OData-Ausdruck, der die Dokumente filtert, die für Vorschläge berücksichtigt werden.
fuzzy	boolean	Ein Wert, der angibt, ob für die Vorschlagsabfrage der Fuzzyabgleich verwendet werden soll. Der Standardwert ist "false". Wenn diese Option auf true festgelegt ist, findet die Abfrage auch dann Vorschläge, wenn der Suchtext ein ersetztes oder fehlendes Zeichen enthält. Dies bietet zwar in einigen Szenarien eine bessere Erfahrung, ist jedoch mit Leistungseinbußen verbunden, da die Suche nach unscharfen Vorschlägen langsamer ist und mehr Ressourcen verbraucht.
highlightPostTag	string	Ein Zeichenfolgen-Tag, das an Treffermarkierungen angehängt wird. Muss mit highlightPreTag gesetzt werden. Wenn diese Option nicht angegeben wird, ist die Trefferhervorhebung von Vorschlägen deaktiviert.
highlightPreTag	string	Ein Zeichenfolgen-Tag, dem das Erreichen von Highlights vorangestellt wird. Muss mit highlightPostTag gesetzt werden. Wenn diese Option nicht angegeben wird, ist die Trefferhervorhebung von Vorschlägen deaktiviert.
minimumCoverage	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 nützlich sein, um die Verfügbarkeit der Suche auch für Dienste mit nur einem Replikat sicherzustellen. Der Standardwert ist 80.
orderby	string	Die durch Trennzeichen getrennte 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. Auf jeden Ausdruck kann asc folgen, um aufsteigend anzugeben, oder desc, um absteigend anzugeben. Die Standardeinstellung ist aufsteigend. Unentschieden werden durch die Spielergebnisse der Dokumente aufgelöst. Wenn keine $orderby angegeben ist, ist die Standardsortierreihenfolge absteigend nach Dokumentabgleichsbewertung. Es können höchstens 32 $orderby Klauseln bestehen.
search	string	Der Suchtext, der zum Vorschlagen von Dokumenten verwendet werden soll. Muss mindestens 1 Zeichen und darf nicht mehr als 100 Zeichen enthalten.
searchFields	string	Die durch Kommas getrennte Liste von Feldnamen, nach denen nach dem angegebenen Suchtext gesucht werden soll. Zielfelder müssen in der angegebenen Vorschlagsfunktion enthalten sein.
select	string	Die durch Kommas getrennte Liste der abzurufenden Felder. Wenn nicht angegeben, wird nur das Schlüsselfeld in die Ergebnisse einbezogen.
suggesterName	string	Der Name der Vorschlagsinstanz, wie er in der Vorschlagsauflistung angegeben ist, die Teil der Indexdefinition ist.
top	integer (int32)	Die Anzahl der Vorschläge, die abgerufen werden sollen. Dies muss ein Wert zwischen 1 und 100 sein. Der Standardwert ist 5.

SuggestResult

Objekt

Ein Ergebnis, das ein Dokument enthält, das von einer Vorschlagsabfrage gefunden wurde, sowie die zugehörigen Metadaten.

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

Freigeben über

Documents - Suggest Post

URI-Parameter

Anforderungsheader

Anforderungstext

Antworten

Beispiele

SearchIndexSuggestDocumentsPost

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

SuggestDocumentsResult

SuggestRequest

SuggestResult