Documents - Suggest Get

Referentie

Service:: Search Service

API-versie:: 2024-07-01

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

GET {endpoint}/indexes('{indexName}')/docs/search.suggest?search={search}&suggesterName={suggesterName}&api-version=2024-07-01

Met optionele parameters:

GET {endpoint}/indexes('{indexName}')/docs/search.suggest?search={search}&suggesterName={suggesterName}&$filter={$filter}&fuzzy={fuzzy}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&$orderby={$orderby}&searchFields={searchFields}&$select={$select}&$top={$top}&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.
search	query	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	query	True	string	De naam van de suggestie zoals opgegeven in de verzameling suggesties die deel uitmaakt van de indexdefinitie.
$filter	query		string	Een OData-expressie waarmee de documenten worden gefilterd die worden overwogen voor suggesties.
$orderby	query		string[]	De lijst met OData $orderby expressies waarop 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.
$select	query		string[]	De lijst met velden die moeten worden opgehaald. Als dit niet is opgegeven, wordt alleen het sleutelveld opgenomen in de resultaten.
$top	query		integer int32	Het aantal suggesties dat moet worden opgehaald. De waarde moet een getal tussen 1 en 100 zijn. De standaardwaarde is 5.
fuzzy	query		boolean	Een waarde die aangeeft of fuzzy overeenkomsten moeten worden gebruikt voor de suggestiequery. De standaardwaarde is onwaar. Als deze optie is ingesteld op true, vindt de query termen, zelfs als er een vervangend of ontbrekend teken in de zoektekst staat. Hoewel dit in sommige scenario's een betere ervaring biedt, worden er prestatiekosten in rekening gebracht, omdat query's met fuzzy suggesties langzamer zijn en meer resources verbruiken.
highlightPostTag	query		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	query		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	query		number double	Een getal tussen 0 en 100 dat het percentage van de index aangeeft dat moet worden gedekt door een suggestiequery om de query te kunnen melden als een succes. Deze parameter kan handig zijn voor het garanderen van de beschikbaarheid van zoekopdrachten, zelfs voor services met slechts één replica. De standaardwaarde is 80.
searchFields	query		string[]	De lijst met veldnamen om te zoeken naar de opgegeven zoektekst. Doelvelden moeten worden opgenomen in de opgegeven suggestiefunctie.

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.

Antwoorden

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

Voorbeelden

SearchIndexSuggestDocumentsGet

Voorbeeldaanvraag

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs/search.suggest?search=hote&suggesterName=sg&$filter=rating gt 10&fuzzy=False&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&$orderby=search.score() desc,rating desc&searchFields=title&$select=docId,title,description&$top=10&api-version=2024-07-01

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

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