Delen via

Documents - Autocomplete Get

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

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

GET {endpoint}/indexes('{indexName}')/docs/search.autocomplete?api-version=2025-09-01&search={search}&suggesterName={suggesterName}
Met optionele parameters: 
GET {endpoint}/indexes('{indexName}')/docs/search.autocomplete?api-version=2025-09-01&search={search}&suggesterName={suggesterName}&autocompleteMode={autocompleteMode}&$filter={$filter}&fuzzy={fuzzy}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&searchFields={searchFields}&$top={$top}

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 onvolledige term die automatisch moet worden aangevuld.
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 worden gebruikt om voltooide termen te produceren voor het resultaat voor automatisch aanvullen.
$top
 query

integer (int32)

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

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

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 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 wazige query's voor automatisch aanvullen langzamer zijn en meer bronnen verbruiken.
highlightPostTag
 query

string

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

string

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

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 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 waarmee u rekening moet houden bij het opzoeken naar automatisch ingevulde termen. 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

AutocompleteResult

Antwoord met voorgestelde querytermen die de gedeeltelijke invoer voltooien.
Other Status Codes

ErrorResponse

Foutreactie.

Voorbeelden

SearchIndexAutocompleteDocumentsGet

Voorbeeldaanvraag

GET https://myservice.search.windows.net/indexes('myindex')/docs/search.autocomplete?api-version=2025-09-01&search=washington medic&suggesterName=sg&autocompleteMode=oneTerm&fuzzy=False&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&searchFields=title,description

Voorbeeldrespons

Statuscode:
200 
[
  {
    "text": "medicaid",
    "queryPlusText": "washington medicaid"
  },
  {
    "text": "medicare",
    "queryPlusText": "washington medicare"
  },
  {
    "text": "medicine",
    "queryPlusText": "washington medicine"
  }
]

Definities

Name Description
AutocompleteItem

Het resultaat van verzoeken 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.
AutocompleteResult

Het resultaat van de query voor automatisch aanvullen.
ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.
ErrorDetail

De foutdetails.
ErrorResponse

Foutreactie

AutocompleteItem

Object

Het resultaat van verzoeken voor automatisch aanvullen.

Name Type Description
queryPlusText

string

De query samen met de voltooide term.
text

string

De voltooide termijn.

AutocompleteMode

Inventarisatie

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.

AutocompleteResult

Object

Het resultaat van de query voor automatisch aanvullen.

Name Type Description
@search.coverage

number (double)

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

AutocompleteItem[]

De lijst met geretourneerde automatisch voltooide artikelen.

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.