Documents - Search Post
Dokumentumokat keres az indexben.
POST {endpoint}/indexes('{indexName}')/docs/search.post.search?api-version=2024-03-01-Preview
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. |
index
|
path | True |
string |
Az index neve. |
api-version
|
query | True |
string |
Client API-verzió. |
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 | Típus | Description |
---|---|---|
answers |
Egy érték, amely meghatározza, hogy a válaszok a keresési válasz részeként legyenek-e visszaadva. |
|
captions |
Egy érték, amely meghatározza, hogy a keresési válasz részeként vissza kell-e adni a feliratokat. |
|
count |
boolean |
Egy érték, amely meghatározza, hogy lekérje-e az eredmények teljes számát. Az alapértelmezett érték a false (hamis). Ha ezt az értéket true (igaz) értékre állítja, az hatással lehet a teljesítményre. Vegye figyelembe, hogy a visszaadott darabszám közelítés. |
debug |
Lehetővé teszi a hibakereső eszközt, amely a reranked eredmények további vizsgálatához használható. |
|
facets |
string[] |
A keresési lekérdezésre alkalmazandó aspektuskifejezések listája. Minden aspektuskifejezés tartalmaz egy mezőnevet, amelyet opcionálisan a név:érték párok vesszővel tagolt listája követ. |
filter |
string |
A keresési lekérdezésre alkalmazandó OData $filter kifejezés. |
highlight |
string |
A találatok kiemeléséhez használandó mezőnevek vesszővel tagolt listája. A találatok kiemeléséhez csak kereshető mezők használhatók. |
highlightPostTag |
string |
A kiemelt találatokhoz hozzáfűzött sztringcímke. A highlightPreTag paraméterrel kell beállítani. Az alapértelmezett érték az </em>. |
highlightPreTag |
string |
Egy sztringcímke, amely a kiemelések eléréséhez van előtagként felfűzve. A highlightPostTag paraméterrel kell beállítani. Az alapértelmezett érték az <em>. |
minimumCoverage |
number |
Egy 0 és 100 közötti szám, amely azt jelzi, hogy a keresési lekérdezésnek hány százalékát kell lefednie az indexnek ahhoz, hogy a lekérdezés sikeresként legyen jelentve. Ez a paraméter akkor is hasznos lehet, ha csak egy replikával rendelkező szolgáltatások esetében is biztosítja a keresések rendelkezésre állását. Az alapértelmezett érték 100. |
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, amely növekvő, a desc pedig csökkenő értéket jelez. Az alapértelmezett érték a növekvő sorrend. A dokumentumok egyezési 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. |
queryLanguage |
A keresési lekérdezés nyelvét meghatározó érték. |
|
queryType |
A keresési lekérdezés szintaxisát meghatározó érték. Az alapértelmezett érték az "egyszerű". Használja a "full" (teljes) értéket, ha a lekérdezés a Lucene lekérdezési szintaxist használja. |
|
scoringParameters |
string[] |
A pontozófüggvényekben (például a referencePointParameterben) használandó paraméterértékek listája a név-értékek formátumával. Ha például a pontozási profil egy "mylocation" nevű paraméterrel definiál egy függvényt, a paraméter sztringje "mylocation--122.2,44.8" lesz (idézőjelek nélkül). |
scoringProfile |
string |
Egy pontozási profil neve, amely kiértékeli az egyező dokumentumok egyező pontszámait az eredmények rendezése érdekében. |
scoringStatistics |
Egy érték, amely meghatározza, hogy globálisan ki szeretnénk-e számítani a pontozási statisztikákat (például a dokumentum gyakoriságát) a konzisztensebb pontozáshoz, vagy helyileg az alacsonyabb késés érdekében. Az alapértelmezett érték a "local" (helyi). A "global" használatával globálisan összesítheti a pontozási statisztikákat a pontozás előtt. A globális pontozási statisztikák használata növelheti a keresési lekérdezések késését. |
|
search |
string |
Egy teljes szöveges keresési lekérdezési kifejezés; Használja a "*" paramétert, vagy hagyja ki ezt a paramétert az összes dokumentum egyeztetéséhez. |
searchFields |
string |
Azoknak a mezőneveknek a vesszővel tagolt listája, amelyekre a teljes szöveges keresés hatóköre kiterjed. Ha mezőalapú keresést (fieldName:searchExpression) használ egy teljes Lucene-lekérdezésben, az egyes mezőalapú keresési kifejezések mezőnevei elsőbbséget élveznek az ebben a paraméterben felsorolt mezőnevekkel szemben. |
searchMode |
Egy érték, amely meghatározza, hogy a keresési kifejezések bármelyikét vagy mindegyikét egyezésnek kell-e tekinteni a dokumentum egyezésként való megszámlálásához. |
|
select |
string |
A beolvasandó mezők vesszővel tagolt listája. Ha nincs meghatározva, a rendszer a sémában lekérdezhetőként megjelölt összes mezőt tartalmazza. |
semanticConfiguration |
string |
Egy szemantikai konfiguráció neve, amelyet a dokumentumok szemantikai típusú lekérdezések feldolgozásához használnak. |
semanticErrorHandling |
Lehetővé teszi, hogy a felhasználó eldöntse, hogy egy szemantikai hívás teljesen meghiúsuljon-e, vagy részleges eredményeket adjon vissza (alapértelmezett). |
|
semanticFields |
string |
A szemantikai rangsoroláshoz használt mezőnevek vesszővel tagolt listája. |
semanticMaxWaitInMilliseconds |
integer |
Lehetővé teszi a felhasználó számára, hogy felső határt állítson be arra az időre, amellyel a szemantikai bővítés befejeződik, mielőtt a kérés meghiúsul. |
semanticQuery |
string |
Lehetővé teszi egy külön keresési lekérdezés beállítását, amely kizárólag szemantikai rerankinghoz, szemantikai feliratokhoz és szemantikai válaszokhoz használható. Olyan helyzetekben hasznos, ahol az alaplekérési és rangsorolási fázis és az L2 szemantikai fázis között különböző lekérdezéseket kell használni. |
sessionId |
string |
A ragadós munkamenet létrehozásához használandó érték, amely segíthet a konzisztensebb eredmények eléréséhez. Ha ugyanazt a munkamenet-azonosítót használja, a rendszer minden tőle telhetőt megtesz, hogy ugyanazt a replikakészletet célozza meg. Legyen óvatos, ha ugyanazokat a sessionID-é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 sessionIdként használt érték nem kezdődhet _karakterrel. |
skip |
integer |
A kihagyandó keresési eredmények száma. 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 kihagyást, fontolja meg az orderby használatát egy teljesen rendezett kulcson, és szűrjön inkább egy tartomány-lekérdezéssel. |
speller |
Egy érték, amely az egyes keresési lekérdezések kifejezéseinek helyesírás-javításához használandó helyesírás-ellenőrző típusát adta meg. |
|
top |
integer |
A lekérendő keresési eredmények száma. Ez a $skip együtt használható a keresési eredmények ügyféloldali lapozásának megvalósításához. Ha a kiszolgálóoldali lapozás miatt csonkulnak az eredmények, a válasz tartalmaz egy folytatási jogkivonatot, amely egy másik Keresés kérés kiadására használható a következő találati lapra vonatkozóan. |
vectorFilterMode |
Meghatározza, hogy a szűrők alkalmazása a vektorkeresés előtt vagy után történjen-e. Az alapértelmezett érték a "preFilter". |
|
vectorQueries | VectorQuery[]: |
A vektoros és hibrid keresési lekérdezések lekérdezési paraméterei. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
A keresési feltételeknek megfelelő dokumentumokat tartalmazó válasz. |
|
Other Status Codes |
Hibaválasz. |
Példák
SearchIndexSearchDocumentsPost
Mintakérelem
POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2024-03-01-Preview
{
"count": true,
"facets": [
"category,count:10,sort:count"
],
"filter": "rating gt 4.0",
"highlight": "description",
"highlightPostTag": "</em>",
"highlightPreTag": "<em>",
"minimumCoverage": null,
"orderby": "rating desc",
"queryType": "simple",
"scoringParameters": [
"currentLocation--122.123,44.77233"
],
"scoringProfile": "sp",
"search": "nice hotels",
"searchFields": "category,description",
"searchMode": "any",
"sessionId": "mysessionid",
"scoringStatistics": "global",
"select": "hotelId,description",
"skip": 0,
"top": 10,
"vectorQueries": [
{
"kind": "vector",
"vector": [
0.103,
0.0712,
0.0852,
0.1547,
0.1183
],
"fields": "descriptionEmbedding",
"k": 5,
"exhaustive": true,
"oversampling": 20
}
],
"vectorFilterMode": "preFilter"
}
Mintaválasz
{
"@odata.count": 25,
"@search.facets": {
"category": [
{
"count": 1,
"value": "Economy"
},
{
"count": 1,
"value": "Luxury"
}
]
},
"@search.nextPageParameters": {
"count": true,
"facets": [
"category,count:10,sort:count"
],
"filter": "rating gt 4.0",
"highlight": "title",
"highlightPostTag": "</em>",
"highlightPreTag": "<em>",
"minimumCoverage": null,
"orderby": "search.score() desc,rating desc",
"queryType": "simple",
"sessionId": "mysessionid",
"scoringStatistics": "global",
"scoringParameters": [
"currentLocation--122.123,44.77233"
],
"scoringProfile": "sp",
"search": "nice hotels",
"searchFields": "title,description",
"searchMode": "any",
"select": "docId,title,description",
"skip": 2,
"top": 8
},
"value": [
{
"@search.score": 1.5,
"@search.highlights": {
"title": [
"<em>Nice</em> <em>Hotel</em>"
]
},
"description": "Cheapest hotel in town",
"docId": "1",
"title": "Nice Hotel"
},
{
"@search.score": 0.7,
"@search.highlights": {
"title": [
"Fancy <em>Hotel</em>"
]
},
"description": "Best hotel in town",
"docId": "2",
"title": "Fancy Hotel"
}
],
"@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2024-03-01-Preview"
}
Definíciók
Name | Description |
---|---|
Answer |
A válasz a lekérdezésnek leginkább megfelelő dokumentumok tartalmából kinyert szövegrészlet. A válaszok a leggyakoribb keresési eredményekből lesznek kinyerve. A válaszjelöltek pontozása és a legjobb válaszok kiválasztása. |
Caption |
A feliratok a dokumentum és a keresési lekérdezés közötti legreprezentesebb szakaszok. Ezeket gyakran használják dokumentum-összefoglalásként. A rendszer csak szemantikai típusú lekérdezések esetén ad vissza feliratokat. |
Document |
A keresési eredmények további vizsgálatához használható hibakeresési információkat tartalmaz. |
Error |
Az erőforrás-kezelési hiba további információi. |
Error |
A hiba részletei. |
Error |
Hibaválasz |
Query |
Egy érték, amely meghatározza, hogy a válaszok a keresési válasz részeként legyenek-e visszaadva. |
Query |
Egy érték, amely meghatározza, hogy a keresési válasz részeként vissza kell-e adni a feliratokat. |
Query |
Lehetővé teszi a keresési eredmények további vizsgálatához használható hibakereső eszközt. |
Query |
A lekérdezés nyelve. |
Query |
A szemantikai bővítési folyamatba küldött nyers összefűzött sztringek. |
Query |
A szemantikai bővítési folyamatnak küldött mezők leírása, valamint azok felhasználási módjának leírása |
Query |
Egy érték, amely az egyes keresési lekérdezések kifejezéseinek helyesírás-javításához használandó helyesírás-ellenőrző típusát adta meg. |
Query |
A keresési lekérdezés szintaxisát adja meg. Az alapértelmezett érték az "egyszerű". Használja a "full" (teljes) értéket, ha a lekérdezés a Lucene lekérdezési szintaxist és a "szemantikai" értéket használja, ha nincs szükség lekérdezési szintaxisra. |
Raw |
A vektorkereséshez használandó lekérdezési paraméterek nyers vektorérték megadásakor. |
Scoring |
Egy érték, amely meghatározza, hogy globálisan ki szeretnénk-e számítani a pontozási statisztikákat (például a dokumentum gyakoriságát) a konzisztensebb pontozáshoz, vagy helyileg az alacsonyabb késés érdekében. Az alapértelmezett érték a "local" (helyi). A "global" használatával globálisan összesítheti a pontozási statisztikákat a pontozás előtt. A globális pontozási statisztikák használata növelheti a keresési lekérdezések késését. |
Search |
Indexből származó keresési eredményeket tartalmazó válasz. |
Search |
Itt adhatja meg, hogy a keresési kifejezések bármelyikének vagy mindegyikének egyeznie kell-e ahhoz, hogy a dokumentumot egyezésnek számítsa. |
Search |
Szűrési, rendezési, arculati, lapozási és egyéb keresési lekérdezési viselkedések paraméterei. |
Search |
Egy keresési lekérdezés által talált dokumentumot és a kapcsolódó metaadatokat tartalmazza. |
Semantic |
|
Semantic |
Lehetővé teszi, hogy a felhasználó eldöntse, hogy egy szemantikai hívás teljesen meghiúsuljon-e, vagy részleges eredményeket adjon vissza (alapértelmezett). |
Semantic |
Annak oka, hogy a rendszer részleges választ adott vissza egy szemantikai rangsorolási kérelemre. |
Semantic |
A mező szemantikai bővítési folyamathoz való felhasználási módja (teljes mértékben, részben vagy nem használt) |
Semantic |
A szemantikai rangsorolási kéréshez visszaadott részleges válasz típusa. |
Vector |
Meghatározza, hogy a szűrők alkalmazása a vektorkeresés előtt vagy után történjen-e. |
Vectorizable |
A vektorkereséshez használandó lekérdezési paraméterek, ha meg van adva egy vektorizálandó szöveges érték. |
Vector |
A végrehajtott vektoros lekérdezés típusa. |
AnswerResult
A válasz a lekérdezésnek leginkább megfelelő dokumentumok tartalmából kinyert szövegrészlet. A válaszok a leggyakoribb keresési eredményekből lesznek kinyerve. A válaszjelöltek pontozása és a legjobb válaszok kiválasztása.
Name | Típus | Description |
---|---|---|
highlights |
string |
Ugyanaz a szövegrész, mint a Text tulajdonságban a lekérdezés szempontjából legrelevánsabb kiemelt szöveges kifejezésekkel. |
key |
string |
A dokumentum kulcsa, amelyből a választ kinyerték. |
score |
number |
A pontszám értéke azt jelzi, hogy mennyire releváns a válasz a lekérdezésre a lekérdezéshez visszaadott egyéb válaszokhoz képest. |
text |
string |
Válaszként a dokumentum tartalmából kinyert szövegrész. |
CaptionResult
A feliratok a dokumentum és a keresési lekérdezés közötti legreprezentesebb szakaszok. Ezeket gyakran használják dokumentum-összefoglalásként. A rendszer csak szemantikai típusú lekérdezések esetén ad vissza feliratokat.
Name | Típus | Description |
---|---|---|
highlights |
string |
Ugyanaz a szövegrész, mint a Text tulajdonságban a lekérdezés szempontjából legrelevánsabb kiemelt kifejezésekkel. |
text |
string |
A keresési lekérdezés szempontjából legrelevánsabb dokumentumból kinyert reprezentatív szövegrészlet. |
DocumentDebugInfo
A keresési eredmények további vizsgálatához használható hibakeresési információkat tartalmaz.
Name | Típus | Description |
---|---|---|
semantic |
A szemantikai rangsorolási kérelmekre vonatkozó hibakeresési információkat tartalmazza. |
ErrorAdditionalInfo
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 adattípus. |
ErrorDetail
A hiba részletei.
Name | Típus | Description |
---|---|---|
additionalInfo |
A hiba további információi. |
|
code |
string |
A hibakód. |
details |
A hiba részletei. |
|
message |
string |
A hibaüzenet. |
target |
string |
A hiba célja. |
ErrorResponse
Hibaválasz
Name | Típus | Description |
---|---|---|
error |
A hibaobjektum. |
QueryAnswerType
Egy érték, amely meghatározza, hogy a válaszok a keresési válasz részeként legyenek-e visszaadva.
Name | Típus | Description |
---|---|---|
extractive |
string |
Kinyeri a válaszjelölteket a természetes nyelvű kérdésként kifejezett lekérdezésre adott válaszként visszaadott dokumentumok tartalmából. |
none |
string |
Ne adjon vissza válaszokat a lekérdezéshez. |
QueryCaptionType
Egy érték, amely meghatározza, hogy a keresési válasz részeként vissza kell-e adni a feliratokat.
Name | Típus | Description |
---|---|---|
extractive |
string |
Feliratokat nyer ki az egyező dokumentumokból, amelyek a keresési lekérdezés szempontjából releváns részeket tartalmaznak. |
none |
string |
Ne adja vissza a lekérdezés feliratait. |
QueryDebugMode
Lehetővé teszi a keresési eredmények további vizsgálatához használható hibakereső eszközt.
Name | Típus | Description |
---|---|---|
disabled |
string |
A rendszer nem ad vissza lekérdezés-hibakeresési adatokat. |
semantic |
string |
Lehetővé teszi, hogy a felhasználó tovább vizsgálja a reranked eredményeket. |
QueryLanguage
A lekérdezés nyelve.
Name | Típus | Description |
---|---|---|
ar-eg |
string |
Az arab (Egyiptom) nyelv értékének lekérdezése. |
ar-jo |
string |
Az arab (Jordánia) nyelv értékének lekérdezése. |
ar-kw |
string |
Az arab (Kuvait) nyelv értékének lekérdezése. |
ar-ma |
string |
Az arab (Marokkó) nyelv értékének lekérdezése. |
ar-sa |
string |
Az arab (Szaúd-Arábia) nyelv értékének lekérdezése. |
bg-bg |
string |
A bolgár (Bulgária) nyelvi értékének lekérdezése. |
bn-in |
string |
A bengáli (India) nyelv értékének lekérdezése. |
ca-es |
string |
A katalán nyelv értékének lekérdezése. |
cs-cz |
string |
A cseh (Cseh Köztársaság) nyelvértékének lekérdezése. |
da-dk |
string |
A dán (Dánia) nyelvi értékének lekérdezése. |
de-de |
string |
A német (Németország) lekérdezési nyelvének értéke. |
el-gr |
string |
A görög (Görögország) nyelv értékének lekérdezése. |
en-au |
string |
Angol (Ausztrália) nyelvi értékének lekérdezése. |
en-ca |
string |
Angol (Kanada) nyelvi értékének lekérdezése. |
en-gb |
string |
Angol (Nagy-Britannia) nyelvi értékének lekérdezése. |
en-in |
string |
Angol (India) lekérdezési nyelvének értéke. |
en-us |
string |
Angol (Egyesült Államok) nyelvi értékének lekérdezése. |
es-es |
string |
A spanyol (Spanyolország) lekérdezési nyelvének értéke. |
es-mx |
string |
A spanyol (Mexikó) lekérdezési nyelvének értéke. |
et-ee |
string |
Az észt (Észtország) lekérdezési nyelvének értéke. |
eu-es |
string |
A baszk nyelv értékének lekérdezése. |
fa-ae |
string |
A perzsa nyelv (U.A.E.) lekérdezési nyelvének értéke. |
fi-fi |
string |
Finn (Finnország) nyelvi értékének lekérdezése. |
fr-ca |
string |
A francia (Kanada) nyelv értékének lekérdezése. |
fr-fr |
string |
Francia (Franciaország) nyelvi értékének lekérdezése. |
ga-ie |
string |
Az ír (Írország) nyelvi értékének lekérdezése. |
gl-es |
string |
A galíciai nyelv értékének lekérdezése. |
gu-in |
string |
A Gujarati (India) lekérdezési nyelvének értéke. |
he-il |
string |
A héber (Izrael) nyelv értékének lekérdezése. |
hi-in |
string |
A hindi (India) nyelvértékének lekérdezése. |
hr-ba |
string |
A horvát (Bosznia-Hercegovina) nyelvértékének lekérdezése. |
hr-hr |
string |
A horvát (Horvátország) nyelvi értékének lekérdezése. |
hu-hu |
string |
A magyar nyelv lekérdezési nyelvének értéke (Magyarország). |
hy-am |
string |
Örményország (Örményország) nyelvértékének lekérdezése. |
id-id |
string |
Indonéz (Indonézia) nyelvértékének lekérdezése. |
is-is |
string |
Izlandi (Izland) nyelvi értékének lekérdezése. |
it-it |
string |
Az olasz (Olaszország) lekérdezési nyelvének értéke. |
ja-jp |
string |
A japán (Japán) nyelvi értékének lekérdezése. |
kn-in |
string |
Kannada (India) nyelvértékének lekérdezése. |
ko-kr |
string |
Koreai (Korea) nyelvi értékének lekérdezése. |
lt-lt |
string |
A litván (Litvánia) nyelvi értékének lekérdezése. |
lv-lv |
string |
Lett (Lettország) lekérdezési nyelvének értéke. |
ml-in |
string |
A malajálam (India) nyelvi értékének lekérdezése. |
mr-in |
string |
Marathi (India) nyelvértékének lekérdezése. |
ms-bn |
string |
A maláj (Brunei Darussalam) lekérdezési nyelvének értéke. |
ms-my |
string |
A maláj (Malajzia) nyelvi értékének lekérdezése. |
nb-no |
string |
A norvég (Norvégia) nyelvi értékének lekérdezése. |
nl-be |
string |
A holland (Belgium) lekérdezési nyelvének értéke. |
nl-nl |
string |
A holland (Hollandia) nyelvi értékének lekérdezése. |
no-no |
string |
A norvég (Norvégia) nyelvi értékének lekérdezése. |
none |
string |
Nincs megadva lekérdezési nyelv. |
pa-in |
string |
Pandzsábi (India) nyelvértékének lekérdezése. |
pl-pl |
string |
Lengyel (Lengyelország) nyelvértékének lekérdezése. |
pt-br |
string |
Portugál (Brazília) nyelvi értékének lekérdezése. |
pt-pt |
string |
Portugál (Portugália) nyelvi értékének lekérdezése. |
ro-ro |
string |
A román (Románia) lekérdezési nyelvének értéke. |
ru-ru |
string |
Az orosz (Oroszország) nyelv értékének lekérdezése. |
sk-sk |
string |
A szlovák (Szlovákia) lekérdezési nyelvének értéke. |
sl-sl |
string |
A szlovén (Szlovénia) nyelvi értékének lekérdezése. |
sr-ba |
string |
Szerb (Bosznia-Hercegovina) lekérdezési nyelvének értéke. |
sr-me |
string |
Szerb (Montenegró) nyelvértékének lekérdezése. |
sr-rs |
string |
A szerb (Szerbia) nyelv értékének lekérdezése. |
sv-se |
string |
A svéd (Svédország) lekérdezési nyelvének értéke. |
ta-in |
string |
A Tamil (India) lekérdezési nyelvének értéke. |
te-in |
string |
A Telugu (India) lekérdezési nyelvének értéke. |
th-th |
string |
Thai (Thaiföld) nyelvi értékének lekérdezése. |
tr-tr |
string |
A török (Törökország) nyelvi értékének lekérdezése. |
uk-ua |
string |
Ukrán (Ukrajna) nyelvértékének lekérdezése. |
ur-pk |
string |
Az Urdu (Pakisztán) lekérdezési nyelvének értéke. |
vi-vn |
string |
A vietnami (Viet Nam) nyelv értékének lekérdezése. |
zh-cn |
string |
Kínai (Kína) nyelvértékének lekérdezése. |
zh-tw |
string |
A kínai (Tajvan) nyelv értékének lekérdezése. |
QueryResultDocumentRerankerInput
A szemantikai bővítési folyamatba küldött nyers összefűzött sztringek.
Name | Típus | Description |
---|---|---|
content |
string |
A szemantikai bővítéshez használt tartalommezők nyers összefűzött sztringjei. |
keywords |
string |
A szemantikai bővítéshez használt kulcsszómezők nyers összefűzött sztringjei. |
title |
string |
A szemantikai bővítéshez használt címmező nyers sztringje. |
QueryResultDocumentSemanticField
A szemantikai bővítési folyamatnak küldött mezők leírása, valamint azok felhasználási módjának leírása
Name | Típus | Description |
---|---|---|
name |
string |
A szemantikai bővítési folyamatnak küldött mező neve |
state |
A mező szemantikai bővítési folyamathoz való felhasználási módja (teljes mértékben, részben vagy nem használt) |
QuerySpellerType
Egy érték, amely az egyes keresési lekérdezések kifejezéseinek helyesírás-javításához használandó helyesírás-ellenőrző típusát adta meg.
Name | Típus | Description |
---|---|---|
lexicon |
string |
A Helyesírás-ellenőrző a queryLanguage paraméter által megadott nyelvhez tartozó statikus lexikon használatával javítja ki az egyes lekérdezési kifejezéseket. |
none |
string |
A helyesírás-ellenőrző nincs engedélyezve. |
QueryType
A keresési lekérdezés szintaxisát adja meg. Az alapértelmezett érték az "egyszerű". Használja a "full" (teljes) értéket, ha a lekérdezés a Lucene lekérdezési szintaxist és a "szemantikai" értéket használja, ha nincs szükség lekérdezési szintaxisra.
Name | Típus | Description |
---|---|---|
full |
string |
A teljes Lucene lekérdezési szintaxist használja a keresésekhez. Keresés szöveg értelmezése a Lucene lekérdezési nyelvvel történik, amely lehetővé teszi a mezőspecifikus és súlyozott kereséseket, valamint egyéb speciális funkciókat. |
semantic |
string |
A természetes nyelven kifejezett lekérdezésekhez ideális, nem pedig kulcsszavakhoz. A webes korpuszon betanított rangsorolási modell használatával javítja a keresési eredmények pontosságát a legjobb keresési eredmények ismételt rangsorolásával. |
simple |
string |
Az egyszerű lekérdezési szintaxist használja a keresésekhez. Keresés szöveget egy egyszerű lekérdezési nyelvvel értelmezi, amely lehetővé teszi az olyan szimbólumok használatát, mint a +, a * és a "". A lekérdezések kiértékelése alapértelmezés szerint az összes kereshető mezőben történik, kivéve, ha a searchFields paraméter meg van adva. |
RawVectorQuery
A vektorkereséshez használandó lekérdezési paraméterek nyers vektorérték megadásakor.
Name | Típus | Description |
---|---|---|
exhaustive |
boolean |
Ha igaz, a teljes k-legközelebbi szomszédkeresést aktiválja a vektorindex összes vektorában. Olyan helyzetekben hasznos, ahol a pontos egyezések kritikus fontosságúak, például az alapvető igazságértékek meghatározása. |
fields |
string |
A keresett vektorban szerepeltetni kívánt Gyűjtemény(Edm.Single) típusú vektormezők. |
k |
integer |
Azoknak a legközelebbi szomszédoknak a száma, aki a legnagyobb találatként tér vissza. |
kind |
string:
vector |
A végrehajtott vektoros lekérdezés típusa. |
oversampling |
number |
Túlbélyegzési tényező. A minimális érték 1. Felülbírálja az indexdefinícióban konfigurált defaultOversampling paramétert. Csak akkor állítható be, ha a "rerankWithOriginalVectors" igaz. Ez a paraméter csak akkor engedélyezett, ha a mögöttes vektormezőn tömörítési módszert használ. |
vector |
number[] |
Egy keresési lekérdezés vektoros ábrázolása. |
ScoringStatistics
Egy érték, amely meghatározza, hogy globálisan ki szeretnénk-e számítani a pontozási statisztikákat (például a dokumentum gyakoriságát) a konzisztensebb pontozáshoz, vagy helyileg az alacsonyabb késés érdekében. Az alapértelmezett érték a "local" (helyi). A "global" használatával globálisan összesítheti a pontozási statisztikákat a pontozás előtt. A globális pontozási statisztikák használata növelheti a keresési lekérdezések késését.
Name | Típus | Description |
---|---|---|
global |
string |
A rendszer globálisan kiszámítja a pontozási statisztikákat a következetesebb pontozás érdekében. |
local |
string |
A pontozási statisztikák helyileg lesznek kiszámítva az alacsonyabb késés érdekében. |
SearchDocumentsResult
Indexből származó keresési eredményeket tartalmazó válasz.
Name | Típus | Description |
---|---|---|
@odata.count |
integer |
A keresési művelet által talált találatok teljes száma, vagy null érték, ha a szám nem lett kérve. Ha jelen van, a szám nagyobb lehet, mint a válaszban szereplő eredmények száma. Ez akkor fordulhat elő, ha a $top vagy $skip paramétereket használja, vagy ha a lekérdezés nem tudja egyetlen válaszban visszaadni az összes kért dokumentumot. |
@odata.nextLink |
string |
A folytatási URL-cím akkor lesz visszaadva, ha a lekérdezés nem tudja egyetlen válaszban visszaadni az összes kért eredményt. Ezzel az URL-címmel létrehozhat egy másik GET vagy POST Keresés kérést a keresési válasz következő részének lekéréséhez. Győződjön meg arról, hogy ugyanazt az igét (GET vagy POST) használja, mint a választ generáló kérés. |
@search.answers |
A válaszok lekérdezési eredményei a keresési művelethez; null értékű, ha a válaszok lekérdezési paramétere nincs megadva, vagy "nincs" értékre van állítva. |
|
@search.coverage |
number |
A lekérdezésben szereplő index százalékos arányát jelző érték, vagy null érték, ha a kérelemben nem volt megadva a minimális hozzáférés. |
@search.facets |
object |
A keresési művelet részletes lekérdezési eredménye, amely gyűjtők gyűjteményeként van rendezve az egyes aspektusmezőkhöz; null értékű, ha a lekérdezés nem tartalmazott aspektuskifejezéseket. |
@search.nextPageParameters |
A folytatási JSON hasznos adat akkor ad vissza, ha a lekérdezés nem tudja egyetlen válaszban visszaadni az összes kért eredményt. Ezzel a JSON-val @odata.nextLink együtt létrehozhat egy másik POST Keresés kérést a keresési válasz következő részének lekéréséhez. |
|
@search.semanticPartialResponseReason |
Annak oka, hogy a rendszer részleges választ adott vissza egy szemantikai rangsorolási kérelemre. |
|
@search.semanticPartialResponseType |
A szemantikai rangsorolási kéréshez visszaadott részleges válasz típusa. |
|
value |
A lekérdezés által visszaadott eredmények sorozata. |
SearchMode
Itt adhatja meg, hogy a keresési kifejezések bármelyikének vagy mindegyikének egyeznie kell-e ahhoz, hogy a dokumentumot egyezésnek számítsa.
Name | Típus | Description |
---|---|---|
all |
string |
A dokumentum egyezésként való megszámlálásához az összes keresési kifejezést meg kell egyeznie. |
any |
string |
A dokumentum egyezésként való megszámlálásához a keresési kifejezéseket össze kell egyeztetni. |
SearchRequest
Szűrési, rendezési, arculati, lapozási és egyéb keresési lekérdezési viselkedések paraméterei.
Name | Típus | Description |
---|---|---|
answers |
Egy érték, amely meghatározza, hogy a válaszokat a keresési válasz részeként kell-e visszaadni. |
|
captions |
Egy érték, amely meghatározza, hogy a keresési válasz részeként vissza kell-e adni a feliratokat. |
|
count |
boolean |
Egy érték, amely megadja, hogy lekérje-e az eredmények teljes számát. Az alapértelmezett érték a false (hamis). Ha ezt az értéket igaz értékre állítja, az hatással lehet a teljesítményre. Vegye figyelembe, hogy a visszaadott szám közelítés. |
debug |
Lehetővé teszi a hibakeresési eszközt, amely a reranked eredmények további feltárására használható. |
|
facets |
string[] |
A keresési lekérdezésre alkalmazandó aspektuskifejezések listája. Minden aspektuskifejezés tartalmaz egy mezőnevet, amelyet igény szerint a név:érték párok vesszővel tagolt listája követ. |
filter |
string |
Az OData $filter kifejezés, amely a keresési lekérdezésre alkalmazandó. |
highlight |
string |
A találatok kiemeléséhez használandó mezőnevek vesszővel tagolt listája. Csak kereshető mezők használhatók a találatok kiemeléséhez. |
highlightPostTag |
string |
A kiemelt találatokhoz hozzáfűzött sztringcímke. A highlightPreTag értéket kell megadni. Az alapértelmezett érték a </em>. |
highlightPreTag |
string |
Egy sztringcímke, amely elő van állítva a kiemelések eléréséhez. A highlightPostTag értéket kell megadni. Az alapértelmezett érték az <em>. |
minimumCoverage |
number |
Egy 0 és 100 közötti szám, amely az index azon százalékát jelzi, amelyet egy keresési lekérdezésnek le kell fednie 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ések rendelkezésre állását. Az alapértelmezett érték 100. |
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ő értéket, a desc pedig csökkenő értéket jelez. Az alapértelmezett érték a növekvő sorrend. A kapcsolatokat a dokumentumok egyező pontszámai fogják megszakítani. 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. |
queryLanguage |
A keresési lekérdezés nyelvét meghatározó érték. |
|
queryType |
A keresési lekérdezés szintaxisát meghatározó érték. Az alapértelmezett érték az "egyszerű". Használja a "full" értéket, ha a lekérdezés a Lucene lekérdezési szintaxist használja. |
|
scoringParameters |
string[] |
A pontozási függvényekben (például referenciaPointParameter) használandó paraméterértékek listája a formátumnév-értékek használatával. Ha például a pontozási profil egy "mylocation" paraméterrel rendelkező függvényt határoz meg, a paramétersztring "mylocation--122.2,44.8" (idézőjelek nélkül). |
scoringProfile |
string |
Egy pontozási profil neve, amely kiértékeli az egyező dokumentumok egyező pontszámait az eredmények rendezése érdekében. |
scoringStatistics |
Egy érték, amely meghatározza, hogy globálisan ki szeretnénk-e számítani a pontozási statisztikákat (például a dokumentum gyakoriságát) a konzisztensebb pontozás érdekében, vagy helyileg az alacsonyabb késés érdekében. Az alapértelmezett érték a "helyi". A "globális" használatával globálisan összesítheti a pontozási statisztikákat a pontozás előtt. A globális pontozási statisztikák használata növelheti a keresési lekérdezések késését. |
|
search |
string |
Teljes szöveges keresési lekérdezési kifejezés; Használja a "*" paramétert, vagy kihagyja ezt a paramétert az összes dokumentum egyeztetéséhez. |
searchFields |
string |
Azoknak a mezőneveknek a vesszővel tagolt listája, amelyekre a teljes szöveges keresés hatóköre kiterjed. Ha egy teljes Lucene-lekérdezésben mezőalapú keresést (fieldName:searchExpression) használ, az egyes mezőalapú keresési kifejezések mezőnevei elsőbbséget élveznek az ebben a paraméterben felsorolt mezőnevekkel szemben. |
searchMode |
Egy érték, amely meghatározza, hogy a keresési kifejezések bármelyikét vagy mindegyikét egyezőnek kell-e tekinteni ahhoz, hogy a dokumentumot egyezésként lehessen megszámolni. |
|
select |
string |
A lekérendő mezők vesszővel tagolt listája. Ha nincs meghatározva, a rendszer a sémában lekérdezhetőként megjelölt összes mezőt tartalmazza. |
semanticConfiguration |
string |
A szemantikai konfiguráció neve, amelyet a dokumentumok szemantikai típusú lekérdezések feldolgozásához használnak. |
semanticErrorHandling |
Lehetővé teszi a felhasználó számára, hogy eldöntse, hogy egy szemantikai hívásnak teljesen sikertelennek kell-e lennie, vagy részleges eredményeket ad vissza (alapértelmezett). |
|
semanticFields |
string |
A szemantikai rangsoroláshoz használt mezőnevek vesszővel tagolt listája. |
semanticMaxWaitInMilliseconds |
integer |
Lehetővé teszi a felhasználó számára, hogy felső korlátot állítson be arra az időre, amíg a szemantikai bővítés befejeződik, mielőtt a kérés meghiúsul. |
semanticQuery |
string |
Lehetővé teszi egy külön keresési lekérdezés beállítását, amely kizárólag szemantikai rerankinghoz, szemantikai feliratokhoz és szemantikai válaszokhoz használható. Olyan esetekben hasznos, amikor különböző lekérdezéseket kell használni az alaplekérési és a rangsorolási fázis, valamint az L2 szemantikai fázis között. |
sessionId |
string |
A ragadós munkamenetek létrehozásához használandó érték, amely segíthet a konzisztensebb eredmények eléréséhez. Amíg ugyanazt a munkamenet-azonosítót használja, a rendszer minden tőle telhetőt megtesz annak érdekében, hogy ugyanazt a replikakészletet célozza meg. Ügyeljen arra, hogy ugyanazon sessionID-értékek ismételt újrafelhasználása zavarja 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 sessionIdként használt érték nem kezdődhet "_" karakterrel. |
skip |
integer |
A kihagyandó keresési eredmények száma. Ez az érték nem lehet nagyobb 100 000-nél. Ha sorrendben kell beolvasnia a dokumentumokat, de a korlátozás miatt nem tudja használni a kihagyást, fontolja meg az orderby használatát egy teljesen rendezett kulcson, és szűrjön egy tartomány lekérdezéssel. |
speller |
Egy érték, amely megadta az egyes keresési lekérdezési kifejezések helyesírási javításához használni kívánt helyesírás-ellenőrző típusát. |
|
top |
integer |
A lekérendő keresési eredmények száma. Ez a $skip együtt használható a keresési eredmények ügyféloldali lapozásának megvalósításához. Ha a kiszolgálóoldali lapozás miatt csonkulnak az eredmények, a válasz tartalmaz egy folytatási jogkivonatot, amellyel egy másik Keresés kérést adhat ki a következő eredményoldalhoz. |
vectorFilterMode |
Meghatározza, hogy a szűrőket a vektorkeresés előtt vagy után alkalmazza-e a rendszer. Az alapértelmezett érték a "preFilter". |
|
vectorQueries | VectorQuery[]: |
A vektoros és hibrid keresési lekérdezések lekérdezési paraméterei. |
SearchResult
Egy keresési lekérdezés által talált dokumentumot és a kapcsolódó metaadatokat tartalmazza.
Name | Típus | Description |
---|---|---|
@search.captions |
A feliratok a dokumentum és a keresési lekérdezés közötti legreprezentesebb szakaszok. Ezeket gyakran használják dokumentum-összefoglalásként. A rendszer csak szemantikai típusú lekérdezések esetén ad vissza feliratokat. |
|
@search.documentDebugInfo |
A keresési eredmények további vizsgálatához használható hibakeresési információkat tartalmaz. |
|
@search.highlights |
object |
A dokumentum szövegtöredékei, amelyek az egyező keresési kifejezéseket jelölik, az egyes alkalmazható mezők szerint rendezve; null érték, ha a találatok kiemelése nem volt engedélyezve a lekérdezéshez. |
@search.rerankerScore |
number |
A legfontosabb keresési eredmények szemantikai rangsorolója által kiszámított relevanciapontszám. Keresés eredményeket először a RerankerScore, majd a Pontszám szerint rendezi. A rerankerScore csak szemantikai típusú lekérdezések esetén lesz visszaadva. |
@search.score |
number |
A dokumentum relevanciapontszáma a lekérdezés által visszaadott többi dokumentumhoz képest. |
SemanticDebugInfo
Name | Típus | Description |
---|---|---|
contentFields |
A szemantikai bővítési folyamatnak küldött tartalommezők, valamint a használatuk |
|
keywordFields |
A szemantikai bővítési folyamatnak küldött kulcsszómezők, valamint azok felhasználási módjának |
|
rerankerInput |
A szemantikai bővítési folyamatba küldött nyers összefűzött sztringek. |
|
titleField |
A szemantikai bővítési folyamatnak küldött címmező, valamint a használatuk |
SemanticErrorMode
Lehetővé teszi, hogy a felhasználó eldöntse, hogy egy szemantikai hívás teljesen meghiúsuljon-e, vagy részleges eredményeket adjon vissza (alapértelmezett).
Name | Típus | Description |
---|---|---|
fail |
string |
Ha kivétel történik a szemantikai feldolgozási lépés során, a lekérdezés sikertelen lesz, és a hibától függően visszaadja a megfelelő HTTP-kódot. |
partial |
string |
Ha a szemantikai feldolgozás sikertelen, a részleges eredmények továbbra is visszatérnek. A részleges eredmények definíciója attól függ, hogy melyik szemantikai lépés meghiúsult, és mi volt a hiba oka. |
SemanticErrorReason
Annak oka, hogy a rendszer részleges választ adott vissza egy szemantikai rangsorolási kérelemre.
Name | Típus | Description |
---|---|---|
capacityOverloaded |
string |
A rendszer szabályozta a kérelmet. Csak az alaperedmények lettek visszaadva. |
maxWaitExceeded |
string |
Ha a "szemanticMaxWaitInMilliseconds" érték be lett állítva, és a szemantikai feldolgozás időtartama túllépte ezt az értéket. Csak az alaperedmények lettek visszaadva. |
transient |
string |
A szemantikai folyamat legalább egy lépése sikertelen volt. |
SemanticFieldState
A mező szemantikai bővítési folyamathoz való felhasználási módja (teljes mértékben, részben vagy nem használt)
Name | Típus | Description |
---|---|---|
partial |
string |
A mezőt részben szemantikai bővítéshez használták. |
unused |
string |
A mezőt nem használták szemantikai bővítéshez. |
used |
string |
A mezőt teljes mértékben a szemantikai bővítéshez használták. |
SemanticSearchResultsType
A szemantikai rangsorolási kéréshez visszaadott részleges válasz típusa.
Name | Típus | Description |
---|---|---|
baseResults |
string |
Szemantikai bővítés vagy reranking nélküli eredmények. |
rerankedResults |
string |
A reranker modell eredményei szemantikai feliratokat tartalmaznak. Nem tartalmaznak válaszokat, válaszokat és képaláírás kiemeléseket. |
VectorFilterMode
Meghatározza, hogy a szűrők alkalmazása a vektorkeresés előtt vagy után történjen-e.
Name | Típus | Description |
---|---|---|
postFilter |
string |
A szűrő a vektoreredmények jelölt készletének visszaadása után lesz alkalmazva. A szűrő szelektivitásától függően ez a k paraméter által kértnél kevesebb eredményt eredményezhet. |
preFilter |
string |
A szűrő a keresési lekérdezés előtt lesz alkalmazva. |
VectorizableTextQuery
A vektorkereséshez használandó lekérdezési paraméterek, ha meg van adva egy vektorizálandó szöveges érték.
Name | Típus | Description |
---|---|---|
exhaustive |
boolean |
Ha igaz, a teljes k-legközelebbi szomszédkeresést aktiválja a vektorindex összes vektorában. Olyan helyzetekben hasznos, ahol a pontos egyezések kritikus fontosságúak, például az alapvető igazságértékek meghatározásához. |
fields |
string |
A keresett vektorban szerepeltetni kívánt Collection(Edm.Single) típusú vektormezők. |
k |
integer |
Azoknak a legközelebbi szomszédoknak a száma, aki a legnagyobb találatként tér vissza. |
kind |
string:
text |
A végrehajtott vektoros lekérdezés típusa. |
oversampling |
number |
Túlbélyegezési tényező. A minimális érték 1. Felülbírálja az indexdefinícióban konfigurált defaultOversampling paramétert. Csak akkor állítható be, ha a rerankWithOriginalVectors értéke igaz. Ez a paraméter csak akkor engedélyezett, ha a mögöttes vektormezőben tömörítési módszert használ. |
text |
string |
A vektoros keresési lekérdezés végrehajtásához használandó szöveg. |
VectorQueryKind
A végrehajtott vektoros lekérdezés típusa.
Name | Típus | Description |
---|---|---|
text |
string |
Vektoros lekérdezés, ahol egy vektorizálandó szöveges érték van megadva. |
vector |
string |
Vektoros lekérdezés, ahol nyers vektorérték van megadva. |