Documents - Suggest Post

Service:
Search Service
API-versie:
2026-04-01

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

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

URI-parameters

Name In Vereist Type Description
endpoint
 path True

string (uri)

De eindpunt-URL van de zoekservice.
indexName
 path True

string

De naam van de index.
api-version
 query True

string

minLength: 1

De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagkoptekst

Name Vereist Type Description
Accept

Accept

De Accepteer kop.
x-ms-client-request-id

string (uuid)

Een ondoorzichtige, wereldwijd unieke, door de client gegenereerde tekenreeks-id voor de aanvraag.

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 in aanmerking komen voor suggesties.
fuzzy

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 suggesties 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 vage zoekopdrachten naar suggesties langzamer zijn en meer bronnen verbruiken.
highlightPostTag

string

Een tekenreekstag die wordt toegevoegd om markeringen te raken. Moet worden ingesteld met highlightPreTag. Als dit wordt weggelaten, wordt het markeren van suggesties voor treffers uitgeschakeld.
highlightPreTag

string

Een tekenreekstag die is voorbereid om markeringen te raken. Moet worden ingesteld met highlightPostTag. Als dit wordt weggelaten, wordt het markeren van suggesties voor treffers uitgeschakeld.
minimumCoverage

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

string

De door komma's gescheiden lijst met veldnamen waarmee naar de opgegeven zoektekst moet worden gezocht. Doelvelden moeten worden opgenomen in de opgegeven suggestie.
select

string

De door komma's gescheiden lijst met velden die u wilt ophalen. Als dit niet is opgegeven, wordt alleen het sleutelveld in de resultaten opgenomen.
top

integer (int32)

Het aantal suggesties om op te halen. Dit moet een waarde zijn tussen 1 en 100. De standaardwaarde is 5.

Antwoorden

Name Type Description
200 OK

SuggestDocumentsResult

De aanvraag is voltooid.
Other Status Codes

ErrorResponse

Een onverwachte foutreactie.

Beveiliging

api-key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiken

Name Description
https://search.azure.com/.default

Voorbeelden

SearchIndexSuggestDocumentsPost

Voorbeeldaanvraag

POST https://exampleservice.search.windows.net/indexes('example-index')/docs/search.post.suggest?api-version=2026-04-01


{
  "filter": "ownerId eq 'sam' and id lt '15'",
  "fuzzy": true,
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": 80,
  "orderby": "id desc",
  "search": "p",
  "searchFields": "category",
  "select": "id,name,category,ownerId",
  "suggesterName": "sg",
  "top": 10
}

Voorbeeldrespons

Statuscode:
200 
{
  "@search.coverage": 100,
  "value": [
    {
      "@search.text": "<em>pu</em>rple",
      "id": "14",
      "name": "test",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.text": "<em>pu</em>rple",
      "id": "13",
      "name": "test",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.text": "<em>pu</em>rple",
      "id": "11",
      "name": "test",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.text": "<em>pu</em>rple",
      "id": "1",
      "name": "test",
      "category": "purple",
      "ownerId": "sam"
    }
  ]
}

Definities

Name Description
Accept

De Accepteer kop.
ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.
ErrorDetail

De foutdetails.
ErrorResponse

Veelvoorkomende foutrespons voor alle Azure Resource Manager API's om foutdetails terug te geven bij mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)
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.

Accept

Opsomming

De Accepteer kop.

Waarde Description
application/json;odata.metadata=none

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name Type Description
info

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

ErrorResponse

Object

Veelvoorkomende foutrespons voor alle Azure Resource Manager API's om foutdetails terug te geven bij mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)

Name Type Description
error

ErrorDetail

Het foutobject.

SuggestDocumentsResult

Object

Antwoord met suggestiequeryresultaten 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 reeks resultaten die door de query worden geretourneerd.

SuggestRequest

Object

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 in aanmerking komen voor suggesties.
fuzzy

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 suggesties 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 vage zoekopdrachten naar suggesties langzamer zijn en meer bronnen verbruiken.
highlightPostTag

string

Een tekenreekstag die wordt toegevoegd om markeringen te raken. Moet worden ingesteld met highlightPreTag. Als dit wordt weggelaten, wordt het markeren van suggesties voor treffers uitgeschakeld.
highlightPreTag

string

Een tekenreekstag die is voorbereid om markeringen te raken. Moet worden ingesteld met highlightPostTag. Als dit wordt weggelaten, wordt het markeren van suggesties voor treffers uitgeschakeld.
minimumCoverage

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 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 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.
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 waarmee naar de opgegeven zoektekst moet worden gezocht. Doelvelden moeten worden opgenomen in de opgegeven suggestie.
select

string

De door komma's gescheiden lijst met velden die u wilt ophalen. Als dit niet is opgegeven, wordt alleen het sleutelveld in de resultaten opgenomen.
suggesterName

string

De naam van de suggestie zoals opgegeven in de verzameling suggesties die deel uitmaakt van de indexdefinitie.
top

integer (int32)

Het aantal suggesties om op te halen. Dit moet een waarde zijn tussen 1 en 100. De standaardwaarde is 5.

SuggestResult

Object

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.