Documents - Suggest Post

Szolgáltatás:: Search Service

API-verzió:: 2025-08-01-preview

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=2025-08-01-preview

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	A dokumentumok javaslatához használt keresési szöveg. Legalább 1 karakterből kell állnia, de legfeljebb 100 karakterből.
suggesterName	True	string	A javaslattevő neve az indexdefiníció részét képező javaslatkészítők gyűjteményében 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	A találati kiemelésekhez hozzáfűzött karakterlánccímke. A highlightPreTag paranccsal kell beállítani. Ha nincs megadva, a javaslatok találatkiemelése 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 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 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.
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. Minden kifejezést követhet az asc a növekvő vagy a desc a csökkenő jelzés jelzésére. Az alapértelmezett sorrend növekvő sorrend. A holtversenyeket a dokumentumok meccspontszáma bontja meg. Ha nincs megadva $orderby, az alapértelmezett rendezési sorrend csökkenő a dokumentum egyezési pontszáma szerint. 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

Name	Típus	Description
200 OK	SuggestDocumentsResult	A részleges bemenetnek megfelelő javasolt dokumentumokat tartalmazó válasz.
Other Status Codes	ErrorResponse	Hibaválasz.

Példák

SearchIndexSuggestDocumentsPost

Mintakérelem

HTTP

POST https://previewexampleservice.search.windows.net/indexes('preview-test')/docs/search.post.suggest?api-version=2025-08-01-preview


{
  "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

Name	Description
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
SuggestDocumentsResult	A javaslatkérést tartalmazó válasz egy indexből származik.
SuggestRequest	Paraméterek szűréshez, rendezéshez, fuzzy egyeztetéshez és egyéb javaslatok lekérdezési viselkedéséhez.
SuggestResult	Egy javaslatkérési lekérdezés által talált dokumentumot és a kapcsolódó metaadatokat tartalmazó eredmény.

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.

SuggestDocumentsResult

Tárgy

A javaslatkérést tartalmazó válasz egy indexből származik.

Name	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 sorrendje.

SuggestRequest

Tárgy

Paraméterek szűréshez, rendezéshez, fuzzy egyeztetéshez és egyéb javaslatok lekérdezési viselkedéséhez.

Name	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	A találati kiemelésekhez hozzáfűzött karakterlánccímke. A highlightPreTag paranccsal kell beállítani. Ha nincs megadva, a javaslatok találatkiemelése 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 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 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.
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. Minden kifejezést követhet az asc a növekvő vagy a desc a csökkenő jelzés jelzésére. Az alapértelmezett sorrend növekvő sorrend. A holtversenyeket a dokumentumok meccspontszáma bontja meg. Ha nincs megadva $orderby, az alapértelmezett rendezési sorrend csökkenő a dokumentum egyezési pontszáma szerint. Legfeljebb 32 $orderby záradék lehet.
search	string	A dokumentumok javaslatához használt keresési szöveg. Legalább 1 karakterből kell állnia, de legfeljebb 100 karakterből.
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ő javaslatkészítők gyűjteményében 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 javaslatkérési lekérdezés által talált dokumentumot és a kapcsolódó metaadatokat tartalmazó eredmény.

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