Documents - Search Post
Dokumentumokat keres az indexben.
POST {endpoint}/indexes('{indexName}')/docs/search.post.search?api-version=2026-08-01-previewURI-paraméterek
| Név | In | Kötelező | Típus | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
A keresési szolgáltatás végpontjának URL-címe. |
|
index
|
path | True |
string |
Az index neve. |
|
api-version
|
query | True |
string minLength: 1 |
A művelethez használni kívánt API-verzió. |
Kérelem fejléce
| Név | Kötelező | Típus | Description |
|---|---|---|---|
| x-ms-client-request-id |
string (uuid) |
A kérés átlátszatlan, globálisan egyedi, ügyfél által generált sztringazonosítója. |
|
| Accept |
Az Elfogadás fejléce. |
||
| x-ms-query-source-authorization |
string |
A lekérdezés végrehajtásához használt felhasználót azonosító jogkivonat. Ez a jogkivonat a dokumentumokra vonatkozó biztonsági korlátozások érvényesítésére szolgál. |
|
| x-ms-enable-elevated-read |
boolean |
Olyan érték, amely lehetővé teszi az emelt szintű olvasást, amely megkerüli a dokumentumszintű engedélyellenőrzéseket a lekérdezési művelethez. |
Kérelem törzse
| Név | 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 meghatározza, hogy lekérje-e az eredmények teljes számát. Az alapértelmezett érték false. Az érték igaz értékre állítása hatással lehet a teljesítményre. Vegye figyelembe, hogy a visszaadott szám közelítés. |
| debug |
Lehetővé tesz egy hibakereső eszközt, amely az újrarangsorolt 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 opcionálisan 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 vonatkozik. |
| 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 |
Egy sztringcímke, amely a kiemelések eléréséhez van hozzáfűzve. A highlightPreTag értéket kell megadni. Az alapértelmezett érték </em>. |
| highlightPreTag |
string |
Egy sztringcímke, amely elő van állítva a kiemelések eléréséhez. A highlightPostTag értéket kell beállítani. Az alapértelmezett érték <em>. |
| hybridSearch |
A hibrid keresési viselkedés konfigurálására szolgáló lekérdezési paraméterek. |
|
| minimumCoverage |
number (double) |
0 és 100 közötti szám, amely azt jelzi, hogy egy keresési lekérdezésnek hány százalékát kell lefednie annak az indexnek, amelyet a lekérdezés sikeresként kell jelentenie. Ez a paraméter akkor is hasznos lehet, ha csak egy replikával rendelkező szolgáltatások esetében is biztosítja a keresés rendelkezésre állását. Az alapértelmezett érték 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ő vagy csökkenő jelzést jelez. Az alapértelmezett érték növekvő sorrend. A dokumentumok egyezésének pontszáma megszakítja a kötelékeket. Ha nincs megadva $orderby, az alapértelmezett rendezési sorrend a dokumentumegyezés pontszáma szerint csökkenő lesz. Legfeljebb 32 $orderby záradék lehet. |
| queryLanguage |
A keresési lekérdezés nyelvét meghatározó érték. |
|
| queryRewrites |
Olyan érték, amely meghatározza, hogy létre kell-e hozni a lekérdezés átírását a keresési lekérdezés bővítéséhez. |
|
| 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és szintaxisát használja. |
|
| scoringParameters |
string[] |
A pontozó függvényekben (például referenciaPontParameter) 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" (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 "*" jelet, vagy hagyja ki ezt a paramétert az összes dokumentum egyeztetéséhez. |
| searchFields |
string |
A teljes szöveges keresés hatókörébe tartozó mezőnevek vesszővel tagolt listája. 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 a paraméterben felsorolt mezőneveknél. |
| 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ésnek számítsa. |
|
| select |
string |
A lekérni kívánt 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 |
Annak a szemantikai konfigurációnak a neve, amelyet a dokumentumok a szemantikai típusú lekérdezések feldolgozásakor használnak. |
| semanticErrorHandling |
Lehetővé teszi a felhasználó számára, hogy eldöntse, hogy a szemantikai hívás teljesen meghiúsuljon-e (alapértelmezett/aktuális viselkedés), vagy részleges eredményeket adjon vissza. |
|
| semanticFields |
string |
A szemantikai rangsoroláshoz használt mezőnevek vesszővel tagolt listája. |
| semanticMaxWaitInMilliseconds |
integer (int32) minimum: 700 |
Lehetővé teszi, hogy a felhasználó felső határt állítson be a szemantikai bővítés befejezéséhez szükséges időhöz, 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 különböző lekérdezéseket kell használni az alaplekérési és rangsorolási fázis és az L2 szemantikai fázis között. |
| sessionId |
string |
Ragadós munkamenet létrehozásához használt érték, amely segíthet konzisztensebb eredmények elérésében. 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 ugyanazokat a sessionID-értékeket ismételten használva 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 munkamenet-azonosítóként használt érték nem kezdődhet "_" karakterrel. |
| skip |
integer (int32) |
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 meghatározza a helyesírás típusát, amellyel az egyes keresőkereső kifejezéseket helyesírásra kell használni. |
|
| top |
integer (int32) |
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 találatok csonkolása kiszolgálóoldali lapozás miatt történik, a válasz tartalmaz egy folytatási jogkivonatot, amellyel egy másik keresési kérést adhat ki a következő találatoldalhoz. |
| vectorFilterMode |
Meghatározza, hogy a szűrők alkalmazása a vektoros keresés előtt vagy után történjen-e. Az alapértelmezett érték a "preFilter" az új indexekhez. |
|
| vectorQueries | VectorQuery[]: |
A vektoros és hibrid keresési lekérdezések lekérdezési paraméterei. |
Válaszok
| Név | Típus | Description |
|---|---|---|
| 200 OK |
A kérés sikeres volt. |
|
| Other Status Codes |
Sikeres |
|
| Other Status Codes |
Váratlan hibaválasz. |
Biztonság
api-key
Típus:
apiKey
In:
header
OAuth2Auth
Típus:
oauth2
Folyamat:
implicit
Engedélyezési URL:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Hatókörök
| Név | Description |
|---|---|
| https://search.azure.com/.default |
Példák
|
Search |
|
Search |
|
Search |
SearchIndexSearchDocumentsPost
Mintakérelem
POST https://typespecpreviewexampleservice.search.windows.net/indexes('preview-test')/docs/search.post.search?api-version=2026-08-01-preview
{
"count": true,
"facets": [
"ownerId",
"price,metric:sum,default:10"
],
"filter": "category eq 'purple' or category eq 'pink'",
"highlight": "category",
"highlightPostTag": "</em>",
"highlightPreTag": "</em>",
"minimumCoverage": 100,
"orderby": "",
"queryType": "semantic",
"scoringStatistics": "global",
"sessionId": "mysessionid",
"scoringParameters": [
"categoryTag:desiredCategoryValue"
],
"scoringProfile": "stringFieldBoost",
"debug": "vector",
"search": "purple",
"searchFields": "id,name,description,category,ownerId",
"searchMode": "any",
"queryLanguage": "en-us",
"speller": "lexicon",
"select": "id,name,description,category,ownerId",
"skip": 0,
"top": 10,
"semanticConfiguration": "testconfig",
"semanticErrorHandling": "partial",
"semanticMaxWaitInMilliseconds": 5000,
"semanticQuery": "find all purple",
"answers": "extractive",
"captions": "extractive",
"queryRewrites": "generative",
"semanticFields": "",
"vectorQueries": [
{
"k": 50,
"fields": "vector22, vector1b",
"oversampling": 20,
"weight": 1,
"threshold": {
"kind": "vectorSimilarity",
"value": 0.984
},
"filterOverride": "ownerId eq 'sam'",
"kind": "vector",
"vector": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
]
}
],
"vectorFilterMode": "preFilter",
"hybridSearch": {
"maxTextRecallSize": 100,
"countAndFacetMode": "countAllResults"
}
}
Mintaválasz
{
"@odata.count": 27,
"@search.coverage": 100,
"@search.facets": {
"ownerId": [
{
"count": 16,
"value": "sam"
},
{
"count": 8,
"value": "ryan"
},
{
"count": 3,
"value": "benny"
}
],
"price": [
{
"sum": 320
}
]
},
"@search.answers": [],
"value": [
{
"@search.score": 0.015625,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7178425788879395,
"@search.rerankerBoostedScore": 1.7178425788879395,
"@search.captions": [
{
"text": "test10 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 27.725889205932617
},
"vectors": [
{}
]
}
}
},
"id": "10",
"name": "test",
"description": "test10 hello",
"category": "purple",
"ownerId": "benny"
},
{
"@search.score": 0.012820512987673283,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7107532024383545,
"@search.rerankerBoostedScore": 1.7107532024383545,
"@search.captions": [
{
"text": "no vector.",
"highlights": "</em>no vector.</em>"
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 21.559860229492188
},
"vectors": [
{}
]
}
}
},
"id": "empty-vectors",
"name": "test",
"description": "no vector",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.011627906933426857,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7107532024383545,
"@search.rerankerBoostedScore": 1.7107532024383545,
"@search.captions": [
{
"text": "no vector.",
"highlights": "</em>no vector.</em>"
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 6.500757217407227
},
"vectors": [
{}
]
}
}
},
"id": "no-vectors",
"name": "test",
"description": "no vector",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.011904762126505375,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6990556716918945,
"@search.rerankerBoostedScore": 1.6990556716918945,
"@search.captions": [
{
"text": "test4 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 6.500757217407227
},
"vectors": [
{}
]
}
}
},
"id": "4",
"name": "test",
"description": "test4 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.012345679104328156,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6951565742492676,
"@search.rerankerBoostedScore": 1.6951565742492676,
"@search.captions": [
{
"text": "test2 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 6.500757217407227
},
"vectors": [
{}
]
}
}
},
"id": "2",
"name": "test",
"description": "test2 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.0117647061124444,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.693029761314392,
"@search.rerankerBoostedScore": 1.693029761314392,
"@search.captions": [
{
"text": "test5 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 6.500757217407227
},
"vectors": [
{}
]
}
}
},
"id": "5",
"name": "test",
"description": "test5 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.01666666753590107,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6909029483795166,
"@search.rerankerBoostedScore": 1.6909029483795166,
"@search.captions": [
{
"text": "test7 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 39.23316955566406
},
"vectors": [
{}
]
}
}
},
"id": "7",
"name": "test",
"description": "test7 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.013698630034923553,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6777875423431396,
"@search.rerankerBoostedScore": 1.6777875423431396,
"@search.captions": [
{
"text": "test0 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 21.559860229492188
},
"vectors": [
{}
]
}
}
},
"id": "0",
"name": "test",
"description": "test0 hello",
"category": "purple",
"ownerId": "benny"
},
{
"@search.score": 0.013888888992369175,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6650266647338867,
"@search.rerankerBoostedScore": 1.6650266647338867,
"@search.captions": [
{
"text": "test8 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 23.01456642150879
},
"vectors": [
{}
]
}
}
},
"id": "8",
"name": "test",
"description": "test8 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.012658228166401386,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6607730388641357,
"@search.rerankerBoostedScore": 1.6607730388641357,
"@search.captions": [
{
"text": "test11 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 6.500757217407227
},
"vectors": [
{}
]
}
}
},
"id": "11",
"name": "test",
"description": "test11 hello",
"category": "purple",
"ownerId": "sam"
}
]
}{
"@odata.count": 27,
"@search.coverage": 100,
"@search.facets": {
"ownerId": [
{
"count": 16,
"value": "sam"
},
{
"count": 8,
"value": "ryan"
},
{
"count": 3,
"value": "benny"
}
],
"price": [
{
"sum": 320
}
]
},
"@search.answers": [],
"value": [
{
"@search.score": 0.015625,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7178425788879395,
"@search.rerankerBoostedScore": 1.7178425788879395,
"@search.captions": [
{
"text": "test10 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 27.725889205932617
},
"vectors": [
{}
]
}
}
},
"id": "10",
"name": "test",
"description": "test10 hello",
"category": "purple",
"ownerId": "benny"
},
{
"@search.score": 0.012820512987673283,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7107532024383545,
"@search.rerankerBoostedScore": 1.7107532024383545,
"@search.captions": [
{
"text": "no vector.",
"highlights": "</em>no vector.</em>"
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 21.559860229492188
},
"vectors": [
{}
]
}
}
},
"id": "empty-vectors",
"name": "test",
"description": "no vector",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.011627906933426857,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7107532024383545,
"@search.rerankerBoostedScore": 1.7107532024383545,
"@search.captions": [
{
"text": "no vector.",
"highlights": "</em>no vector.</em>"
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 6.500757217407227
},
"vectors": [
{}
]
}
}
},
"id": "no-vectors",
"name": "test",
"description": "no vector",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.011904762126505375,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6990556716918945,
"@search.rerankerBoostedScore": 1.6990556716918945,
"@search.captions": [
{
"text": "test4 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 6.500757217407227
},
"vectors": [
{}
]
}
}
},
"id": "4",
"name": "test",
"description": "test4 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.012345679104328156,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6951565742492676,
"@search.rerankerBoostedScore": 1.6951565742492676,
"@search.captions": [
{
"text": "test2 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 6.500757217407227
},
"vectors": [
{}
]
}
}
},
"id": "2",
"name": "test",
"description": "test2 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.0117647061124444,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.693029761314392,
"@search.rerankerBoostedScore": 1.693029761314392,
"@search.captions": [
{
"text": "test5 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 6.500757217407227
},
"vectors": [
{}
]
}
}
},
"id": "5",
"name": "test",
"description": "test5 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.01666666753590107,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6909029483795166,
"@search.rerankerBoostedScore": 1.6909029483795166,
"@search.captions": [
{
"text": "test7 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 39.23316955566406
},
"vectors": [
{}
]
}
}
},
"id": "7",
"name": "test",
"description": "test7 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.013698630034923553,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6777875423431396,
"@search.rerankerBoostedScore": 1.6777875423431396,
"@search.captions": [
{
"text": "test0 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 21.559860229492188
},
"vectors": [
{}
]
}
}
},
"id": "0",
"name": "test",
"description": "test0 hello",
"category": "purple",
"ownerId": "benny"
},
{
"@search.score": 0.013888888992369175,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6650266647338867,
"@search.rerankerBoostedScore": 1.6650266647338867,
"@search.captions": [
{
"text": "test8 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 23.01456642150879
},
"vectors": [
{}
]
}
}
},
"id": "8",
"name": "test",
"description": "test8 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.012658228166401386,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6607730388641357,
"@search.rerankerBoostedScore": 1.6607730388641357,
"@search.captions": [
{
"text": "test11 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 6.500757217407227
},
"vectors": [
{}
]
}
}
},
"id": "11",
"name": "test",
"description": "test11 hello",
"category": "purple",
"ownerId": "sam"
}
]
}SearchIndexSearchDocumentsPostOsV2
Mintakérelem
POST https://previewexampleservice.search.windows.net/indexes('preview-test')/docs/search.post.search?api-version=2026-08-01-preview
{
"count": true,
"facets": [
"ownerId",
"price,metric:sum,default:10"
],
"filter": "category eq 'purple' or category eq 'pink'",
"highlight": "category",
"highlightPostTag": "</em>",
"highlightPreTag": "</em>",
"minimumCoverage": 100,
"queryType": "semantic",
"scoringStatistics": "global",
"sessionId": "mysessionid",
"scoringParameters": [
"categoryTag:desiredCategoryValue"
],
"scoringProfile": "stringFieldBoost",
"debug": "vector",
"search": "purple",
"searchFields": "id,name,description,category,ownerId",
"searchMode": "any",
"queryLanguage": "en-us",
"speller": "lexicon",
"select": "id,name,description,category,ownerId",
"skip": 0,
"top": 10,
"semanticConfiguration": "testconfig",
"semanticErrorHandling": "partial",
"semanticMaxWaitInMilliseconds": 5000,
"semanticQuery": "find all purple",
"answers": "extractive",
"captions": "extractive",
"queryRewrites": "generative",
"vectorQueries": [
{
"vector": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
],
"kind": "vector",
"k": 50,
"fields": "vector22, vector1b",
"oversampling": 20,
"weight": 1,
"threshold": {
"value": 0.984,
"kind": "vectorSimilarity"
},
"filterOverride": "ownerId eq 'sam'"
}
],
"vectorFilterMode": "preFilter",
"hybridSearch": {
"maxTextRecallSize": 100,
"countAndFacetMode": "countAllResults"
}
}
Mintaválasz
{
"@odata.count": 27,
"@search.coverage": 100,
"@search.facets": {
"ownerId": [
{
"count": 16,
"value": "sam"
},
{
"count": 8,
"value": "ryan"
},
{
"count": 3,
"value": "benny"
}
],
"price": [
{
"sum": 320
}
]
},
"@search.answers": [],
"value": [
{
"@search.score": 0.012987012974917889,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7178425788879395,
"@search.rerankerBoostedScore": 1.7178425788879395,
"@search.captions": [
{
"text": "test10 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 15.319689750671387
},
"vectors": [
{}
]
}
}
},
"id": "10",
"name": "test",
"description": "test10 hello",
"category": "purple",
"ownerId": "benny"
},
{
"@search.score": 0.013333333656191826,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7079174518585205,
"@search.rerankerBoostedScore": 1.7079174518585205,
"@search.captions": [
{
"text": "no vector.",
"highlights": "</em>no vector.</em>"
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 18.800146102905273
},
"vectors": [
{}
]
}
}
},
"id": "no-vectors",
"name": "test",
"description": "no vector",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.012195121496915817,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7079174518585205,
"@search.rerankerBoostedScore": 1.7079174518585205,
"@search.captions": [
{
"text": "no vector.",
"highlights": "</em>no vector.</em>"
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 15.319689750671387
},
"vectors": [
{}
]
}
}
},
"id": "empty-vectors",
"name": "test",
"description": "no vector",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.012345679104328156,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6994102001190186,
"@search.rerankerBoostedScore": 1.6994102001190186,
"@search.captions": [
{
"text": "test4 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 15.319689750671387
},
"vectors": [
{}
]
}
}
},
"id": "4",
"name": "test",
"description": "test4 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.0117647061124444,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6937386989593506,
"@search.rerankerBoostedScore": 1.6937386989593506,
"@search.captions": [
{
"text": "test2 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 11.507283210754395
},
"vectors": [
{}
]
}
}
},
"id": "2",
"name": "test",
"description": "test2 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.013698630034923553,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6923208236694336,
"@search.rerankerBoostedScore": 1.6923208236694336,
"@search.captions": [
{
"text": "test5 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 21.559860229492188
},
"vectors": [
{}
]
}
}
},
"id": "5",
"name": "test",
"description": "test5 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.013513513840734959,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.691611886024475,
"@search.rerankerBoostedScore": 1.691611886024475,
"@search.captions": [
{
"text": "test7 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 18.800146102905273
},
"vectors": [
{}
]
}
}
},
"id": "7",
"name": "test",
"description": "test7 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.01315789483487606,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6781420707702637,
"@search.rerankerBoostedScore": 1.6781420707702637,
"@search.captions": [
{
"text": "test0 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 15.319689750671387
},
"vectors": [
{}
]
}
}
},
"id": "0",
"name": "test",
"description": "test0 hello",
"category": "purple",
"ownerId": "benny"
},
{
"@search.score": 0.015625,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6653810739517212,
"@search.rerankerBoostedScore": 1.6653810739517212,
"@search.captions": [
{
"text": "test8 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 33.067142486572266
},
"vectors": [
{}
]
}
}
},
"id": "8",
"name": "test",
"description": "test8 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.016393441706895828,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6618363857269287,
"@search.rerankerBoostedScore": 1.6618363857269287,
"@search.captions": [
{
"text": "test11 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 33.067142486572266
},
"vectors": [
{}
]
}
}
},
"id": "11",
"name": "test",
"description": "test11 hello",
"category": "purple",
"ownerId": "sam"
}
]
}{
"value": []
}SearchIndexSearchDocumentsSemanticPost
Mintakérelem
POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2026-08-01-preview
{
"count": true,
"highlightPostTag": "</em>",
"highlightPreTag": "<em>",
"queryType": "semantic",
"search": "how do clouds form",
"semanticConfiguration": "my-semantic-config",
"answers": "extractive|count-3",
"captions": "extractive|highlight-true",
"semanticErrorHandling": "partial",
"semanticMaxWaitInMilliseconds": 780
}
Mintaválasz
{
"@odata.count": 25,
"@search.answers": [
{
"key": "4123",
"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
}
],
"@search.nextPageParameters": {
"count": true,
"highlightPostTag": "</em>",
"highlightPreTag": "<em>",
"queryType": "semantic",
"search": "how do clouds form",
"semanticConfiguration": "my-semantic-config",
"answers": "extractive|count-3",
"captions": "extractive|highlight-true",
"semanticErrorHandling": "partial",
"semanticMaxWaitInMilliseconds": 780,
"skip": 2,
"top": 8
},
"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."
}
],
"id": "4123",
"title": "Earth Atmosphere",
"content": "Fog 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",
"locations": [
"Pacific Northwest",
"North America",
"Vancouver"
]
}
],
"@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2025-05-01-preview"
}{
"@odata.count": 25,
"@search.answers": [
{
"key": "4123",
"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
}
],
"@search.nextPageParameters": {
"count": true,
"highlightPostTag": "</em>",
"highlightPreTag": "<em>",
"queryType": "semantic",
"search": "how do clouds form",
"semanticConfiguration": "my-semantic-config",
"answers": "extractive|count-3",
"captions": "extractive|highlight-true",
"semanticErrorHandling": "partial",
"semanticMaxWaitInMilliseconds": 780,
"skip": 2,
"top": 8
},
"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."
}
],
"id": "4123",
"title": "Earth Atmosphere",
"content": "Fog 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",
"locations": [
"Pacific Northwest",
"North America",
"Vancouver"
]
}
],
"@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2025-05-01-preview"
}Definíciók
| Név | Description |
|---|---|
| Accept |
Az Elfogadás fejléce. |
|
Debug |
Olyan hibakeresési információkat tartalmaz, amelyek a keresési eredmények további vizsgálatához használhatók. |
|
Document |
Olyan hibakeresési információkat tartalmaz, amelyek a keresési eredmények további vizsgálatához használhatók. |
|
Error |
Az erőforrás-kezelési hiba további információi. |
|
Error |
A hiba részletei. |
|
Error |
Az Összes Azure Resource Manager API gyakori hibaválasza a sikertelen műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.) |
|
Hybrid |
Meghatározza, hogy a darabszám és a dimenziók tartalmazzák-e a keresési lekérdezésnek megfelelő összes dokumentumot, vagy csak a "maxTextRecallSize" ablakban lekért dokumentumokat. Az alapértelmezett érték a "countAllResults". |
|
Hybrid |
A hibrid keresési viselkedés konfigurálására szolgáló lekérdezési paraméterek. |
|
Query |
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 nyerhetők ki. A válaszjelöltek pontszámot kapnak, és a legjobb válaszok lesznek kiválasztva. |
|
Query |
Ez a paraméter csak akkor érvényes, ha a lekérdezés típusa . |
|
Query |
A feliratok a dokumentumtól a keresési lekérdezésig a leginkább reprezentatív szakaszok. Ezeket gyakran használják a dokumentumok összegzéseként. A rendszer csak |
|
Query |
Ez a paraméter csak akkor érvényes, ha a lekérdezés típusa . |
|
Query |
Lehetővé tesz egy hibakereső eszközt, amely a keresési eredmények további felfedezésére használható. Egyszerre több hibakeresési módot is engedélyezhet, ha elválasztja őket egy | karakter, például: semantic|queryRewrites. |
|
Query |
A lekérdezés nyelve. |
|
Query |
A szemantikai dúsí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 |
Az almagok lebontása a dokumentum keresési lekérdezésének szöveges és vektoros lekérdezési összetevői között. Minden vektoros lekérdezés külön objektumként jelenik meg a kapott sorrendben. |
|
Query |
A lekérdezések átírására vonatkozó hibakeresési információkat tartalmaz. |
|
Query |
Ez a paraméter csak akkor érvényes, ha a lekérdezés típusa . |
|
Query |
A lekérdezések átírására vonatkozó hibakeresési információkat tartalmaz. |
|
Query |
A keresési visszahívás javítása az egyes keresési lekérdezési kifejezések helyesírás-javításával. |
|
Query |
Megadja a keresési lekérdezés szintaxisát. Az alapértelmezett érték az "egyszerű". Használja a "teljes" szót, ha a lekérdezés a Lucene-lekérdezés szintaxisát használja, és a "szemantikai" szót, ha nincs szükség lekérdezési szintaxisra. |
|
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á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 |
Egy index keresési eredményeit tartalmazó válasz. |
|
Search |
Megadja, hogy a keresési kifejezések bármelyikének vagy mindegyikének egyeznie kell-e ahhoz, hogy a dokumentum egyezésnek számítson. |
|
Search |
Szűrési, rendezési, arcfelismerési, lapozási és egyéb keresési lekérdezési viselkedés paraméterei. |
|
Search |
Egy keresési lekérdezés által talált dokumentumot tartalmaz, valamint a kapcsolódó metaadatokat. |
|
Search |
A vektorlekérdezés eredményei a ' alapján szűrik |
|
Semantic |
A szemantikai rangsorolási kérelmekre vonatkozó hibakeresési információkat tartalmaz. |
|
Semantic |
Lehetővé teszi a felhasználó számára, hogy eldöntse, hogy egy szemantikai hívás teljesen meghibássul-e, vagy részleges eredményeket adjon. |
|
Semantic |
Az ok, amiért a rendszer részleges választ adott vissza egy szemantikai rangsorolási kérelemre. |
|
Semantic |
A mező használata a szemantikai gazdagítási folyamathoz. |
|
Semantic |
A kéréshez használt lekérdezés átírásának típusa. |
|
Semantic |
A szemantikai rangsorolási kérelemhez visszaadott részleges válasz típusa. |
|
Single |
Egyetlen vektormező eredménye. Both |
|
Text |
A lekérdezés szöveges részének BM25 vagy Klasszikus pontszáma. |
|
Vector |
Meghatározza, hogy a szűrők alkalmazása a vektoros keresés előtt vagy után történjen-e. |
|
Vectorizable |
A vektorkereséshez használandó lekérdezési paraméterek, ha egy vektorizált kép 64-es alapkódolt bináris fájlja van megadva. |
|
Vectorizable |
A vektorkereséshez használandó lekérdezési paraméterek, ha egy vektorizálandó képértéket képviselő URL-cím van megadva. |
|
Vectorizable |
A vektorkereséshez használandó lekérdezési paraméterek, ha egy vektorizálandó szöveges érték van megadva. |
|
Vectorized |
A vektorkereséshez használandó lekérdezési paraméterek nyers vektorérték megadásakor. |
|
Vector |
A végrehajtott vektoros lekérdezés típusa. |
|
Vectors |
"Vektor- és hibrid keresésre jellemző hibakeresési információkat tartalmaz.") |
|
Vector |
A vektoros lekérdezés eredményei a vektoros hasonlóság metrikája alapján lesznek szűrve. Vegye figyelembe, hogy ez a hasonlósági metrika canonikus definíciója, nem pedig a "távolság" verziója. A küszöbérték iránya (nagyobb vagy kisebb) automatikusan lesz kiválasztva a mező által használt metrikának megfelelően. |
|
Vector |
Az a fajta küszöb, amit vektorlekérdezések szűrésére használnak. |
Accept
Az Elfogadás fejléce.
| Érték | Description |
|---|---|
| application/json;odata.metadata=none |
DebugInfo
Olyan hibakeresési információkat tartalmaz, amelyek a keresési eredmények további vizsgálatához használhatók.
| Név | Típus | Description |
|---|---|---|
| queryRewrites |
A lekérdezések átírására vonatkozó hibakeresési információkat tartalmaz. |
DocumentDebugInfo
Olyan hibakeresési információkat tartalmaz, amelyek a keresési eredmények további vizsgálatához használhatók.
| Név | Típus | Description |
|---|---|---|
| innerHits |
object |
Összetett típusok gyűjteményében egyező vektorokra jellemző hibakeresési információkat tartalmaz. |
| semantic |
A szemantikai rangsorolási kérelmekre vonatkozó hibakeresési információkat tartalmaz. |
|
| vectors |
A vektorokra és a hibrid keresésre vonatkozó hibakeresési információkat tartalmaz. |
ErrorAdditionalInfo
Az erőforrás-kezelési hiba további információi.
| Név | Típus | Description |
|---|---|---|
| info |
A további információk. |
|
| type |
string |
A további információtípus. |
ErrorDetail
A hiba részletei.
| Név | 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élpontja. |
ErrorResponse
Az Összes Azure Resource Manager API gyakori hibaválasza a sikertelen műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.)
| Név | Típus | Description |
|---|---|---|
| error |
A hibaobjektum. |
HybridCountAndFacetMode
Meghatározza, hogy a darabszám és a dimenziók tartalmazzák-e a keresési lekérdezésnek megfelelő összes dokumentumot, vagy csak a "maxTextRecallSize" ablakban lekért dokumentumokat. Az alapértelmezett érték a "countAllResults".
| Érték | Description |
|---|---|
| countRetrievableResults |
Csak azokat a dokumentumokat foglalja bele, amelyek a "maxTextRecallSize" lekérési ablakban egyeztek a "count" és a "facets" kiszámításakor. |
| countAllResults |
Foglalja bele az összes olyan dokumentumot, amelyet a keresési lekérdezés egyeztetett a "darabszám" és a "dimenziók" kiszámításakor, függetlenül attól, hogy ezek a dokumentumok a "maxTextRecallSize" lekérési ablakban vannak-e. |
HybridSearch
A hibrid keresési viselkedés konfigurálására szolgáló lekérdezési paraméterek.
| Név | Típus | Description |
|---|---|---|
| countAndFacetMode |
Meghatározza, hogy a darabszám és a dimenziók tartalmazzák-e a keresési lekérdezésnek megfelelő összes dokumentumot, vagy csak a "maxTextRecallSize" ablakban lekért dokumentumokat. |
|
| maxTextRecallSize |
integer (int32) |
Meghatározza a hibrid keresési kérelem szöveges lekérdezési része által lekérhető dokumentumok maximális számát. Ezeket a dokumentumokat a vektoros lekérdezéseknek megfelelő dokumentumokkal kombinálva egyetlen végleges eredménylistát hoznak létre. Nagyobb maxTextRecallSize érték kiválasztása lehetővé teszi több dokumentum lekérését és lapozását (a top és a skip paraméterek használatával), a magasabb erőforrás-kihasználtság és a nagyobb késés árán. Az értéknek 1 és 10 000 között kell lennie. Az alapértelmezett érték 1000. |
QueryAnswerResult
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 nyerhetők ki. A válaszjelöltek pontszámot kapnak, és a legjobb válaszok lesznek kiválasztva.
| Név | Típus | Description |
|---|---|---|
| highlights |
string |
Ugyanaz a szövegrész, mint a Szöveg tulajdonságban a lekérdezés szempontjából legrelevánsabb kiemelt szöveges kifejezésekkel. |
| key |
string |
Annak a dokumentumnak a kulcsa, amelyből a választ kinyerték. |
| score |
number (double) |
A pontszám értéke azt jelzi, hogy a válasz mennyire releváns 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észlet. |
QueryAnswerType
Ez a paraméter csak akkor érvényes, ha a lekérdezés típusa .semantic Ha be van állítva, a lekérdezés a legmagasabb rangsorolt dokumentumok kulcsszakaszaiból kinyert válaszokat adja vissza. A visszaadott válaszok száma úgy konfigurálható, hogy hozzáfűzi a cső karaktert | , majd a válaszok paraméter értéke utáni opciót count-<number of answers> , például extractive|count-3. Az alapértelmezett szám 1. A megbízhatósági küszöbérték úgy konfigurálható, hogy hozzáfűzi a cső karaktert | , majd a válasz paraméter értéke utáni opciót threshold-<confidence threshold> , például extractive|threshold-0.9. Az alapértelmezett küszöbérték 0,7. A válaszok maximális karakterhossza a "|" karakter hozzáfűzésével állítható be, majd a "maximális karakterhossz< száma>" hozzáfűzésével, például "extractive|maxcharlength-600".
| Érték | Description |
|---|---|
| none |
Ne adja vissza a lekérdezésre adott válaszokat. |
| extractive |
Kinyeri a válaszjelölteket a visszaadott dokumentumok tartalmából egy kérdésre adott válaszként természetes nyelven kifejezve. |
QueryCaptionResult
A feliratok a dokumentumtól a keresési lekérdezésig a leginkább reprezentatív szakaszok. Ezeket gyakran használják a dokumentumok összegzéseként. A rendszer csak semantictípusú lekérdezésekhez ad vissza feliratokat.
| Név | Típus | Description |
|---|---|---|
| highlights |
string |
Ugyanaz a szövegrész, mint a Szöveg 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. |
QueryCaptionType
Ez a paraméter csak akkor érvényes, ha a lekérdezés típusa .semantic Ha be van állítva, a lekérdezés a legmagasabb rangsorolt dokumentumok kulcsszakaszaiból kinyert feliratokat adja vissza. Ha a Feliratok beállítása extractive, a kiemelés alapértelmezés szerint engedélyezve van, és a cső karakter | hozzáfűzésével konfigurálható, majd a highlight-<true/false> beállítás (például extractive|highlight-true. Alapértelmezett érték: None. A feliratok maximális karakterhossza a "|" karakter hozzáfűzésével állítható be, majd a "maximális karakterhossz< száma>", például "extractive|maxcharlength-600" hozzáadásával.
| Érték | Description |
|---|---|
| none |
Ne adjon vissza feliratokat a lekérdezéshez. |
| extractive |
A keresési lekérdezés szempontjából releváns részeket tartalmazó megfelelő dokumentumokból kinyeri a feliratokat. |
QueryDebugMode
Lehetővé tesz egy hibakereső eszközt, amely a keresési eredmények további felfedezésére használható. Egyszerre több hibakeresési módot is engedélyezhet, ha elválasztja őket egy | karakter, például: semantic|queryRewrites.
| Érték | Description |
|---|---|
| disabled |
A rendszer nem ad vissza lekérdezés-hibakeresési adatokat. |
| semantic |
Lehetővé teszi a felhasználó számára, hogy tovább vizsgálja a reranked eredményeket. |
| vector |
Lehetővé teszi a felhasználó számára a hibrid és vektoros lekérdezések eredményeinek további megismerését. |
| queryRewrites |
Lehetővé teszi, hogy a felhasználó megismerje a keresési kérelemhez létrehozott lekérdezés-átírások listáját. |
| innerHits |
Lehetővé teszi a felhasználó számára, hogy lekérje a pontozási információkat az összetett típusok gyűjteményén belül egyező vektorokról. |
| all |
Kapcsolja be az összes hibakeresési lehetőséget. |
QueryLanguage
A lekérdezés nyelve.
| Érték | Description |
|---|---|
| none |
A lekérdezés nyelve nincs megadva. |
| en-us |
Angol nyelvi értéket kérdezzen (Egyesült Államok). |
| en-gb |
Lekérdezés nyelvi értéke angol (Nagy-Britannia) esetén. |
| en-in |
Lekérdezés nyelvi értéke angol (India) esetén. |
| en-ca |
Lekérdezés nyelvi értéke angol (Kanada) nyelvhez. |
| en-au |
Lekérdezés nyelvi értéke angol (Ausztrália) esetén. |
| fr-fr |
Lekérdezési nyelv értéke a francia (Franciaország) számára. |
| fr-ca |
Lekérdezés nyelvi értéke a francia (Kanada) számára. |
| de-de |
Lekérdezési nyelv értéke a német (Németország) számára. |
| es-es |
Lekérdezés nyelvi értéke spanyol (Spanyolország) esetén. |
| es-mx |
Lekérdezési nyelv értéke spanyol (Mexikó) esetén. |
| zh-cn |
Lekérdezési nyelv értéke a kínai (Kína) számára. |
| zh-tw |
Lekérdezési nyelv értéke a kínai (Tajvan) számára. |
| pt-br |
Lekérdezés nyelvi értéke portugál (Brazília) nyelvhez. |
| pt-pt |
Lekérdezés nyelvi értéke portugál (Portugália) számára. |
| it-it |
Lekérdezés nyelvi értéke az olasz (Olaszország) számára. |
| ja-jp |
Lekérdezési nyelv értéke japán (japán) nyelvhez. |
| ko-kr |
Lekérdezési nyelv értéke koreai (koreai) nyelvhez. |
| ru-ru |
Lekérdezési nyelv értéke az orosz (Oroszország) számára. |
| cs-cz |
Lekérdezés nyelvi értéke a cseh (Cseh Köztársaság) számára. |
| nl-be |
Lekérdezés nyelvi értéke holland (Belgium) esetén. |
| nl-nl |
Lekérdezési nyelv értéke holland (Hollandia) nyelvhez. |
| hu-hu |
Lekérdezés nyelvi értéke a magyar (Magyarország) számára. |
| pl-pl |
Lekérdezés nyelvi értéke a lengyel (Lengyelország) számára. |
| sv-se |
A svéd (Svédország) lekérdezési nyelvének értéke. |
| tr-tr |
Lekérdezési nyelv értéke török (Törökország) nyelvhez. |
| hi-in |
Hindi (India) lekérdezési nyelvének értéke. |
| ar-sa |
Lekérdezési nyelv értéke arab (Szaúd-Arábia) nyelvhez. |
| ar-eg |
Lekérdezési nyelv értéke arab (Egyiptom) nyelvhez. |
| ar-ma |
Lekérdezési nyelv értéke arab (Marokkó) nyelvhez. |
| ar-kw |
Lekérdezés nyelvének értéke arab (Kuvait) nyelvhez. |
| ar-jo |
Lekérdezési nyelv értéke arab (Jordan) nyelvhez. |
| da-dk |
Dán (Dánia) lekérdezési nyelvi értéke. |
| no-no |
Lekérdezés nyelvi értéke a norvég (Norvégia) számára. |
| bg-bg |
Lekérdezés nyelvi értéke bolgár (Bulgária) esetén. |
| hr-hr |
Horvát (Horvátország) lekérdezési nyelvi értéke. |
| hr-ba |
Horvát (Bosznia-Hercegovina) lekérdezési nyelvi értéke. |
| ms-my |
A maláj (Malajzia) lekérdezési nyelvének értéke. |
| ms-bn |
A maláj (Brunei: Darussalam) lekérdezési nyelvi értéke. |
| sl-sl |
Lekérdezés nyelvi értéke a szlovén (Szlovénia) nyelvhez. |
| ta-in |
Tamil (India) lekérdezési nyelvének értéke. |
| vi-vn |
Lekérdezési nyelv értéke vietnámi nyelvhez (Vietnam). |
| el-gr |
Lekérdezési nyelv értéke görög (Görögország) esetén. |
| ro-ro |
A román (romániai) lekérdezés nyelvének értéke. |
| is-is |
Lekérdezési nyelv értéke az izlandi (Izland) számára. |
| id-id |
Lekérdezési nyelv értéke indonéz (Indonézia) nyelvhez. |
| th-th |
A thai (Thaiföld) lekérdezési nyelvének értéke. |
| lt-lt |
A litván (Litvánia) lekérdezés nyelvének értéke. |
| uk-ua |
Ukrán (Ukrajna) lekérdezési nyelvének értéke. |
| lv-lv |
A lett (Lettország) lekérdezési nyelvének értéke. |
| et-ee |
Lekérdezés nyelvi értéke az észt (Észtország) számára. |
| ca-es |
A katalánok lekérdezési nyelvének értéke. |
| fi-fi |
Lekérdezés nyelvi értéke finn (Finnország) esetén. |
| sr-ba |
Szerb (Bosznia-Hercegovina) lekérdezési nyelvi értéke. |
| sr-me |
Szerb (montenegró) lekérdezési nyelvi értéke. |
| sr-rs |
Lekérdezés nyelvi értéke a szerb (Szerbia) nyelvhez. |
| sk-sk |
A szlovák (Szlovákia) lekérdezés nyelvének értéke. |
| nb-no |
Lekérdezés nyelvi értéke a norvég (Norvégia) számára. |
| hy-am |
Lekérdezés nyelvi értéke az örmény (Örményország) számára. |
| bn-in |
Lekérdezési nyelv értéke a bengáli nyelvhez (India). |
| eu-es |
A baszk lekérdezés nyelvének értéke. |
| gl-es |
A galíciai lekérdezés nyelvi értéke. |
| gu-in |
Gudzsaráti (India) lekérdezési nyelvének értéke. |
| he-il |
A héber (Izrael) lekérdezési nyelvének értéke. |
| ga-ie |
Lekérdezés nyelvének értéke az ír (Írország) számára. |
| kn-in |
Lekérdezési nyelv értéke a kannada (India) nyelvhez. |
| ml-in |
Lekérdezési nyelv értéke a malajálam (India) nyelvhez. |
| mr-in |
A Marathi (India) lekérdezési nyelvi értéke. |
| fa-ae |
A perzsa (Egyesült Arab Emírségek) lekérdezési nyelvének értéke. |
| pa-in |
A pandzsábi (India) lekérdezési nyelvének értéke. |
| te-in |
A telugu (India) lekérdezési nyelvének értéke. |
| ur-pk |
Urdu (Pakisztán) lekérdezési nyelvének értéke. |
QueryResultDocumentRerankerInput
A szemantikai dúsítási folyamatba küldött nyers összefűzött sztringek.
| Név | 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
| Név | Típus | Description |
|---|---|---|
| name |
string |
A szemantikai bővítési folyamathoz küldött mező neve |
| state |
A mező használatának módja a szemantikai bővítési folyamathoz (teljesen használt, részben használt vagy nem használt) |
QueryResultDocumentSubscores
Az almagok lebontása a dokumentum keresési lekérdezésének szöveges és vektoros lekérdezési összetevői között. Minden vektoros lekérdezés külön objektumként jelenik meg a kapott sorrendben.
| Név | Típus | Description |
|---|---|---|
| documentBoost |
number (double) |
A lekérdezés szöveges részének BM25 vagy Klasszikus pontszáma. |
| text |
A lekérdezés szöveges részének BM25 vagy Klasszikus pontszáma. |
|
| vectors |
<string,
Single |
A vektor-hasonlóság és |
QueryRewritesDebugInfo
A lekérdezések átírására vonatkozó hibakeresési információkat tartalmaz.
| Név | Típus | Description |
|---|---|---|
| text |
A szöveges lekérdezéshez létrehozott lekérdezés-átírások listája. |
|
| vectors |
A vektorizálható szöveges lekérdezésekhez létrehozott lekérdezés-átírások listája. |
QueryRewritesType
Ez a paraméter csak akkor érvényes, ha a lekérdezés típusa .semantic Ha a QueryRewrites beállítása generative, a lekérdezési kifejezések egy generáló modellnek lesznek elküldve, amely 10 (alapértelmezett) átírást hoz létre a kérés visszahívásának növelése érdekében. A kért szám úgy konfigurálható, hogy hozzáfűzi a cső karaktert | , majd a beállítást count-<number of rewrites> , például generative|count-3. Alapértelmezett érték: None.
| Érték | Description |
|---|---|
| none |
Ne hozzon létre további lekérdezés-átírásokat ehhez a lekérdezéshez. |
| generative |
Alternatív lekérdezési kifejezések létrehozása a keresési kérések visszahívásának növeléséhez. |
QueryRewritesValuesDebugInfo
A lekérdezések átírására vonatkozó hibakeresési információkat tartalmaz.
| Név | Típus | Description |
|---|---|---|
| inputQuery |
string |
A generatív lekérdezés átírási modelljének bemeneti szövege. Előfordulhatnak olyan esetek, amikor a felhasználói lekérdezés és a generatív modell bemenete nem azonos. |
| rewrites |
string[] |
Lekérdezések átírásainak listája. |
QuerySpellerType
A keresési visszahívás javítása az egyes keresési lekérdezési kifejezések helyesírás-javításával.
| Érték | Description |
|---|---|
| none |
A Speller nincs engedélyezve. |
| lexicon |
A Speller az egyes lekérdezési kifejezéseket a queryLanguage paraméter által megadott nyelv statikus lexikonjával javítja. |
QueryType
Megadja a keresési lekérdezés szintaxisát. Az alapértelmezett érték az "egyszerű". Használja a "teljes" szót, ha a lekérdezés a Lucene-lekérdezés szintaxisát használja, és a "szemantikai" szót, ha nincs szükség lekérdezési szintaxisra.
| Érték | Description |
|---|---|
| simple |
Az egyszerű lekérdezési szintaxist használja a keresésekhez. A keresési szöveg értelmezése egy egyszerű lekérdezési nyelvvel történik, amely lehetővé teszi az olyan szimbólumok használatát, mint a +, * és "". A lekérdezések kiértékelése alapértelmezés szerint az összes kereshető mezőben megtörténik, kivéve, ha a searchFields paraméter meg van adva. |
| full |
A keresésekhez a teljes Lucene-lekérdezési szintaxist használja. A keresési szöveg értelmezése a Lucene lekérdezési nyelven történik, amely lehetővé teszi a mezőspecifikus és súlyozott keresést, valamint más speciális funkciókat. |
| semantic |
A legalkalmasabb a természetes nyelven kifejezett lekérdezésekhez, nem pedig a kulcsszavakhoz. Javítja a keresési eredmények pontosságát azáltal, hogy a webes korpuszon betanított rangsorolási modell segítségével újrarangsorolja a legjobb keresési eredményeket. |
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.
| Érték | Description |
|---|---|
| local |
A pontozási statisztikák kiszámítása helyileg történik az alacsonyabb késés érdekében. |
| global |
A pontozási statisztikákat globálisan számítják ki a konzisztensebb pontozás érdekében. |
SearchDocumentsResult
Egy index keresési eredményeit tartalmazó válasz.
| Név | Típus | Description |
|---|---|---|
| @odata.count |
integer (int64) |
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étert 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 egy másik GET vagy POST keresési kérést fogalmazhat meg a keresési válasz következő részének lekéréséhez. Ügyeljen arra, hogy ugyanazt az igét (GET vagy POST) használja, mint a választ kiváltó 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 (double) |
Olyan érték, amely a lekérdezésben szereplő index százalékos arányát jelzi, vagy null értéket, ha a kérelemben nem volt megadva a minimális hozzáférés. |
| @search.debug |
A keresési eredmények egészére vonatkozó hibakeresési információk. |
|
| @search.facets |
object |
A keresési művelet részletes lekérdezési eredményei gyűjtők gyűjteményeként rendszerezve az egyes aspektusmezőkhöz; null értékű, ha a lekérdezés nem tartalmaz egyetlen aspektuskifejezést sem. |
| @search.nextPageParameters |
A folytatás JSON-hasznos adatai akkor lesznek visszaadva, ha a lekérdezés nem tudja egyetlen válaszban visszaadni az összes kért eredményt. Ezt a JSON-t használhatod a |
|
| @search.semanticPartialResponseReason |
Az ok, amiért a rendszer részleges választ adott vissza egy szemantikai rangsorolási kérelemre. |
|
| @search.semanticPartialResponseType |
A szemantikai rangsorolási kérelemhez visszaadott részleges válasz típusa. |
|
| @search.semanticQueryRewritesResultType |
A dokumentumok lekéréséhez használt lekérdezés-átírás típusa. |
|
| value |
A lekérdezés által visszaadott eredmények sorozata. |
SearchMode
Megadja, hogy a keresési kifejezések bármelyikének vagy mindegyikének egyeznie kell-e ahhoz, hogy a dokumentum egyezésnek számítson.
| Érték | Description |
|---|---|
| any |
A keresési kifejezések bármelyikének egyeznie kell ahhoz, hogy a dokumentum egyezésnek számítson. |
| all |
Az összes keresési kifejezésnek egyeznie kell ahhoz, hogy a dokumentum egyezésnek számítson. |
SearchRequest
Szűrési, rendezési, arcfelismerési, lapozási és egyéb keresési lekérdezési viselkedés paraméterei.
| Név | 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 meghatározza, hogy lekérje-e az eredmények teljes számát. Az alapértelmezett érték false. Az érték igaz értékre állítása hatással lehet a teljesítményre. Vegye figyelembe, hogy a visszaadott szám közelítés. |
| debug |
Lehetővé tesz egy hibakereső eszközt, amely az újrarangsorolt 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 opcionálisan 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 vonatkozik. |
| 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 |
Egy sztringcímke, amely a kiemelések eléréséhez van hozzáfűzve. A highlightPreTag értéket kell megadni. Az alapértelmezett érték </em>. |
| highlightPreTag |
string |
Egy sztringcímke, amely elő van állítva a kiemelések eléréséhez. A highlightPostTag értéket kell beállítani. Az alapértelmezett érték <em>. |
| hybridSearch |
A hibrid keresési viselkedés konfigurálására szolgáló lekérdezési paraméterek. |
|
| minimumCoverage |
number (double) |
0 és 100 közötti szám, amely azt jelzi, hogy egy keresési lekérdezésnek hány százalékát kell lefednie annak az indexnek, amelyet a lekérdezés sikeresként kell jelentenie. Ez a paraméter akkor is hasznos lehet, ha csak egy replikával rendelkező szolgáltatások esetében is biztosítja a keresés rendelkezésre állását. Az alapértelmezett érték 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ő vagy csökkenő jelzést jelez. Az alapértelmezett érték növekvő sorrend. A dokumentumok egyezésének pontszáma megszakítja a kötelékeket. Ha nincs megadva $orderby, az alapértelmezett rendezési sorrend a dokumentumegyezés pontszáma szerint csökkenő lesz. Legfeljebb 32 $orderby záradék lehet. |
| queryLanguage |
A keresési lekérdezés nyelvét meghatározó érték. |
|
| queryRewrites |
Olyan érték, amely meghatározza, hogy létre kell-e hozni a lekérdezés átírását a keresési lekérdezés bővítéséhez. |
|
| 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és szintaxisát használja. |
|
| scoringParameters |
string[] |
A pontozó függvényekben (például referenciaPontParameter) 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" (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 "*" jelet, vagy hagyja ki ezt a paramétert az összes dokumentum egyeztetéséhez. |
| searchFields |
string |
A teljes szöveges keresés hatókörébe tartozó mezőnevek vesszővel tagolt listája. 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 a paraméterben felsorolt mezőneveknél. |
| 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ésnek számítsa. |
|
| select |
string |
A lekérni kívánt 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 |
Annak a szemantikai konfigurációnak a neve, amelyet a dokumentumok a szemantikai típusú lekérdezések feldolgozásakor használnak. |
| semanticErrorHandling |
Lehetővé teszi a felhasználó számára, hogy eldöntse, hogy a szemantikai hívás teljesen meghiúsuljon-e (alapértelmezett/aktuális viselkedés), vagy részleges eredményeket adjon vissza. |
|
| semanticFields |
string |
A szemantikai rangsoroláshoz használt mezőnevek vesszővel tagolt listája. |
| semanticMaxWaitInMilliseconds |
integer (int32) minimum: 700 |
Lehetővé teszi, hogy a felhasználó felső határt állítson be a szemantikai bővítés befejezéséhez szükséges időhöz, 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 különböző lekérdezéseket kell használni az alaplekérési és rangsorolási fázis és az L2 szemantikai fázis között. |
| sessionId |
string |
Ragadós munkamenet létrehozásához használt érték, amely segíthet konzisztensebb eredmények elérésében. 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 ugyanazokat a sessionID-értékeket ismételten használva 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 munkamenet-azonosítóként használt érték nem kezdődhet "_" karakterrel. |
| skip |
integer (int32) |
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 meghatározza a helyesírás típusát, amellyel az egyes keresőkereső kifejezéseket helyesírásra kell használni. |
|
| top |
integer (int32) |
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 találatok csonkolása kiszolgálóoldali lapozás miatt történik, a válasz tartalmaz egy folytatási jogkivonatot, amellyel egy másik keresési kérést adhat ki a következő találatoldalhoz. |
| vectorFilterMode |
Meghatározza, hogy a szűrők alkalmazása a vektoros keresés előtt vagy után történjen-e. Az alapértelmezett érték a "preFilter" az új indexekhez. |
|
| 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 tartalmaz, valamint a kapcsolódó metaadatokat.
| Név | Típus | Description |
|---|---|---|
| @search.captions |
A feliratok a dokumentumtól a keresési lekérdezésig a leginkább reprezentatív szakaszok. Ezeket gyakran használják a dokumentumok összegzéseként. A feliratok csak a "szemantikai" típusú lekérdezések esetén lesznek visszaadva. |
|
| @search.documentDebugInfo |
Olyan hibakeresési információkat tartalmaz, amelyek a keresési eredmények további vizsgálatához használhatók. |
|
| @search.highlights |
object |
A dokumentum szövegtöredékei, amelyek jelzik a megfelelő keresési kifejezéseket, az egyes megfelelő mezők szerint rendezve; Null, ha a találatkiemelés nincs engedélyezve a lekérdezéshez. |
| @search.rerankerBoostedScore |
number (double) |
A Relevancia-pontszám kiszámítása a Reranker-pontszám növelésével. A keresési eredményeket a RerankerScore/RerankerBoostedScore szerint rendezik a Semantic Config userScoringProfileBoostedRanking alapján. A RerankerBoostedScore csak a 'szemantika' típusú lekérdezéseknél jelenik meg. |
| @search.rerankerScore |
number (double) |
A szemantikai rangsoroló által kiszámított relevanciapontszám a legjobb keresési eredményekhez. A keresési eredményeket először a RerankerScore, majd a Score szerint rendezzük. A RerankerScore csak a "szemantikai" típusú lekérdezések esetén lesz visszaadva. |
| @search.score |
number (double) |
A dokumentum relevanciapontszáma a lekérdezés által visszaadott többi dokumentumhoz képest. |
SearchScoreThreshold
A vektorlekérdezés eredményei a ' alapján szűrik
| Név | Típus | Description |
|---|---|---|
| kind |
string:
search |
A küszöb típusa. |
| value |
number (double) |
A küszöb a ' alapján szűri a ' |
SemanticDebugInfo
A szemantikai rangsorolási kérelmekre vonatkozó hibakeresési információkat tartalmaz.
| Név | Típus | Description |
|---|---|---|
| contentFields |
A szemantikai bővítési folyamathoz küldött tartalommezők, valamint azok használata |
|
| keywordFields |
A szemantikai bővítési folyamatnak küldött kulcsszómezők, valamint azok használatának módja |
|
| rerankerInput |
A szemantikai dúsí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 annak használata |
SemanticErrorMode
Lehetővé teszi a felhasználó számára, hogy eldöntse, hogy egy szemantikai hívás teljesen meghibássul-e, vagy részleges eredményeket adjon.
| Érték | Description |
|---|---|
| partial |
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 milyen szemantikai lépés meghiúsult, és mi volt a hiba oka. |
| fail |
Ha kivétel történik a szemantikai feldolgozási lépés során, a lekérdezés sikertelen lesz, és a hiba függvényében visszaadja a megfelelő HTTP-kódot. |
SemanticErrorReason
Az ok, amiért a rendszer részleges választ adott vissza egy szemantikai rangsorolási kérelemre.
| Érték | Description |
|---|---|
| maxWaitExceeded |
Ha |
| capacityOverloaded |
A kérés szabályozva lett. Csak az alaperedmények lettek visszaadva. |
| transient |
A szemantikai folyamat legalább egy lépése sikertelen volt. |
SemanticFieldState
A mező használata a szemantikai gazdagítási folyamathoz.
| Érték | Description |
|---|---|
| used |
A mezőt teljes mértékben szemantikai gazdagításra használták. |
| unused |
A mezőt nem használták szemantikai gazdagításra. |
| partial |
A mezőt részben szemantikai gazdagításra használták. |
SemanticQueryRewritesResultType
A kéréshez használt lekérdezés átírásának típusa.
| Érték | Description |
|---|---|
| originalQueryOnly |
A lekérdezések átírása nem sikerült létrehozni ehhez a kéréshez. Az eredmények lekéréséhez csak az eredeti lekérdezést használták. |
SemanticSearchResultsType
A szemantikai rangsorolási kérelemhez visszaadott részleges válasz típusa.
| Érték | Description |
|---|---|
| baseResults |
Eredmény szemantikai dúsítás vagy reranking nélkül. |
| rerankedResults |
Az eredményeket a reranker-modell újraküldte, és szemantikai feliratokat is tartalmaz. Ezek nem tartalmaznak válaszokat, válaszkiemeléseket vagy feliratkiemeléseket. |
SingleVectorFieldResult
Egyetlen vektormező eredménye. Both
| Név | Típus | Description |
|---|---|---|
| searchScore |
number (double) |
A |
| vectorSimilarity |
number (double) |
A dokumentum vektorhasonlósági pontszáma. Vegye figyelembe, hogy ez a hasonlósági metrika canonikus definíciója, nem pedig a "távolság" verziója. Például koszinusz hasonlóság a koszinusz távolság helyett. |
TextResult
A lekérdezés szöveges részének BM25 vagy Klasszikus pontszáma.
| Név | Típus | Description |
|---|---|---|
| searchScore |
number (double) |
A lekérdezés szöveges részének BM25 vagy Klasszikus pontszáma. |
VectorFilterMode
Meghatározza, hogy a szűrők alkalmazása a vektoros keresés előtt vagy után történjen-e.
| Érték | Description |
|---|---|
| postFilter |
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 |
A szűrő a keresési lekérdezés előtt lesz alkalmazva. |
| strictPostFilter |
A szűrő a vektoreredmények globális top-k jelöltkészletének visszaadása után lesz alkalmazva. Ez kevesebb eredményt eredményez, mint amennyit a "k" paraméter kér. |
VectorizableImageBinaryQuery
A vektorkereséshez használandó lekérdezési paraméterek, ha egy vektorizált kép 64-es alapkódolt bináris fájlja van megadva.
| Név | Típus | Description |
|---|---|---|
| base64Image |
string |
A vektoros keresési lekérdezés végrehajtásához vektorizálandó kép 64-es kódolású binárisja. |
| exhaustive |
boolean |
Ha igaz, teljes k-legközelebbi szomszédkeresést indít el a vektorindex összes vektorában. Olyan helyzetekben hasznos, ahol a pontos egyezések kritikus fontosságúak, például az alapigazság-értékek meghatározásához. |
| fields |
string |
Gyűjtemény típusú vektormezők (Edm.Single), amely szerepel a keresett vektorban. |
| filterOverride |
string |
Az adott vektoros lekérdezésre alkalmazandó OData-szűrőkifejezés. Ha nincs definiálva szűrőkifejezés a vektor szintjén, a rendszer ehelyett a felső szintű szűrőparaméterben definiált kifejezést használja. |
| k |
integer (int32) |
Azoknak a legközelebbi szomszédoknak a száma, mint a legnépszerűbb találatok. |
| kind |
string:
image |
A lekérdezés típusa. |
| oversampling |
number (double) |
Túlmintavételi 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. |
| perDocumentVectorLimit |
integer (int32) |
Azt szabályozza, hogy hány vektor párosítható az egyes dokumentumokból egy vektoros keresési lekérdezésben. Az 1-re állítás biztosítja, hogy dokumentumonként legfeljebb egy vektor egyezzen, garantálva, hogy az eredmények különböző dokumentumokból származzanak. Ha 0-ra (korlátlanra) állítja, akkor ugyanabból a dokumentumból több releváns vektor is megfeleltethető. Az alapértelmezett érték 0. |
| threshold | VectorThreshold: |
A vektoros lekérdezésekhez használt küszöbérték. Vegye figyelembe, hogy ez csak akkor állítható be, ha minden "mező" ugyanazt a hasonlósági metrikát használja. |
| weight |
number (float) |
A vektoros lekérdezés relatív súlya a többi vektoros lekérdezéshez és/vagy a szöveges lekérdezéshez képest ugyanabban a keresési kérelemben. Ez az érték a különböző vektoros lekérdezések és/vagy a szöveges lekérdezésen keresztül lekért eredmények több rangsorolási lista eredményeinek kombinálásakor használatos. Minél nagyobb a súly, annál magasabb lesz a lekérdezésnek megfelelő dokumentumok rangsorolása. Az alapértelmezett érték 1,0, az értéknek nullánál nagyobb pozitív számnak kell lennie. |
VectorizableImageUrlQuery
A vektorkereséshez használandó lekérdezési paraméterek, ha egy vektorizálandó képértéket képviselő URL-cím van megadva.
| Név | Típus | Description |
|---|---|---|
| exhaustive |
boolean |
Ha igaz, teljes k-legközelebbi szomszédkeresést indít el a vektorindex összes vektorában. Olyan helyzetekben hasznos, ahol a pontos egyezések kritikus fontosságúak, például az alapigazság-értékek meghatározásához. |
| fields |
string |
Gyűjtemény típusú vektormezők (Edm.Single), amely szerepel a keresett vektorban. |
| filterOverride |
string |
Az adott vektoros lekérdezésre alkalmazandó OData-szűrőkifejezés. Ha nincs definiálva szűrőkifejezés a vektor szintjén, a rendszer ehelyett a felső szintű szűrőparaméterben definiált kifejezést használja. |
| k |
integer (int32) |
Azoknak a legközelebbi szomszédoknak a száma, mint a legnépszerűbb találatok. |
| kind |
string:
image |
A lekérdezés típusa. |
| oversampling |
number (double) |
Túlmintavételi 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. |
| perDocumentVectorLimit |
integer (int32) |
Azt szabályozza, hogy hány vektor párosítható az egyes dokumentumokból egy vektoros keresési lekérdezésben. Az 1-re állítás biztosítja, hogy dokumentumonként legfeljebb egy vektor egyezzen, garantálva, hogy az eredmények különböző dokumentumokból származzanak. Ha 0-ra (korlátlanra) állítja, akkor ugyanabból a dokumentumból több releváns vektor is megfeleltethető. Az alapértelmezett érték 0. |
| threshold | VectorThreshold: |
A vektoros lekérdezésekhez használt küszöbérték. Vegye figyelembe, hogy ez csak akkor állítható be, ha minden "mező" ugyanazt a hasonlósági metrikát használja. |
| url |
string |
A vektoros keresési lekérdezés végrehajtásához vektorizálandó kép URL-címe. |
| weight |
number (float) |
A vektoros lekérdezés relatív súlya a többi vektoros lekérdezéshez és/vagy a szöveges lekérdezéshez képest ugyanabban a keresési kérelemben. Ez az érték a különböző vektoros lekérdezések és/vagy a szöveges lekérdezésen keresztül lekért eredmények több rangsorolási lista eredményeinek kombinálásakor használatos. Minél nagyobb a súly, annál magasabb lesz a lekérdezésnek megfelelő dokumentumok rangsorolása. Az alapértelmezett érték 1,0, az értéknek nullánál nagyobb pozitív számnak kell lennie. |
VectorizableTextQuery
A vektorkereséshez használandó lekérdezési paraméterek, ha egy vektorizálandó szöveges érték van megadva.
| Név | Típus | Description |
|---|---|---|
| exhaustive |
boolean |
Ha igaz, teljes k-legközelebbi szomszédkeresést indít el a vektorindex összes vektorában. Olyan helyzetekben hasznos, ahol a pontos egyezések kritikus fontosságúak, például az alapigazság-értékek meghatározásához. |
| fields |
string |
Gyűjtemény típusú vektormezők (Edm.Single), amely szerepel a keresett vektorban. |
| filterOverride |
string |
Az adott vektoros lekérdezésre alkalmazandó OData-szűrőkifejezés. Ha nincs definiálva szűrőkifejezés a vektor szintjén, a rendszer ehelyett a felső szintű szűrőparaméterben definiált kifejezést használja. |
| k |
integer (int32) |
Azoknak a legközelebbi szomszédoknak a száma, mint a legnépszerűbb találatok. |
| kind |
string:
text |
A lekérdezés típusa. |
| oversampling |
number (double) |
Túlmintavételi 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. |
| perDocumentVectorLimit |
integer (int32) |
Azt szabályozza, hogy hány vektor párosítható az egyes dokumentumokból egy vektoros keresési lekérdezésben. Az 1-re állítás biztosítja, hogy dokumentumonként legfeljebb egy vektor egyezzen, garantálva, hogy az eredmények különböző dokumentumokból származzanak. Ha 0-ra (korlátlanra) állítja, akkor ugyanabból a dokumentumból több releváns vektor is megfeleltethető. Az alapértelmezett érték 0. |
| queryRewrites |
Konfigurálható úgy, hogy egy generatív modell újraírja a lekérdezést, mielőtt vektorosra küldené. |
|
| text |
string |
A vektoros keresési lekérdezés végrehajtásához vektorizálandó szöveg. |
| threshold | VectorThreshold: |
A vektoros lekérdezésekhez használt küszöbérték. Vegye figyelembe, hogy ez csak akkor állítható be, ha minden "mező" ugyanazt a hasonlósági metrikát használja. |
| weight |
number (float) |
A vektoros lekérdezés relatív súlya a többi vektoros lekérdezéshez és/vagy a szöveges lekérdezéshez képest ugyanabban a keresési kérelemben. Ez az érték a különböző vektoros lekérdezések és/vagy a szöveges lekérdezésen keresztül lekért eredmények több rangsorolási lista eredményeinek kombinálásakor használatos. Minél nagyobb a súly, annál magasabb lesz a lekérdezésnek megfelelő dokumentumok rangsorolása. Az alapértelmezett érték 1,0, az értéknek nullánál nagyobb pozitív számnak kell lennie. |
VectorizedQuery
A vektorkereséshez használandó lekérdezési paraméterek nyers vektorérték megadásakor.
| Név | Típus | Description |
|---|---|---|
| exhaustive |
boolean |
Ha igaz, teljes k-legközelebbi szomszédkeresést indít el a vektorindex összes vektorában. Olyan helyzetekben hasznos, ahol a pontos egyezések kritikus fontosságúak, például az alapigazság-értékek meghatározásához. |
| fields |
string |
Gyűjtemény típusú vektormezők (Edm.Single), amely szerepel a keresett vektorban. |
| filterOverride |
string |
Az adott vektoros lekérdezésre alkalmazandó OData-szűrőkifejezés. Ha nincs definiálva szűrőkifejezés a vektor szintjén, a rendszer ehelyett a felső szintű szűrőparaméterben definiált kifejezést használja. |
| k |
integer (int32) |
Azoknak a legközelebbi szomszédoknak a száma, mint a legnépszerűbb találatok. |
| kind |
string:
vector |
A lekérdezés típusa. |
| oversampling |
number (double) |
Túlmintavételi 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. |
| perDocumentVectorLimit |
integer (int32) |
Azt szabályozza, hogy hány vektor párosítható az egyes dokumentumokból egy vektoros keresési lekérdezésben. Az 1-re állítás biztosítja, hogy dokumentumonként legfeljebb egy vektor egyezzen, garantálva, hogy az eredmények különböző dokumentumokból származzanak. Ha 0-ra (korlátlanra) állítja, akkor ugyanabból a dokumentumból több releváns vektor is megfeleltethető. Az alapértelmezett érték 0. |
| threshold | VectorThreshold: |
A vektoros lekérdezésekhez használt küszöbérték. Vegye figyelembe, hogy ez csak akkor állítható be, ha minden "mező" ugyanazt a hasonlósági metrikát használja. |
| vector |
number[] (float) |
A keresési lekérdezés vektoros ábrázolása. |
| weight |
number (float) |
A vektoros lekérdezés relatív súlya a többi vektoros lekérdezéshez és/vagy a szöveges lekérdezéshez képest ugyanabban a keresési kérelemben. Ez az érték a különböző vektoros lekérdezések és/vagy a szöveges lekérdezésen keresztül lekért eredmények több rangsorolási lista eredményeinek kombinálásakor használatos. Minél nagyobb a súly, annál magasabb lesz a lekérdezésnek megfelelő dokumentumok rangsorolása. Az alapértelmezett érték 1,0, az értéknek nullánál nagyobb pozitív számnak kell lennie. |
VectorQueryKind
A végrehajtott vektoros lekérdezés típusa.
| Érték | Description |
|---|---|
| vector |
Vektoros lekérdezés, ahol nyers vektorérték van megadva. |
| text |
Vektoros lekérdezés, amelyben egy vektorosított szöveges értéket ad meg. |
| imageUrl |
Vektoros lekérdezés, ahol egy vektorizálandó képértéket képviselő URL-cím van megadva. |
| imageBinary |
Vektoros lekérdezés, ahol egy vektorizálandó kép 64-es kódolású bináris fájlja van megadva. |
VectorsDebugInfo
"Vektor- és hibrid keresésre jellemző hibakeresési információkat tartalmaz.")
| Név | Típus | Description |
|---|---|---|
| subscores |
A dokumentum részpontszámainak bontása a választott eredményhalmaz fúziós/kombinált módszere, például az RRF előtt. |
VectorSimilarityThreshold
A vektoros lekérdezés eredményei a vektoros hasonlóság metrikája alapján lesznek szűrve. Vegye figyelembe, hogy ez a hasonlósági metrika canonikus definíciója, nem pedig a "távolság" verziója. A küszöbérték iránya (nagyobb vagy kisebb) automatikusan lesz kiválasztva a mező által használt metrikának megfelelően.
| Név | Típus | Description |
|---|---|---|
| kind |
string:
vector |
A küszöb típusa. |
| value |
number (double) |
A küszöbérték a hasonlósági metrika értéke alapján lesz szűrve. Vegye figyelembe, hogy ez a hasonlósági metrika canonikus definíciója, nem pedig a "távolság" verziója. A küszöbérték iránya (nagyobb vagy kisebb) automatikusan lesz kiválasztva a mező által használt metrikának megfelelően. |
VectorThresholdKind
Az a fajta küszöb, amit vektorlekérdezések szűrésére használnak.
| Érték | Description |
|---|---|
| vectorSimilarity |
A vektoros lekérdezés eredményei a vektoros hasonlóság metrikája alapján lesznek szűrve. Vegye figyelembe, hogy ez a hasonlósági metrika canonikus definíciója, nem pedig a "távolság" verziója. A küszöbérték iránya (nagyobb vagy kisebb) automatikusan lesz kiválasztva a mező által használt metrikának megfelelően. |
| searchScore |
A vektoros lekérdezés eredményei a "@search.score" érték alapján szűrnek. Vegye figyelembe, hogy ez @search.score a keresési válasz részeként visszaadott. A küszöb irányát a magasabb @search.score. |