Documents - Search Get

Szolgáltatás:: Search Service

API-verzió:: 2025-03-01-preview

Dokumentumokat keres az indexben.

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

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-03-01-preview&semanticConfiguration={semanticConfiguration}&semanticErrorHandling={semanticErrorHandling}&semanticMaxWaitInMilliseconds={semanticMaxWaitInMilliseconds}&answers={answers}&captions={captions}&semanticQuery={semanticQuery}&queryRewrites={queryRewrites}&debug={debug}&queryLanguage={queryLanguage}&speller={speller}&semanticFields={semanticFields}

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string	A keresési szolgáltatás végponti URL-címe.
indexName	path	True	string	Az index neve.
api-version	query	True	string	Ügyfél API-verziója.
$count	query		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.
$filter	query		string	Az OData $filter kifejezés, amely a keresési lekérdezésre vonatkozik.
$orderby	query		string[]	Az OData $orderby kifejezések listája, 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ő, a desc pedig csökkenő értéket 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.
$select	query		string[]	A lekérendő mezők listája. Ha nincs meghatározva, a rendszer a sémában lekérdezhetőként megjelölt összes mezőt tartalmazza.
$skip	query		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 $skip, fontolja meg a $orderby egy teljesen rendezett kulcson való használatát, és $filter inkább egy tartomány-lekérdezéssel.
$top	query		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.
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 rangsorolt dokumentumok kulcsszakaszaiból kinyert válaszokat adja vissza. A visszaadott válaszok száma úgy konfigurálható, hogy hozzáfűzi a cső karakterét `\|`, majd a válaszparaméter értéke után a `count-<number of answers>` beállítást, például `extractive\|count-3`. Az alapértelmezett szám 1. A megbízhatósági küszöbértéket úgy lehet konfigurálni, hogy hozzáfűzi a cső karakterét `\|`, majd a válaszparaméter értéke után a `threshold-<confidence threshold>` beállítást, 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".
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 rangsorolt dokumentumok kulcsszakaszaiból kinyert feliratokat adja vissza. Ha a feliratok `extractive`értékre van állítva, a kiemelés alapértelmezés szerint engedélyezve van, és úgy konfigurálható, hogy hozzáfűzi a pipajelet `\|`, majd a `highlight-<true/false>` beállítást, 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.
debug	query		QueryDebugMode	Lehetővé teszi a keresési eredmények további feltárására használható hibakereső eszközt.
facet	query		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.
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éhez.
highlightPostTag	query		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	query		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>.
minimumCoverage	query		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.
queryLanguage	query		QueryLanguage	A lekérdezés nyelve.
queryRewrites	query		QueryRewritesType	Ha a QueryRewrites `generative`értékre van állítva, a rendszer elküldi a lekérdezési feltételeket egy generált modellnek, 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 darabszám konfigurálható úgy, hogy hozzáfűzi a pipajelet `\|`, majd a `count-<number of rewrites>` beállítást, például `generative\|count-3`. Alapértelmezett érték: `None`. Ez a paraméter csak akkor érvényes, ha a lekérdezés típusa `semantic`.
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 "full" értéket, ha a lekérdezés a Lucene-lekérdezés szintaxisát használja.
scoringParameter	query		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	query		string	Egy pontozási profil neve, amely kiértékeli az egyező dokumentumok egyező pontszámait az eredmények rendezése érdekében.
scoringStatistics	query		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.
search	query		string	Teljes szöveges keresési lekérdezési kifejezés; Használja a "*" paramétert, vagy hagyja ki ezt a paramétert az összes dokumentumnak való egyeztetéshez.
searchFields	query		string[]	Azoknak a mezőneveknek a listája, amelyekre a teljes szöveges keresés hatóköre kiterjed. Ha mezőalapú keresést (fieldName:searchExpression) használ egy teljes Lucene-lekérdezésben, az egyes mezőalapú keresési kifejezések mezőnevei elsőbbséget élveznek a paraméterben felsorolt mezőneveknél.
searchMode	query		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.
semanticConfiguration	query		string	Annak a szemantikai konfigurációnak a neve, amely felsorolja, hogy mely mezőket kell használni a szemantikai rangsoroláshoz, a feliratokhoz, a kiemelésekhez és a válaszokhoz
semanticErrorHandling	query		SemanticErrorMode	Lehetővé teszi a felhasználó számára, hogy eldöntse, hogy egy szemantikai hívásnak teljesen sikertelennek kell-e lennie, vagy részleges eredményeket ad vissza (alapértelmezett).
semanticFields	query		string[]	A szemantikai rangsoroláshoz használt mezőnevek listája.
semanticMaxWaitInMilliseconds	query		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	query		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	query		string	Egy ragadós munkamenet létrehozásához használandó érték, amely segíthet a konzisztensebb eredmények eléréséhez. Amíg ugyanazt a munkamenet-azonosítót használja, a rendszer minden tőle telhetőt megtesz annak érdekében, hogy ugyanazt a replikakészletet célozza meg. Ügyeljen arra, hogy 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.
speller	query		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.

Kérelem fejléce

Name	Kötelező	Típus	Description
x-ms-client-request-id		string (uuid)	A kéréssel együtt küldött nyomkövetési azonosító, amely segít a hibakeresésben.

Válaszok

Name	Típus	Description
200 OK	SearchDocumentsResult	A keresési feltételeknek megfelelő 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-03-01-preview&speller={speller}

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"
    }
  ]
}

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-03-01-preview&semanticConfiguration=my-semantic-config&semanticErrorHandling=partial&semanticMaxWaitInMilliseconds=780&answers=extractive|count-3&captions=extractive|highlight-true&semanticQuery={semanticQuery}&semanticFields={semanticFields}

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"
      ]
    }
  ]
}

Definíciók

Name	Description
AnswerResult	A válasz a lekérdezésnek leginkább megfelelő dokumentumok tartalmából kinyert szövegrészlet. A válaszok a leggyakoribb keresési eredményekből nyerhetők ki. A válaszjelöltek pontszámot kapnak, és a legjobb válaszok lesznek kiválasztva.
CaptionResult	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 `semantic`típusú lekérdezésekhez ad vissza feliratokat.
DebugInfo	Olyan hibakeresési információkat tartalmaz, amelyek a keresési eredmények további vizsgálatához használhatók.
DocumentDebugInfo	Olyan hibakeresési információkat tartalmaz, amelyek a keresési eredmények további vizsgálatához használhatók.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
HybridCountAndFacetMode	Meghatározza, hogy a darabszám és az aspektusok 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".
HybridSearch	TA lekérdezési paraméterek a hibrid keresési viselkedés konfigurálásához.
QueryAnswerType	Egy érték, amely meghatározza, hogy a válaszokat a keresési válasz részeként kell-e visszaadni.
QueryCaptionType	Egy érték, amely meghatározza, hogy a keresési válasz részeként vissza kell-e adni a feliratokat.
QueryDebugMode	Lehetővé teszi a keresési eredmények további feltárására használható hibakereső eszközt. Egyszerre több hibakeresési módot is engedélyezhet, ha \| karakter, például: szemantic\|queryRewrites.
QueryLanguage	A lekérdezés nyelve.
QueryResultDocumentRerankerInput	A szemantikai dúsítási folyamatba küldött nyers összefűzött sztringek.
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
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.
QueryRewritesDebugInfo	Olyan hibakeresési információkat tartalmaz, amelyek a lekérdezés újraírására vonatkoznak.
QueryRewritesType	Egy érték, amely meghatározza, hogy létre kell-e hozni a lekérdezés újraírását a keresési lekérdezés kibővítéséhez.
QueryRewritesValuesDebugInfo	Olyan hibakeresési információkat tartalmaz, amelyek a lekérdezés újraírására vonatkoznak.
QuerySpellerType	Egy érték, amely meghatározta az egyes keresési lekérdezési kifejezések helyesírás-kijavításához használandó helyesírás-ellenőrző típusát.
QueryType	A keresési lekérdezés szintaxisát adja meg. Az alapértelmezett érték az "egyszerű". Használja a "full" értéket, ha a lekérdezés a Lucene lekérdezési szintaxist és a szemantikai értéket használja, ha nincs szükség lekérdezési szintaxisra.
RawVectorQuery	A vektorkereséshez használandó lekérdezési paraméterek nyers vektorérték megadásakor.
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 "global" használatával globálisan összesítheti a pontozási statisztikákat a pontozás előtt. A globális pontozási statisztikák használata növelheti a keresési lekérdezések késését.
SearchDocumentsResult	Egy index keresési eredményeit tartalmazó válasz.
SearchMode	Megadja, 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.
SearchRequest	Szűrési, rendezési, arcfelismerési, lapozási és egyéb keresési lekérdezési viselkedés paraméterei.
SearchResult	Egy keresési lekérdezés által talált dokumentumot tartalmaz, valamint a kapcsolódó metaadatokat.
SearchScoreThreshold	A vektoros lekérdezés eredményei a "@search.score" érték alapján szűrnek. Vegye figyelembe, hogy ez a keresési válasz részeként visszaadott @search.score. A küszöbérték iránya magasabb @search.scorelesz kiválasztva.
SemanticDebugInfo
SemanticErrorMode	Lehetővé teszi a felhasználó számára, hogy eldöntse, hogy egy szemantikai hívásnak teljesen sikertelennek kell-e lennie (alapértelmezett/aktuális viselkedés), vagy részleges eredményeket ad vissza.
SemanticErrorReason	Annak oka, hogy a rendszer részleges választ adott a szemantikai rangsorolási kérelemre.
SemanticFieldState	A mező felhasználási módja a szemantikai dúsítási folyamathoz (teljesen használva, részben használva vagy nem használva)
SemanticQueryRewritesResultType	A kéréshez használt lekérdezés-átírás típusa.
SemanticSearchResultsType	A szemantikai rangsorolási kéréshez visszaadott részleges válasz típusa.
SingleVectorFieldResult	Egyetlen vektormező eredménye. A @search.score és a vektorok hasonlósági értékei is vissza lesznek adva. A vektorok hasonlósága egy egyenlet @search.score függ össze.
TextResult	A lekérdezés szöveges részének BM25 vagy Klasszikus pontszáma.
VectorFilterMode	Meghatározza, hogy a szűrőket a vektorkeresés előtt vagy után alkalmazza-e a rendszer.
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.
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.
VectorizableTextQuery	A vektorkereséshez használandó lekérdezési paraméterek, ha egy vektorizálandó szöveges érték van megadva.
VectorQueryKind	A végrehajtott vektoros lekérdezés típusa.
VectorsDebugInfo
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.
VectorThresholdKind	A végrehajtott vektoros lekérdezés típusa.

AnswerResult

Tárgy

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.

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

CaptionResult

Tárgy

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.

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észlet.

DebugInfo

Tárgy

Olyan hibakeresési információkat tartalmaz, amelyek a keresési eredmények további vizsgálatához használhatók.

Name	Típus	Description
queryRewrites	QueryRewritesDebugInfo	Olyan hibakeresési információkat tartalmaz, amelyek a lekérdezés újraírására vonatkoznak.

DocumentDebugInfo

Tárgy

Olyan hibakeresési információkat tartalmaz, amelyek a keresési eredmények további vizsgálatához használhatók.

Name	Típus	Description
semantic	SemanticDebugInfo	A szemantikai rangsorolási kérelmekre vonatkozó hibakeresési információkat tartalmaz.
vectors	VectorsDebugInfo	A vektorokra és a hibrid keresésre vonatkozó 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.

HybridCountAndFacetMode

Felsorolás

Meghatározza, hogy a darabszám és az aspektusok 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 a "maxTextRecallSize" beolvasási ablakban egyeztetett dokumentumokat tartalmazza a "darabszám" és a "aspektusok" kiszámításakor.
countAllResults	A "count" és a "facets" számítása során a keresési lekérdezés által egyeztetett összes dokumentumot belefoglalja, függetlenül attól, hogy ezek a dokumentumok a "maxTextRecallSize" lekérési ablakban találhatók-e.

HybridSearch

Tárgy

TA lekérdezési paraméterek a hibrid keresési viselkedés konfigurálásához.

Name	Típus	Description
countAndFacetMode	HybridCountAndFacetMode	Meghatározza, hogy a darabszám és az aspektusok 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érendő dokumentumok maximális számát. Ezeket a dokumentumokat a vektoros lekérdezéseknek megfelelő dokumentumokkal kombináljuk, hogy egyetlen végső találatlistát állítsunk elő. Ha nagyobb maxTextRecallSize értéket választ, több dokumentumon keresztüli beolvasást és lapozást tesz lehetővé (a felső és kihagyási paraméterek használatával), magasabb erőforrás-kihasználtság és nagyobb késés árán. Az értéknek 1 és 10 000 között kell lennie. Az alapértelmezett érték 1000.

QueryAnswerType

Felsorolás

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

Érték	Description
none	Ne adja vissza a lekérdezésre vonatkozó 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.

QueryCaptionType

Felsorolás

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

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

QueryDebugMode

Felsorolás

Lehetővé teszi a keresési eredmények további feltárására használható hibakereső eszközt. Egyszerre több hibakeresési módot is engedélyezhet, ha | karakter, például: szemantic|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.
all	Kapcsolja be az összes hibakeresési lehetőséget.

QueryLanguage

Felsorolás

A lekérdezés nyelve.

Érték	Description
none	Nincs megadva lekérdezési nyelv.
en-us	Az angol (Egyesült Államok) nyelvi értékének lekérdezése.
en-gb	Az angol (Nagy-Britannia) nyelvértékének lekérdezése.
en-in	Angol (India) nyelvi értékének lekérdezése.
en-ca	Az angol (Kanada) nyelvi értékének lekérdezése.
en-au	Angol (Ausztrália) nyelvi értékének lekérdezése.
fr-fr	A francia (Franciaország) nyelvi értékének lekérdezése.
fr-ca	A francia (Kanada) nyelvértékének lekérdezése.
de-de	A német (Németország) nyelvi értékének lekérdezése.
es-es	A spanyol (Spanyolország) lekérdezési nyelvi értéke.
es-mx	A spanyol (Mexikó) nyelvi értékének lekérdezése.
zh-cn	A kínai (Kína) nyelvértékének lekérdezése.
zh-tw	A kínai (Tajvan) nyelvértékének lekérdezése.
pt-br	Portugál (Brazília) nyelvérték lekérdezése.
pt-pt	Portugál (Portugália) lekérdezési nyelvi értéke.
it-it	Az olasz (Olaszország) nyelvi értékének lekérdezése.
ja-jp	A japán (Japán) nyelvi értékének lekérdezése.
ko-kr	Koreai (Korea) nyelvértékének lekérdezése.
ru-ru	Az orosz (Oroszország) nyelvértékének lekérdezése.
cs-cz	Cseh (Cseh Köztársaság) lekérdezési nyelvi értéke.
nl-be	Holland (Belgium) lekérdezési nyelvi értéke.
nl-nl	Holland (Hollandia) lekérdezési nyelvi értéke.
hu-hu	A magyar (Magyarország) nyelv lekérdezési nyelvének értéke.
pl-pl	A lengyel (Lengyelország) nyelvértékének lekérdezése.
sv-se	A svéd (Svédország) lekérdezési nyelvi értéke.
tr-tr	A török (Törökország) nyelvi értékének lekérdezése.
hi-in	A hindi (India) nyelvértékének lekérdezése.
ar-sa	Arab (Szaúd-Arábia) nyelvértékének lekérdezése.
ar-eg	Az arab (Egyiptom) nyelv értékének lekérdezése.
ar-ma	Az arab (Marokkó) nyelvi értékének lekérdezése.
ar-kw	Az arab (Kuvait) nyelvértékének lekérdezése.
ar-jo	Az arab (Jordánia) nyelvi értékének lekérdezése.
da-dk	A dán (Dánia) lekérdezési nyelvi értéke.
no-no	A norvég (Norvégia) nyelvi értékének lekérdezése.
bg-bg	A bolgár (Bulgária) nyelvi értékének lekérdezése.
hr-hr	A horvát (Horvátország) nyelvi értékének lekérdezése.
hr-ba	A horvát (Bosznia-Hercegovina) nyelvértékének lekérdezése.
ms-my	Maláj (Malajzia) nyelvértékének lekérdezése.
ms-bn	A maláj (Brunei Darussalam) nyelvértékének lekérdezése.
sl-sl	Szlovén (Szlovénia) nyelvi értékének lekérdezése.
ta-in	Tamil (India) nyelvi értékének lekérdezése.
vi-vn	A vietnami (Viet Nam) nyelvértékének lekérdezése.
el-gr	A görög (Görögország) nyelvi értékének lekérdezése.
ro-ro	A román (Románia) lekérdezési nyelvi értéke.
is-is	Izlandi (Izland) nyelvérték lekérdezése.
id-id	Indonéz (Indonézia) nyelvérték lekérdezése.
th-th	Thai (Thaiföld) nyelvértékének lekérdezése.
lt-lt	A litván (Litvánia) nyelvi értékének lekérdezése.
uk-ua	Az ukrán (Ukrajna) nyelvértékének lekérdezése.
lv-lv	A lett (Lettország) lekérdezési nyelvi értéke.
et-ee	Az észt (Észt) nyelv lekérdezési nyelvének értéke.
ca-es	A katalán nyelv értékének lekérdezése.
fi-fi	Finn (Finnország) nyelvi értékének lekérdezése.
sr-ba	A szerb (Bosznia-Hercegovina) nyelvértékének lekérdezése.
sr-me	Szerb (Montenegró) nyelvérték lekérdezése.
sr-rs	Szerb (Szerbia) nyelvérték lekérdezése.
sk-sk	A szlovák (Szlovákia) nyelvi értékének lekérdezése.
nb-no	A norvég (Norvégia) nyelvi értékének lekérdezése.
hy-am	Örmény (Örményország) nyelvértékének lekérdezése.
bn-in	A bengáli (India) nyelvértékének lekérdezése.
eu-es	A baszk nyelv értékének lekérdezése.
gl-es	A galíciai nyelv értékének lekérdezése.
gu-in	A Gujarati (India) nyelvértékének lekérdezése.
he-il	A héber (Izrael) nyelv értékének lekérdezése.
ga-ie	Az ír (Írország) nyelvértékének lekérdezése.
kn-in	Kannada (India) nyelvértékének lekérdezése.
ml-in	A malajalam (India) nyelvértékének lekérdezése.
mr-in	A Marathi (India) nyelvértékének lekérdezése.
fa-ae	A perzsa nyelv értékének lekérdezése (U.A.E.).
pa-in	A punjabi (India) nyelvértékének lekérdezése.
te-in	A Telugu (India) nyelvértékének lekérdezése.
ur-pk	Az Urdu (Pakisztán) lekérdezési nyelvi értéke.

QueryResultDocumentRerankerInput

Tárgy

A szemantikai dúsítási folyamatba küldött nyers összefűzött sztringek.

Name	Típus	Description
content	string	A szemantikai bővítéshez használt tartalommezők nyers összefűzött sztringjei.
keywords	string	A szemantikai bővítéshez használt kulcsszómezők nyers összefűzött sztringjei.
title	string	A szemantikai bővítéshez használt címmező nyers sztringje.

QueryResultDocumentSemanticField

Tárgy

A szemantikai bővítési folyamatnak küldött mezők leírása, valamint azok felhasználási módjának leírása

Name	Típus	Description
name	string	A szemantikai bővítési folyamatnak küldött mező neve
state	SemanticFieldState	A mező felhasználási módja a szemantikai dúsítási folyamathoz (teljesen használva, részben használva vagy nem használva)

QueryResultDocumentSubscores

Tárgy

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.

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>	A vektorok hasonlósága és @search.score értékei az egyes vektoros lekérdezésekhez.

QueryRewritesDebugInfo

Tárgy

Olyan hibakeresési információkat tartalmaz, amelyek a lekérdezés újraírására vonatkoznak.

Name	Típus	Description
text	QueryRewritesValuesDebugInfo	A szöveges lekérdezéshez létrehozott újraírások listája.
vectors	QueryRewritesValuesDebugInfo[]	A vektorizálható szöveges lekérdezésekhez létrehozott újraírások listája.

QueryRewritesType

Felsorolás

Egy érték, amely meghatározza, hogy létre kell-e hozni a lekérdezés újraírását a keresési lekérdezés kibővítéséhez.

Érték	Description
none	Ne hozzon létre további lekérdezés-átírásokat ehhez a lekérdezéshez.
generative	Hozzon létre alternatív lekérdezési kifejezéseket a keresési kérések visszahívásának növeléséhez.

QueryRewritesValuesDebugInfo

Tárgy

Olyan hibakeresési információkat tartalmaz, amelyek a lekérdezés újraírására vonatkoznak.

Name	Típus	Description
inputQuery	string	A generatív lekérdezés újraírási modelljének bemeneti szövege. Előfordulhat, hogy a felhasználói lekérdezés és a generatív modell bemenete nem azonos.
rewrites	string[]	A lekérdezés újraírásainak listája.

QuerySpellerType

Felsorolás

Egy érték, amely meghatározta az egyes keresési lekérdezési kifejezések helyesírás-kijavításához használandó helyesírás-ellenőrző típusát.

Érték	Description
none	A helyesírás-ellenőrző nincs engedélyezve.
lexicon	A Speller az egyes lekérdezési kifejezéseket a queryLanguage paraméter által megadott nyelv statikus lexikonjának használatával javítja ki.

QueryType

Felsorolás

A keresési lekérdezés szintaxisát adja meg. Az alapértelmezett érték az "egyszerű". Használja a "full" értéket, ha a lekérdezés a Lucene lekérdezési szintaxist és a szemantikai értéket használja, ha nincs szükség lekérdezési szintaxisra.

Érték	Description
simple	Az egyszerű lekérdezési szintaxist használja a keresésekhez. A keresési szöveget egy egyszerű lekérdezési nyelv használatával értelmezzük, amely lehetővé teszi az olyan szimbólumok használatát, mint a +, * és a "". A lekérdezések alapértelmezés szerint az összes kereshető mezőre ki vannak értékelve, kivéve, ha a searchFields paraméter meg van adva.
full	A keresések teljes Lucene-lekérdezési szintaxisát használja. A keresési szöveg értelmezése a Lucene lekérdezési nyelvvel történik, amely lehetővé teszi a mezőspecifikus és súlyozott kereséseket, valamint egyéb speciális funkciókat.
semantic	A természetes nyelven kifejezett lekérdezésekhez leginkább a kulcsszavak helyett használható. A webes korpuszon betanított rangsorolási modell használatával javítja a keresési eredmények pontosságát.

RawVectorQuery

Tárgy

A vektorkereséshez használandó lekérdezési paraméterek nyers vektorérték megadásakor.

Name	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 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 é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.
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	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.

ScoringStatistics

Felsorolás

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 "global" használatával globálisan összesítheti a pontozási statisztikákat a pontozás előtt. A globális pontozási statisztikák használata növelheti a keresési lekérdezések késését.

Érték	Description
local	A pontozási statisztikák helyileg lesznek kiszámítva az alacsonyabb késés érdekében.
global	A pontozási statisztikák globálisan lesznek kiszámítva a következetesebb pontozás érdekében.

SearchDocumentsResult

Tárgy

Egy index keresési eredményeit tartalmazó válasz.

Name	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étereket használja, vagy ha a lekérdezés nem tudja egyetlen válaszban visszaadni az összes kért dokumentumot.
@odata.nextLink	string	A folytatási URL-cím akkor lesz visszaadva, ha a lekérdezés nem tudja egyetlen válaszban visszaadni az összes kért eredményt. Ezzel az URL-címmel létrehozhat egy másik GET vagy POST keresési kérést 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 generáló kérés.
@search.answers	AnswerResult[]	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	DebugInfo	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	SearchRequest	A folytatási JSON hasznos adat akkor ad vissza, ha a lekérdezés nem tudja egyetlen válaszban visszaadni az összes kért eredményt. Ezt a JSON-t és @odata.nextLink használhatja egy másik POST Search-kérés kialakításához a keresési válasz következő részének lekéréséhez.
@search.semanticPartialResponseReason	SemanticErrorReason	Annak oka, hogy a rendszer részleges választ adott a szemantikai rangsorolási kérelemre.
@search.semanticPartialResponseType	SemanticSearchResultsType	A szemantikai rangsorolási kéréshez visszaadott részleges válasz típusa.
@search.semanticQueryRewritesResultType	SemanticQueryRewritesResultType	A dokumentumok lekéréséhez használt lekérdezés-átírás típusa.
value	SearchResult[]	A lekérdezés által visszaadott eredmények sorozata.

SearchMode

Felsorolás

Megadja, 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.

Érték	Description
any	A dokumentum egyezésként való megszámlálásához a keresési kifejezéseket egyezni kell.
all	A dokumentum egyezésként való megszámlálásához az összes keresési kifejezést egyezni kell.

SearchRequest

Tárgy

Szűrési, rendezési, arcfelismerési, lapozási és egyéb keresési lekérdezési viselkedés paraméterei.

Name	Típus	Description
answers	QueryAnswerType	Egy érték, amely meghatározza, hogy a válaszokat a keresési válasz részeként kell-e visszaadni.
captions	QueryCaptionType	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	QueryDebugMode	Lehetővé teszi a hibakeresési eszközt, amellyel tovább vizsgálhatja a rerankedt eredményeket.
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	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	QueryLanguage	A keresési lekérdezés nyelvét meghatározó érték.
queryRewrites	QueryRewritesType	Egy érték, amely meghatározza, hogy létre kell-e hozni a lekérdezés újraírását a keresési lekérdezés kibővítéséhez.
queryType	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	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 "global" használatával globálisan összesítheti a pontozási statisztikákat a pontozás előtt. A globális pontozási statisztikák használata növelheti a keresési lekérdezések késését.
search	string	Teljes szöveges keresési lekérdezési kifejezés; Használja a "*" paramétert, vagy hagyja ki ezt a paramétert az összes dokumentumnak való egyeztetéshez.
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	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 beolvasandó mezők vesszővel tagolt listája. Ha nincs meghatározva, a rendszer a sémában lekérdezhetőként megjelölt összes mezőt tartalmazza.
semanticConfiguration	string	Annak a szemantikai konfigurációnak a neve, amelyet a dokumentumok a szemantikai típusú lekérdezések feldolgozásakor használnak.
semanticErrorHandling	SemanticErrorMode	Lehetővé teszi a felhasználó számára, hogy eldöntse, hogy egy szemantikai hívásnak teljesen sikertelennek kell-e lennie (alapértelmezett/aktuális viselkedés), vagy részleges eredményeket ad 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	A ragadós munkamenetek létrehozásához használandó érték, amely segíthet konzisztensebb eredmények eléréséhez. Amíg ugyanazt a munkamenet-azonosítót használja, a rendszer minden tőle telhetőt megtesz annak érdekében, hogy ugyanazt a replikakészletet célozza meg. Ügyeljen arra, hogy 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	QuerySpellerType	Egy érték, amely meghatározta az egyes keresési lekérdezési kifejezések helyesírás-kijavításához használandó helyesírás-ellenőrző típusát.
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	VectorFilterMode	Meghatározza, hogy a szűrőket a vektorkeresés előtt vagy után alkalmazza-e a rendszer. Az új indexek alapértelmezett értéke "preSzűrő".
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableImageBinaryQuery[] VectorizableImageUrlQuery[] VectorizableTextQuery[]	A vektoros és hibrid keresési lekérdezések lekérdezési paraméterei.

SearchResult

Tárgy

Egy keresési lekérdezés által talált dokumentumot tartalmaz, valamint a kapcsolódó metaadatokat.

Name	Típus	Description
@search.captions	CaptionResult[]	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 "szemantikai" típusú lekérdezésekhez ad vissza feliratokat.
@search.documentDebugInfo	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 az egyező keresési kifejezéseket jelölik, az egyes alkalmazható mezők szerint rendezve; null értékű, ha a lekérdezéshez nincs engedélyezve a találatkiemelés.
@search.rerankerScore	number (double)	A legfontosabb keresési eredmények szemantikai rangsorolója által kiszámított relevanciapont. A keresési eredményeket először a RerankerScore, majd a Pontszám rendezi. A RerankerScore csak "szemantikai" típusú lekérdezésekhez lesz visszaadva.
@search.score	number (double)	A dokumentum relevanciapontszáma a lekérdezés által visszaadott többi dokumentumhoz képest.

SearchScoreThreshold

Tárgy

A vektoros lekérdezés eredményei a "@search.score" érték alapján szűrnek. Vegye figyelembe, hogy ez a keresési válasz részeként visszaadott @search.score. A küszöbérték iránya magasabb @search.scorelesz kiválasztva.

Name	Típus	Description
kind	string: searchScore	A vektoros lekérdezések szűréséhez használt küszöbérték típusa
value	number (double)	A küszöbérték a "@search.score" érték alapján lesz szűrve. Vegye figyelembe, hogy ez a keresési válasz részeként visszaadott @search.score. A küszöbérték iránya magasabb @search.scorelesz kiválasztva.

SemanticDebugInfo

Tárgy

Name	Típus	Description
contentFields	QueryResultDocumentSemanticField[]	A szemantikai bővítési folyamatnak küldött tartalommezők, valamint azok felhasználási módját
keywordFields	QueryResultDocumentSemanticField[]	A szemantikai bővítési folyamatnak küldött kulcsszómezők, valamint azok felhasználási módjá
rerankerInput	QueryResultDocumentRerankerInput	A szemantikai dúsítási folyamatba küldött nyers összefűzött sztringek.
titleField	QueryResultDocumentSemanticField	A szemantikai bővítési folyamatnak küldött címmező, valamint a használat módja

SemanticErrorMode

Felsorolás

Lehetővé teszi a felhasználó számára, hogy eldöntse, hogy egy szemantikai hívásnak teljesen sikertelennek kell-e lennie (alapértelmezett/aktuális viselkedés), vagy részleges eredményeket ad vissza.

É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

Felsorolás

Annak oka, hogy a rendszer részleges választ adott a szemantikai rangsorolási kérelemre.

Érték	Description
maxWaitExceeded	Ha `semanticMaxWaitInMilliseconds` van beállítva, és a szemantikai feldolgozási időtartam túllépte ezt az értéket. Csak az alaperedmények lettek visszaadva.
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

Felsorolás

A mező felhasználási módja a szemantikai dúsítási folyamathoz (teljesen használva, részben használva vagy nem használva)

Érték	Description
used	A mezőt teljes mértékben a szemantikai dúsításhoz használták.
unused	A mező nem használt szemantikai dúsításhoz.
partial	A mezőt részben szemantikai dúsításra használták.

SemanticQueryRewritesResultType

Felsorolás

A kéréshez használt lekérdezés-átírás típusa.

Érték	Description
originalQueryOnly	A lekérdezés újraírása nem sikerült a kéréshez. Az eredmények lekéréséhez csak az eredeti lekérdezést használták.

SemanticSearchResultsType

Felsorolás

A szemantikai rangsorolási kéréshez 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

Tárgy

Egyetlen vektormező eredménye. A @search.score és a vektorok hasonlósági értékei is vissza lesznek adva. A vektorok hasonlósága egy egyenlet @search.score függ össze.

Name	Típus	Description
searchScore	number (double)	A vektor hasonlósági pontszámából kiszámított @search.score érték. Ez az a pontszám, amely egy tiszta egymezős egyvektoros lekérdezésben látható.
vectorSimilarity	number (double)	A dokumentum vektor-hasonló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 a koszinusz hasonlósága a koszinusz távolsága 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őket a vektorkeresés előtt vagy után alkalmazza-e a rendszer.

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

VectorizableImageBinaryQuery

Tárgy

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.

Name	Típus	Description
base64Image	string	Egy vektorizált kép 64-es alapkódolt bináris kódja vektorkeresési lekérdezés végrehajtásához.
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: imageBinary	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 é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.
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	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

Tárgy

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.

Name	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: imageUrl	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 é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.
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	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

Tárgy

A vektorkereséshez használandó lekérdezési paraméterek, ha egy vektorizálandó szöveges érték van megadva.

Name	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 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 é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.
queryRewrites	QueryRewritesType	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: SearchScoreThreshold VectorSimilarityThreshold	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.

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, amelyben egy vektorosított szöveges értéket ad meg.
imageUrl	Vektoros lekérdezés, amelyben a vektorizálni kívánt képértéket képviselő URL-cím van megadva.
imageBinary	Vektoros lekérdezés, ahol egy kép 64-es alapkódolt bináris fájlja van megadva, amelyet vektorizálni kell.

VectorsDebugInfo

Tárgy

Name	Típus	Description
subscores	QueryResultDocumentSubscores	A dokumentum részmagjainak lebontása a kiválasztott eredményhalmaz fúziós/kombinációs módszere, például az RRF előtt.

VectorSimilarityThreshold

Tárgy

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.

Name	Típus	Description
kind	string: vectorSimilarity	A vektoros lekérdezések szűréséhez használt küszöbérték 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

Felsorolás

A végrehajtott vektoros lekérdezés típusa.

É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 a keresési válasz részeként visszaadott @search.score. A küszöbérték iránya magasabb @search.scorelesz kiválasztva.