Documents - Autocomplete Get

Service:

Search Service

API Version:

2023-11-01

Automatikusan befejezi 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}

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-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	Client API-verzió.
search	query	True	string	Az automatikusan kitöltendő hiányos kifejezés.
suggesterName	query	True	string	A javaslattevőnek az indexdefiníció részét képező javaslattevő-gyűjteményben megadott neve.
$filter	query		string	OData-kifejezés, amely szűri az automatikus kiegészítés eredményének befejezett kifejezéseinek 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, a "oneTermWithContext" pedig az aktuális környezetet az automatikusan kitöltött kifejezések létrehozásakor.
fuzzy	query		boolean	Egy érték, amely azt jelzi, hogy használjon-e intelligens egyeztetést az automatikus kiegészítési lekérdezéshez. Az alapértelmezett érték a false (hamis). Ha igaz értékre van állítva, a lekérdezés akkor is kifejezéseket talál, 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 az intelligens automatikus kiegészítési lekérdezések lassabbak és több erőforrást használnak fel.
highlightPostTag	query		string	A kiemelt találatokhoz hozzáfűzött sztringcímke. A highlightPreTag paraméterrel kell beállítani. Ha nincs megadva, a találatkiemelés le van tiltva.
highlightPreTag	query		string	Egy sztringcímke, amely a kiemelések eléréséhez van előtagként felfűzve. A highlightPostTag paraméterrel kell beállítani. Ha nincs megadva, a 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 sikeresként legyen jelentve. Ez a paraméter akkor is hasznos lehet, ha csak egy replikával rendelkező szolgáltatások esetében is biztosítja a keresések rendelkezésre állását. Az alapértelmezett érték 80.
searchFields	query		string[]	Az automatikusan kitöltött kifejezések lekérdezésekor 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

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"
  }
]

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 a zsindelyeket, a "oneTermWithContext" pedig az aktuális környezetet az automatikus kiegészítési kifejezések létrehozásához.
AutocompleteResult	Az automatikus kiegészítési lekérdezés eredménye.
SearchError	Az API hibafeltételét ismerteti.

AutocompleteItem

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

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, a "oneTermWithContext" pedig az aktuális környezetet az automatikus kiegészítési kifejezések létrehozásához.

Name	Típus	Description
oneTerm	string	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 "medicine".
oneTermWithContext	string	Egy lekérdezés utolsó kifejezését tölti ki két vagy több kifejezéssel, 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ött szerepelhet a "washington medicaid" és a "washington medical" kifejezés.
twoTerms	string	Javasoljuk, hogy az indexben szereplő kétkifejezéses kifejezések egyezőek legyenek. Ha például a bemenet "medic", a javasolt kifejezések között szerepelhet a "medicare coverage" és az "orvosi segéd".

AutocompleteResult

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

Name	Típus	Description
@search.coverage	number	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 minimális átvétel.
value	AutocompleteItem[]	A visszaadott automatikus kiegészítésű elemek listája.

SearchError

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 emberi olvasásra alkalmas ábrázolása.