Documents - Suggest Post

Referenz

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, beim Debuggen zu helfen.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
search	True	string	Der Suchtext, der zum Vorschlag von Dokumenten verwendet werden soll. Er muss zwischen 1 und 100 Zeichen lang sein.
suggesterName	True	string	Der Name des Vorschlags, wie er in der Suggesters-Auflistung angegeben ist, 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 matching für die Vorschlagsabfrage verwendet werden soll. Der Standardwert ist "false". Wenn sie auf true festgelegt ist, findet die Abfrage Vorschläge, auch wenn im Suchtext ein ersetztes oder fehlendes Zeichen vorhanden ist. Dies verbessert zwar in einigen Szenarien die Erfahrungen, führt aber zu Leistungseinbußen, da Fuzzysuchvorschläge langsamer sind und mehr Ressourcen verbrauchen.
highlightPostTag		string	Ein Zeichenfolgentag, das an Hervorhebungen angefügt wird. Muss mit highlightPreTag festgelegt werden. Wenn sie nicht angegeben wird, ist die Treffermarkierung von Vorschlägen deaktiviert.
highlightPreTag		string	Ein Zeichenfolgentag, dem das Erreichen von Hervorhebungen vorangestellt ist. Muss mit highlightPostTag festgelegt werden. Wenn sie nicht angegeben wird, ist die Treffermarkierung von Vorschlägen deaktiviert.
minimumCoverage		number	Eine Zahl zwischen 0 und 100, die den Prozentsatz des Indexes angibt, der von einer Vorschlagsabfrage abgedeckt werden muss, damit die Abfrage erfolgreich gemeldet wird. Dieser Parameter kann nützlich sein, um die Suchverfügbarkeit auch für Dienste mit nur einem Replikat sicherzustellen. Der Standardwert beträgt 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 anzugeben, oder desc, um absteigend anzugeben. Standardmäßig wird in aufsteigender Reihenfolge sortiert. Verknüpfungen werden durch die Ergebnisstände von Dokumenten getrennt. Wenn kein $orderby angegeben ist, wird die Standardsortierreihenfolge nach dokumentgleicher Bewertung absteigend. Es können maximal 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 Vorschlag 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	Die Anzahl der abzurufenden Vorschläge. Dies muss ein Wert zwischen 1 und 100 sein. Der Standardwert ist 5.

Antworten

Name	Typ	Beschreibung
200 OK	SuggestDocumentsResult	Antwort mit vorgeschlagenen Dokumenten, 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 Die Ergebnisse der Vorschlagsabfrage aus einem Index enthält.
SuggestRequest	Parameter für Filterung, Sortierung, Fuzzyabgleich und andere Vorschläge zum Abfrageverhalten.
SuggestResult	Ein Ergebnis, das ein Dokument enthält, das von einer Vorschlagsabfrage gefunden wurde, sowie zugeordnete Metadaten.

SearchError

Beschreibt eine Fehlerbedingung für die API.

Name	Typ	Beschreibung
code	string	Einer der vom Server definierten Fehlercodes.
details	SearchError[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
message	string	Eine für Menschen lesbare Darstellung des Fehlers.

SuggestDocumentsResult

Antwort, die Die Ergebnisse der Vorschlagsabfrage aus einem Index enthält.

Name	Typ	Beschreibung
@search.coverage	number	Ein Wert, der den Prozentsatz des Index angibt, der in der Abfrage enthalten war, oder NULL, wenn minimumCoverage in der Anforderung nicht festgelegt wurde.
value	SuggestResult[]	Die Sequenz der von der Abfrage zurückgegebenen Ergebnisse.

SuggestRequest

Parameter für Filterung, Sortierung, Fuzzyabgleich und andere Vorschläge zum 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 matching für die Vorschlagsabfrage verwendet werden soll. Der Standardwert ist "false". Wenn sie auf true festgelegt ist, findet die Abfrage Vorschläge, auch wenn im Suchtext ein ersetztes oder fehlendes Zeichen vorhanden ist. Dies verbessert zwar in einigen Szenarien die Erfahrungen, führt aber zu Leistungseinbußen, da Fuzzysuchvorschläge langsamer sind und mehr Ressourcen verbrauchen.
highlightPostTag	string	Ein Zeichenfolgentag, das an Hervorhebungen angefügt wird. Muss mit highlightPreTag festgelegt werden. Wenn sie nicht angegeben wird, ist die Treffermarkierung von Vorschlägen deaktiviert.
highlightPreTag	string	Ein Zeichenfolgentag, dem das Erreichen von Hervorhebungen vorangestellt ist. Muss mit highlightPostTag festgelegt werden. Wenn sie nicht angegeben wird, ist die Treffermarkierung von Vorschlägen deaktiviert.
minimumCoverage	number	Eine Zahl zwischen 0 und 100, die den Prozentsatz des Indexes angibt, der von einer Vorschlagsabfrage abgedeckt werden muss, damit die Abfrage erfolgreich gemeldet wird. Dieser Parameter kann nützlich sein, um die Suchverfügbarkeit auch für Dienste mit nur einem Replikat sicherzustellen. Der Standardwert beträgt 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 anzugeben, oder desc, um absteigend anzugeben. Standardmäßig wird in aufsteigender Reihenfolge sortiert. Verknüpfungen werden durch die Ergebnisstände von Dokumenten getrennt. Wenn kein $orderby angegeben ist, wird die Standardsortierreihenfolge nach dokumentgleicher Bewertung absteigend. Es können maximal 32 $orderby-Klauseln vorhanden sein.
search	string	Der Suchtext, der zum Vorschlag von Dokumenten verwendet werden soll. Er muss zwischen 1 und 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 Vorschlag 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 Vorschlags, wie er in der Suggesters-Auflistung angegeben ist, die Teil der Indexdefinition ist.
top	integer	Die Anzahl der abzurufenden Vorschläge. Dies muss ein Wert zwischen 1 und 100 sein. Der Standardwert ist 5.

SuggestResult

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.

Freigeben über