Documents - Suggest Post

Referentie

Service:: Search Service

API Version:: 2023-11-01

Hiermee worden documenten in de index voorgesteld die overeenkomen met de opgegeven gedeeltelijke querytekst.

POST {endpoint}/indexes('{indexName}')/docs/search.post.suggest?api-version=2023-11-01

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string	De eindpunt-URL van de zoekservice.
indexName	path	True	string	De naam van de index.
api-version	query	True	string	Client-API-versie.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-request-id		string uuid	De tracerings-id die met de aanvraag is verzonden om te helpen bij foutopsporing.

Aanvraagbody

Name	Vereist	Type	Description
search	True	string	De zoektekst die moet worden gebruikt om documenten voor te stellen. Moet ten minste één teken en niet meer dan 100 tekens bevatten.
suggesterName	True	string	De naam van de suggestiefunctie zoals opgegeven in de verzameling suggesties die deel uitmaakt van de indexdefinitie.
filter		string	Een OData-expressie die de documenten filtert die in aanmerking komen voor suggesties.
fuzzy		boolean	Een waarde die aangeeft of fuzzy matching moet worden gebruikt voor de suggestiequery. De standaardinstelling is onwaar. Als deze optie is ingesteld op true, vindt de query suggesties, zelfs als er een vervangend of ontbrekend teken in de zoektekst staat. Hoewel dit in sommige scenario's een betere ervaring biedt, gaat dit gepaard met prestatiekosten omdat zoekopdrachten voor fuzzy suggesties langzamer zijn en meer resources verbruiken.
highlightPostTag		string	Een tekenreekstag die wordt toegevoegd aan hit-markeringen. Moet worden ingesteld met highlightPreTag. Als u dit weglaat, is markeren van suggesties uitgeschakeld.
highlightPreTag		string	Een tekenreekstag die is voorbereid om markeringen te raken. Moet worden ingesteld met highlightPostTag. Als u dit weglaat, is markeren van suggesties uitgeschakeld.
minimumCoverage		number	Een getal tussen 0 en 100 dat het percentage van de index aangeeft dat moet worden gedekt door een suggestiequery om de query als geslaagd te kunnen rapporteren. Deze parameter kan handig zijn om de beschikbaarheid van zoekopdrachten te garanderen, zelfs voor services met slechts één replica. De standaardwaarde is 80.
orderby		string	De door komma's gescheiden lijst met OData-$orderby expressies waarop de resultaten moeten worden gesorteerd. Elke expressie kan een veldnaam zijn of een aanroep naar de functies geo.distance() of search.score(). Elke expressie kan worden gevolgd door asc om oplopend aan te geven, of desc om aflopend aan te geven. De standaardwaarde is oplopende volgorde. Ties worden verbroken door de matchscores van documenten. Als er geen $orderby is opgegeven, is de standaardsorteervolgorde aflopend op documentmatchscore. Er kunnen maximaal 32 $orderby-componenten zijn.
searchFields		string	De door komma's gescheiden lijst met veldnamen om te zoeken naar de opgegeven zoektekst. Doelvelden moeten worden opgenomen in de opgegeven suggestiefunctie.
select		string	De door komma's gescheiden lijst met velden die moeten worden opgehaald. Als u dit niet opgeeft, wordt alleen het sleutelveld opgenomen in de resultaten.
top		integer	Het aantal suggesties dat moet worden opgehaald. Dit moet een waarde zijn tussen 1 en 100. De standaardwaarde is 5.

Antwoorden

Name	Type	Description
200 OK	SuggestDocumentsResult	Antwoord met voorgestelde documenten die overeenkomen met de gedeeltelijke invoer.
Other Status Codes	SearchError	Foutreactie.

Voorbeelden

SearchIndexSuggestDocumentsPost

Sample Request

HTTP

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

{
  "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
}

Sample Response

Status code:: 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"
    }
  ]
}

Definities

Name	Description
SearchError	Beschrijft een foutvoorwaarde voor de API.
SuggestDocumentsResult	Antwoord met suggestiequeryresultaten van een index.
SuggestRequest	Parameters voor het filteren, sorteren, fuzzy matching en andere suggesties voor querygedrag.
SuggestResult	Een resultaat met een document dat is gevonden door een suggestiequery, plus bijbehorende metagegevens.

SearchError

Beschrijft een foutvoorwaarde voor de API.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	SearchError[]	Een matrix met details over specifieke fouten die tot deze gerapporteerde fout hebben geleid.
message	string	Een door mensen leesbare weergave van de fout.

SuggestDocumentsResult

Antwoord met suggestiequeryresultaten van een index.

Name	Type	Description
@search.coverage	number	Een waarde die het percentage van de index aangeeft dat is opgenomen in de query, of null als minimumCoverage niet is ingesteld in de aanvraag.
value	SuggestResult[]	De volgorde van de resultaten die door de query worden geretourneerd.

SuggestRequest

Parameters voor het filteren, sorteren, fuzzy matching en andere suggesties voor querygedrag.

Name	Type	Description
filter	string	Een OData-expressie die de documenten filtert die in aanmerking komen voor suggesties.
fuzzy	boolean	Een waarde die aangeeft of fuzzy matching moet worden gebruikt voor de suggestiequery. De standaardinstelling is onwaar. Als deze optie is ingesteld op true, vindt de query suggesties, zelfs als er een vervangend of ontbrekend teken in de zoektekst staat. Hoewel dit in sommige scenario's een betere ervaring biedt, gaat dit gepaard met prestatiekosten omdat zoekopdrachten voor fuzzy suggesties langzamer zijn en meer resources verbruiken.
highlightPostTag	string	Een tekenreekstag die wordt toegevoegd aan hit-markeringen. Moet worden ingesteld met highlightPreTag. Als u dit weglaat, is markeren van suggesties uitgeschakeld.
highlightPreTag	string	Een tekenreekstag die is voorbereid om markeringen te raken. Moet worden ingesteld met highlightPostTag. Als u dit weglaat, is markeren van suggesties uitgeschakeld.
minimumCoverage	number	Een getal tussen 0 en 100 dat het percentage van de index aangeeft dat moet worden gedekt door een suggestiequery om de query als geslaagd te kunnen rapporteren. Deze parameter kan handig zijn om de beschikbaarheid van zoekopdrachten te garanderen, zelfs voor services met slechts één replica. De standaardwaarde is 80.
orderby	string	De door komma's gescheiden lijst met OData-$orderby expressies waarop de resultaten moeten worden gesorteerd. Elke expressie kan een veldnaam zijn of een aanroep naar de functies geo.distance() of search.score(). Elke expressie kan worden gevolgd door asc om oplopend aan te geven, of desc om aflopend aan te geven. De standaardwaarde is oplopende volgorde. Ties worden verbroken door de matchscores van documenten. Als er geen $orderby is opgegeven, is de standaardsorteervolgorde aflopend op documentmatchscore. Er kunnen maximaal 32 $orderby-componenten zijn.
search	string	De zoektekst die moet worden gebruikt om documenten voor te stellen. Moet ten minste één teken en niet meer dan 100 tekens bevatten.
searchFields	string	De door komma's gescheiden lijst met veldnamen om te zoeken naar de opgegeven zoektekst. Doelvelden moeten worden opgenomen in de opgegeven suggestiefunctie.
select	string	De door komma's gescheiden lijst met velden die moeten worden opgehaald. Als u dit niet opgeeft, wordt alleen het sleutelveld opgenomen in de resultaten.
suggesterName	string	De naam van de suggestiefunctie zoals opgegeven in de verzameling suggesties die deel uitmaakt van de indexdefinitie.
top	integer	Het aantal suggesties dat moet worden opgehaald. Dit moet een waarde zijn tussen 1 en 100. De standaardwaarde is 5.

SuggestResult

Een resultaat met een document dat is gevonden door een suggestiequery, plus bijbehorende metagegevens.

Name	Type	Description
@search.text	string	De tekst van het resultaat van de suggestie.

Share via