Documents - Autocomplete Post

Referenz

Dienst:: Search Service

API-Version:: 2024-07-01

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

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	Die Endpunkt-URL des Suchdiensts.
indexName	path	True	string	Der Name des Indexes.
api-version	query	True	string	Client-API-Version.

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.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
search	True	string	Der Suchtext, auf dem autoVervollständigen-Ergebnisse basieren sollen.
suggesterName	True	string	Der Name des Suggesters, 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 und "oneTermWithContext" zu erhalten, um den aktuellen Kontext zu verwenden, während automatisch abgeschlossene Ausdrücke erstellt werden.
filter		string	Ein OData-Ausdruck, der die Dokumente filtert, mit denen abgeschlossene Ausdrücke für das AutoVervollständigen-Ergebnis erzeugt werden.
fuzzy		boolean	Ein Wert, der angibt, ob der Fuzzy-Abgleich für die AutoVervollständigen-Abfrage verwendet werden soll. Der Standardwert ist "false". Wenn die Abfrage auf "true" festgelegt ist, werden Ausdrücke automatisch abgeschlossen, 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		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		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		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 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		string	Die durch Trennzeichen getrennte Liste der Feldnamen, die beim Abfragen nach automatisch abgeschlossenen Ausdrücken berücksichtigt werden sollen. Zielfelder müssen im angegebenen Vorschlager enthalten sein.
top		integer	Die Anzahl der automatisch abgeschlossenen Ausdrücke, 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, die vorgeschlagene Abfragebegriffe enthält, die die teilweise Eingabe abschließen.
Other Status Codes	ErrorResponse	Fehlerantwort.

Beispiele

SearchIndexAutocompleteDocumentsPost

Beispielanforderung

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.autocomplete?api-version=2024-07-01

{
  "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 und "oneTermWithContext" abzurufen, um den aktuellen Kontext bei der Erstellung von AutoVervollständigen-Ausdrücken zu verwenden.
AutocompleteRequest	Parameter für fuzzy matching, and other autocomplete query behaviors.
AutocompleteResult	Das Ergebnis der AutoVervollständigen-Abfrage.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das 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 Ausdruck.

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.

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 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.
twoTerms	string	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.

AutocompleteRequest

Parameter für fuzzy matching, and other autocomplete query behaviors.

Name	Typ	Beschreibung
autocompleteMode	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.
filter	string	Ein OData-Ausdruck, der die Dokumente filtert, mit denen abgeschlossene Ausdrücke für das AutoVervollständigen-Ergebnis erzeugt werden.
fuzzy	boolean	Ein Wert, der angibt, ob der Fuzzy-Abgleich für die AutoVervollständigen-Abfrage verwendet werden soll. Der Standardwert ist "false". Wenn die Abfrage auf "true" festgelegt ist, werden Ausdrücke automatisch abgeschlossen, 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	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	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	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 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.
search	string	Der Suchtext, auf dem autoVervollständigen-Ergebnisse basieren sollen.
searchFields	string	Die durch Trennzeichen getrennte Liste der Feldnamen, die beim Abfragen nach automatisch abgeschlossenen Ausdrücken berücksichtigt werden sollen. Zielfelder müssen im angegebenen Vorschlager enthalten sein.
suggesterName	string	Der Name des Suggesters, wie in der Suggesters-Auflistung angegeben, die Teil der Indexdefinition ist.
top	integer	Die Anzahl der automatisch abgeschlossenen Ausdrücke, 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 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

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

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

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

Freigeben über