Documents - Suggest Post

Szolgáltatás:: Search Service

API-verzió:: 2026-04-01

Az indexben olyan dokumentumokat javasol, amelyek megfelelnek az adott részleges lekérdezési szövegnek.

POST {endpoint}/indexes('{indexName}')/docs/search.post.suggest?api-version=2026-04-01

URI-paraméterek

Név	In	Kötelező	Típus	Description
endpoint	path	True	string (uri)	A keresési szolgáltatás végpontjának URL-címe.
indexName	path	True	string	Az index neve.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Kérelem fejléce

Név	Kötelező	Típus	Description
x-ms-client-request-id		string (uuid)	A kérés átlátszatlan, globálisan egyedi, ügyfél által generált sztringazonosítója.
Accept		Accept	Az Elfogadás fejléce.

Kérelem törzse

Név	Kötelező	Típus	Description
search	True	string	A dokumentumok javaslatára használható keresési szöveg. Legalább 1 karakternek és legfeljebb 100 karakternek kell lennie.
suggesterName	True	string	A javaslattevő neve az indexdefiníció részét képező javaslattevő-gyűjteményben megadottak szerint.
filter		string	Egy OData-kifejezés, amely szűri a javaslatokhoz figyelembe vett dokumentumokat.
fuzzy		boolean	Az az érték, amely azt jelzi, hogy a javaslatleké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 akkor is javaslatokat talál, ha a keresési szövegben helyettesített vagy hiányzó karakter található. Bár ez bizonyos esetekben jobb élményt nyújt, teljesítményköltséggel jár, mivel az elmosódott javaslatkeresések lassabbak és több erőforrást fogyasztanak.
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, a javaslatok találatkiemelése 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, a javaslatok találatkiemelése le van tiltva.
minimumCoverage		number (double)	0 és 100 közötti szám, amely azt jelzi, hogy az index hány százalékát kell lefednie egy javaslati 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.
orderby		string	Az OData vesszővel tagolt listája $orderby kifejezéseket, amelyek alapján rendezheti az eredményeket. Minden kifejezés lehet mezőnév vagy a geo.distance() vagy a search.score() függvény hívása. Az egyes kifejezéseket követheti az asc, amely növekvő vagy csökkenő jelzést jelez. Az alapértelmezett érték növekvő sorrend. A dokumentumok egyezésének pontszáma megszakítja a kötelékeket. Ha nincs megadva $orderby, az alapértelmezett rendezési sorrend a dokumentumegyezés pontszáma szerint csökkenő lesz. Legfeljebb 32 $orderby záradék lehet.
searchFields		string	A megadott keresési szöveg kereséséhez használt mezőnevek vesszővel tagolt listája. A célmezőket a megadott javaslattevőnek kell tartalmaznia.
select		string	A lekérni kívánt mezők vesszővel tagolt listája. Ha nincs megadva, csak a kulcsmező szerepel az eredményekben.
top		integer (int32)	A lekérni kívánt javaslatok száma. Ennek 1 és 100 közötti értéknek kell lennie. Az alapértelmezett érték 5.

Válaszok

Név	Típus	Description
200 OK	SuggestDocumentsResult	A kérés sikeres volt.
Other Status Codes	ErrorResponse	Váratlan hibaválasz.

Biztonság

api-key

Típus: apiKey
In: header

OAuth2Auth

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Hatókörök

Név	Description
https://search.azure.com/.default

Példák

SearchIndexSuggestDocumentsPost

Mintakérelem

HTTP

POST https://exampleservice.search.windows.net/indexes('example-index')/docs/search.post.suggest?api-version=2026-04-01


{
  "filter": "ownerId eq 'sam' and id lt '15'",
  "fuzzy": true,
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": 80,
  "orderby": "id desc",
  "search": "p",
  "searchFields": "category",
  "select": "id,name,category,ownerId",
  "suggesterName": "sg",
  "top": 10
}

Mintaválasz

Állapotkód:: 200

{
  "@search.coverage": 100,
  "value": [
    {
      "@search.text": "<em>pu</em>rple",
      "id": "14",
      "name": "test",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.text": "<em>pu</em>rple",
      "id": "13",
      "name": "test",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.text": "<em>pu</em>rple",
      "id": "11",
      "name": "test",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.text": "<em>pu</em>rple",
      "id": "1",
      "name": "test",
      "category": "purple",
      "ownerId": "sam"
    }
  ]
}

Definíciók

Név	Description
Accept	Az Elfogadás fejléce.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Az Összes Azure Resource Manager API gyakori hibaválasza a sikertelen műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.)
SuggestDocumentsResult	Javaslati lekérdezési eredményeket tartalmazó válasz egy indexből.
SuggestRequest	A szűrési, rendezési, homályos egyeztetési és egyéb javaslatok lekérdezési viselkedésének paraméterei.
SuggestResult	Egy javaslati lekérdezés által talált dokumentumot és a kapcsolódó metaadatokat tartalmazó eredmény.

Accept

Felsorolás

Az Elfogadás fejléce.

Érték	Description
application/json;odata.metadata=none

ErrorAdditionalInfo

Tárgy

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

Név	Típus	Description
info		A további információk.
type	string	A további információtípus.

ErrorDetail

Tárgy

A hiba részletei.

Név	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 hiba célpontja.

ErrorResponse

Tárgy

Az Összes Azure Resource Manager API gyakori hibaválasza a sikertelen műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.)

Név	Típus	Description
error	ErrorDetail	A hibaobjektum.

SuggestDocumentsResult

Tárgy

Javaslati lekérdezési eredményeket tartalmazó válasz egy indexből.

Név	Típus	Description
@search.coverage	number (double)	A lekérdezésben szereplő index százalékos arányát jelző érték, vagy null, ha a kérelemben nincs beállítva minimumCoverage.
value	SuggestResult[]	A lekérdezés által visszaadott eredmények sorozata.

SuggestRequest

Tárgy

A szűrési, rendezési, homályos egyeztetési és egyéb javaslatok lekérdezési viselkedésének paraméterei.

Név	Típus	Description
filter	string	Egy OData-kifejezés, amely szűri a javaslatokhoz figyelembe vett dokumentumokat.
fuzzy	boolean	Az az érték, amely azt jelzi, hogy a javaslatleké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 akkor is javaslatokat talál, ha a keresési szövegben helyettesített vagy hiányzó karakter található. Bár ez bizonyos esetekben jobb élményt nyújt, teljesítményköltséggel jár, mivel az elmosódott javaslatkeresések lassabbak és több erőforrást fogyasztanak.
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, a javaslatok találatkiemelése 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, a javaslatok találatkiemelése le van tiltva.
minimumCoverage	number (double)	0 és 100 közötti szám, amely azt jelzi, hogy az index hány százalékát kell lefednie egy javaslati 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.
orderby	string	Az OData vesszővel tagolt listája $orderby kifejezéseket, amelyek alapján rendezheti az eredményeket. Minden kifejezés lehet mezőnév vagy a geo.distance() vagy a search.score() függvény hívása. Az egyes kifejezéseket követheti az asc, amely növekvő vagy csökkenő jelzést jelez. Az alapértelmezett érték növekvő sorrend. A dokumentumok egyezésének pontszáma megszakítja a kötelékeket. Ha nincs megadva $orderby, az alapértelmezett rendezési sorrend a dokumentumegyezés pontszáma szerint csökkenő lesz. Legfeljebb 32 $orderby záradék lehet.
search	string	A dokumentumok javaslatára használható keresési szöveg. Legalább 1 karakternek és legfeljebb 100 karakternek kell lennie.
searchFields	string	A megadott keresési szöveg kereséséhez használt mezőnevek vesszővel tagolt listája. A célmezőket a megadott javaslattevőnek kell tartalmaznia.
select	string	A lekérni kívánt mezők vesszővel tagolt listája. Ha nincs megadva, csak a kulcsmező szerepel az eredményekben.
suggesterName	string	A javaslattevő neve az indexdefiníció részét képező javaslattevő-gyűjteményben megadottak szerint.
top	integer (int32)	A lekérni kívánt javaslatok száma. Ennek 1 és 100 közötti értéknek kell lennie. Az alapértelmezett érték 5.

SuggestResult

Tárgy

Egy javaslati lekérdezés által talált dokumentumot és a kapcsolódó metaadatokat tartalmazó eredmény.

Név	Típus	Description
@search.text	string	A javaslat szövege eredmény.