Documents - Autocomplete Post

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

Onvolledige querytermen worden automatisch aangevuld op basis van invoertekst en overeenkomende termen in de index.

POST {endpoint}/indexes('{indexName}')/docs/search.post.autocomplete?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 waarop automatisch aanvullensresultaten moeten worden gebaseerd.
suggesterName True

string

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

AutocompleteMode

Hiermee geeft u de modus voor Automatisch aanvullen op. De standaardinstelling is 'oneTerm'. Gebruik 'twoTerms' om gordelroos te krijgen en 'oneTermWithContext' om de huidige context te gebruiken bij het produceren van automatisch ingevulde termen.
filter

string

Een OData-expressie waarmee de documenten worden gefilterd die worden gebruikt om voltooide termen te produceren voor het resultaat voor automatisch aanvullen.
fuzzy

boolean

Een waarde die aangeeft of fuzzy matching moet worden gebruikt voor de query voor automatisch aanvullen. De standaardwaarde is vals. Als de query is ingesteld op true, worden termen automatisch aangevuld, 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 wazige query's voor automatisch aanvullen langzamer zijn en meer bronnen verbruiken.
highlightPostTag

string

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

string

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

number (double)

Een getal tussen 0 en 100 dat het percentage van de index aangeeft dat moet worden gedekt door een autocomplete-query om de query als geslaagd 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.
searchFields

string

De door komma's gescheiden lijst met veldnamen waarmee rekening moet worden gehouden bij het opzoeken naar automatisch ingevulde termen. Doelvelden moeten worden opgenomen in de opgegeven suggestie.
top

integer (int32)

Het aantal automatisch ingevulde termen dat moet worden opgehaald. Dit moet een waarde zijn tussen 1 en 100. De standaardwaarde is 5.

Antwoorden

Name Type Description
200 OK

AutocompleteResult

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

SearchIndexAutocompleteDocumentsPost

Voorbeeldaanvraag

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


{
  "search": "p",
  "autocompleteMode": "oneTerm",
  "filter": "ownerId ne '1'",
  "fuzzy": true,
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": 80,
  "searchFields": "category, ownerId",
  "suggesterName": "sg",
  "top": 10
}

Voorbeeldrespons

Statuscode:
200 
{
  "@search.coverage": 100,
  "value": [
    {
      "text": "purple",
      "queryPlusText": "<em>purple</em>"
    },
    {
      "text": "pink",
      "queryPlusText": "<em>pink</em>"
    }
  ]
}

Definities

Name Description
Accept

De Accepteer kop.
AutocompleteItem

Het resultaat van aanvragen voor automatisch aanvullen.
AutocompleteMode

Hiermee geeft u de modus voor Automatisch aanvullen op. De standaardinstelling is 'oneTerm'. Gebruik 'twoTerms' om gordelroos te krijgen en 'oneTermWithContext' om de huidige context te gebruiken bij het produceren van termen voor automatisch aanvullen.
AutocompleteRequest

Parameters voor fuzzy matching en andere gedrag voor automatisch aanvullen van query's.
AutocompleteResult

Het resultaat van de query voor automatisch aanvullen.
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.)

Accept

Opsomming

De Accepteer kop.

Waarde Description
application/json;odata.metadata=none

AutocompleteItem

Object

Het resultaat van aanvragen voor automatisch aanvullen.

Name Type Description
queryPlusText

string

De query samen met de voltooide term.
text

string

De voltooide term.

AutocompleteMode

Opsomming

Hiermee geeft u de modus voor Automatisch aanvullen op. De standaardinstelling is 'oneTerm'. Gebruik 'twoTerms' om gordelroos te krijgen en 'oneTermWithContext' om de huidige context te gebruiken bij het produceren van termen voor automatisch aanvullen.

Waarde Description
oneTerm

Er wordt slechts één term voorgesteld. Als de query uit twee termen bestaat, wordt alleen de laatste term voltooid. Als de invoer bijvoorbeeld 'washington medic' is, kunnen de voorgestelde termen 'medicaid', 'medicare' en 'medicine' zijn.
twoTerms

Er wordt voorgesteld om zinnen met twee termen in de index te matchen. Als de invoer bijvoorbeeld 'medic' is, kunnen de voorgestelde termen 'medicare-dekking' en 'medisch assistent' bevatten.
oneTermWithContext

Hiermee vult u de laatste term in een query aan met twee of meer termen, waarbij de laatste twee termen een woordgroep zijn die in de index voorkomt. Als de invoer bijvoorbeeld 'washington medic' is, kunnen de voorgestelde termen 'washington medicaid' en 'washington medical' bevatten.

AutocompleteRequest

Object

Parameters voor fuzzy matching en andere gedrag voor automatisch aanvullen van query's.

Name Type Description
autocompleteMode

AutocompleteMode

Hiermee geeft u de modus voor Automatisch aanvullen op. De standaardinstelling is 'oneTerm'. Gebruik 'twoTerms' om gordelroos te krijgen en 'oneTermWithContext' om de huidige context te gebruiken bij het produceren van automatisch ingevulde termen.
filter

string

Een OData-expressie waarmee de documenten worden gefilterd die worden gebruikt om voltooide termen te produceren voor het resultaat voor automatisch aanvullen.
fuzzy

boolean

Een waarde die aangeeft of fuzzy matching moet worden gebruikt voor de query voor automatisch aanvullen. De standaardwaarde is vals. Als de query is ingesteld op true, worden termen automatisch aangevuld, 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 wazige query's voor automatisch aanvullen langzamer zijn en meer bronnen verbruiken.
highlightPostTag

string

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

string

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

number (double)

Een getal tussen 0 en 100 dat het percentage van de index aangeeft dat moet worden gedekt door een autocomplete-query om de query als geslaagd 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.
search

string

De zoektekst waarop automatisch aanvullensresultaten moeten worden gebaseerd.
searchFields

string

De door komma's gescheiden lijst met veldnamen waarmee rekening moet worden gehouden bij het opzoeken naar automatisch ingevulde termen. Doelvelden moeten worden opgenomen in de opgegeven suggestie.
suggesterName

string

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

integer (int32)

Het aantal automatisch ingevulde termen dat moet worden opgehaald. Dit moet een waarde zijn tussen 1 en 100. De standaardwaarde is 5.

AutocompleteResult

Object

Het resultaat van de query voor automatisch aanvullen.

Name Type Description
@search.coverage

number (double)

Een waarde die het percentage aangeeft van de index die is overwogen door de aanvraag voor automatisch aanvullen, of null als minimumCoverage niet is opgegeven in de aanvraag.
value

AutocompleteItem[]

De lijst met geretourneerde automatisch aangevulde items.

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.