Documents - Autocomplete Get

Tjänst:: Search Service

API-version:: 2026-04-01

Slutför automatiskt ofullständiga frågetermer baserat på indatatext och matchande termer i indexet.

GET {endpoint}/indexes('{indexName}')/docs/search.autocomplete?api-version=2026-04-01&search={search}&suggesterName={suggesterName}

Med valfria parametrar:

GET {endpoint}/indexes('{indexName}')/docs/search.autocomplete?api-version=2026-04-01&search={search}&suggesterName={suggesterName}&autocompleteMode={autocompleteMode}&$filter={$filter}&fuzzy={fuzzy}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&searchFields={searchFields}&$top={$top}

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string (uri)	Slutpunkts-URL:en för söktjänsten.
indexName	path	True	string	Namnet på indexet.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.
search	query	True	string	Den ofullständiga termen som ska fyllas i automatiskt.
suggesterName	query	True	string	Namnet på förslagstagaren enligt beskrivningen i den förslagssamling som ingår i indexdefinitionen.
$filter	query		string	Ett OData-uttryck som filtrerar de dokument som används för att skapa slutförda termer för resultatet av automatisk komplettering.
$top	query		integer (int32)	Antalet automatiskt ifyllda termer som ska hämtas. Detta måste vara ett värde mellan 1 och 100. Standardvärdet är 5.
autocompleteMode	query		AutocompleteMode	Anger läget för Komplettera automatiskt. Standardvärdet är "oneTerm". Använd "twoTerms" för att hämta bältros och "oneTermWithContext" för att använda den aktuella kontexten när du skapar automatiskt ifyllda termer.
fuzzy	query		boolean	Ett värde som anger om fuzzy-matchning ska användas för frågan för automatisk komplettering. Standardvärdet är false. När värdet är true hittar frågan termer även om det finns ett ersatt eller saknat tecken i söktexten. Även om detta ger en bättre upplevelse i vissa scenarier, medför det en prestandakostnad eftersom fuzzy-frågor för automatisk komplettering är långsammare och förbrukar mer resurser.
highlightPostTag	query		string	En strängtagg som läggs till för att träffa markeringar. Måste anges med highlightPreTag. Om det utelämnas inaktiveras träffmarkering.
highlightPreTag	query		string	En strängtagg som förbereds för att träffa markeringar. Måste anges med highlightPostTag. Om det utelämnas inaktiveras träffmarkering.
minimumCoverage	query		number (double)	Ett tal mellan 0 och 100 som anger procentandelen av indexet som måste täckas av en fråga som kompletteras automatiskt för att frågan ska rapporteras som lyckad. Den här parametern kan vara användbar för att säkerställa söktillgänglighet även för tjänster med endast en replik. Standardvärdet är 80.
searchFields	query		string[]	Listan över fältnamn att tänka på när du frågar efter automatiskt ifyllda termer. Målfält måste ingå i den angivna förslagsställaren.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Accept		Accept	Acceptera-rubriken.
x-ms-client-request-id		string (uuid)	En ogenomskinlig, globalt unik, klientgenererad strängidentifierare för begäran.

Svar

Name	Typ	Description
200 OK	AutocompleteResult	Begäran har slutförts.
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Säkerhet

api-key

Typ: apiKey
I: header

OAuth2Auth

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Omfattningar

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

Exempel

SearchIndexAutocompleteDocumentsGet

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 200

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

Definitioner

Name	Description
Accept	Acceptera-rubriken.
AutocompleteItem	Resultatet av autocomplete-begäranden.
AutocompleteMode	Anger läget för Komplettera automatiskt. Standardvärdet är "oneTerm". Använd "twoTerms" för att hämta bältros och "oneTermWithContext" för att använda den aktuella kontexten för att skapa termer för automatisk komplettering.
AutocompleteResult	Resultatet av frågan Komplettera automatiskt.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.).

Accept

Uppräkning

Acceptera-rubriken.

Värde	Description
application/json;odata.metadata=none

AutocompleteItem

Objekt

Resultatet av autocomplete-begäranden.

Name	Typ	Description
queryPlusText	string	Frågan tillsammans med den slutförda termen.
text	string	Den slutförda termen.

AutocompleteMode

Uppräkning

Anger läget för Komplettera automatiskt. Standardvärdet är "oneTerm". Använd "twoTerms" för att hämta bältros och "oneTermWithContext" för att använda den aktuella kontexten för att skapa termer för automatisk komplettering.

Värde	Description
oneTerm	Endast en term föreslås. Om frågan har två termer slutförs bara den sista termen. Om indata till exempel är "washington medic" kan de föreslagna termerna vara "medicaid", "medicare" och "medicine".
twoTerms	Matchande fraser med två termer i indexet kommer att föreslås. Om indata till exempel är "medic" kan de föreslagna termerna inkludera "medicare-täckning" och "medicinsk assistent".
oneTermWithContext	Slutför den sista termen i en fråga med två eller flera termer, där de två sista termerna är en fras som finns i indexet. Om indata till exempel är "washington medic" kan de föreslagna termerna vara "washington medicaid" och "washington medical".

AutocompleteResult

Objekt

Resultatet av frågan Komplettera automatiskt.

Name	Typ	Description
@search.coverage	number (double)	Ett värde som anger procentandelen av indexet som övervägdes av begäran om automatisk komplettering eller null om minimumCoverage inte angavs i begäran.
value	AutocompleteItem[]	Listan över returnerade automatiskt kompletterade objekt.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info		Den ytterligare informationen.
type	string	Typen av ytterligare information.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Felet ytterligare information.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.).

Name	Typ	Description
error	ErrorDetail	Felet objektet.