Documents - Autocomplete Post
Automatikusan kitölti a hiányos lekérdezési kifejezéseket a bemeneti szöveg és az index megfelelő kifejezései alapján.
POST {endpoint}/indexes('{indexName}')/docs/search.post.autocomplete?api-version=2023-10-01-PreviewURI-paraméterek
| Name | In | Kötelező | Típus | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string |
A keresési szolgáltatás végponti URL-címe. |
|
index
|
path | True |
string |
Az index neve. |
|
api-version
|
query | True |
string |
Ügyfél API-verziója. |
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. |
Kérelem törzse
| Name | Kötelező | Típus | Description |
|---|---|---|---|
| search | True |
string |
Az a keresési szöveg, amelyre az automatikus kiegészítési eredményeket alapozza. |
| suggesterName | True |
string |
A javaslattevő neve az indexdefiníció részét képező javaslattevő-gyűjteményben megadottak szerint. |
| 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. |
||
| filter |
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. |
|
| fuzzy |
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 automatikusan kitölti a kifejezéseket akkor is, 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 |
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 |
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 |
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 |
string |
Az automatikusan kitöltött kifejezések lekérdezése során figyelembe veendő mezőnevek vesszővel tagolt listája. A célmezőknek szerepelnie kell a megadott javaslattevőben. |
|
| top |
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. |
Válaszok
| Name | Típus | Description |
|---|---|---|
| 200 OK |
A részleges bemenetet befejező javasolt lekérdezési kifejezéseket tartalmazó válasz. |
|
| Other Status Codes |
Hibaválasz. |
Példák
SearchIndexAutocompleteDocumentsPost
Mintakérelem
POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.autocomplete?api-version=2023-10-01-Preview
{
"autocompleteMode": "oneTerm",
"search": "washington medic",
"suggesterName": "sg",
"filter": "search.in(docId,'101,102,105')",
"highlightPostTag": "</em>",
"highlightPreTag": "<em>",
"minimumCoverage": 80,
"searchFields": "title,description",
"top": 10
}
Mintaválasz
[
{
"text": "medicaid",
"queryPlusText": "washington medicaid"
},
{
"text": "medicare",
"queryPlusText": "washington medicare"
},
{
"text": "medicine",
"queryPlusText": "washington medicine"
}
]Definíciók
| Name | Description |
|---|---|
|
Autocomplete |
Az automatikus kiegészítési kérések eredménye. |
|
Autocomplete |
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. |
|
Autocomplete |
A homályos egyezés paraméterei és egyéb automatikus kiegészítési lekérdezési viselkedések. |
|
Autocomplete |
Az Automatikus kiegészítés lekérdezés eredménye. |
|
Search |
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 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". |
AutocompleteRequest
A homályos egyezés paraméterei és egyéb automatikus kiegészítési lekérdezési viselkedések.
| Name | Típus | Description |
|---|---|---|
| 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. |
|
| filter |
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. |
| fuzzy |
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 automatikusan kitölti a kifejezéseket akkor is, 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 |
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 |
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 |
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. |
| search |
string |
Az a keresési szöveg, amelyre az automatikus kiegészítési eredményeket alapozza. |
| searchFields |
string |
Az automatikusan kitöltött kifejezések lekérdezése során figyelembe veendő mezőnevek vesszővel tagolt listája. A célmezőknek szerepelnie kell a megadott javaslattevőben. |
| suggesterName |
string |
A javaslattevő neve az indexdefiníció részét képező javaslattevő-gyűjteményben megadottak szerint. |
| top |
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. |
AutocompleteResult
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 |
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 |
A jelentett hibához vezető konkrét hibák részleteinek tömbje. |
|
| message |
string |
A hiba ember által olvasható ábrázolása. |