Documents - Suggest Get

Szolgáltatás:: Search Service

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

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

GET {endpoint}/indexes('{indexName}')/docs/search.suggest?api-version=2025-11-01-preview&search={search}&suggesterName={suggesterName}

Opcionális paraméterekkel:

GET {endpoint}/indexes('{indexName}')/docs/search.suggest?api-version=2025-11-01-preview&search={search}&suggesterName={suggesterName}&$filter={$filter}&fuzzy={fuzzy}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&$orderby={$orderby}&searchFields={searchFields}&$select={$select}&$top={$top}

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álandó API-verzió.
search	query	True	string	A dokumentumok javaslatára használható keresési szöveg. Legalább 1 karakternek és legfeljebb 100 karakternek kell lennie.
suggesterName	query	True	string	A javaslattevő neve az indexdefiníció részét képező javaslattevő-gyűjteményben megadottak szerint.
$filter	query		string	Egy OData-kifejezés, amely szűri a javaslatokhoz figyelembe vett dokumentumokat.
$orderby	query		string[]	Az OData $orderby kifejezések listája, 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.
$select	query		string[]	A lekérendő mezők listája. Ha nincs megadva, csak a kulcsmező szerepel az eredményekben.
$top	query		integer (int32)	A lekérni kívánt javaslatok száma. Az értéknek 1 és 100 közötti számnak kell lennie. Az alapértelmezett érték 5.
fuzzy	query		boolean	Egy érték, amely azt jelzi, hogy a javaslatok lekérdezéséhez 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 megtalálja a kifejezéseket, 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 javaslatok lekérdezései lassabbak és több erőforrást fogyasztanak.
highlightPostTag	query		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	query		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	query		number (double)	0 és 100 közötti szám, amely azt jelzi, hogy az index hány százalékát kell lefednie a 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.
searchFields	query		string[]	A megadott keresési szöveg kereséséhez használt mezőnevek listája. A célmezőket a megadott javaslattevőnek kell tartalmaznia.

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.

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

SearchIndexSuggestDocumentsGet

Mintakérelem

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs/search.suggest?api-version=2025-11-01-preview&search=hote&suggesterName=sg&$filter=rating gt 10&fuzzy=False&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&$orderby=search.score() desc,rating desc&searchFields=title&$select=docId,title,description&$top=10

Mintaválasz

Állapotkód:: 200

{
  "value": [
    {
      "@search.text": "Nice <em>Hotel</em>",
      "description": "Cheapest hotel in town",
      "docId": "1",
      "title": "Nice Hotel"
    },
    {
      "@search.text": "Fancy <em>Hotel</em>",
      "description": "Best hotel in town",
      "docId": "2",
      "title": "Fancy Hotel"
    }
  ]
}

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.
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 hibacél.

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.

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.