Documents - Autocomplete Get

Szolgáltatás:: Search Service

API-verzió:: 2023-11-01

Automatikusan kitölti a hiányos lekérdezési kifejezéseket a bemeneti szöveg és az index megfelelő kifejezései alapján.

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

Opcionális paraméterekkel:

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-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string	A keresési szolgáltatás végponti URL-címe.
indexName	path	True	string	Az index neve.
api-version	query	True	string	Ügyfél API-verziója.
search	query	True	string	Az automatikusan kitöltendő hiányos kifejezés.
suggesterName	query	True	string	A javaslattevő neve az indexdefiníció részét képező javaslattevő-gyűjteményben megadottak szerint.
$filter	query		string	OData-kifejezés, amely szűri az automatikus kiegészítés eredményéhez használt befejezett kifejezések előállításához használt dokumentumokat.
$top	query		integer (int32)	A lekérendő automatikusan kitöltött kifejezések száma. Ennek 1 és 100 közötti értéknek kell lennie. Az alapértelmezett érték 5.
autocompleteMode	query		AutocompleteMode	Az automatikus kiegészítés módját adja meg. Az alapértelmezett érték a "oneTerm". A "twoTerms" használatával lekérheti a zsindelyeket és a "oneTermWithContext" parancsot az aktuális környezet használatára az automatikusan kitöltött kifejezések előállításakor.
fuzzy	query		boolean	Egy érték, amely azt jelzi, hogy használjon-e homályos egyezést az automatikus kiegészítési lekérdezéshez. Az alapértelmezett érték hamis. Ha igaz értékre van állítva, a lekérdezés akkor is megkeresi a kifejezéseket, ha egy helyettesítő vagy hiányzó karakter szerepel a keresési szövegben. Bár ez bizonyos helyzetekben jobb élményt nyújt, teljesítményköltséggel jár, mivel a homályos automatikus kiegészítési lekérdezések lassabbak és több erőforrást használnak fel.
highlightPostTag	query		string	Egy sztringcímke, amely a kiemelések eléréséhez van hozzáfűzve. A highlightPreTag értéket kell megadni. Ha nincs megadva, az találatkiemelés le van tiltva.
highlightPreTag	query		string	Egy sztringcímke, amely elő van állítva a kiemelések eléréséhez. A highlightPostTag értéket kell beállítani. Ha nincs megadva, az találatkiemelés le van tiltva.
minimumCoverage	query		number (double)	Egy 0 és 100 közötti szám, amely azt jelzi, hogy az index hány százalékát kell lefednie egy automatikus kiegészítési lekérdezésnek ahhoz, hogy a lekérdezés sikeres legyen. Ez a paraméter akkor is hasznos lehet, ha csak egy replikával rendelkező szolgáltatások esetében is biztosítja a keresés rendelkezésre állását. Az alapértelmezett érték 80.
searchFields	query		string[]	Az automatikusan kitöltött kifejezések lekérdezése során figyelembe veendő mezőnevek listája. A célmezőknek szerepelnie kell a megadott javaslattevőben.

Kérelem fejléce

Name	Kötelező	Típus	Description
x-ms-client-request-id		string (uuid)	A kéréssel együtt küldött nyomkövetési azonosító, amely segít a hibakeresésben.

Válaszok

Name	Típus	Description
200 OK	AutocompleteResult	A részleges bemenetet befejező javasolt lekérdezési kifejezéseket tartalmazó válasz.
Other Status Codes	SearchError	Hibaválasz.

Példák

SearchIndexAutocompleteDocumentsGet

Mintakérelem

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

Mintaválasz

Állapotkód:: 200

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

Definíciók

Name	Description
AutocompleteItem	Az automatikus kiegészítési kérések eredménye.
AutocompleteMode	Az automatikus kiegészítés módját adja meg. Az alapértelmezett érték a "oneTerm". A "twoTerms" használatával lekérheti az övsömört és a oneTermWithContextet, hogy az aktuális környezetet használja az automatikus kiegészítési kifejezések létrehozásához.
AutocompleteResult	Az Automatikus kiegészítés lekérdezés eredménye.
SearchError	Az API hibafeltételét ismerteti.

AutocompleteItem

Tárgy

Az automatikus kiegészítési kérések eredménye.

Name	Típus	Description
queryPlusText	string	A lekérdezés és a befejezett kifejezés.
text	string	A befejezett kifejezés.

AutocompleteMode

Felsorolás

Az automatikus kiegészítés módját adja meg. Az alapértelmezett érték a "oneTerm". A "twoTerms" használatával lekérheti az övsömört és a oneTermWithContextet, hogy az aktuális környezetet használja az automatikus kiegészítési kifejezések létrehozásához.

Érték	Description
oneTerm	Csak egy kifejezés javasolt. Ha a lekérdezésnek két kifejezése van, csak az utolsó kifejezés fejeződik be. Ha például a bemenet "washington medic", a javasolt kifejezések közé tartozhat a "medicaid", a "medicare" és a "gyógyszer".
twoTerms	Az indexben lévő kétkifejezéses kifejezések javasoltak lesznek. Ha például a bemenet "medic", a javasolt kifejezések közé tartozhat a "medicare lefedettség" és az "orvosi asszisztens".
oneTermWithContext	Egy lekérdezés utolsó kifejezését két vagy több kifejezéssel fejezi be, ahol az utolsó két kifejezés az indexben található kifejezés. Ha például a bemenet "washington medic", a javasolt kifejezések közé tartozhat a "washington medicaid" és a "washington medical".

AutocompleteResult

Tárgy

Az Automatikus kiegészítés lekérdezés eredménye.

Name	Típus	Description
@search.coverage	number (double)	Az automatikus kiegészítési kérelem által figyelembe vett index százalékos arányát jelző érték, vagy null, ha a kérelemben nem volt megadva a minimumfeltárás.
value	AutocompleteItem[]	A visszaadott automatikus kiegészítésű elemek listája.

SearchError

Tárgy

Az API hibafeltételét ismerteti.

Name	Típus	Description
code	string	A kiszolgáló által definiált hibakódok egyike.
details	SearchError[]	A jelentett hibához vezető konkrét hibák részleteinek tömbje.
message	string	A hiba ember által olvasható ábrázolása.