Documents - Autocomplete Post

Referenz

Dienst:: Search Service

API-Version:: 2024-05-01-preview

Automatisches Vervollständigen unvollständiger Abfragebegriffe basierend auf Eingabetext und übereinstimmenden Begriffen im Index.

POST {endpoint}/indexes('{indexName}')/docs/search.post.autocomplete?api-version=2024-05-01-preview

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 Verfolgungs-ID, die mit der Anforderung gesendet wurde, um beim Debuggen zu helfen.

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 Vorschlagsfunktion, wie in der Suggesters-Auflistung angegeben, die Teil der Indexdefinition ist.
autocompleteMode		AutocompleteMode	Gibt den Modus für autovervollständigen an. Der Standardwert ist "oneTerm". Verwenden Sie "twoTerms", um Shingles zu erhalten, und "oneTermWithContext", um den aktuellen Kontext zu verwenden, während automatisch abgeschlossene Begriffe erstellt werden.
filter		string	Ein OData-Ausdruck, der die Dokumente filtert, die verwendet werden, um abgeschlossene Begriffe für das AutoVervollständigen-Ergebnis zu erzeugen.
fuzzy		boolean	Ein Wert, der angibt, ob der Fuzzyabgleich für die AutoVervollständigen-Abfrage verwendet werden soll. Der Standardwert ist "false". Wenn diese Einstellung auf TRUE festgelegt ist, werden Begriffe automatisch vervollständigt, auch wenn im Suchtext ein ersatzfähiges oder fehlendes Zeichen vorhanden ist. Dies bietet zwar in einigen Szenarien eine bessere Benutzererfahrung, hat jedoch Leistungskosten, da Fuzzy-Autovervollständigen-Abfragen langsamer sind und mehr Ressourcen verbrauchen.
highlightPostTag		string	Ein Zeichenfolgentag, das an Trefferhighlights angefügt wird. Muss mit highlightPreTag festgelegt werden. Wenn sie nicht angegeben wird, ist die Trefferherhebung deaktiviert.
highlightPreTag		string	Ein Zeichenfolgentag, dem Trefferhighlights vorangestellt sind. Muss mit highlightPostTag festgelegt werden. Wenn sie nicht angegeben wird, ist die Trefferherhebung deaktiviert.
minimumCoverage		number	Eine Zahl zwischen 0 und 100, die den Prozentsatz des Indexes angibt, der von einer AutoVervollständigen-Abfrage abgedeckt werden muss, damit die Abfrage erfolgreich gemeldet wird. Dieser Parameter kann hilfreich sein, um die Suchverfügbarkeit auch für Dienste mit nur einem Replikat sicherzustellen. Der Standardwert beträgt 80.
searchFields		string	Die durch Trennzeichen getrennte Liste der Feldnamen, die beim Abfragen von automatisch abgeschlossenen Begriffen berücksichtigt werden sollen. Zielfelder müssen in der angegebenen Vorschlagsfunktion enthalten sein.
top		integer	Die Anzahl der automatisch abgeschlossenen 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://myservice.search.windows.net/indexes('myindex')/docs/search.post.autocomplete?api-version=2024-05-01-preview

{
  "autocompleteMode": "oneTerm",
  "search": "washington medic",
  "suggesterName": "sg",
  "filter": "search.in(docId,'101,102,105')",
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": 80,
  "searchFields": "title,description",
  "top": 10
}

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 zu erhalten, und "oneTermWithContext", um den aktuellen Kontext zum Erstellen von AutoVervollständigen-Begriffen zu verwenden.
AutocompleteRequest	Parameter für Fuzzyabgleich und andere Verhalten von Abfragen mit automatischer Vervollständigung.
AutocompleteResult	Das Ergebnis der AutoVervollständigen-Abfrage.
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort

AutocompleteItem

Das Ergebnis von AutoVervollständigen-Anforderungen.

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

AutocompleteMode

Gibt den Modus für autovervollständigen an. Der Standardwert ist "oneTerm". Verwenden Sie "twoTerms", um Shingles zu erhalten, und "oneTermWithContext", um den aktuellen Kontext zum Erstellen von AutoVervollständigen-Begriffen zu verwenden.

Name	Typ	Beschreibung
oneTerm	string	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.
oneTermWithContext	string	Schließt den letzten Ausdruck in einer Abfrage mit zwei oder mehr Begriffen ab, wobei die letzten beiden Begriffe 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.
twoTerms	string	Es werden übereinstimmende Zweibegriffe im Index vorgeschlagen. Wenn die Eingabe beispielsweise "medic" lautet, könnten die vorgeschlagenen Begriffe "medizinische Abdeckung" und "medizinische Assistent" enthalten.

AutocompleteRequest

Parameter für Fuzzyabgleich und andere Verhalten von Abfragen mit automatischer Vervollständigung.

Name	Typ	Beschreibung
autocompleteMode	AutocompleteMode	Gibt den Modus für autovervollständigen an. Der Standardwert ist "oneTerm". Verwenden Sie "twoTerms", um Shingles zu erhalten, und "oneTermWithContext", um den aktuellen Kontext zu verwenden, während automatisch abgeschlossene Begriffe erstellt werden.
filter	string	Ein OData-Ausdruck, der die Dokumente filtert, die verwendet werden, um abgeschlossene Begriffe für das AutoVervollständigen-Ergebnis zu erzeugen.
fuzzy	boolean	Ein Wert, der angibt, ob der Fuzzyabgleich für die AutoVervollständigen-Abfrage verwendet werden soll. Der Standardwert ist "false". Wenn diese Einstellung auf TRUE festgelegt ist, werden Begriffe automatisch vervollständigt, auch wenn im Suchtext ein ersatzfähiges oder fehlendes Zeichen vorhanden ist. Dies bietet zwar in einigen Szenarien eine bessere Benutzererfahrung, hat jedoch Leistungskosten, da Fuzzy-Autovervollständigen-Abfragen langsamer sind und mehr Ressourcen verbrauchen.
highlightPostTag	string	Ein Zeichenfolgentag, das an Trefferhighlights angefügt wird. Muss mit highlightPreTag festgelegt werden. Wenn sie nicht angegeben wird, ist die Trefferherhebung deaktiviert.
highlightPreTag	string	Ein Zeichenfolgentag, dem Trefferhighlights vorangestellt sind. Muss mit highlightPostTag festgelegt werden. Wenn sie nicht angegeben wird, ist die Trefferherhebung deaktiviert.
minimumCoverage	number	Eine Zahl zwischen 0 und 100, die den Prozentsatz des Indexes angibt, der von einer AutoVervollständigen-Abfrage abgedeckt werden muss, damit die Abfrage erfolgreich gemeldet wird. Dieser Parameter kann hilfreich sein, um die Suchverfügbarkeit auch für Dienste mit nur einem Replikat sicherzustellen. Der Standardwert beträgt 80.
search	string	Der Suchtext, auf dem die Ergebnisse der automatischen Vervollständigung basieren sollen.
searchFields	string	Die durch Trennzeichen getrennte Liste der Feldnamen, die beim Abfragen von automatisch abgeschlossenen Begriffen berücksichtigt werden sollen. Zielfelder müssen in der angegebenen Vorschlagsfunktion enthalten sein.
suggesterName	string	Der Name der Vorschlagsfunktion, wie in der Suggesters-Auflistung angegeben, die Teil der Indexdefinition ist.
top	integer	Die Anzahl der automatisch abgeschlossenen Begriffe, die abgerufen werden sollen. Dies muss ein Wert zwischen 1 und 100 sein. Der Standardwert ist 5.

AutocompleteResult

Das Ergebnis der AutoVervollständigen-Abfrage.

Name	Typ	Beschreibung
@search.coverage	number	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 vervollständigten Elemente.

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

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

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

Freigeben über