Documents - Autocomplete Get

Dienst:: Search Service

API-Version:: 2026-04-01

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

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

Mit optionalen Parametern:

GET {endpoint}/indexes('{indexName}')/docs/search.autocomplete?api-version=2026-04-01&search={search}&suggesterName={suggesterName}&autocompleteMode={autocompleteMode}&$filter={$filter}&fuzzy={fuzzy}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&searchFields={searchFields}&$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 unvollständige Begriff, der automatisch vervollständigt werden soll.
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 zum Erstellen abgeschlossener Ausdrücke für das AutoVervollständigen-Ergebnis verwendet werden.
$top	query		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.
autocompleteMode	query		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.
fuzzy	query		boolean	Ein Wert, der angibt, ob der Fuzzyabgleich für die AutoVervollständigen-Abfrage 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 Fuzzy-Abfragen für die automatische Vervollständigung langsamer sind und mehr Ressourcen verbrauchen.
highlightPostTag	query		string	Ein Zeichenfolgentag, das an Trefferhighlights angefügt wird. Muss mit highlightPreTag festgelegt werden. Wenn nicht angegeben, ist die Trefferhervorhebung deaktiviert.
highlightPreTag	query		string	Ein Zeichenfolgentag, das den Trefferhighlights vorangestellt ist. Muss mit highlightPostTag festgelegt werden. Wenn nicht angegeben, ist die Trefferhervorhebung deaktiviert.
minimumCoverage	query		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 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, die bei der Abfrage von automatisch vervollständigten Begriffen berücksichtigt werden sollen. 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	AutocompleteResult	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

SearchIndexAutocompleteDocumentsGet

Beispielanforderung

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs/search.autocomplete?api-version=2026-04-01&search=washington medic&suggesterName=sg&autocompleteMode=oneTerm&fuzzy=False&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&searchFields=title,description

Beispiel für eine Antwort

Statuscode:: 200

[
  {
    "text": "medicaid",
    "queryPlusText": "washington medicaid"
  },
  {
    "text": "medicare",
    "queryPlusText": "washington medicare"
  },
  {
    "text": "medicine",
    "queryPlusText": "washington medicine"
  }
]

Definitionen

Name	Beschreibung
Accept	Die Überschrift "Annehmen".
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.
AutocompleteResult	Das Ergebnis der AutoVervollständigen-Abfrage.
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.)

Accept

Enumeration

Die Überschrift "Annehmen".

Wert	Beschreibung
application/json;odata.metadata=none

AutocompleteItem

Objekt

Das Ergebnis von AutoVervollständigen-Anforderungen.

Name	Typ	Beschreibung
queryPlusText	string	Die Abfrage zusammen mit dem abgeschlossenen Ausdruck.
text	string	Der abgeschlossene Ausdruck.

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.

AutocompleteResult

Objekt

Das Ergebnis der AutoVervollständigen-Abfrage.

Name	Typ	Beschreibung
@search.coverage	number (double)	Ein Wert, der den Prozentsatz des Index 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 AutoVervollständigen-Elemente.

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.