Documents - Suggest Get

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.

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

Opcionális paraméterekkel:

GET {endpoint}/indexes('{indexName}')/docs/search.suggest?search={search}&suggesterName={suggesterName}&$filter={$filter}&fuzzy={fuzzy}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&$orderby={$orderby}&searchFields={searchFields}&$select={$select}&$top={$top}&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.
search	query	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	query	True	string	A javaslattevő neve az indexdefiníció részét képező javaslatkészítők gyűjteményében megadottak szerint.
$filter	query		string	Egy OData-kifejezés, amely szűri a javaslatokhoz figyelembe vett dokumentumokat.
$orderby	query		string[]	Az OData listája $orderby kifejezések, 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.
$select	query		string[]	A lekérni kívánt 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	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	query		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	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 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	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

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ó.

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

SearchIndexSuggestDocumentsGet

Mintakérelem

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs/search.suggest?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&api-version=2025-08-01-preview

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

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

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.