Documents - Autocomplete Post

Dienst:: Search Service

API-Version:: 2025-09-01

Vervollständigt unvollständige Abfragebegriffe automatisch auf der Grundlage von Eingabetext und übereinstimmenden Begriffen im Index.

POST {endpoint}/indexes('{indexName}')/docs/search.post.autocomplete?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, auf dem die Ergebnisse der automatischen Vervollständigung basieren sollen.
suggesterName	True	string	Der Name der Vorschlagsinstanz, wie er in der Vorschlagsauflistung angegeben ist, die Teil der Indexdefinition ist.
autocompleteMode		AutocompleteMode	Gibt den Modus für die automatische Vervollständigung an. Der Standardwert ist 'oneTerm'. Verwenden Sie 'twoTerms', um Gürtelrose abzurufen, und 'oneTermWithContext', um den aktuellen Kontext zu verwenden, während automatisch vervollständigte Begriffe erstellt werden.
filter		string	Ein OData-Ausdruck, der die Dokumente filtert, die zum Erstellen abgeschlossener Ausdrücke für das AutoVervollständigen-Ergebnis verwendet werden.
fuzzy		boolean	Ein Wert, der angibt, ob der Fuzzyabgleich für die AutoVervollständigen-Abfrage verwendet werden soll. Der Standardwert ist "false". Wenn diese Option auf true festgelegt ist, vervollständigt die Abfrage Begriffe auch dann automatisch, 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 Fuzzy-Abfragen für die automatische Vervollständigung langsamer sind und mehr Ressourcen verbrauchen.
highlightPostTag		string	Ein Zeichenfolgen-Tag, das an Treffermarkierungen angehängt wird. Muss mit highlightPreTag gesetzt werden. Wenn nicht angegeben, ist die Trefferhervorhebung deaktiviert.
highlightPreTag		string	Ein Zeichenfolgen-Tag, dem das Erreichen von Highlights vorangestellt wird. Muss mit highlightPostTag gesetzt werden. Wenn nicht angegeben, ist die Trefferhervorhebung deaktiviert.
minimumCoverage		number (double)	Eine Zahl zwischen 0 und 100, die den Prozentsatz des Indexes angibt, der von einer AutoVervollständigen-Abfrage 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.
searchFields		string	Die durch Trennzeichen getrennte Liste von Feldnamen, die bei der Abfrage von automatisch vervollständigten Begriffen berücksichtigt werden sollen. Zielfelder müssen in der angegebenen Vorschlagsfunktion enthalten sein.
top		integer (int32)	Die Anzahl der automatisch vervollständigten Begriffe, die abgerufen werden sollen. Dies muss ein Wert zwischen 1 und 100 sein. Der Standardwert ist 5.

Antworten

Name	Typ	Beschreibung
200 OK	AutocompleteResult	Antwort mit vorgeschlagenen Abfragebegriffen, die die Teileingabe vervollständigen.
Other Status Codes	ErrorResponse	Fehlerantwort.

Beispiele

SearchIndexAutocompleteDocumentsPost

Beispielanforderung

HTTP

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


{
  "search": "p",
  "autocompleteMode": "oneTerm",
  "filter": "ownerId ne '1'",
  "fuzzy": true,
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": 80,
  "searchFields": "category, ownerId",
  "suggesterName": "sg",
  "top": 10
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "@search.coverage": 100,
  "value": [
    {
      "text": "purple",
      "queryPlusText": "<em>purple</em>"
    },
    {
      "text": "pink",
      "queryPlusText": "<em>pink</em>"
    }
  ]
}

Definitionen

Name	Beschreibung
AutocompleteItem	Das Ergebnis von AutoVervollständigen-Anforderungen.
AutocompleteMode	Gibt den Modus für die automatische Vervollständigung an. Der Standardwert ist 'oneTerm'. Verwenden Sie 'twoTerms', um Gürtelrose abzurufen, und 'oneTermWithContext', um den aktuellen Kontext bei der Erstellung von Autovervollständigungsbegriffen zu verwenden.
AutocompleteRequest	Parameter für Fuzzyabgleich und andere Abfrageverhaltensweisen bei der automatischen Vervollständigung.
AutocompleteResult	Das Ergebnis der AutoVervollständigen-Abfrage.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort

AutocompleteItem

Objekt

Das Ergebnis von AutoVervollständigen-Anforderungen.

Name	Typ	Beschreibung
queryPlusText	string	Die Abfrage zusammen mit dem abgeschlossenen Begriff.
text	string	Die abgeschlossene Laufzeit.

AutocompleteMode

Enumeration

Gibt den Modus für die automatische Vervollständigung an. Der Standardwert ist 'oneTerm'. Verwenden Sie 'twoTerms', um Gürtelrose abzurufen, und 'oneTermWithContext', um den aktuellen Kontext bei der Erstellung von Autovervollständigungsbegriffen zu verwenden.

Wert	Beschreibung
oneTerm	Es wird nur ein Begriff vorgeschlagen. Wenn die Abfrage zwei Ausdrücke enthält, wird nur der letzte Begriff abgeschlossen. Wenn die Eingabe z. B. "Washington Medic" lautet, könnten die vorgeschlagenen Begriffe "Medicaid", "Medicare" und "Medizin" umfassen.
twoTerms	Übereinstimmende Ausdrücke mit zwei Begriffen im Index werden vorgeschlagen. Wenn die Eingabe z. B. "Medic" lautet, könnten die vorgeschlagenen Begriffe "Medicare-Abdeckung" und "medizinischer Assistent" umfassen.
oneTermWithContext	Vervollständigt den letzten Ausdruck in einer Abfrage mit zwei oder mehr Begriffen, wobei die letzten beiden Begriffe ein Ausdruck sind, der im Index vorhanden ist. Wenn die Eingabe z. B. "washington medic" lautet, könnten die vorgeschlagenen Begriffe "washington medicaid" und "washington medical" enthalten.

AutocompleteRequest

Objekt

Parameter für Fuzzyabgleich und andere Abfrageverhaltensweisen bei der automatischen Vervollständigung.

Name	Typ	Beschreibung
autocompleteMode	AutocompleteMode	Gibt den Modus für die automatische Vervollständigung an. Der Standardwert ist 'oneTerm'. Verwenden Sie 'twoTerms', um Gürtelrose abzurufen, und 'oneTermWithContext', um den aktuellen Kontext zu verwenden, während automatisch vervollständigte Begriffe erstellt werden.
filter	string	Ein OData-Ausdruck, der die Dokumente filtert, die zum Erstellen abgeschlossener Ausdrücke für das AutoVervollständigen-Ergebnis verwendet werden.
fuzzy	boolean	Ein Wert, der angibt, ob der Fuzzyabgleich für die AutoVervollständigen-Abfrage verwendet werden soll. Der Standardwert ist "false". Wenn diese Option auf true festgelegt ist, vervollständigt die Abfrage Begriffe auch dann automatisch, 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 Fuzzy-Abfragen für die automatische Vervollständigung langsamer sind und mehr Ressourcen verbrauchen.
highlightPostTag	string	Ein Zeichenfolgen-Tag, das an Treffermarkierungen angehängt wird. Muss mit highlightPreTag gesetzt werden. Wenn nicht angegeben, ist die Trefferhervorhebung deaktiviert.
highlightPreTag	string	Ein Zeichenfolgen-Tag, dem das Erreichen von Highlights vorangestellt wird. Muss mit highlightPostTag gesetzt werden. Wenn nicht angegeben, ist die Trefferhervorhebung deaktiviert.
minimumCoverage	number (double)	Eine Zahl zwischen 0 und 100, die den Prozentsatz des Indexes angibt, der von einer AutoVervollständigen-Abfrage 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.
search	string	Der Suchtext, auf dem die Ergebnisse der automatischen Vervollständigung basieren sollen.
searchFields	string	Die durch Trennzeichen getrennte Liste von Feldnamen, die bei der Abfrage von automatisch vervollständigten Begriffen berücksichtigt werden sollen. Zielfelder müssen in der angegebenen Vorschlagsfunktion enthalten sein.
suggesterName	string	Der Name der Vorschlagsinstanz, wie er in der Vorschlagsauflistung angegeben ist, die Teil der Indexdefinition ist.
top	integer (int32)	Die Anzahl der automatisch vervollständigten Begriffe, die abgerufen werden sollen. Dies muss ein Wert zwischen 1 und 100 sein. Der Standardwert ist 5.

AutocompleteResult

Objekt

Das Ergebnis der AutoVervollständigen-Abfrage.

Name	Typ	Beschreibung
@search.coverage	number (double)	Ein Wert, der den Prozentsatz des Indexes angibt, der von der AutoVervollständigen-Anforderung berücksichtigt wurde, oder NULL, wenn minimumCoverage in der Anforderung nicht angegeben wurde.
value	AutocompleteItem[]	Die Liste der zurückgegebenen automatisch abgeschlossenen Elemente.

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.

Freigeben über

Documents - Autocomplete Post

URI-Parameter

Anforderungsheader

Anforderungstext

Antworten

Beispiele

SearchIndexAutocompleteDocumentsPost

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AutocompleteItem

AutocompleteMode

AutocompleteRequest

AutocompleteResult

ErrorAdditionalInfo

ErrorDetail

ErrorResponse