Dokumentumok keresése (REST API előzetes verziója)

API-verzió: 2021-04-30-Preview, 2020-06-30-Preview

Fontos

2021-04-30-Preview bővítmények:

  • A "szemanticConfiguration" támogatja a szemantikai rangsorolás hatókörének adott mezőkre történő hatókörkezelését.
  • A "feliratok" a legmagasabb szemantikailag rangsorolt dokumentumok kulcsszakaszaiból kinyert kifejezéseket ad vissza.

2020-06-30-Preview bővítmények:

  • A "queryType=szemantic" támogatja a szemantikai rerankingot és a válaszokat.
  • A "speller" lehetővé teszi a helyesírás-javítást a lekérdezés bemenetén.
  • A "queryType=szemantic" és a "speller" kifejezéshez egyaránt szükség van a "queryLanguage" kifejezésre.
  • A "featuresMode" kicsomagolja a keresési pontszámot, jelentést készít a mezőnkénti kifejezés gyakoriságáról, a mezőnkénti hasonlósági pontszámról és az egyedi egyezések mezőnkénti számáról.

A lekérdezési kérelem egyetlen index dokumentumgyűjteményét célozza meg egy keresési szolgáltatásban. Olyan paramétereket tartalmaz, amelyek meghatározzák a megfeleltetés feltételeit, valamint a választ formázó paramétereket. Indexalias használatával egy adott indexet is megcélozhat, nem pedig magát az indexnevet.

Használhatja a GET vagy a POST parancsot. A lekérdezési paraméterek a lekérdezési sztringen vannak megadva GET kérések esetén, post kérések esetén pedig a kérelem törzsében.

GET https://[service name].search.windows.net/indexes/[index name]/docs?[query parameters] 
  Content-Type: application/json   
  api-key: [admin or query key]  

HA POST-ot használ, adja hozzá a "keresési" műveletet URI-paraméterként.

POST https://[service name].search.windows.net/indexes/[index name]/docs/search?api-version=[api-version]  
  Content-Type: application/json  
  api-key: [admin or query key]  

GET használatával történő meghívás esetén a kérelem URL-címe nem haladhatja meg a 8 KB-ot. Ez a hossz a legtöbb alkalmazáshoz elegendő. Egyes alkalmazások azonban nagy lekérdezéseket hoznak létre, különösen OData-szűrőkifejezések használatakor. Ezekben az alkalmazásokban a HTTP POST jobb választás, mert nagyobb szűrőket tesz lehetővé, mint a GET.

A POST esetében a szűrőben lévő záradékok száma a korlátozó tényező, nem pedig a nyers szűrősztring mérete, mivel a POST kérésméretkorlátja körülbelül 16 MB. Bár a POST kérelem méretkorlátja nagyon nagy, a szűrőkifejezések nem lehetnek önkényesen összetettek. A szűrés összetettségi korlátozásairól további információt az Azure Cognitive Search OData kifejezésszintaxisában talál.

URI-paraméterek

Paraméter Leírás
[szolgáltatás neve] Kötelező. Állítsa ezt a nevet a keresési szolgáltatás egyedi, felhasználó által definiált nevére.
[index neve]/dokumentumok Kötelező. Egy elnevezett index dokumentumgyűjteményét adja meg. Az indexalias neve az indexnév helyett is használható.
[lekérdezési paraméterek] A lekérdezési paraméterek a GET-kérések URI-ja és a POST-kérések kérelemtörzsében vannak megadva.
api-verzió Kötelező. Az aktuális verzió a következő api-version=2021-04-30-Preview: . További verziókért tekintse meg az API-verziókat .

URL-kódolási javaslatok

Ne felejtse el URL-kódolással megadni a lekérdezési paramétereket, amikor közvetlenül meghívja a GET REST API-t. A Dokumentumok keresése művelet esetén az URL-kódolás a következő lekérdezési paraméterekhez lehet szükséges:

  • keresés
  • $filter
  • Tényezője
  • highlightPreTag
  • highlightPostTag

Az URL-kódolás csak az egyes paraméterek esetében ajánlott. Ha véletlenül URL-kódolással kódolja a teljes lekérdezési sztringet (mindent a következő után), a ?kérések megszakadnak.

Emellett az URL-kódolás csak akkor szükséges, ha a REST API-t közvetlenül a GET használatával hívja meg. A POST használatakor vagy a kódolást kezelő Azure Cognitive Search .NET-ügyfélkódtár használatakor nincs szükség URL-kódolásra.

Kérelemfejlécek

Az alábbi táblázat a szükséges és nem kötelező kérelemfejléceket ismerteti.

Mezők Description
Content-Type Kötelező. Állítsa ezt "application/json" értékre
api-key Kötelező. Egy egyedi, rendszer által generált sztring, amely hitelesíti a kérést a keresési szolgáltatásnak. A dokumentumgyűjteményre irányuló lekérdezési kérések megadhatnak rendszergazdai vagy lekérdezési kulcsot API-kulcsként. A lekérdezéskulcs a dokumentumgyűjteményen végzett írásvédett műveletekhez használható. Az API-kulcsot a keresési szolgáltatás irányítópultján találja a Azure Portal.

Kérelem törzse

Get: Nincs.

POST esetén:

{  
     "answers": "none" (default) | "extractive", 
     "count": true | false (default),
     "captions": "none" (default) | "extractive",
     "facets": [ "facet_expression_1", "facet_expression_2", ... ],  
     "featuresMode" : "disabled" (default) | "enabled",
     "filter": "odata_filter_expression",  
     "highlight": "highlight_field_1, highlight_field_2, ...",  
     "highlightPreTag": "pre_tag",  
     "highlightPostTag": "post_tag",  
     "minimumCoverage": # (% of index that must be covered to declare query successful; default 100),  
     "orderby": "orderby_expression",
     "queryLanguage": "en-us" (default) | (a supported language code), 
     "queryType": "simple" (default) | "full" | "semantic",
     "scoringParameters": [ "scoring_parameter_1", "scoring_parameter_2", ... ],  
     "scoringProfile": "scoring_profile_name",  
     "scoringStatistics" : "local" (default) | "global",
     "search": "simple_query_expression",  
     "searchFields": "field_name_1, field_name_2, ...",  
     "searchMode": "any" (default) | "all",  
     "select": "field_name_1, field_name_2, ...",  
     "semanticConfiguration": "semantic_configuration_name",
     "sessionId" : "session_id",
     "skip": # (default 0), 
     "speller": "none" (default) | "lexicon",  
     "top": #  
   }  

Részleges keresési válaszok folytatása

Néha Azure Cognitive Search nem tudja egyetlen keresési válaszban visszaadni az összes kért találatot. Ez különböző okokból történhet, például ha a lekérdezés túl sok dokumentumot kér, ha nem ad meg $top, vagy nem ad meg túl nagy $top értéket. Ilyen esetekben Azure Cognitive Search tartalmazni fogja a @odata.nextLink megjegyzést a válasz törzsében, és azt is@search.nextPageParameters, hogy post kérés volt-e. Ezeknek a széljegyzeteknek az értékeit használva egy másik keresési kérést fogalmazhat meg a keresési válasz következő részének lekéréséhez. Ez az eredeti keresési kérelem folytatása , a széljegyzetek pedig folytatási jogkivonatok. A megjegyzések szintaxisával és a válasz törzsében való megjelenésük helyével kapcsolatos részletekért tekintse meg az alábbi Válaszban található példát.

Az Azure Cognitive Search által visszaadott folytatási jogkivonatok implementációspecifikusak és változhatnak. A robusztus ügyfeleknek mindig készen kell állniuk az olyan esetek kezelésére, amikor a vártnál kevesebb dokumentumot adnak vissza, és egy folytatási jogkivonatot is tartalmaz a dokumentumok lekérésének folytatásához. Azt is vegye figyelembe, hogy a folytatáshoz ugyanazt a HTTP-metódust kell használnia, mint az eredeti kérés. Ha például GET kérést küldött, az elküldött folytatási kéréseknek a GET(és a POST) függvényt is használniuk kell.

Megjegyzés

A szolgáltatás célja és @search.nextPageParameters célja @odata.nextLink a túl sok eredményt kérő lekérdezések elleni védelem, nem pedig a lapozás általános mechanizmusának biztosítása. Ha szeretné áttekinteni az eredményeket, használja $top és $skip együtt. Ha például 10-es méretű lapokat szeretne, az első kérésnek $top=10 és $skip=0, a második kérésnek $top=10 és $skip=10, a harmadik kérésnek $top=10 és $skip=20 stb.

Lekérdezési paraméterek

A lekérdezések több paramétert is elfogadnak az URL-címben, ha GET-lel hívják meg őket, és JSON-tulajdonságokként a kérelem törzsében, amikor POST-tal hívják meg őket. Egyes paraméterek szintaxisa kissé eltér a GET és a POST függvény között. Ezeket a különbségeket az alábbiakban ismertetjük.

Név Típus Description
válaszok (előzetes verzió) sztring Választható. Az érvényes értékek a "none" és a "extractive". Alapértelmezés szerint a "none" (nincs) értékre van kapcsolva. Ez a paraméter csak akkor érvényes, ha a lekérdezés típusa "szemantikai". Ha "kivonatoló" értékre van állítva, a lekérdezés a legmagasabb szemantikailag rangsorolt dokumentumok kulcsszakaszaiból hoz létre és ad vissza válaszokat. Az alapértelmezett válasz egy válasz, de a darabszám hozzáadásával legfeljebb 10-et adhat meg. Az "answers": "extractive|count-3" kifejezés például három választ ad vissza. A válasz visszaadásához elegendő információnak kell lennie a keresőmezőkben ahhoz, hogy megfogalmazzon egyet. Emellett magának a lekérdezésnek is kérdésnek kell lennie. A kulcsszókeresés nem ad vissza választ.
api-verzió sztring Kötelező. A kéréshez használt REST API verziója. A támogatott verziók listájáért tekintse meg az API-verziókat. Ehhez a művelethez az API-verzió URI-paraméterként van megadva, függetlenül attól, hogy a GET vagy a POST használatával hívja-e meg a Keresési dokumentumok szolgáltatást .
feliratok (előzetes verzió) sztring Választható. Az érvényes értékek a "none" és a "extractive". Alapértelmezés szerint a "none" (nincs) értékre van kapcsolva. Ez a paraméter csak akkor érvényes, ha a lekérdezés típusa "szemantikai". Ha a "kivonatoló" értékre van állítva, a lekérdezés a legmagasabb rangsorban lévő dokumentumok fő szakaszaiból kinyert feliratokat adja vissza. Ha a feliratok "extractive" értékre van állítva, a kiemelés alapértelmezés szerint engedélyezve van, és úgy konfigurálható, hogy hozzáfűzi a "|" csövet, majd a "highlight-true</false>" beállítást, például "extractive|highlight-true".
$count boolean Választható. Az érvényes értékek "igaz" vagy "hamis". Az alapértelmezett érték a "false" (hamis). A POST használatával történő meghívásakor a paraméter neve count lesz $count helyett. Meghatározza, hogy lekérje-e az eredmények teljes számát. Ez az összes olyan dokumentum száma, amely megfelel a keresési és $filter paramétereknek, figyelmen kívül hagyva $top és $skip. Ha ezt az értéket "true" értékre állítja, az ronthatja a teljesítményt. A darabszám akkor pontos, ha az index stabil, de a aktívan hozzáadott, frissített vagy törölt dokumentumok alatt vagy felül fog jelenteni. Ha dokumentum nélkül csak a darabszámot szeretné megkapni, használhatja a $top=0 értéket.
Tényezője sztring Választható. Egy szempontú mező. A sztring tartalmazhat paramétereket az aspektus testreszabásához, vesszővel tagolt név:érték párokként kifejezve. A POST használatával történő meghívásakor ezt a paramétert a aspektus helyett aspektusoknak nevezzük.

Érvényes: "count", "sort", "values", "interval" és "timeoffset".

A "count" a jellemző kifejezések maximális száma; alapértelmezett értéke 10. A kifejezések számának nincs felső korlátja, de a magasabb értékek rontják a teljesítményt, különösen akkor, ha a jellemző mező nagy számú egyedi kifejezést tartalmaz. Például a "facet=category,count:5" az első öt kategóriát kapja meg a aspektuseredményekben. Ha a count paraméter kisebb, mint az egyedi kifejezések száma, előfordulhat, hogy az eredmények nem pontosak. Ennek az az oka, ahogyan az arculati lekérdezések el vannak osztva a szegmensek között. A darabszámot nullára vagy olyan értékre állíthatja, amely nagyobb vagy egyenlő a facetable mező egyedi értékeinek számával, hogy pontos számot kapjon az összes szegmensben. A kompromisszum a megnövekedett késés.

A "sort" értéke lehet "count", "-count", "value", "-value". A darabszám használatával csökkenő sorrendbe rendezhet darabszám szerint. A -count függvénnyel növekvő sorrendbe rendezheti a számokat. Érték használatával növekvő sorrendbe rendezheti az értékeket. Az -value függvénnyel csökkenő sorrendbe rendezheti az értékeket (például a "facet=category,count:3,sort:count" a aspektus első három kategóriáját kapja meg, és csökkenő sorrendben jeleníti meg az egyes városneveket tartalmazó dokumentumok számát). Ha az első három kategória a Budget, a Motel és a Luxus, és a Budget 5 találatot, Motel 6, és a Luxus 4, akkor a gyűjtők lesznek a sorrend Motel, Költségvetés, Luxus. A -value esetében a "facet=rating,sort:-value" gyűjtőket hoz létre az összes lehetséges értékeléshez, érték szerint csökkenő sorrendben (például ha az értékelések 1 és 5 között vannak, a gyűjtők 5, 4, 3, 2, 1 sorrendben jelennek meg, függetlenül attól, hogy hány dokumentum felel meg az egyes minősítéseknek).

Az "értékek" vesszővel tagolt numerikus értékekre vagy Edm.DateTimeOffset értékekre állíthatók, amely a aspektusbejegyzési értékek dinamikus készletét adja meg (például "facet=baseRate,values:10 | A 20" három gyűjtőt állít elő: egyet az alapkamathoz 0-ig, de nem tartalmazza a 10-et, egyet a 10-hez, egyet a 20-ig, egyet pedig a 20-hoz vagy magasabbhoz). A "facet=lastRenovationDate,values:2010-02-01T00:00:00Z" sztring két gyűjtőt hoz létre: egyet a 2010 februárja előtt felújított szállodákhoz, egyet pedig a 2010. február 1-jei vagy újabb felújítású szállodákhoz. Az értékeknek szekvenciális, növekvő sorrendben kell szerepelnie a várt eredmények lekéréséhez.

Az "intervallum" számok esetén 0-nál nagyobb egész számintervallum, a dátum-időértékek esetében pedig perc, óra, nap, hét, hónap, negyedév, év. A "facet=baseRate,interval:100" például a 100-es alapkamattartományok alapján állít elő gyűjtőket. Ha az alapkamatok 60 és 600 dollár között vannak, akkor 0-100, 100-200, 200-300, 300-400, 400-500 és 500-600 gyűjtők lesznek. A "facet=lastRenovationDate,interval:year" sztring minden évben egy gyűjtőt állít elő a szállodák felújításakor.

A "timeoffset" értéke ([+-]hh:mm, [+-]hhmm vagy [+-]hh). Ha használja, az időeltérési paramétert össze kell kapcsolni az intervallum beállítással, és csak akkor, ha Edm.DateTimeOffset típusú mezőre alkalmazza. Az érték az időhatárok beállításához figyelembe venni kívánt UTC időeltolódást adja meg. A "facet=lastRenovationDate,interval:day,timeoffset:-01:00" például a 01:00:00 UTC időpontban (a cél időzónában éjfélkor) kezdődő naphatárt használja.

a count és a sort kombinálható ugyanabban a szempontspecifikációban, de nem kombinálhatók intervallummal vagy értékekkel, és az intervallum és az értékek nem kombinálhatók.

Ha nincs megadva időeltolás, akkor a dátumidő időközi aspektusainak kiszámítása az UTC-idő alapján történik. Például: a "facet=lastRenovationDate,interval:day" esetében a nap határa 00:00:00 UTC-kor kezdődik.
featuresMode (előzetes verzió) boolean Választható. Az érvényes értékek "engedélyezve" és "letiltva" értékűek. Az alapértelmezett érték "letiltva". Egy érték, amely meghatározza, hogy az eredmények tartalmazzák-e a lekérdezés eredményfunkcióit, amelyek a dokumentumok lekérdezéshez viszonyított relevanciapontszámának kiszámítására szolgálnak, például mezőenkénti hasonlóságra. Az "engedélyezve" funkcióval további lekérdezési eredmények jeleníthetők meg: mezőenkénti hasonlósági pontszám, mezőnkénti kifejezés gyakorisága és az egyeztetett egyedi jogkivonatok mezőnkénti száma. További információ: Hasonlóság és pontozás.
$filter sztring Választható. Strukturált keresési kifejezés a standard OData szintaxisban. Szűrőben csak szűrhető mezők használhatók. A POST használatával történő meghívásakor ez a paraméter $filter helyett szűrőnek lesz elnevezve. A Azure Cognitive Search OData-kifejezésszintaxisát az OData-kifejezés nyelvtanának Azure Cognitive Search által támogatott részhalmazával kapcsolatos részletekért olvassa el.
kiemel sztring Választható. A találatok kiemeléséhez használt, vesszővel tagolt mezőnevek halmaza. Csak kereshető mezők használhatók a találatok kiemeléséhez. Alapértelmezés szerint Azure Cognitive Search mezőnként legfeljebb öt kiemelést ad vissza. A korlát mezőnként konfigurálható, ha a mező neve után hozzáfűzi a "-<max # of highlights>" értéket. A "highlight=title-3,description-10" például legfeljebb három kiemelt találatot ad vissza a címmezőből, és legfeljebb 10 találatot a leírásmezőből. A kiemelések maximális számának 1 és 1000 közötti egész számnak kell lennie.
highlightPostTag sztring Választható. Defaults to "</em>". A kiemelt kifejezéshez hozzáfűző sztringcímke. A highlightPreTag paraméterrel kell beállítani. Az URL-címben a fenntartott karaktereknek százalékban kódoltnak kell lenniük (például a #helyett %23).
highlightPreTag sztring Választható. Defaults to "</em>". Egy sztringcímke, amely a kiemelt kifejezésre hivatkozik. A highlightPostTag értéket kell megadni. Az URL-címben a fenntartott karaktereknek százalékban kódoltnak kell lenniük (például a #helyett %23).
minimumCoverage egész szám Választható. Az érvényes értékek egy 0 és 100 közötti szám, amely azt jelzi, hogy az index hány százalékát kell rendelkezésre bocsátani a lekérdezés kiszolgálásához ahhoz, hogy sikeresként lehessen jelenteni. Alapértelmezés szerint "100".

A száz százalékos lefedettség azt jelenti, hogy minden szegmens válaszolt a kérésre (sem a szolgáltatás állapotával kapcsolatos problémák, sem a karbantartási tevékenységek nem csökkentették a lefedettséget). Az alapértelmezett beállítás szerint a teljesnél kisebb lefedettség az 503-ás HTTP-állapotkódot adja vissza.

A minimális helyreállítás csökkentése 503 hiba esetén lehet hasznos, és növelni szeretné a lekérdezés sikerességének valószínűségét, különösen az egy replikához konfigurált szolgáltatások esetében. Ha beállítja a minimumfeltárást, és a keresés sikeres, a függvény HTTP 200-as értéket ad vissza, és a válaszban szerepel egy @search.coverage érték, amely a lekérdezésben szereplő index százalékos arányát jelzi. Ebben a forgatókönyvben nem minden egyező dokumentum jelenik meg a keresési eredményekben, de ha a keresés elérhetősége fontosabb a visszahívásnál, akkor a lefedettség csökkentése életképes kockázatcsökkentési stratégia lehet.
$orderby sztring Választható. Vesszővel tagolt kifejezések listája az eredmények rendezéséhez. Ha POST használatával hívjuk meg, a paraméter neve orderby lesz $orderby helyett. Minden kifejezés lehet mezőnév vagy a geo.distance() függvény hívása. Minden kifejezést követhet az "asc" a növekvő, a "desc" pedig a csökkenő jelzéshez. Ha a rendezési mezőben nullértékek találhatók, a null értékek először növekvő sorrendben jelennek meg, majd csökkenő sorrendben. Az alapértelmezett érték növekvő sorrend. A csatolók a dokumentumok egyezésének pontszáma alapján lesznek megszakítva. Ha nincs megadva $orderby, az alapértelmezett rendezési sorrend a dokumentumegyezés pontszáma szerint csökkenő lesz. A $orderby legfeljebb 32 záradékot tartalmaz.
queryLanguage (előzetes verzió) sztring Választható. Az érvényes értékek támogatott nyelvek. Az alapértelmezett érték az "en-us". Ezt a paramétert be kell állítani, ha a speller=lexikon vagy a queryType=szemantic függvényt használja. A queryLanguage-ban megadott nyelvet a helyesírás-ellenőrzéshez és a szemantikai modellekhez is használják, amelyek az eredményeket újraküldik, és feliratot vagy választ nyernek ki. A queryLanguage függvénytárak függetlenek más területi beállításokon alapuló mezőattribútumtól, például az indexeléshez és a teljes szöveges kereséshez használt nyelvelemzőktől .
queryType sztring Választható. Az érvényes értékek a következők: "simple", "full" vagy "szemantic" (előzetes verzió). Alapértelmezés szerint "egyszerű".

Az "simple" a lekérdezési sztringeket az egyszerű lekérdezési szintaxissal értelmezi, amely lehetővé teszi az olyan szimbólumok használatát, mint +a , *és "". A lekérdezések alapértelmezés szerint az egyes dokumentumok összes kereshető mezőjében (vagy a keresőmezőkben jelzett mezőkben) vannak kiértékelve.

A "full" a lekérdezési sztringeket a teljes Lucene lekérdezési szintaxissal értelmezi, amely lehetővé teszi a mezőspecifikus és súlyozott kereséseket. A Lucene lekérdezési nyelv tartománykeresése nem támogatott a hasonló funkciókat kínáló $filter mellett.

" A szemantikai" a keresési eredmények pontosságát javítja azáltal, hogy a Bing-korpuszra betanított rangsorolási modell használatával az első 50 találatot a kulcsszavak helyett a természetes nyelven kifejezett lekérdezésekre tanítja be. Ha a lekérdezés típusát szemantikai értékre állítja, akkor a queryLanguage és a szemanticConfiguration beállítást is meg kell adnia. Ha az első 3 választ is szeretné visszaadni, ha a lekérdezési bemenet természetes nyelven lett megfogalmazva ("mi az a ...), és igény szerint feliratokat is beállíthat a legfontosabb szakaszok kinyeréséhez a legmagasabb rangsorolt dokumentumokból.
scoringParameter sztring Választható. Egy pontozófüggvényben (például referencePointParameter) definiált paraméterek értékeit jelzi a "name-value1,value2,..." formátumban Ha POST-tal hívjuk, ez a paraméter scoringParameters néven van elnevezve a scoringParameter helyett. Emellett sztringek JSON-tömbjeként is megadhatja, ahol minden sztring külön név-érték pár.

Függvényt tartalmazó pontozási profilok esetén válassza el a függvényt a bemeneti listától egy - karakterrel. Egy úgynevezett "mylocation" függvény például a következő: "&scoringParameter=mylocation--122.2,44.8". Az első kötőjel elválasztja a függvény nevét az értéklistától, míg a második kötőjel az első érték része (ebben a példában a hosszúság).

Olyan pontozási paraméterek esetén, mint például a vesszőket tartalmazó címkenövelés, a listában szereplő értékek egyetlen idézőjellel kerülhetők el. Ha maguk az értékek szimpla idézőjeleket tartalmaznak, a duplikálással feloldhatja őket. Tegyük fel, hogy van egy címkefokozó paramétere "mytag" , amelyet a "Hello, O'Brien" és "Smith" címkeértékeken szeretne növelni, a lekérdezési sztring beállítás ezután a következő lesz: "&scoringParameter=mytag-'Hello, O''Brien',Smith". Az idézőjelek csak vesszőket tartalmazó értékekhez szükségesek.
scoringProfile sztring Választható. Annak a pontozási profilnak a neve, amely kiértékeli az egyező dokumentumok egyező pontszámait az eredmények rendezése érdekében.
scoringStatistics sztring Választható. Az érvényes értékek a "helyi" vagy a "globális". Alapértelmezés szerint a "local" (helyi). Adja meg, hogy számítsa-e ki a pontozási statisztikákat, például a dokumentum gyakoriságát globálisan (az összes szegmensben) a következetesebb pontozás érdekében, vagy helyileg (az aktuális szegmensen) az alacsonyabb késés érdekében. Lásd a pontozási statisztikákat Azure Cognitive Search. A pontozási statisztikákat a rendszer mindig helyileg számítja ki az intelligens keresést (~) használó kifejezésekhez.
keresés sztring Választható. A keresendő szöveg. Alapértelmezés szerint az összes kereshető mező keresésre kerül, kivéve, ha a keresőmezők meg vannak adva. Az indexben a kereshető mezőben lévő szöveg jogkivonatos, így több kifejezés is elválasztható szóközzel (például: "search=hello world"). Bármely kifejezéshez használjon * (ez logikai szűrőlekérdezések esetén lehet hasznos). A paraméter kihagyása ugyanazzal a hatással jár, mint a beállítás.* A keresési szintaxissal kapcsolatos részletekért tekintse meg az Egyszerű lekérdezési szintaxist .

Az eredmények néha meglepőek lehetnek a kereshető mezők lekérdezésekor. A tokenizer olyan logikát tartalmaz, amely az angol nyelvű szövegekben gyakran előforduló eseteket, például aposztrófokat, számok vesszőit stb. kezeli. A "search=123,456" kifejezés például egyetlen "123 456" kifejezéssel fog megegyezni a "123" és a "456" egyéni kifejezés helyett, mivel a vesszőket több ezer elválasztóként használják nagy számokhoz angol nyelven. Ezért azt javasoljuk, hogy írásjelek helyett használjon szóközt a kifejezések elválasztásához a keresési paraméterben.
searchMode sztring Választható. Az érvényes értékek az "any" vagy az "all" alapértelmezett értékeként "any". Itt adhatja meg, hogy a keresési kifejezések bármelyikét vagy mindegyikét egyezésnek kell-e tekinteni ahhoz, hogy a dokumentumot egyezésnek számítsa.
searchFields sztring Választható. A megadott szöveg kereséséhez használandó vesszővel tagolt mezőnevek listája. A célmezőket kereshetőként kell megjelölni az indexsémában.
$select sztring Választható. Az eredményhalmazba felvenni kívánt vesszővel tagolt mezők listája. Ebben a záradékban csak lekértként megjelölt mezők szerepelhetnek. Ha nincs megadva vagy be van állítva *, a sémában lekérdezhetőként megjelölt összes mező szerepel a leképezésben. Ha POST-tal hívja meg, a paraméter neve select lesz $select helyett.
semanticConfiguration (előzetes verzió) sztring Választható. Kötelező, ha queryType="szemantic". Annak a szemantikai konfigurációnak a neve, amely felsorolja, hogy mely mezőket kell használni a szemantikai rangsoroláshoz, a feliratokhoz, a kiemelésekhez és a válaszokhoz. További információ: Szemantikai lekérdezés létrehozása.
munkamenet-azonosító sztring Választható. A sessionId használatával javíthatja a több replikával rendelkező keresési szolgáltatások relevanciapont-konzisztenciáját. A többreplika-konfigurációkban az egyes dokumentumok relevanciapontszámai között kisebb különbségek lehetnek ugyanazon lekérdezés esetében. Amikor megadja a munkamenet-azonosítót, a szolgáltatás mindent megtesz annak érdekében, hogy egy adott kérést ugyanarra a replikára irányítson az adott munkamenethez. Legyen óvatos, ha ugyanazokat a munkamenet-azonosító értékeket ismételten használja fel, az megzavarhatja a kérések terheléselosztását a replikák között, és hátrányosan befolyásolhatja a keresési szolgáltatás teljesítményét. A sessionId azonosítóként használt érték nem kezdődhet _karakterrel. Ha egy szolgáltatás nem rendelkezik replikákkal, ez a paraméter nincs hatással a teljesítményre vagy a pontszám konzisztenciájára.
$skip egész szám Választható. A kihagyandó keresési eredmények száma. A POST használatával történő meghívásakor ezt a paramétert a rendszer kihagyásnak nevezi $skip helyett. Ez az érték nem lehet nagyobb 100 000-nél. Ha egymás után kell beolvasnia a dokumentumokat, de a korlátozás miatt nem tudja használni a $skip, fontolja meg a $orderby használatát egy olyan mezőn, amely egyedi értékekkel rendelkezik az index minden dokumentumához (például a dokumentumkulcshoz), és $filter tartomány lekérdezéssel.
speller (előzetes verzió) Sztring Választható. Az érvényes értékek a "none" és a "lexicon". Az alapértelmezett érték a "nincs". A visszahívás javítása az egyes keresési lekérdezési kifejezések helyesírás-javításával. Egyszerű, teljes és szemantikai lekérdezéstípusokon is használhatja. Ha használja, a helyesírás-ellenőrző paraméterhez queryLanguage szükséges. További információkért és példákért lásd: Helyesírás-ellenőrzés hozzáadása a lekérdezésekhez.
$top egész szám Választható. A lekérendő keresési eredmények száma. Ez az alapértelmezett érték 50. A POST használatával történő meghívásakor ez a paraméter a $top helyett a felső névvel lesz elnevezve. Ha 1000-nél nagyobb értéket ad meg, és több mint 1000 találatot ad meg, csak az első 1000 találat lesz visszaadva, valamint a következő találati lapra mutató hivatkozás (lásd az alábbi példában a "@odata.nextLink" elemet).

Azure Cognitive Search kiszolgálóoldali lapozással megakadályozza, hogy a lekérdezések egyszerre túl sok dokumentumot lekértek. Az alapértelmezett oldalméret 50, a maximális oldalméret pedig 1000. Ez azt jelenti, hogy a Dokumentumok keresése alapértelmezés szerint legfeljebb 50 találatot ad vissza, ha nem ad meg $top. Ha több mint 50 találat van, a válasz legfeljebb 50 találat következő oldalának lekérésére vonatkozó információkat tartalmaz (lásd az alábbi példákban a "@odata.nextLink" és a "@search.nextPageParameters" elemet. Hasonlóképpen, ha 1000-nél nagyobb értéket ad meg $top, és több mint 1000 találat van, csak az első 1000 találatot adja vissza, valamint a legfeljebb 1000 találat következő oldalának lekérésére vonatkozó információkat.

Reagálás

Állapotkód: Sikeres válasz esetén a rendszer 200 OK-t ad vissza. Ebben a cikkben két mintaválasz található, egyet a szemantikai kereséshez és a featuresMode-hoz.

Mintaválasz szemantikai lekérdezéshez

Az első példában a "hogyan alakulnak a felhők" szemantikai lekérdezés legfelső eredményére adott teljes válasz látható.

  • A "@search.answers" kifejezés akkor jelenik meg, amikor megadja az answers paramétert, és amikor a lekérdezés és a mögöttes searchFields elősegíti a válasz előállítását. A @search.answers kulcsot, szöveget és kiemeléseket tartalmazó tömb. A pontszám a válasz erősségét jelzi.

  • Az "érték" a válasz törzse. A @search.rerankerScore szemantikai rangsorolási algoritmus rendeli hozzá, és az eredmények rangsorolásához használatos (@search.score a BM25 hasonlósági algoritmusból származik, amely a kezdeti eredmények pontozásához használatos). A feliratok egyszerű szöveget és kiemelt verziókat tartalmaznak. Ez a példa OCR- és entitásfelismerési képességekkel lett létrehozva. A kinyert és egyesített tartalom mezői szerepelnek a válaszban.

{
    "@search.answers": [
        {
            "key": "aHR0cHM6Ly9oZWlkaXN0YmxvYnN0b3JhZ2UuYmxvYi5jb3JlLndpbmRvd3MubmV0L25hc2EtZWJvb2stMS01MC9wYWdlLTQ1LnBkZg2",
            "text": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form where air is ascending (over land in this case),   but not where it is descending (over the river).",
            "highlights": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form<em> where air is ascending</em> (over land in this case),   but not where it is<em> descending</em> (over the river).",
            "score": 0.94639826
        }
    ],
    "value": [
        {
            "@search.score": 0.5479723,
            "@search.rerankerScore": 1.0321671911515296,
            "@search.captions": [
                {
                    "text": "Like all clouds, it forms when the air reaches its dew point—the temperature at    which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley fog, which is common in the Pacific Northwest of North America.",
                    "highlights": "Like all<em> clouds</em>, it<em> forms</em> when the air reaches its dew point—the temperature at    which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley<em> fog</em>, which is common in the Pacific Northwest of North America."
                }
            ],
            "content": "\nA\nT\n\nM\nO\n\nS\nP\n\nH\nE\n\nR\nE\n\nE\nA\n\nR\nT\n\nH\n\n34\n\nValley Fog\nCanada\n\nFog is essentially a cloud lying on the ground. Like all clouds, it forms when the air reaches its dew point—the temperature at  \n\nwhich an air mass is cool enough for its water vapor to condense into liquid droplets.\n\nThis false-color image shows valley fog, which is common in the Pacific Northwest of North America. On clear winter nights, the \n\nground and overlying air cool off rapidly, especially at high elevations. Cold air is denser than warm air, and it sinks down into the \n\nvalleys. The moist air in the valleys gets chilled to its dew point, and fog forms. If undisturbed by winds, such fog may persist for \n\ndays. The Terra satellite captured this image of foggy valleys northeast of Vancouver in February 2010.\n\n\n",
            "metadata_storage_path": "aHR0cHM6Ly9oZWlkaXN0YmxvYnN0b3JhZ2UuYmxvYi5jb3JlLndpbmRvd3MubmV0L25hc2EtZWJvb2stMS01MC9wYWdlLTQxLnBkZg2",
            "people": [],
            "locations": [
                "Pacific Northwest",
                "North America",
                "Vancouver"
            ],
            "merged_content": "\nA\nT\n\nM\nO\n\nS\nP\n\nH\nE\n\nR\nE\n\nE\nA\n\nR\nT\n\nH\n\n34\n\nValley Fog\nCanada\n\nFog is essentially a cloud lying on the ground. Like all clouds, it forms when the air reaches its dew point—the temperature at  \n\nwhich an air mass is cool enough for its water vapor to condense into liquid droplets.\n\nThis false-color image shows valley fog, which is common in the Pacific Northwest of North America. On clear winter nights, the \n\nground and overlying air cool off rapidly, especially at high elevations. Cold air is denser than warm air, and it sinks down into the \n\nvalleys. The moist air in the valleys gets chilled to its dew point, and fog forms. If undisturbed by winds, such fog may persist for \n\ndays. The Terra satellite captured this image of foggy valleys northeast of Vancouver in February 2010.\n\n\n",
            "text": [],
            "layoutText": []
        }

A featuresMode mintaválasza

Ez a példa egy featuresMode értéket tartalmazó lekérdezés "@search.features" kimenetét mutatja be.

  {
    "@odata.count": # (if $count=true was provided in the query),
    "@search.coverage": # (if minimumCoverage was provided in the query),
    "@search.facets": { (if faceting was specified in the query)
      "facet_field": [
        {
          "value": facet_entry_value (for non-range facets),
          "from": facet_entry_value (for range facets),
          "to": facet_entry_value (for range facets),
          "count": number_of_documents
        }
      ],
      ...
    },
    "@search.nextPageParameters": { (request body to fetch the next page of results if not all results could be returned in this response and Search was called with POST)
      "count": ... (value from request body if present),
      "facets": ... (value from request body if present),
      "featuresMode" : ... (value from request body if present),
      "filter": ... (value from request body if present),
      "highlight": ... (value from request body if present),
      "highlightPreTag": ... (value from request body if present),
      "highlightPostTag": ... (value from request body if present),
      "minimumCoverage": ... (value from request body if present),
      "orderby": ... (value from request body if present),
      "scoringParameters": ... (value from request body if present),
      "scoringProfile": ... (value from request body if present),
      "scoringStatistics": ... (value from request body if present),
      "search": ... (value from request body if present),
      "searchFields": ... (value from request body if present),
      "searchMode": ... (value from request body if present),
      "select": ... (value from request body if present),
      "sessionId" : ... (value from request body if present),
      "skip": ... (page size plus value from request body if present),
      "top": ... (value from request body if present minus page size),
    },
    "value": [
      {
        "@search.score": document_score (if a text query was provided),
        "@search.highlights": {
          field_name: [ subset of text, ... ],
          ...
        },
        "@search.features": {
          "field_name": {
            "uniqueTokenMatches": feature_score,
            "similarityScore": feature_score,
            "termFrequency": feature_score,
          },
          ...
        },
        key_field_name: document_key,
        field_name: field_value (retrievable fields or specified projection),
        ...
      },
      ...
    ],
    "@odata.nextLink": (URL to fetch the next page of results if not all results could be returned in this response; Applies to both GET and POST)
  }

Példák

További példákat az OData kifejezésszintaxisában talál Azure Cognitive Search.

Példa: egyszerű keresés

Dokumentumok keresése az indexben egyszerű lekérdezési szintaxissal. Ez a lekérdezés olyan szállodákat ad vissza, ahol a kereshető mezők a "comfort" és a "location" kifejezést tartalmazzák, de a "motel" szót nem:

Get /indexes/hotels/docs?search=comfort +location –motel&searchMode=all&api-version=2021-04-30-Preview
POST /indexes/hotels/docs/search?api-version=2021-04-30-Preview
    {  
      "search": "comfort +location -motel",  
      "searchMode": "all"  
    }  

Tipp

A felülbírálások használata searchMode=all az alapértelmezett searchMode=anyértéket jelenti, ami azt jelenti, hogy -motel "ÉS NEM" a "VAGY NEM" helyett. E nélkül searchMode=alla "VAGY NEM" kifejezés jelenik meg, amely nem korlátozza, hanem kibővíti a keresési eredményeket, és ez egyes felhasználók számára nem magától értetődő lehet.

Példa: teljes Lucene-keresés

Dokumentumok keresése az indexben Lucene lekérdezési szintaxissal (lásd a Lucene lekérdezési szintaxist Azure Cognitive Search). Ez a lekérdezés olyan szállodákat ad vissza, ahol a kategóriamező tartalmazza a "költségvetés" kifejezést és az összes kereshető mezőt, amely a "nemrégiben felújított" kifejezést tartalmazza. A "nemrégiben felújított" kifejezést tartalmazó dokumentumokat a "kiemelési érték" kifejezés magasabbra sorolja (3)

GET /indexes/hotels/docs?search=Category:budget AND \"recently renovated\"^3&searchMode=all&api-version=2021-04-30-Preview&querytype=full`
POST /indexes/hotels/docs/search?api-version=2021-04-30-Preview
    {  
      "search": "Category:budget AND \"recently renovated\"^3",  
      "queryType": "full",  
      "searchMode": "all"  
}  

Példa: szemantikai keresés

Hívja meg a szemantikai rangsorolási modellt válaszokkal, feliratokkal és kiemelt tartalommal. A lekérdezésre adott válasz az előző szakaszban található.

POST /indexes/hotels/docs/search?api-version=2021-04-30-Preview
{
  "search": "how do clouds form",
  "queryType": "semantic",
  "semanticConfiguration": "my-semantic-config",
  "queryLanguage": "en-us",
  "answers": "extractive",
  "captions": "extractive",
  "count": "true"
}

Példa: orderby

Keressen az indexben, és adja vissza az eredményeket dátum szerint csökkenő sorrendben.

GET /indexes/hotels/docs?search=*&$orderby=LastRenovationDate desc&api-version=2021-04-30-Preview
POST /indexes/hotels/docs/search?api-version=2021-04-30-Preview
    {  
      "search": "*",  
      "orderby": "LastRenovationDate desc"
    }  

Példa: szűrés OData-kifejezés használatával

Egy adott szűrőkifejezésnek megfelelő dokumentumok lekérése:

GET /indexes/hotels/docs?$filter=(Rooms/BaseRate ge 60 and Rooms/BaseRate lt 300) or HotelName eq 'Fancy Stay'&api-version=2021-04-30-Preview
POST /indexes/hotels/docs/search?api-version=2021-04-30-Preview
    {  
      "filter": "(Rooms/BaseRate ge 60 and Rooms/BaseRate lt 300) or HotelName eq 'Fancy Stay'"  
    }  

Példa: jellemzőalapú keresés

A jellemzőalapú keresésben keressen rá az indexre, és lekérje a kategóriák, minősítések, címkék, valamint adott tartományokban a baseRate értéket tartalmazó elemek aspektusait.

GET /indexes/hotels/docs?search=*&facet=Category&facet=Rating&facet=Tags&facet=Rooms/BaseRate,values:80|150|220&api-version=2021-04-30-Preview
POST /indexes/hotels/docs/search?api-version=2021-04-30-Preview
    {  
      "search": "test",  
      "facets": [ "Category", "Rating", "Tags", "Rooms/BaseRate,values:80|150|220" ]  
    }  

Figyelje meg, hogy az utolsó szempont egy almezőben van. A aspektusok megszámolják a szülődokumentumot (Szállodák) és nem a köztes aldokumentumokat (Szobák), így a válasz meghatározza az egyes árgyűjtőkben található szobák számát.

Példa: Jellemzővel rendelkező lekérdezés szűkítése

Szűrő használatával szűkítse le az előző jellemzős lekérdezési eredményt, miután a felhasználó a 3. minősítést és a "Motel" kategóriát választja.

GET /indexes/hotels/docs?search=*&facet=tags&facet=Rooms/BaseRate,values:80|150|220&$filter=Rating eq 3 and Category eq 'Motel'&api-version=2021-04-30-Preview  
POST /indexes/hotels/docs/search?api-version=2021-04-30-Preview 
    {  
      "search": "test",  
      "facets": [ "tags", "Rooms/BaseRate,values:80|150|220" ],  
      "filter": "Rating eq 3 and Category eq 'Motel'"  
    }  

Példa: jellemzőalapú keresés az egyes kategóriákra vonatkozó korlátozásokkal

A jellemzőalapú keresésben állítsa be a lekérdezésben visszaadott egyedi kifejezések felső korlátját. Az alapértelmezett érték 10, de ezt az értéket növelheti vagy csökkentheti a facet attribútum count paraméterével. Ez a példa a város aspektusait adja vissza, legfeljebb 5-öt.

GET /indexes/hotels/docs?search=*&facet=Address/City,count:5&api-version=2021-04-30-Preview
POST /indexes/hotels/docs/search?api-version=2021-04-30-Preview
    {  
      "search": "test",  
      "facets": [ "Address/City,count:5" ]  
    }  

Példa: helyszíni keresés

Keresés az indexben adott mezőkben (például egy nyelvmezőben)

GET /indexes/hotels/docs?search=hôtel&searchFields=Description_fr&api-version=2021-04-30-Preview
POST /indexes/hotels/docs/search?api-version=2021-04-30-Preview
    {  
      "search": "hôtel",  
      "searchFields": "Description_fr"
    }  

Keresés az indexben több mező között. A kereshető mezőket például több nyelven is tárolhatja és kérdezheti le, ugyanabban az indexben. Ha az angol és francia nyelvű leírások ugyanazon dokumentumon belül is megtalálhatóak, a lekérdezés eredményében bármelyiket vagy az összeset visszaadhatja:

GET /indexes/hotels/docs?search=hotel&searchFields=Description,Description_fr&api-version=2021-04-30-Preview
POST /indexes/hotels/docs/search?api-version=2021-04-30-Preview
    {  
      "search": "hotel",  
      "searchFields": "Description, Description_fr"
    }  

Egyszerre csak egy indexet kérdezhet le. Ne hozzon létre több indexet az egyes nyelvekhez, kivéve, ha egyenként szeretne lekérdezést végezni.

Példa: eredmények lapozása

Az elemek első oldalának lekérése (az oldalméret 10):

GET /indexes/hotels/docs?search=*&$skip=0&$top=10&api-version=2021-04-30-Preview
POST /indexes/hotels/docs/search?api-version=2021-04-30-Preview
    {  
      "search": "*",  
      "skip": 0,  
      "top": 10  
    }  

Az elemek második oldalának lekérése (az oldalméret 10):

GET /indexes/hotels/docs?search=*&$skip=10&$top=10&api-version=2021-04-30-Preview
POST /indexes/hotels/docs/search?api-version=2021-04-30-Preview
    {  
      "search": "*",  
      "skip": 10,  
      "top": 10  
    }  

Példa: mezők korlátozása egy eredményhalmazban

Adott mezőkészlet lekérése:

GET /indexes/hotels/docs?search=*&$select=HotelName,Description&api-version=2021-04-30-Preview
POST /indexes/hotels/docs/search?api-version=2021-04-30-Preview
    {  
      "search": "*",  
      "select": "HotelName, Description"
    }  

Példa: találatok kiemelése az eredményekben

Keressen az indexben, és adja vissza a találatok kiemelésével rendelkező töredékeket:

GET /indexes/hotels/docs?search=something&highlight=Description&api-version=2021-04-30-Preview
POST /indexes/hotels/docs/search?api-version=2021-04-30-Preview
    {  
      "search": "something",  
      "highlight": "Description"  
    }  

Példa: Térinformatikai keresés

Keressen rá az indexben, és adja vissza a dokumentumokat a hivatkozási helytől közelebbről távolabbra rendezve:

GET /indexes/hotels/docs?search=something&$orderby=geo.distance(Location, geography'POINT(-122.12315 47.88121)')&api-version=2021-04-30-Preview
POST /indexes/hotels/docs/search?api-version=2021-04-30-Preview
    {  
      "search": "something",  
      "orderby": "geo.distance(Location, geography'POINT(-122.12315 47.88121)')"
    }  

Példa: "find by me" (a közeli helyek relevanciájának növelése)

Keressen az indexben, feltéve, hogy van egy "geo" nevű pontozási profil két távolsági pontozási függvénysel, az egyik a "currentLocation" paramétert definiálja, a másik pedig a "lastLocation" paramétert definiálja:

GET /indexes/hotels/docs?search=something&scoringProfile=geo&scoringParameter=currentLocation--122.123,44.77233&scoringParameter=lastLocation--121.499,44.2113&api-version=2021-04-30-Preview
POST /indexes/hotels/docs/search?api-version=2021-04-30-Preview
    {  
      "search": "something",  
      "scoringProfile": "geo",  
      "scoringParameters": [ "currentLocation--122.123,44.77233", "lastLocation--121.499,44.2113" ]  
    }  

Példa: teljes index lekérdezése szegmensek helyett

Dokumentumokat kereshet az indexben, miközben az alacsonyabb késéshez való konzisztens pontozást részesíti előnyben. Ez a lekérdezés kiszámítja a dokumentum gyakoriságát a teljes indexben, és mindent megtesz annak érdekében, hogy ugyanazt a replikát célozza meg az ugyanazon a "munkameneten" belüli összes lekérdezéshez, ami elősegíti a stabil és reprodukálható rangsorolást.

GET /indexes/hotels/docs?search=hotel&sessionId=mySessionId&scoringStatistics=global&api-version=2021-04-30-Preview
POST /indexes/hotels/docs/search?api-version=2021-04-30-Preview
    {  
      "search": "hotel",  
      "sessionId": "mySessionId",
      "scoringStatistics" :"global"
    }  

Példa: pontozási statisztika (featuresMode)

Keresse meg a dokumentumokat az indexben, és adja vissza az egyes eredmények információlekérési funkcióinak listáját, amely leírja az egyező dokumentum és a lekérdezés közötti pontozást. A lekérdezés a dokumentum gyakoriságát is kiszámítja a teljes indexben, így egységesebb pontozást eredményez.

GET /indexes/hotels/docs?search=hotel&featuresMode=enabled&scoringStatistics=global&api-version=2021-04-30-Preview
POST /indexes/hotels/docs/search?api-version=2021-04-30-Preview
    {  
      "search": "hotel",  
      "featuresMode": "enabled",
      "scoringStatistics" :"global"
    }  

Példa egy válaszra, amely az search.features alábbihoz hasonlóan néz ki:

    "@search.score": 0.91875637,
    "@search.features": {
        "Description": {
            "uniqueTokenMatches": 1,
            "similarityScore": 0.2917966,
            "termFrequency": 2
        },
        "HotelName": {
            "uniqueTokenMatches": 1,
            "similarityScore": 0.44458693,
            "termFrequency": 1
        }
      . . .

Definíciók

Ez a szakasz azokat a paramétereket ismerteti, amelyek túl összetettek ahhoz, hogy a főtáblában szerepeljenek.

Hivatkozás Description
queryLanguage A helyesírás- és szemantikai keresés támogatott nyelveinek listája.

queryLanguage

A queryLanguage paraméter érvényes értékei a következő táblázatban, a "queryLanguage" oszlopban találhatók, és nem különböztetik meg a kis- és nagybetűket. A paraméter egészének alapértelmezett értéke az "en-us". Minden nyelvhez tartozik egy alapértelmezett változat minden két karakterből álló nyelvi kódhoz. Ha például az "es" értéket adja meg, akkor a rendszer alapértelmezés szerint az "es-us" értéket használja. A queryLanguage paraméter a "queryType=szemantic" vagy a "speller=lexicon" kifejezést tartalmazó lekérdezési kérelemhez szükséges. A teljes kérelemhez csak egy queryLanguage érték tartozik, és ez az érték lesz használva a szemantikai rangsoroláshoz, a feliratokhoz, a válaszokhoz és a helyesírás-ellenőrzőhöz (az egyes funkciók esetében nincs felülbírálás).

Jelenleg a nyelvi támogatás funkciónként változik. A funkciók teljes készlete csak az angol, a spanyol, a francia és a német nyelvet támogatja, de figyelje meg, hogy a helyesírás-ellenőrzés kevesebb változatot valósít meg.

Ha olyan nyelvi kódot ad meg, amelyet egy adott funkció nem támogat( például EN-GB helyesírás-ellenőrzővel), a szolgáltatás HTTP 400-as hibát ad vissza.

További információ az egyes funkciók használatáról: Szemantikai rangsorolás és feliratok engedélyezése, szemantikai válasz visszaadása és helyesírás-ellenőrzés hozzáadása a lekérdezésekhez.

Az "(előzetes verzió)" megjelölés azt jelzi, hogy az ellenőrzési tesztelés minden funkcióban (szemantikai rangsorolás, feliratok, válaszok és helyesírás-ellenőrzés) folyamatban van vagy függőben van. Javasoljuk, hogy az alábbi táblázatban szereplő összes nyelvi változatot használja, de javasoljuk az előnézeti nyelvek további tesztelését, hogy az eredmények érvényesek legyenek a tartalomra. A zöld pipával és előzetes verziójú megjelöléssel nem rendelkező nyelvek egyenértékű adatkészletek használatával lettek ellenőrizve, és a relevancia mérhetően megnőtt.

Nyelv queryLanguage Szemantikai rangsoroló és feliratok Szemantikai válasz Helyesírás
Angol [hu] en, en-US (alapértelmezett), en-GB, en-IN, en-CA, en-AU ✔️ ✔️ ✔️ (en, en-US)
Francia [fr] fr, fr-FR (alapértelmezett), fr-CA ✔️ ✔️ ✔️ (fr, fr-FR)
Német [de] de, de-DE (alapértelmezett) ✔️ ✔️ ✔️ (de, de-DE)
Spanyol [es] es, es-ES (alapértelmezett), es-MX ✔️ ✔️ ✔️ (es, es-ES)
Olasz [it] it, it-IT (alapértelmezett) ✔️ ✔️
Japán [ja] ja, ja-JP (alapértelmezett) ✔️ ✔️ (előzetes verzió)
Kínai [zh] zh, zh-CN (alapértelmezett), zh-TW ✔️ ✔️ (előzetes verzió)
Portugál [pt] pt, pt-BR (alapértelmezett), pt-PT ✔️ ✔️ (előzetes verzió)
Holland [nl] nl, nl-BE, nl-NL (alapértelmezett) ✔️ (előzetes verzió) ✔️ (előzetes verzió) ✔️ (nl, nl-NL)
Arab [ar] ar, ar-SA (alapértelmezett), ar-EG, ar-MA. ar-KW, ar-JO ✔️ (előzetes verzió) ✔️ (előzetes verzió)
Örmény hy-AM (alapértelmezett) ✔️ (előzetes verzió) ✔️ (előzetes verzió)
Bangla bn-IN (alapértelmezett) ✔️ (előzetes verzió) ✔️ (előzetes verzió)
Baszk eu-ES (alapértelmezett) ✔️ (előzetes verzió) ✔️ (előzetes verzió)
Bolgár [bg] bg, bg-BG (alapértelmezett) ✔️ (előzetes verzió) ✔️ (előzetes verzió)
Katalán [ca] ca, ca-ES (alapértelmezett) ✔️ (előzetes verzió) ✔️ (előzetes verzió)
Horvát [hr] hr, hr-HR (alapértelmezett), hr-BA ✔️ (előzetes verzió) ✔️ (előzetes verzió)
Cseh [cs] cs, cs-CZ (alapértelmezett) ✔️ (előzetes verzió) ✔️ (előzetes verzió)
Dán [da] da, da-DK (alapértelmezett) ✔️ (előzetes verzió) ✔️ (előzetes verzió)
Észt [et] et, et-EE (alapértelmezett) ✔️ (előzetes verzió) ✔️ (előzetes verzió)
Finn [fi] fi, fi-FI (alapértelmezett) ✔️ (előzetes verzió) ✔️ (előzetes verzió)
Gallego gl-ES (alapértelmezett) ✔️ (előzetes verzió) ✔️ (előzetes verzió)
Görög [el] el, el-GR (alapértelmezett) ✔️ (előzetes verzió) ✔️ (előzetes verzió)
Gudzsaráti gu-IN (alapértelmezett) ✔️ (előzetes verzió) ✔️ (előzetes verzió)
héber he-IL (alapértelmezett) ✔️ (előzetes verzió) ✔️ (előzetes verzió)
Hindi [szia] hi, hi-IN (alapértelmezett) ✔️ (előzetes verzió) ✔️ (előzetes verzió)
Magyar [hu] hu, hu-HU (alapértelmezett) ✔️ (előzetes verzió) ✔️ (előzetes verzió)
Izlandi [is] is, is-IS (alapértelmezett) ✔️ (előzetes verzió) ✔️ (előzetes verzió)
Indonéz [id] id, id-ID (alapértelmezett) ✔️ (előzetes verzió) ✔️ (előzetes verzió)
Ír ga-IE (alapértelmezett) ✔️ (előzetes verzió) ✔️ (előzetes verzió)
Kannada kn-IN (alapértelmezett) ✔️ (előzetes verzió) ✔️ (előzetes verzió)
Koreai [ko] ko, ko-KR (alapértelmezett) ✔️ (előzetes verzió) ✔️ (előzetes verzió)
Lett [lv] lv, lv-LV (alapértelmezett) ✔️ (előzetes verzió) ✔️ (előzetes verzió)
Litván [lt] lt, lt-LT (alapértelmezett) ✔️ (előzetes verzió) ✔️ (előzetes verzió)
Malajálam ml-IN (alapértelmezett) ✔️ (előzetes verzió) ✔️ (előzetes verzió)
Malajziai [ms] ms, ms-MY (alapértelmezett), ms-BN ✔️ (előzetes verzió) ✔️ (előzetes verzió)
Marathi mr-IN (alapértelmezett) ✔️ (előzetes verzió) ✔️ (előzetes verzió)
Norvég [nem] no, no-NO (alapértelmezett), nb-NO ✔️ (előzetes verzió) ✔️ (előzetes verzió)
Perzsa fa-AE (alapértelmezett) ✔️ (előzetes verzió) ✔️ (előzetes verzió)
Lengyel [pl] pl, pl-PL (alapértelmezett) ✔️ (előzetes verzió) ✔️ (előzetes verzió)
Pandzsábi pa-IN (alapértelmezett) ✔️ (előzetes verzió) ✔️ (előzetes verzió)
Román [ro] ro, ro-RO (alapértelmezett) ✔️ (előzetes verzió) ✔️ (előzetes verzió)
Orosz [ru] ru, ru-RU (alapértelmezett) ✔️ (előzetes verzió) ✔️ (előzetes verzió)
Szerb [sr] (cirill betűs vagy latin betűs) sr, sr-BA (alapértelmezett), sr-ME, sr-RS ✔️ (előzetes verzió) ✔️ (előzetes verzió)
Szlovák [sk] sk, sk-SK (alapértelmezett) ✔️ (előzetes verzió) ✔️ (előzetes verzió)
Szlovén [sl] sl, sl-SL (alapértelmezett) ✔️ (előzetes verzió) ✔️ (előzetes verzió)
Tamil [ta] ta, ta-IN (alapértelmezett) ✔️ (előzetes verzió) ✔️ (előzetes verzió)
Svéd [sv] sv, sv-SE (alapértelmezett) ✔️ (előzetes verzió) ✔️ (előzetes verzió)
Telugu te-IN (alapértelmezett) ✔️ (előzetes verzió) ✔️ (előzetes verzió)
Thai [th] th, th-TH (alapértelmezett) ✔️ (előzetes verzió) ✔️ (előzetes verzió)
Török [tr] tr, tr-TR (alapértelmezett) ✔️ (előzetes verzió) ✔️ (előzetes verzió)
Ukrán [uk] uk, uk-UA (alapértelmezett) ✔️ (előzetes verzió) ✔️ (előzetes verzió)
urdu saját PK (alapértelmezett) ✔️ (előzetes verzió) ✔️ (előzetes verzió)
Vietnami [va] va, vi-VN (alapértelmezett) ✔️ (előzetes verzió) ✔️ (előzetes verzió)

Lásd még