Documents - Autocomplete Get

Referens

Service:: Search Service

API Version:: 2023-11-01

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

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

With optional parameters:

GET {endpoint}/indexes('{indexName}')/docs/search.autocomplete?api-version=2023-11-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	Slutpunkts-URL:en för söktjänsten.
indexName	path	True	string	Namnet på indexet.
api-version	query	True	string	Klient-API-version.
search	query	True	string	Den ofullständiga termen som ska slutföras 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 Komplettera automatiskt.
$top	query		integer int32	Antalet automatiskt slutförda 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 slutförda termer.
fuzzy	query		boolean	Ett värde som anger om fuzzy-matchning ska användas för den automatiska kompletteringsfrågan. 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. Detta ger en bättre upplevelse i vissa scenarier, men det medför en prestandakostnad eftersom fuzzy autocomplete-frågor är långsammare och förbrukar fler resurser.
highlightPostTag	query		string	En strängtagg som läggs till för att träffa höjdpunkter. Måste anges med highlightPreTag. Om det utelämnas inaktiveras träffmarkeringen.
highlightPreTag	query		string	En strängtagg som förbereds för att träffa höjdpunkter. Måste anges med highlightPostTag. Om det utelämnas inaktiveras träffmarkeringen.
minimumCoverage	query		number double	Ett tal mellan 0 och 100 som anger procentandelen av indexet som måste omfattas av en automatisk kompletteringsfråga 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 slutförda termer. Målfält måste inkluderas i den angivna förslagsspelaren.

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-request-id		string uuid	Spårnings-ID:t som skickas med begäran för att hjälpa till med felsökning.

Svar

Name	Typ	Description
200 OK	AutocompleteResult	Svar som innehåller föreslagna frågetermer som slutför de partiella indata.
Other Status Codes	SearchError	Felsvar.

Exempel

SearchIndexAutocompleteDocumentsGet

Sample Request

HTTP

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

Sample Response

Status code:: 200

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

Definitioner

Name	Description
AutocompleteItem	Resultatet av begäranden om automatisk komplettering.
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.
SearchError	Beskriver ett felvillkor för API:et.

AutocompleteItem

Resultatet av begäranden om automatisk komplettering.

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

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.

Name	Typ	Description
oneTerm	string	Endast en term föreslås. Om frågan har två termer slutförs bara den sista termen. Om indata till exempel är "washington läkare" kan de föreslagna termerna innehålla "medicaid", "medicare" och "medicine".
oneTermWithContext	string	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 läkare" kan de föreslagna termerna innehålla "washington medicaid" och "washington medical".
twoTerms	string	Matchning av fraser med två terminer i indexet föreslås. Om indata till exempel är "läkare" kan de föreslagna termerna innehålla "medicare coverage" och "medical assistent".

AutocompleteResult

Resultatet av frågan Komplettera automatiskt.

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

SearchError

Beskriver ett felvillkor för API:et.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
details	SearchError[]	En matris med information om specifika fel som ledde till det rapporterade felet.
message	string	En mänsklig läsbar representation av felet.