Documents - Autocomplete Get

Dienst:: Search Service

API-Version:: 2023-11-01

AutoVervollständigen unvollständige Abfragebegriffe basierend auf Eingabetext und übereinstimmenden Begriffen im Index.

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

Mit optionalen Parametern:

GET {endpoint}/indexes('{indexName}')/docs/search.autocomplete?api-version=2023-11-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	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 unvollständige Begriff, der automatisch abgeschlossen 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, mit denen abgeschlossene Ausdrücke für das AutoVervollständigen-Ergebnis erzeugt werden.
$top	query		integer (int32)	Die Anzahl der automatisch abgeschlossenen Ausdrücke, die abgerufen werden sollen. Dies muss ein Wert zwischen 1 und 100 sein. Der Standard ist 5.
autocompleteMode	query		AutocompleteMode	Gibt den Modus für AutoVervollständigen an. Der Standardwert ist "oneTerm". Verwenden Sie "twoTerms", um Shingles und "oneTermWithContext" zu erhalten, um den aktuellen Kontext zu verwenden, während automatisch abgeschlossene Ausdrücke erstellt werden.
fuzzy	query		boolean	Ein Wert, der angibt, ob der Fuzzy-Abgleich für die AutoVervollständigen-Abfrage verwendet werden soll. Der Standardwert ist "false". Bei Festlegung auf "true" findet die Abfrage Ausdrücke, auch wenn im Suchtext ein ersetztes oder fehlendes Zeichen vorhanden ist. Dies bietet zwar in einigen Szenarien eine bessere Benutzererfahrung, es kommt jedoch zu Leistungskosten, da Fuzzy-AutoVervollständigen-Abfragen 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 weggelassen wird, ist die Hervorhebung durch Treffer deaktiviert.
highlightPreTag	query		string	Ein Zeichenfolgentag, das den Trefferhighlights vorangestellt ist. Muss mit highlightPostTag festgelegt werden. Wenn diese Option weggelassen wird, ist die Hervorhebung durch Treffer 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 Erfolg gemeldet werden kann. 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 beim Abfragen nach automatisch abgeschlossenen Ausdrücken berücksichtigt werden sollen. Zielfelder müssen im angegebenen Vorschlager enthalten sein.

Anforderungsheader

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

Antworten

Name	Typ	Beschreibung
200 OK	AutocompleteResult	Antwort, die vorgeschlagene Abfragebegriffe enthält, die die teilweise Eingabe abschließen.
Other Status Codes	SearchError	Fehlerantwort.

Beispiele

SearchIndexAutocompleteDocumentsGet

Beispielanforderung

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs/search.autocomplete?api-version=2023-11-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
AutocompleteItem	Das Ergebnis von AutoVervollständigen-Anforderungen.
AutocompleteMode	Gibt den Modus für AutoVervollständigen an. Der Standardwert ist "oneTerm". Verwenden Sie "twoTerms", um Shingles und "oneTermWithContext" abzurufen, um den aktuellen Kontext bei der Erstellung von AutoVervollständigen-Ausdrücken zu verwenden.
AutocompleteResult	Das Ergebnis der AutoVervollständigen-Abfrage.
SearchError	Beschreibt eine Fehlerbedingung für die API.

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 AutoVervollständigen an. Der Standardwert ist "oneTerm". Verwenden Sie "twoTerms", um Shingles und "oneTermWithContext" abzurufen, um den aktuellen Kontext bei der Erstellung von AutoVervollständigen-Ausdrücken zu verwenden.

Wert	Beschreibung
oneTerm	Es wird nur ein Begriff vorgeschlagen. Wenn die Abfrage zwei Begriffe enthält, wird nur der letzte Ausdruck abgeschlossen. Wenn die Eingabe beispielsweise "washington medic" lautet, könnten die vorgeschlagenen Begriffe "medicaid", "medicare" und "medicine" enthalten.
twoTerms	Es wird empfohlen, zwei Begriffsausdrücke im Index abzugleichen. Wenn die Eingabe beispielsweise "medic" lautet, könnten die vorgeschlagenen Begriffe "medicare coverage" und "medical assistant" enthalten.
oneTermWithContext	Schließt den letzten Ausdruck in einer Abfrage mit zwei oder mehr Ausdrücken ab, wobei die letzten beiden Ausdrücke ein Ausdruck sind, der im Index vorhanden ist. Wenn die Eingabe beispielsweise "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.

SearchError

Objekt

Beschreibt eine Fehlerbedingung für die API.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe 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.