Documents - Suggest Post

Referencia

Szolgáltatás:: Search Service

API-verzió:: 2024-07-01

A megadott részleges lekérdezési szövegnek megfelelő dokumentumokat javasol az indexben.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string	A keresési szolgáltatás végponti 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 kéréssel együtt küldött nyomkövetési azonosító, amely segít a hibakeresésben.

Kérelem törzse

Name	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	OData-kifejezés, amely szűri a javaslatoknak tekintett dokumentumokat.
fuzzy		boolean	Egy érték, amely jelzi, hogy a javaslati lekérdezéshez használjon-e homályos egyezést. Az alapértelmezett érték hamis. Ha igaz értékre van állítva, a lekérdezés akkor is talál javaslatokat, ha egy helyettesítő vagy hiányzó karakter szerepel a keresési szövegben. Bár ez jobb élményt nyújt bizonyos helyzetekben, teljesítményköltséggel jár, mivel a homályos javaslatkeresések lassabbak és több erőforrást használnak fel.
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 kiemelé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 kiemelése le van tiltva.
minimumCoverage		number (double)	0 és 100 közötti szám, amely az index azon százalékát jelzi, amelyet egy javaslati lekérdezésnek tartalmaznia kell 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őknek szerepelnie kell a megadott javaslattevőben.
select		string	A beolvasandó mezők vesszővel tagolt listája. Ha nincs meghatározva, csak a kulcsmező szerepel az eredmények között.
top		integer (int32)	A lekérendő 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://myservice.search.windows.net/indexes('myindex')/docs/search.post.suggest?api-version=2024-07-01

{
  "filter": "rating gt 4.0",
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": 80,
  "orderby": "rating desc",
  "search": "hote",
  "searchFields": "title",
  "select": "docId,title,description",
  "suggesterName": "sg",
  "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

Name	Description
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
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.

ErrorAdditionalInfo

Objektum

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

Objektum

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

Objektum

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

SuggestDocumentsResult

Objektum

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

Name	Típus	Description
@search.coverage	number (double)	Egy érték, amely a lekérdezésben szereplő index százalékos arányát jelzi, vagy null értéket, ha a kérelemben nem volt megadva a minimális hozzáférés.
value	SuggestResult[]	A lekérdezés által visszaadott eredmények sorozata.

SuggestRequest

Objektum

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

Name	Típus	Description
filter	string	OData-kifejezés, amely szűri a javaslatoknak tekintett dokumentumokat.
fuzzy	boolean	Egy érték, amely jelzi, hogy a javaslati lekérdezéshez használjon-e homályos egyezést. Az alapértelmezett érték hamis. Ha igaz értékre van állítva, a lekérdezés akkor is talál javaslatokat, ha egy helyettesítő vagy hiányzó karakter szerepel a keresési szövegben. Bár ez jobb élményt nyújt bizonyos helyzetekben, teljesítményköltséggel jár, mivel a homályos javaslatkeresések lassabbak és több erőforrást használnak fel.
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 kiemelé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 kiemelése le van tiltva.
minimumCoverage	number (double)	0 és 100 közötti szám, amely az index azon százalékát jelzi, amelyet egy javaslati lekérdezésnek tartalmaznia kell 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őknek szerepelnie kell a megadott javaslattevőben.
select	string	A beolvasandó mezők vesszővel tagolt listája. Ha nincs meghatározva, csak a kulcsmező szerepel az eredmények között.
suggesterName	string	A javaslattevő neve az indexdefiníció részét képező javaslattevő-gyűjteményben megadottak szerint.
top	integer (int32)	A lekérendő javaslatok száma. Ennek 1 és 100 közötti értéknek kell lennie. Az alapértelmezett érték 5.

SuggestResult

Objektum

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

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

Megosztás a következőn keresztül:

Documents - Suggest Post

URI-paraméterek

Kérelem fejléce

Kérelem törzse

Válaszok

Példák

SearchIndexSuggestDocumentsPost

Mintakérelem

Mintaválasz

Definíciók

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

SuggestDocumentsResult

SuggestRequest

SuggestResult

További források