Documents - Suggest Post

Dienst:: Search Service

API-Version:: 2023-10-01-Preview

Schlägt Dokumente im Index vor, die dem angegebenen Teilabfragetext entsprechen.

POST {endpoint}/indexes('{indexName}')/docs/search.post.suggest?api-version=2023-10-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 Tracking-ID, die mit der Anforderung gesendet wurde, um beim Debuggen zu helfen.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
search	True	string	Der Suchtext, der zum Vorschlagen von Dokumenten verwendet werden soll. Darf mindestens 1 Zeichen und maximal 100 Zeichen lang sein.
suggesterName	True	string	Der Name des Suggesters, wie in der Suggesters-Auflistung angegeben, die Teil der Indexdefinition ist.
filter		string	Ein OData-Ausdruck, der die dokumente filtert, die für Vorschläge berücksichtigt werden.
fuzzy		boolean	Ein Wert, der angibt, ob Fuzzy-Abgleich für die Vorschlagsabfrage verwendet werden soll. Der Standardwert ist "false". Bei Festlegung auf "true" findet die Abfrage Vorschläge, auch wenn im Suchtext ein ersetztes oder fehlendes Zeichen vorhanden ist. Dies bietet zwar eine bessere Erfahrung in einigen Szenarien, es kommt jedoch zu Leistungskosten, da Fuzzy-Vorschlagssuchen 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 von Vorschlägen deaktiviert.
highlightPreTag		string	Ein Zeichenfolgentag, das den Trefferhighlights vorangestellt ist. Muss mit highlightPostTag festgelegt werden. Wenn diese Option weggelassen wird, ist die Hervorhebung von Vorschlägen deaktiviert.
minimumCoverage		number (double)	Eine Zahl zwischen 0 und 100, die den Prozentsatz des Indexes angibt, der von einer Vorschlagsabfrage 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.
orderby		string	Die durch Trennzeichen getrennte Liste der OData-$orderby Ausdrücke, nach denen die Ergebnisse sortiert werden sollen. Jeder Ausdruck kann entweder ein Feldname oder ein Aufruf der Funktionen geo.distance() oder search.score() sein. Jedem Ausdruck kann asc folgen, um aufsteigend oder desc anzuzeigen, um absteigend anzugeben. Der Standardwert ist die aufsteigende Reihenfolge. Die Verknüpfungen werden durch die Übereinstimmungsergebnisse von Dokumenten unterbrochen. Wenn keine $orderby angegeben ist, wird die Standardsortierreihenfolge nach Dokumentabgleichsbewertung absteigend ausgeführt. Es können höchstens 32 $orderby Klauseln vorhanden sein.
searchFields		string	Die durch Trennzeichen getrennte Liste der Feldnamen, die nach dem angegebenen Suchtext gesucht werden sollen. Zielfelder müssen im angegebenen Vorschlager enthalten sein.
select		string	Die durch Trennzeichen getrennte Liste der abzurufenden Felder. Wenn nicht angegeben, wird nur das Schlüsselfeld in die Ergebnisse einbezogen.
top		integer (int32)	Die Anzahl der abzurufenden Vorschläge. Dies muss ein Wert zwischen 1 und 100 sein. Der Standard ist 5.

Antworten

Name	Typ	Beschreibung
200 OK	SuggestDocumentsResult	Antwort, die vorgeschlagene Dokumente enthält, die mit der partiellen Eingabe übereinstimmen.
Other Status Codes	SearchError	Fehlerantwort.

Beispiele

SearchIndexSuggestDocumentsPost

Beispielanforderung

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.suggest?api-version=2023-10-01-Preview

{
  "filter": "rating gt 4.0",
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": 80,
  "orderby": "rating desc",
  "search": "hote",
  "searchFields": "title",
  "select": "docId,title,description",
  "suggesterName": "sg",
  "top": 10
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "value": [
    {
      "@search.text": "Nice <em>Hotel</em>",
      "description": "Cheapest hotel in town",
      "docId": "1",
      "title": "Nice Hotel"
    },
    {
      "@search.text": "Fancy <em>Hotel</em>",
      "description": "Best hotel in town",
      "docId": "2",
      "title": "Fancy Hotel"
    }
  ]
}

Definitionen

Name	Beschreibung
SearchError	Beschreibt eine Fehlerbedingung für die API.
SuggestDocumentsResult	Antwort, die Vorschlagsabfrageergebnisse aus einem Index enthält.
SuggestRequest	Parameter zum Filtern, Sortieren, Fuzzyabgleich und andere Vorschläge abfrageverhalten.
SuggestResult	Ein Ergebnis, das ein Dokument enthält, das von einer Vorschlagsabfrage gefunden wurde, sowie zugeordnete Metadaten.

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.

SuggestDocumentsResult

Objekt

Antwort, die Vorschlagsabfrageergebnisse aus einem Index enthält.

Name	Typ	Beschreibung
@search.coverage	number (double)	Ein Wert, der den Prozentsatz des Indexes angibt, der in der Abfrage enthalten war, oder null, wenn minimumCoverage nicht in der Anforderung festgelegt wurde.
value	SuggestResult[]	Die Abfolge der ergebnisse, die von der Abfrage zurückgegeben werden.

SuggestRequest

Objekt

Parameter zum Filtern, Sortieren, Fuzzyabgleich und andere Vorschläge abfrageverhalten.

Name	Typ	Beschreibung
filter	string	Ein OData-Ausdruck, der die dokumente filtert, die für Vorschläge berücksichtigt werden.
fuzzy	boolean	Ein Wert, der angibt, ob Fuzzy-Abgleich für die Vorschlagsabfrage verwendet werden soll. Der Standardwert ist "false". Bei Festlegung auf "true" findet die Abfrage Vorschläge, auch wenn im Suchtext ein ersetztes oder fehlendes Zeichen vorhanden ist. Dies bietet zwar eine bessere Erfahrung in einigen Szenarien, es kommt jedoch zu Leistungskosten, da Fuzzy-Vorschlagssuchen 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 von Vorschlägen deaktiviert.
highlightPreTag	string	Ein Zeichenfolgentag, das den Trefferhighlights vorangestellt ist. Muss mit highlightPostTag festgelegt werden. Wenn diese Option weggelassen wird, ist die Hervorhebung von Vorschlägen deaktiviert.
minimumCoverage	number (double)	Eine Zahl zwischen 0 und 100, die den Prozentsatz des Indexes angibt, der von einer Vorschlagsabfrage 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.
orderby	string	Die durch Trennzeichen getrennte Liste der OData-$orderby Ausdrücke, nach denen die Ergebnisse sortiert werden sollen. Jeder Ausdruck kann entweder ein Feldname oder ein Aufruf der Funktionen geo.distance() oder search.score() sein. Jedem Ausdruck kann asc folgen, um aufsteigend oder desc anzuzeigen, um absteigend anzugeben. Der Standardwert ist die aufsteigende Reihenfolge. Die Verknüpfungen werden durch die Übereinstimmungsergebnisse von Dokumenten unterbrochen. Wenn keine $orderby angegeben ist, wird die Standardsortierreihenfolge nach Dokumentabgleichsbewertung absteigend ausgeführt. Es können höchstens 32 $orderby Klauseln vorhanden sein.
search	string	Der Suchtext, der zum Vorschlagen von Dokumenten verwendet werden soll. Darf mindestens 1 Zeichen und maximal 100 Zeichen lang sein.
searchFields	string	Die durch Trennzeichen getrennte Liste der Feldnamen, die nach dem angegebenen Suchtext gesucht werden sollen. Zielfelder müssen im angegebenen Vorschlager enthalten sein.
select	string	Die durch Trennzeichen getrennte Liste der abzurufenden Felder. Wenn nicht angegeben, wird nur das Schlüsselfeld in die Ergebnisse einbezogen.
suggesterName	string	Der Name des Suggesters, wie in der Suggesters-Auflistung angegeben, die Teil der Indexdefinition ist.
top	integer (int32)	Die Anzahl der abzurufenden Vorschläge. Dies muss ein Wert zwischen 1 und 100 sein. Der Standard ist 5.

SuggestResult

Objekt

Ein Ergebnis, das ein Dokument enthält, das von einer Vorschlagsabfrage gefunden wurde, sowie zugeordnete Metadaten.

Name	Typ	Beschreibung
@search.text	string	Der Text des Vorschlagsergebnisses.