Documents - Search Get

Szolgáltatás:: Search Service

API-verzió:: 2025-09-01

Dokumentumokat keres az indexben.

GET {endpoint}/indexes('{indexName}')/docs?api-version=2025-09-01

Opcionális paraméterekkel:

GET {endpoint}/indexes('{indexName}')/docs?search={search}&$count={$count}&facet={facet}&$filter={$filter}&highlight={highlight}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&$orderby={$orderby}&queryType={queryType}&scoringParameter={scoringParameter}&scoringProfile={scoringProfile}&searchFields={searchFields}&searchMode={searchMode}&scoringStatistics={scoringStatistics}&sessionId={sessionId}&$select={$select}&$skip={$skip}&$top={$top}&api-version=2025-09-01&semanticConfiguration={semanticConfiguration}&semanticErrorHandling={semanticErrorHandling}&semanticMaxWaitInMilliseconds={semanticMaxWaitInMilliseconds}&answers={answers}&captions={captions}&semanticQuery={semanticQuery}&debug={debug}

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string	A keresési szolgáltatás végpontjának URL-címe.
indexName	path	True	string	Az index neve.
api-version	query	True	string	Ügyfél API-verziója.
$count	query		boolean	Olyan érték, amely meghatározza, hogy le kell-e kérni az eredmények teljes számát. Az alapértelmezett érték false. 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őleges.
$filter	query		string	Az OData $filter keresési lekérdezésre alkalmazandó kifejezés.
$orderby	query		string[]	Az OData listája $orderby kifejezések, amelyek alapján rendezheti az eredményeket. Minden kifejezés lehet mezőnév vagy a geo.distance() vagy a search.score() függvény hívása. Minden kifejezést követhet az asc a növekvő és a desc a csökkenő jelzés jelzésére. Az alapértelmezett sorrend növekvő sorrend. A holtversenyeket a dokumentumok meccspontszáma bontja meg. Ha nincs megadva OrderBy, az alapértelmezett rendezési sorrend csökkenő a dokumentum egyezési pontszáma szerint. Legfeljebb 32 $orderby záradék lehet.
$select	query		string[]	A lekérni kívánt mezők listája. Ha nincs megadva, a sémában lekérhetőként megjelölt összes mező szerepel.
$skip	query		integer (int32)	A kihagyandó keresési eredmények száma. Ez az érték nem lehet nagyobb 100 000-nél. Ha a dokumentumokat egymás után kell beolvasnia, de a korlátozás miatt nem tudja használni a $skip, fontolja meg a $orderby használatát egy teljesen rendezett kulcson, és inkább egy tartománylekérdezéssel $filter.
$top	query		integer (int32)	A lekérni kívánt keresési eredmények száma. Ez a $skip-vel együtt használható a keresési eredmények ügyféloldali lapozásának megvalósításához. Ha az eredmények a kiszolgálóoldali lapozás miatt csonkolódnak, a válasz tartalmaz egy folytatási jogkivonatot, amely egy másik keresési kérés kiadására használható az eredmények következő oldalához.
answers	query		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 rangú 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.
captions	query		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 rangú 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`.
debug	query		QueryDebugMode	Lehetővé tesz egy hibakereső eszközt, amely a keresési eredmények további felfedezésére használható.
facet	query		string[]	A keresési lekérdezésre alkalmazandó dimenziós kifejezések listája. Minden dimenziós kifejezés tartalmaz egy mezőnevet, amelyet opcionálisan a név:érték párok vesszővel tagolt listája követ.
highlight	query		string[]	A találatok kiemeléséhez használandó mezőnevek listája. Csak kereshető mezők használhatók a találatok kiemelésére.
highlightPostTag	query		string	A találati kiemelésekhez hozzáfűzött karakterlánccímke. A highlightPreTag paranccsal kell beállítani. Az alapértelmezett érték az </em>.
highlightPreTag	query		string	Egy karakterlánccímke, amely a csúcsfények eléréséhez van hozzáadva. A highlightPostTag paranccsal kell beállítani. Az alapértelmezett az <em>.
minimumCoverage	query		number (double)	0 és 100 közötti szám, amely azt jelzi, hogy az index hány százalékát kell lefednie a keresési lekérdezésnek ahhoz, hogy a lekérdezés sikeresként legyen jelentve. Ez a paraméter hasznos lehet a keresés rendelkezésre állásának biztosításához még az egyetlen replikával rendelkező szolgáltatások esetében is. Az alapértelmezett érték 100.
queryType	query		QueryType	A keresési lekérdezés szintaxisát meghatározó érték. 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.
scoringParameter	query		string[]	A pontozási függvényekben (például referencePointParameter) használandó paraméterértékek listája a formátum névértékei használatával. Ha például a pontozási profil egy függvényt határoz meg egy "mylocation" nevű paraméterrel, a paramétersztring a következő lesz: "mylocation--122.2,44.8" (idézőjelek nélkül).
scoringProfile	query		string	Egy pontozási profil neve, amely kiértékeli az egyező dokumentumok egyezési pontszámait az eredmények rendezése érdekében.
scoringStatistics	query		ScoringStatistics	Olyan érték, amely meghatározza, hogy a pontozási statisztikákat (például a dokumentumok gyakoriságát) globálisan kívánjuk-e kiszámítani a konzisztensebb pontozás érdekében, vagy helyileg az alacsonyabb késés érdekében.
search	query		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	query		string[]	Azon mezőnevek listája, amelyekre a teljes szöveges keresés hatókörét alkalmazni kell. Ha mezős keresést (fieldName:searchExpression) használ egy teljes Lucene-lekérdezésben, az egyes mezős keresési kifejezések mezőnevei elsőbbséget élveznek a paraméterben felsorolt mezőnevekkel szemben.
searchMode	query		SearchMode	Olyan érték, amely meghatározza, hogy a keresési kifejezések bármelyikének vagy mindegyikének egyeznie kell-e ahhoz, hogy a dokumentum egyezésnek számítson.
semanticConfiguration	query		string	A szemantikai konfiguráció neve, amely felsorolja, hogy mely mezőket kell használni a szemantikai rangsoroláshoz, a feliratokhoz, a kiemelésekhez és a válaszokhoz
semanticErrorHandling	query		SemanticErrorMode	Lehetővé teszi a felhasználó számára, hogy eldöntse, hogy a szemantikai hívás teljesen meghiúsuljon-e, vagy részleges eredményeket adjon vissza (alapértelmezett).
semanticMaxWaitInMilliseconds	query		integer (int32) minimum: 700	Lehetővé teszi a felhasználó számára, hogy felső korlátot állítson be a szemantikai bővítés feldolgozásának befejezéséhez szükséges időhöz, mielőtt a kérés meghiúsul.
semanticQuery	query		string	Lehetővé teszi egy külön keresési lekérdezés beállítását, amely kizárólag szemantikai átrangsoroláshoz, szemantikai feliratokhoz és szemantikai válaszokhoz lesz használva. Olyan forgatókönyvek esetén hasznos, ahol különböző lekérdezéseket kell használni az alap lekérési és rangsorolási fázisa, valamint az L2 szemantikai fázis között.
sessionId	query		string	A ragadós munkamenet létrehozásához használható érték, amely segíthet konzisztensebb eredmények elérésében. Ha ugyanazt a sessionId használja, a rendszer a lehető legnagyobb erőfeszítést teszi ugyanazon replikakészlet megcélzására. Ügyeljen arra, hogy ugyanazon munkamenet-azonosító értékek ismételt újrafelhasználása megzavarhatja a kérések terheléselosztását a replikák között, és hátrányosan befolyásolhatja a keresési szolgáltatás teljesítményét. A sessionId értékként használt érték nem kezdődhet "_" karakterrel.

Kérelem fejléce

Name	Kötelező	Típus	Description
x-ms-client-request-id		string (uuid)	A hibakeresési kérelemmel küldött nyomkövetési azonosító.

Válaszok

Name	Típus	Description
200 OK	SearchDocumentsResult	A keresési feltételeknek megfelelő dokumentumokat tartalmazó válasz.
Other Status Codes	SearchDocumentsResult	A keresési feltételeknek megfelelő részleges dokumentumokat tartalmazó válasz.
Other Status Codes	ErrorResponse	Hibaválasz.

Példák

SearchIndexSearchDocumentsGet

SearchIndexSearchDocumentsSemanticGet

SearchIndexSearchDocumentsGet

Mintakérelem

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs?search=nice hotels&$count=True&facet=category,count:10,sort:count&$filter=rating gt 10&highlight=title&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&$orderby=search.score() desc,rating desc&queryType=simple&scoringProfile=sp&searchFields=title,description&searchMode=any&scoringStatistics=global&sessionId=mysessionid&$select=docId,title,description&$skip=100&$top=10&api-version=2025-09-01

Mintaválasz

Állapotkód:: 200

{
  "@odata.count": 25,
  "@search.coverage": 80,
  "@search.facets": {
    "category": [
      {
        "count": 1,
        "value": "Economy"
      },
      {
        "count": 1,
        "value": "Luxury"
      }
    ]
  },
  "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"
    }
  ]
}

Állapotkód:: 206

{
  "@odata.count": 25,
  "@search.coverage": 80,
  "@search.facets": {
    "category": [
      {
        "count": 1,
        "value": "Economy"
      },
      {
        "count": 1,
        "value": "Luxury"
      }
    ]
  },
  "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"
    }
  ]
}

SearchIndexSearchDocumentsSemanticGet

Mintakérelem

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs?search=how do clouds form&$count=True&highlightPostTag=</em>&highlightPreTag=<em>&queryType=semantic&api-version=2025-09-01&semanticConfiguration=my-semantic-config&semanticErrorHandling=partial&semanticMaxWaitInMilliseconds=780&answers=extractive|count-3&captions=extractive|highlight-true&semanticQuery={semanticQuery}

Mintaválasz

Állapotkód:: 200

{
  "@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
    }
  ],
  "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"
      ]
    }
  ]
}

Állapotkód:: 206

{
  "@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
    }
  ],
  "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"
      ]
    }
  ]
}

Definíciók

Name	Description
AnswerResult	A válasz egy szöveges rész, amelyet a lekérdezésnek megfelelő legrelevánsabb dokumentumok tartalmából nyertek ki. A válaszok a legjobb keresési eredményekből származnak. A válaszjelölteket pontozzák, és kiválasztják a legjobb válaszokat.
CaptionResult	A feliratok a dokumentum legreprezentatívabb részei a keresési lekérdezéshez képest. Gyakran használják dokumentum-összefoglalóként. A feliratokat csak a következő típusú `semantic`lekérdezések esetén adja vissza a rendszer.
DocumentDebugInfo	Hibakeresési információkat tartalmaz, amelyek felhasználhatók a keresési eredmények további feltárására.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
QueryAnswerType	Olyan érték, amely meghatározza, hogy a válaszokat vissza kell-e adni a keresési válasz részeként.
QueryCaptionType	Olyan érték, amely meghatározza, hogy a feliratokat vissza kell-e adni a keresési válasz részeként.
QueryDebugMode	Lehetővé tesz egy hibakereső eszközt, amely a keresési eredmények további felfedezésére használható.
QueryResultDocumentSubscores	A dokumentum keresési lekérdezésének szöveges és vektoros lekérdezési összetevői közötti részpontszámok lebontása. Minden vektoros lekérdezés külön objektumként jelenik meg a fogadás sorrendjében.
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.
RawVectorQuery	A vektoros kereséshez használandó lekérdezési paraméterek, ha nyers vektorérték van megadva.
ScoringStatistics	Olyan érték, amely meghatározza, hogy a pontozási statisztikákat (például a dokumentumok gyakoriságát) globálisan kívánjuk-e kiszámítani 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.
SearchDocumentsResult	Indexből származó keresési eredményeket tartalmazó válasz.
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.
SearchRequest	Paraméterek szűréshez, rendezéshez, dimenziózáshoz, lapozáshoz és egyéb keresési lekérdezési viselkedésekhez.
SearchResult	Keresési lekérdezés által talált dokumentumot és a kapcsolódó metaadatokat tartalmaz.
SemanticErrorMode	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.
SemanticErrorReason	Az ok, amiért a rendszer részleges választ adott vissza egy szemantikai rangsorolási kérelemre.
SemanticSearchResultsType	A szemantikai rangsorolási kérelemhez visszaadott részleges válasz típusa.
SingleVectorFieldResult	Egyetlen vektormező eredménye. Mindkettő @search.score és vektorhasonlósági értékeket ad vissza. A vektor hasonlóságát egy egyenlet köti össze @search.score .
TextResult	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.
VectorizableTextQuery	A vektoros kereséshez használandó lekérdezési paraméterek, ha vektorizálni kívánt szöveges érték van megadva.
VectorQueryKind	A végrehajtott vektoros lekérdezés típusa.
VectorsDebugInfo

AnswerResult

Tárgy

A válasz egy szöveges rész, amelyet a lekérdezésnek megfelelő legrelevánsabb dokumentumok tartalmából nyertek ki. A válaszok a legjobb keresési eredményekből származnak. A válaszjelölteket pontozzák, és kiválasztják a legjobb válaszokat.

Name	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	A dokumentum kulcsa, amelyből a választ kivették.
score	number (double)	A pontszám értéke azt jelzi, hogy a válasz mennyire releváns a lekérdezés szempontjából a lekérdezéshez visszaadott többi válaszhoz képest.
text	string	A dokumentum tartalmából kivont szövegrész válaszként.

CaptionResult

Tárgy

A feliratok a dokumentum legreprezentatívabb részei a keresési lekérdezéshez képest. Gyakran használják dokumentum-összefoglalóként. A feliratokat csak a következő típusú semanticlekérdezések esetén adja vissza a rendszer.

Name	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ész.

DocumentDebugInfo

Tárgy

Hibakeresési információkat tartalmaz, amelyek felhasználhatók a keresési eredmények további feltárására.

Name	Típus	Description
vectors	VectorsDebugInfo	A vektoros és hibrid keresésre jellemző hibakeresési információkat tartalmaz.

ErrorAdditionalInfo

Tárgy

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Tárgy

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Tárgy

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

QueryAnswerType

Felsorolás

Olyan érték, amely meghatározza, hogy a válaszokat vissza kell-e adni a keresési válasz részeként.

Érték	Description
none	Ne adja vissza a lekérdezésre adott válaszokat.
extractive	Kivonja a válaszjelölteket a természetes nyelven megfogalmazott kérdésre adott válaszként visszaadott dokumentumok tartalmából.

QueryCaptionType

Felsorolás

Olyan érték, amely meghatározza, hogy a feliratokat vissza kell-e adni a keresési válasz részeként.

Érték	Description
none	Ne adjon vissza feliratokat a lekérdezéshez.
extractive	Kinyeri a keresési lekérdezés szempontjából releváns részeket tartalmazó feliratokat a megfelelő dokumentumokból.

QueryDebugMode

Felsorolás

Lehetővé tesz egy hibakereső eszközt, amely a keresési eredmények további felfedezésére használható.

Érték	Description
disabled	A rendszer nem ad vissza lekérdezési hibakeresési információkat.
vector	Lehetővé teszi a felhasználó számára, hogy tovább vizsgálja a hibrid és vektoros lekérdezési eredményeket.

QueryResultDocumentSubscores

Tárgy

A dokumentum keresési lekérdezésének szöveges és vektoros lekérdezési összetevői közötti részpontszámok lebontása. Minden vektoros lekérdezés külön objektumként jelenik meg a fogadás sorrendjében.

Name	Típus	Description
documentBoost	number (double)	A lekérdezés szöveges részének BM25 vagy klasszikus pontszáma.
text	TextResult	A lekérdezés szöveges részének BM25 vagy klasszikus pontszáma.
vectors	<string, SingleVectorFieldResult>	Az egyes vektorlekérdezések vektorhasonlósága és @search.score értékei.

QueryType

Felsorolás

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.

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

RawVectorQuery

Tárgy

A vektoros kereséshez használandó lekérdezési paraméterek, ha nyers vektorérték van megadva.

Name	Típus	Description
exhaustive	boolean	Ha igaz, kimerítő k-legközelebbi szomszéd keresést indít el a vektorindexen belüli összes vektoron. Hasznos olyan forgatókönyvekhez, ahol a pontos egyezések kritikusak, például az alapigazság-értékek meghatározása.
fields	string	Gyűjtemény(Edm.Single) típusú vektormezők, amelyeket fel kell venni a keresett vektorba.
k	integer (int32)	A legközelebbi szomszédok száma, akik csúcstalálatként térnek vissza.
kind	string: vector	A végrehajtott vektoros 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" igaz. Ez a paraméter csak akkor engedélyezett, ha tömörítési módszert használ az alapul szolgáló vektormezőn.
vector	number[] (float)	A keresési lekérdezés vektoros ábrázolása.
weight	number (float)	A vektoros lekérdezés relatív súlyozása más vektoros lekérdezéshez és/vagy ugyanazon keresési kérelemen belüli szöveges lekérdezéshez képest. Ez az érték a különböző vektoros lekérdezések által előállított több rangsorlista és/vagy a szöveges lekérdezéssel lekért eredmények kombinálásakor használatos. Minél nagyobb a súly, annál magasabbak lesznek a lekérdezésnek megfelelő dokumentumok a végső rangsorban. Az alapértelmezett érték 1,0, és az értéknek nullánál nagyobb pozitív számnak kell lennie.

ScoringStatistics

Felsorolás

Olyan érték, amely meghatározza, hogy a pontozási statisztikákat (például a dokumentumok gyakoriságát) globálisan kívánjuk-e kiszámítani 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

Tárgy

Indexből származó keresési eredményeket tartalmazó válasz.

Name	Típus	Description
@odata.count	integer (int64)	A keresési művelet által talált eredmények teljes száma, vagy null, ha a számlálást nem kérték. 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	AnswerResult[]	A keresési művelet válaszai lekérdezik a lekérdezés eredményeit; Null, ha az Answers lekérdezési paraméter nincs megadva, vagy nincs beállítva.
@search.coverage	number (double)	A lekérdezésben szereplő index százalékos arányát jelző érték, vagy null, ha a kérelemben nem volt megadva minimumCoverage.
@search.facets	object	A keresési művelet dimenziós lekérdezési eredményei, amelyek gyűjtők gyűjteményeként vannak rendezve az egyes dimenziós mezőkhöz; null, ha a lekérdezés nem tartalmazott dimenziós kifejezéseket.
@search.nextPageParameters	SearchRequest	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 @odata.nextLink egy másik POST keresési kérés megfogalmazásához használhatja a keresési válasz következő részének lekéréséhez.
@search.semanticPartialResponseReason	SemanticErrorReason	Az ok, amiért a rendszer részleges választ adott vissza egy szemantikai rangsorolási kérelemre.
@search.semanticPartialResponseType	SemanticSearchResultsType	A szemantikai rangsorolási kérelemhez visszaadott részleges válasz típusa.
value	SearchResult[]	A lekérdezés által visszaadott eredmények sorrendje.

SearchMode

Felsorolás

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

Tárgy

Paraméterek szűréshez, rendezéshez, dimenziózáshoz, lapozáshoz és egyéb keresési lekérdezési viselkedésekhez.

Name	Típus	Description
answers	QueryAnswerType	Olyan érték, amely meghatározza, hogy a válaszokat vissza kell-e adni a keresési válasz részeként.
captions	QueryCaptionType	Olyan érték, amely meghatározza, hogy a feliratokat vissza kell-e adni a keresési válasz részeként.
count	boolean	Olyan érték, amely meghatározza, hogy le kell-e kérni az eredmények teljes számát. Az alapértelmezett érték false. 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őleges.
debug	QueryDebugMode	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ó dimenziós kifejezések listája. Minden dimenziós kifejezé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 keresési lekérdezésre alkalmazandó kifejezés.
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ére.
highlightPostTag	string	A találati kiemelésekhez hozzáfűzött karakterlánccímke. A highlightPreTag paranccsal kell beállítani. Az alapértelmezett érték az </em>.
highlightPreTag	string	Egy karakterlánccímke, amely a csúcsfények eléréséhez van hozzáadva. A highlightPostTag paranccsal kell beállítani. Az alapértelmezett az <em>.
minimumCoverage	number (double)	0 és 100 közötti szám, amely azt jelzi, hogy az index hány százalékát kell lefednie a keresési lekérdezésnek ahhoz, hogy a lekérdezés sikeresként legyen jelentve. Ez a paraméter hasznos lehet a keresés rendelkezésre állásának biztosításához még az egyetlen replikával rendelkező szolgáltatások esetében is. Az alapértelmezett érték 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 a növekvő vagy a desc a csökkenő jelzés jelzésére. Az alapértelmezett sorrend növekvő sorrend. A holtversenyeket a dokumentumok meccspontszáma bontja meg. Ha nincs megadva $orderby, az alapértelmezett rendezési sorrend csökkenő a dokumentum egyezési pontszáma szerint. Legfeljebb 32 $orderby záradék lehet.
queryType	QueryType	A keresési lekérdezés szintaxisát meghatározó érték. 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.
scoringParameters	string[]	A pontozási függvényekben (például referencePointParameter) használandó paraméterértékek listája a formátum névértékei használatával. Ha például a pontozási profil egy függvényt határoz meg egy "mylocation" nevű paraméterrel, a paramétersztring a következő lesz: "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ési pontszámait az eredmények rendezése érdekében.
scoringStatistics	ScoringStatistics	Olyan érték, amely meghatározza, hogy a pontozási statisztikákat (például a dokumentumok gyakoriságát) globálisan kívánjuk-e kiszámítani 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 mezőnevek vesszővel tagolt listája, amelyre a teljes szöveges keresés hatókörét ki kell terjeszteni. Ha mezős keresést (fieldName:searchExpression) használ egy teljes Lucene-lekérdezésben, az egyes mezős keresési kifejezések mezőnevei elsőbbséget élveznek a paraméterben felsorolt mezőnevekkel szemben.
searchMode	SearchMode	Olyan érték, amely meghatározza, hogy a keresési kifejezések bármelyikének vagy mindegyikének egyeznie kell-e ahhoz, hogy a dokumentum egyezésnek számítson.
select	string	A lekérni kívánt mezők vesszővel tagolt listája. Ha nincs megadva, a sémában lekérhetőként megjelölt összes mező szerepel.
semanticConfiguration	string	A szemantikai típusú lekérdezések dokumentumainak feldolgozásakor használt szemantikai konfiguráció neve.
semanticErrorHandling	SemanticErrorMode	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.
semanticMaxWaitInMilliseconds	integer (int32) minimum: 700	Lehetővé teszi a felhasználó számára, hogy felső korlátot állítson be a szemantikai bővítés feldolgozásának 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 átrangsoroláshoz, szemantikai feliratokhoz és szemantikai válaszokhoz lesz használva. Olyan forgatókönyvek esetén hasznos, ahol különböző lekérdezéseket kell használni az alap lekérési és rangsorolási fázisa, valamint 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. Ha ugyanazt a sessionId használja, a rendszer a lehető legnagyobb erőfeszítést teszi ugyanazon replikakészlet megcélzására. Ügyeljen arra, hogy ugyanazon munkamenet-azonosító értékek ismételt újrafelhasználása megzavarhatja a kérések terheléselosztását a replikák között, és hátrányosan befolyásolhatja a keresési szolgáltatás teljesítményét. A sessionId értékké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 e 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 helyette egy tartománylekérdezéssel.
top	integer (int32)	A lekérni kívánt keresési eredmények száma. Ez a $skip-vel együtt használható a keresési eredmények ügyféloldali lapozásának megvalósításához. Ha az eredmények a kiszolgálóoldali lapozás miatt csonkolódnak, a válasz tartalmaz egy folytatási jogkivonatot, amely egy másik keresési kérés kiadására használható az eredmények következő oldalához.
vectorFilterMode	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[]: RawVectorQuery[] VectorizableTextQuery[]	A vektoros és hibrid keresési lekérdezések lekérdezési paraméterei.

SearchResult

Tárgy

Keresési lekérdezés által talált dokumentumot és a kapcsolódó metaadatokat tartalmaz.

Name	Típus	Description
@search.captions	CaptionResult[]	A feliratok a dokumentum legreprezentatívabb részei a keresési lekérdezéshez képest. Gyakran használják dokumentum-összefoglalóként. A feliratok csak a "szemantikai" típusú lekérdezések esetén lesznek visszaadva.
@search.documentDebugInfo	DocumentDebugInfo	Hibakeresési információkat tartalmaz, amelyek felhasználhatók a keresési eredmények további feltárására.
@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ények a RerankerScore/RerankerBoostedScore alapján vannak rendezve a szemantikai konfiguráció useScoringProfileBoostedRanking alapján. A RerankerBoostedScore csak a "szemantikai" típusú lekérdezések esetén lesz visszaadva
@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.

SemanticErrorMode

Felsorolás

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.

Érték	Description
partial	Ha a szemantikai feldolgozás sikertelen, a részleges eredmények továbbra is visszaadódnak. A részleges eredmények meghatározása attól függ, hogy melyik szemantikai lépés hibásodott meg, és mi volt a kudarc oka.
fail	Ha a szemantikai feldolgozási lépés során kivétel történik, a lekérdezés sikertelen lesz, és a hibától függően a megfelelő HTTP-kódot adja vissza.

SemanticErrorReason

Felsorolás

Az ok, amiért a rendszer részleges választ adott vissza egy szemantikai rangsorolási kérelemre.

Érték	Description
maxWaitExceeded	Ha `semanticMaxWaitInMilliseconds` be volt állítva, és a szemantikai feldolgozás időtartama meghaladta ezt az értéket. Csak az alaperedményeket adta vissza.
capacityOverloaded	A kérést elfojtották. Csak az alaperedményeket adta vissza.
transient	A szemantikai folyamat legalább egy lépése meghiúsult.

SemanticSearchResultsType

Felsorolás

A szemantikai rangsorolási kérelemhez visszaadott részleges válasz típusa.

Érték	Description
baseResults	Az eredmények szemantikai bővítés vagy átrangsorolás nélkül.
rerankedResults	Az eredményeket az újrarangsoroló modellel rangsoroltuk, és szemantikai feliratokat tartalmaznak. Nem tartalmaznak válaszokat, válaszkiemeléseket vagy feliratkiemeléseket.

SingleVectorFieldResult

Tárgy

Egyetlen vektormező eredménye. Mindkettő @search.score és vektorhasonlósági értékeket ad vissza. A vektor hasonlóságát egy egyenlet köti össze @search.score .

Name	Típus	Description
searchScore	number (double)	A @search.score vektor hasonlósági pontszámából kiszámított érték. Ez az a pontszám, amely egy tiszta egymezős egyvektoros lekérdezésben látható.
vectorSimilarity	number (double)	A dokumentum vektorhasonlósági pontszáma. Vegye figyelembe, hogy ez a hasonlósági metrika kanonikus definíciója, nem pedig a "távolság" verzió. Például koszinusz hasonlóság a koszinusz távolság helyett.

TextResult

Tárgy

A lekérdezés szöveges részének BM25 vagy klasszikus pontszáma.

Name	Típus	Description
searchScore	number (double)	A lekérdezés szöveges részének BM25 vagy klasszikus pontszáma.

VectorFilterMode

Felsorolás

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 jelölt vektoros eredmények visszaadása után kerül alkalmazásra. A szűrő szelektivitásától függően ez kevesebb eredményt eredményezhet, mint amennyit a "k" paraméter kér.
preFilter	A szűrő a keresési lekérdezés előtt lesz alkalmazva.

VectorizableTextQuery

Tárgy

A vektoros kereséshez használandó lekérdezési paraméterek, ha vektorizálni kívánt szöveges érték van megadva.

Name	Típus	Description
exhaustive	boolean	Ha igaz, kimerítő k-legközelebbi szomszéd keresést indít el a vektorindexen belüli összes vektoron. Hasznos olyan forgatókönyvekhez, ahol a pontos egyezések kritikusak, például az alapigazság-értékek meghatározása.
fields	string	Gyűjtemény(Edm.Single) típusú vektormezők, amelyeket fel kell venni a keresett vektorba.
k	integer (int32)	A legközelebbi szomszédok száma, akik csúcstalálatként térnek vissza.
kind	string: text	A végrehajtott vektoros 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" igaz. Ez a paraméter csak akkor engedélyezett, ha tömörítési módszert használ az alapul szolgáló vektormezőn.
text	string	A vektoros keresési lekérdezés végrehajtásához vektorizálandó szöveg.
weight	number (float)	A vektoros lekérdezés relatív súlyozása más vektoros lekérdezéshez és/vagy ugyanazon keresési kérelemen belüli szöveges lekérdezéshez képest. Ez az érték a különböző vektoros lekérdezések által előállított több rangsorlista és/vagy a szöveges lekérdezéssel lekért eredmények kombinálásakor használatos. Minél nagyobb a súly, annál magasabbak lesznek a lekérdezésnek megfelelő dokumentumok a végső rangsorban. Az alapértelmezett érték 1,0, és az értéknek nullánál nagyobb pozitív számnak kell lennie.

VectorQueryKind

Felsorolás

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, ahol vektorizálni kívánt szöveges érték van megadva.

VectorsDebugInfo

Tárgy

Name	Típus	Description
subscores	QueryResultDocumentSubscores	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.