Delen via

Documents - Suggest Get

Service:
Search Service
API-versie:
2025-09-01

Stelt documenten in de index voor die overeenkomen met de opgegeven gedeeltelijke querytekst.

GET {endpoint}/indexes('{indexName}')/docs/search.suggest?search={search}&suggesterName={suggesterName}&api-version=2025-09-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=2025-09-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 1 teken zijn en niet meer dan 100 tekens.
suggesterName
 query True

string

De naam van de suggestie zoals opgegeven in de verzameling suggestiezoekers die deel uitmaakt van de indexdefinitie.
$filter
 query

string

Een OData-expressie waarmee de documenten worden gefilterd die in aanmerking komen voor suggesties.
$orderby
 query

string[]

De 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 uitdrukking kan worden gevolgd door asc om oplopend aan te geven, of desc om aflopend aan te geven. De standaardinstelling is oplopende volgorde. Gelijkspel wordt verbroken door de wedstrijdscores van documenten. Als er geen $orderby is opgegeven, is de standaardsorteervolgorde aflopend op documentovereenkomstscore. Er kunnen maximaal 32 $orderby clausules zijn.
$select
 query

string[]

De lijst met velden die u wilt ophalen. Als dit niet is opgegeven, wordt alleen het sleutelveld in de resultaten opgenomen.
$top
 query

integer (int32)

Het aantal suggesties om op te halen. 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 vals. Als de query is ingesteld op true, worden er termen gevonden, zelfs als er een vervangen of ontbrekend teken in de zoektekst staat. Hoewel dit in sommige scenario's een betere ervaring biedt, brengt het prestatiekosten met zich mee omdat fuzzy suggestiequery's langzamer zijn en meer bronnen verbruiken.
highlightPostTag
 query

string

Een tekenreekstag die wordt toegevoegd aan hoogtepunten raken. Moet worden ingesteld met highlightPreTag. Als dit wordt weggelaten, wordt het markeren van suggesties voor treffers uitgeschakeld.
highlightPreTag
 query

string

Een string-tag die is voorafgegaan om hoogtepunten te raken. Moet worden ingesteld met highlightPostTag. Als dit wordt weggelaten, wordt het markeren van suggesties voor treffers uitgeschakeld.
minimumCoverage
 query

number (double)

Een getal tussen 0 en 100 dat het percentage van de index aangeeft dat door een suggestiequery moet worden gedekt om de query als succesvol te kunnen rapporteren. Deze parameter kan nuttig zijn om de beschikbaarheid van zoekopdrachten te garanderen, zelfs voor services met slechts één replica. De standaardwaarde is 80.
searchFields
 query

string[]

De lijst met veldnamen om naar de opgegeven zoektekst te zoeken. Doelvelden moeten worden opgenomen in de opgegeven suggestie.

Aanvraagkoptekst

Name Vereist Type Description
x-ms-client-request-id

string (uuid)

De tracking-ID die is verzonden met het verzoek om te helpen bij het opsporen.

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

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=2025-09-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 suggestiequery is het resultaat van een index.
SuggestResult

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

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name Type Description
info

object

De aanvullende informatie.
type

string

Het extra informatietype.

ErrorDetail

Object

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

Object

Foutreactie

Name Type Description
error

ErrorDetail

Het foutobject.

SuggestDocumentsResult

Object

Antwoord met suggestiequery is het resultaat van een index.

Name Type Description
@search.coverage

number (double)

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.

SuggestResult

Object

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

Name Type Description
@search.text

string

De tekst van het suggestieresultaat.