Documents - Suggest Post

Referentie

Service:: Search Service

API-versie:: 2024-07-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=2024-07-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 is verzonden met de aanvraag om hulp te bieden 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 suggestie zoals opgegeven in de verzameling suggesties die deel uitmaakt van de indexdefinitie.
filter		string	Een OData-expressie waarmee de documenten worden gefilterd die worden overwogen voor suggesties.
fuzzy		boolean	Een waarde die aangeeft of fuzzy overeenkomsten moeten worden gebruikt voor de suggestiequery. De standaardwaarde is onwaar. Als deze optie is ingesteld op waar, vindt de query suggesties, zelfs als er een vervangend of ontbrekend teken in de zoektekst staat. Hoewel dit een betere ervaring biedt in sommige scenario's, worden er prestatiekosten in rekening gebracht omdat zoekopdrachten met fuzzy suggesties langzamer zijn en meer resources verbruiken.
highlightPostTag		string	Een tekenreekstag die wordt toegevoegd om markeringen te raken. Moet worden ingesteld met highlightPreTag. Als u dit weglaat, wordt het markeren van suggesties uitgeschakeld.
highlightPreTag		string	Een tekenreekstag die is voorbereid om markeringen te raken. Moet worden ingesteld met highlightPostTag. Als u dit weglaat, wordt het 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, zodat de query kan worden gerapporteerd als geslaagd. Deze parameter kan handig zijn voor het garanderen van de beschikbaarheid van zoekopdrachten, zelfs voor services met slechts één replica. De standaardwaarde is 80.
orderby		string	De door komma's gescheiden lijst met OData $orderby expressies waarmee de resultaten moeten worden gesorteerd. Elke expressie kan een veldnaam of een aanroep zijn van 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 standaardvolgorde is oplopend. Ties worden verbroken door de overeenkomende scores van documenten. Als er geen $orderby is opgegeven, wordt de standaardsorteervolgorde aflopend op de score van de documentovereenkomst. 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 dit niet is opgegeven, wordt alleen het sleutelveld opgenomen in de resultaten.
top		integer	Het aantal suggesties dat moet worden opgehaald. Dit moet een waarde tussen 1 en 100 zijn. De standaardwaarde is 5.

Antwoorden

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

Voorbeelden

SearchIndexSuggestDocumentsPost

Voorbeeldaanvraag

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.suggest?api-version=2024-07-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
}

Voorbeeldrespons

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

Definities

Name	Description
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
SuggestDocumentsResult	Antwoord met suggestiequeryresultaten van een index.
SuggestRequest	Parameters voor filteren, sorteren, fuzzy overeenkomsten en andere suggesties voor querygedrag.
SuggestResult	Een resultaat met een document dat is gevonden door een suggestiequery, plus de bijbehorende metagegevens.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

SuggestDocumentsResult

Antwoord met suggestiequeryresultaten van een index.

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

SuggestRequest

Parameters voor filteren, sorteren, fuzzy overeenkomsten en andere suggesties voor querygedrag.

Name	Type	Description
filter	string	Een OData-expressie waarmee de documenten worden gefilterd die worden overwogen voor suggesties.
fuzzy	boolean	Een waarde die aangeeft of fuzzy overeenkomsten moeten worden gebruikt voor de suggestiequery. De standaardwaarde is onwaar. Als deze optie is ingesteld op waar, vindt de query suggesties, zelfs als er een vervangend of ontbrekend teken in de zoektekst staat. Hoewel dit een betere ervaring biedt in sommige scenario's, worden er prestatiekosten in rekening gebracht omdat zoekopdrachten met fuzzy suggesties langzamer zijn en meer resources verbruiken.
highlightPostTag	string	Een tekenreekstag die wordt toegevoegd om markeringen te raken. Moet worden ingesteld met highlightPreTag. Als u dit weglaat, wordt het markeren van suggesties uitgeschakeld.
highlightPreTag	string	Een tekenreekstag die is voorbereid om markeringen te raken. Moet worden ingesteld met highlightPostTag. Als u dit weglaat, wordt het 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, zodat de query kan worden gerapporteerd als geslaagd. Deze parameter kan handig zijn voor het garanderen van de beschikbaarheid van zoekopdrachten, zelfs voor services met slechts één replica. De standaardwaarde is 80.
orderby	string	De door komma's gescheiden lijst met OData $orderby expressies waarmee de resultaten moeten worden gesorteerd. Elke expressie kan een veldnaam of een aanroep zijn van 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 standaardvolgorde is oplopend. Ties worden verbroken door de overeenkomende scores van documenten. Als er geen $orderby is opgegeven, wordt de standaardsorteervolgorde aflopend op de score van de documentovereenkomst. 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 dit niet is opgegeven, wordt alleen het sleutelveld opgenomen in de resultaten.
suggesterName	string	De naam van de suggestie 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 tussen 1 en 100 zijn. De standaardwaarde is 5.

SuggestResult

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

Name	Type	Description
@search.text	string	De tekst van het suggestieresultaat.

Delen via