Documents - Autocomplete Post

Szolgáltatás:
Search Service
API-verzió:
2025-09-01

Automatikusan kiegészíti a hiányos lekérdezési kifejezéseket a bemeneti szöveg és az index egyező kifejezései alapján.

POST {endpoint}/indexes('{indexName}')/docs/search.post.autocomplete?api-version=2025-09-01

URI-paraméterek

Name In Kötelező Típus Description
endpoint
 path True

string

A keresési szolgáltatás végpontjának URL-címe.
indexName
 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 hibakeresési kérelemmel küldött nyomkövetési azonosító.

Kérelem törzse

Name Kötelező Típus Description
search True

string

Az automatikus kiegészítési eredmények alapjául szolgáló keresési szöveg.
suggesterName True

string

A javaslattevő neve az indexdefiníció részét képező javaslatkészítők gyűjteményében megadottak szerint.
autocompleteMode

AutocompleteMode

Megadja az automatikus kiegészítés módját. Az alapértelmezett érték a "oneTerm". A "twoTerms" használatával kapja meg a zsindelyeket, a "oneTermWithContext" pedig az aktuális környezetet használja az automatikusan kitöltött kifejezések előállításához.
filter

string

Egy 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.
fuzzy

boolean

Az azt jelző érték, hogy az automatikus kiegészítési lekérdezéshez fuzzy egyezést kell-e használni. Az alapértelmezett érték false. Ha igaz értékre van állítva, a lekérdezés automatikusan kiegészíti a kifejezéseket, még akkor is, ha a keresési szövegben helyettesített vagy hiányzó karakter található. Bár ez bizonyos esetekben jobb felhasználói é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 fogyasztanak.
highlightPostTag

string

A találati kiemelésekhez hozzáfűzött karakterlánccímke. A highlightPreTag paranccsal kell beállítani. Ha nincs megadva, a találatkiemelés le van tiltva.
highlightPreTag

string

Egy karakterlánccímke, amely a csúcsfények eléréséhez van hozzáadva. A highlightPostTag paranccsal kell beállítani. Ha nincs megadva, a találatkiemelés le van tiltva.
minimumCoverage

number (double)

0 és 100 közötti szám, amely azt jelzi, hogy az indexnek hány százalékát kell lefednie az automatikus kiegészítési lekérdezésnek ahhoz, hogy a lekérdezés sikeres legyen. Ez a paraméter hasznos lehet a keresés rendelkezésre állásának biztosításához még az egyetlen replikával rendelkező szolgáltatások esetében is. Az alapértelmezett érték 80.
searchFields

string

Az automatikusan kitöltött kifejezések lekérdezésekor figyelembe veendő mezőnevek vesszővel tagolt listája. A célmezőket a megadott javaslattevőnek kell tartalmaznia.
top

integer (int32)

A lekérni kívánt 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

AutocompleteResult

A részleges bemenetet befejező javasolt lekérdezési kifejezéseket tartalmazó válasz.
Other Status Codes

ErrorResponse

Hibaválasz.

Példák

SearchIndexAutocompleteDocumentsPost

Mintakérelem

POST https://stableexampleservice.search.windows.net/indexes('stable-test')/docs/search.post.autocomplete?api-version=2025-09-01


{
  "search": "p",
  "autocompleteMode": "oneTerm",
  "filter": "ownerId ne '1'",
  "fuzzy": true,
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": 80,
  "searchFields": "category, ownerId",
  "suggesterName": "sg",
  "top": 10
}

Mintaválasz

Állapotkód:
200 
{
  "@search.coverage": 100,
  "value": [
    {
      "text": "purple",
      "queryPlusText": "<em>purple</em>"
    },
    {
      "text": "pink",
      "queryPlusText": "<em>pink</em>"
    }
  ]
}

Definíciók

Name Description
AutocompleteItem

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

Megadja az automatikus kiegészítés módját. Az alapértelmezett érték a "oneTerm". A "twoTerms" használatával kapja meg a zsindelyeket, a "oneTermWithContext" pedig az aktuális környezetet használja az automatikus kiegészítési kifejezések előállításához.
AutocompleteRequest

A fuzzy egyezés és egyéb automatikus kiegészítési lekérdezési viselkedések paraméterei.
AutocompleteResult

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

Az erőforrás-kezelési hiba további információi.
ErrorDetail

A hiba részletei.
ErrorResponse

Hibaválasz

AutocompleteItem

Tárgy

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

Name Típus Description
queryPlusText

string

A lekérdezés a befejezett kifejezéssel együtt.
text

string

A befejezett időszak.

AutocompleteMode

Felsorolás

Megadja az automatikus kiegészítés módját. Az alapértelmezett érték a "oneTerm". A "twoTerms" használatával kapja meg a zsindelyeket, a "oneTermWithContext" pedig az aktuális környezetet használja az automatikus kiegészítési kifejezések előállításához.

Érték Description
oneTerm

Csak egy kifejezést javasol. Ha a lekérdezés két kifejezésből áll, csak az utolsó kifejezés fejeződik be. Például, ha a bemenet "washington medic", a javasolt kifejezések közé tartozhat a "medicaid", a "medicare" és a "medicine".
twoTerms

A rendszer kétkifejezéses kifejezések egyeztetését javasolja az indexben. Például, ha a bemenet "orvos", a javasolt kifejezések közé tartozhat a "medicare fedezet" és az "orvosi asszisztens".
oneTermWithContext

A lekérdezés utolsó kifejezését két vagy több kifejezéssel egészíti ki, 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

Tárgy

A fuzzy egyezés és egyéb automatikus kiegészítési lekérdezési viselkedések paraméterei.

Name Típus Description
autocompleteMode

AutocompleteMode

Megadja az automatikus kiegészítés módját. Az alapértelmezett érték a "oneTerm". A "twoTerms" használatával kapja meg a zsindelyeket, a "oneTermWithContext" pedig az aktuális környezetet használja az automatikusan kitöltött kifejezések előállításához.
filter

string

Egy 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.
fuzzy

boolean

Az azt jelző érték, hogy az automatikus kiegészítési lekérdezéshez fuzzy egyezést kell-e használni. Az alapértelmezett érték false. Ha igaz értékre van állítva, a lekérdezés automatikusan kiegészíti a kifejezéseket, még akkor is, ha a keresési szövegben helyettesített vagy hiányzó karakter található. Bár ez bizonyos esetekben jobb felhasználói é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 fogyasztanak.
highlightPostTag

string

A találati kiemelésekhez hozzáfűzött karakterlánccímke. A highlightPreTag paranccsal kell beállítani. Ha nincs megadva, a találatkiemelés le van tiltva.
highlightPreTag

string

Egy karakterlánccímke, amely a csúcsfények eléréséhez van hozzáadva. A highlightPostTag paranccsal kell beállítani. Ha nincs megadva, a találatkiemelés le van tiltva.
minimumCoverage

number (double)

0 és 100 közötti szám, amely azt jelzi, hogy az indexnek hány százalékát kell lefednie az automatikus kiegészítési lekérdezésnek ahhoz, hogy a lekérdezés sikeres legyen. Ez a paraméter hasznos lehet a keresés rendelkezésre állásának biztosításához még az egyetlen replikával rendelkező szolgáltatások esetében is. Az alapértelmezett érték 80.
search

string

Az automatikus kiegészítési eredmények alapjául szolgáló keresési szöveg.
searchFields

string

Az automatikusan kitöltött kifejezések lekérdezésekor figyelembe veendő mezőnevek vesszővel tagolt listája. A célmezőket a megadott javaslattevőnek kell tartalmaznia.
suggesterName

string

A javaslattevő neve az indexdefiníció részét képező javaslatkészítők gyűjteményében megadottak szerint.
top

integer (int32)

A lekérni kívánt 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

Tárgy

Az automatikus kiegészítési 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 minimumCoverage.
value

AutocompleteItem[]

A visszaküldött automatikus kitöltött elemek listája.

ErrorAdditionalInfo

Tárgy

Az erőforrás-kezelési hiba további információi.

Name Típus Description
info

object

A további információk.
type

string

A további információtípus.

ErrorDetail

Tárgy

A hiba részletei.

Name Típus Description
additionalInfo

ErrorAdditionalInfo[]

A hiba további információi.
code

string

A hibakód.
details

ErrorDetail[]

A hiba részletei.
message

string

A hibaüzenet.
target

string

A hibacél.

ErrorResponse

Tárgy

Hibaválasz

Name Típus Description
error

ErrorDetail

A hibaobjektum.