Documents - Search Get

Referencia

Szolgáltatás:: Search Service

API-verzió:: 2024-07-01

Dokumentumokat keres az indexben.

GET {endpoint}/indexes('{indexName}')/docs?api-version=2024-07-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=2024-07-01&semanticConfiguration={semanticConfiguration}&semanticErrorHandling={semanticErrorHandling}&semanticMaxWaitInMilliseconds={semanticMaxWaitInMilliseconds}&answers={answers}&captions={captions}&semanticQuery={semanticQuery}

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 hamis. 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.
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értelmezés szerint `None`.
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.
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).
semanticMaxWaitInMilliseconds	query		integer int32	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.

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=2024-07-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"
    }
  ]
}

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=2024-07-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"
      ]
    }
  ]
}

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.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
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.
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és szintaxisát használja.
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.
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.
SemanticSearchResultsType	A szemantikai rangsorolási kéréshez visszaadott részleges válasz típusa.
VectorFilterMode	Meghatározza, hogy a szűrőket a vektorkeresés előtt vagy után alkalmazza-e a rendszer.
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.

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.

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

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.

ErrorAdditionalInfo

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

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

ErrorDetail

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

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

QueryAnswerType

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

Name	Típus	Description
extractive	string	Kinyeri a válaszjelölteket a visszaadott dokumentumok tartalmából egy kérdésre adott válaszként természetes nyelven kifejezve.
none	string	Ne adja vissza a lekérdezésre vonatkozó válaszokat.

QueryCaptionType

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

Name	Típus	Description
extractive	string	A keresési lekérdezés szempontjából releváns részeket tartalmazó megfelelő dokumentumokból kinyeri a feliratokat.
none	string	Ne adja vissza a lekérdezés feliratait.

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és szintaxisát használja.

Name	Típus	Description
full	string	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	string	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.
simple	string	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.

RawVectorQuery

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

Name	Típus	Description
exhaustive	boolean	Ha igaz, 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.
k	integer	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	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.
vector	number[]	A keresési lekérdezés vektoros ábrázolása.
weight	number	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

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.

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

SearchDocumentsResult

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

Name	Típus	Description
@odata.count	integer	A keresési művelet által talált találatok teljes száma, vagy null érték, ha a szám nem lett kérve. Ha jelen van, a szám nagyobb lehet, mint a válaszban szereplő eredmények száma. Ez akkor fordulhat elő, ha a $top vagy $skip paramétereket használja, vagy ha a lekérdezés nem tudja egyetlen válaszban visszaadni az összes kért dokumentumot.
@odata.nextLink	string	A folytatási URL-cím akkor lesz visszaadva, ha a lekérdezés nem tudja egyetlen válaszban visszaadni az összes kért eredményt. Ezzel az URL-címmel létrehozhat egy másik GET vagy POST keresé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	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.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.
value	SearchResult[]	A lekérdezés által visszaadott eredmények sorozata.

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.

Name	Típus	Description
all	string	A dokumentum egyezésként való megszámlálásához az összes keresési kifejezést egyezni kell.
any	string	A dokumentum egyezésként való megszámlálásához a keresési kifejezéseket egyezni kell.

SearchRequest

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 hamis. 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.
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>.
minimumCoverage	number	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.
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.
semanticMaxWaitInMilliseconds	integer	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	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.
top	integer	A lekérendő keresési eredmények száma. Ez a $skip együtt használható a keresési eredmények ügyféloldali lapozásának megvalósításához. Ha a 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[] VectorizableTextQuery[]	A vektoros és hibrid keresési lekérdezések lekérdezési paraméterei.

SearchResult

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

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.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	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	A dokumentum relevanciapontszáma a lekérdezés által visszaadott többi dokumentumhoz képest.

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.

Name	Típus	Description
fail	string	Ha kivétel történik a szemantikai feldolgozási lépés során, a lekérdezés sikertelen lesz, és a hiba függvényében visszaadja a megfelelő HTTP-kódot.
partial	string	Ha a szemantikai feldolgozás sikertelen, a részleges eredmények továbbra is visszatérnek. A részleges eredmények definíciója attól függ, hogy milyen szemantikai lépés meghiúsult, és mi volt a hiba oka.

SemanticErrorReason

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

Name	Típus	Description
capacityOverloaded	string	A kérés szabályozva lett. Csak az alaperedmények lettek visszaadva.
maxWaitExceeded	string	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.
transient	string	A szemantikai folyamat legalább egy lépése sikertelen volt.

SemanticSearchResultsType

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

Name	Típus	Description
baseResults	string	Eredmény szemantikai dúsítás vagy reranking nélkül.
rerankedResults	string	Az eredményeket a reranker-modell újraküldte, és szemantikai feliratokat is tartalmaz. Ezek nem tartalmaznak válaszokat, válaszkiemeléseket vagy feliratkiemeléseket.

VectorFilterMode

Meghatározza, hogy a szűrőket a vektorkeresés előtt vagy után alkalmazza-e a rendszer.

Name	Típus	Description
postFilter	string	A szűrő a vektoreredmények jelölt készletének visszaadása után lesz alkalmazva. A szűrő szelektivitásától függően ez a k paraméter által kértnél kevesebb eredményt eredményezhet.
preFilter	string	A szűrő a keresési lekérdezés előtt lesz alkalmazva.

VectorizableTextQuery

A vektorkereséshez használandó lekérdezési paraméterek, ha 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.
k	integer	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	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.
text	string	A vektoros keresési lekérdezés végrehajtásához vektorizálandó szöveg.
weight	number	A vektoros lekérdezés relatív súlya a többi vektoros lekérdezéshez és/vagy a szöveges lekérdezéshez képest ugyanabban a keresési kérelemben. Ez az érték a különböző vektoros lekérdezések és/vagy a szöveges lekérdezésen keresztül lekért eredmények több rangsorolási lista eredményeinek kombinálásakor használatos. Minél nagyobb a súly, annál magasabb lesz a lekérdezésnek megfelelő dokumentumok rangsorolása. Az alapértelmezett érték 1,0, az értéknek nullánál nagyobb pozitív számnak kell lennie.

VectorQueryKind

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

Name	Típus	Description
text	string	Vektoros lekérdezés, amelyben egy vektorosított szöveges értéket ad meg.
vector	string	Vektoros lekérdezés, ahol nyers vektorérték van megadva.

Megosztás a következőn keresztül:

Documents - Search Get

URI-paraméterek

Kérelem fejléce

Válaszok

Példák

SearchIndexSearchDocumentsGet

Mintakérelem

Mintaválasz

SearchIndexSearchDocumentsSemanticGet

Mintakérelem

Mintaválasz

Definíciók

AnswerResult

CaptionResult

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

QueryAnswerType

QueryCaptionType

QueryType

RawVectorQuery

ScoringStatistics

SearchDocumentsResult

SearchMode

SearchRequest

SearchResult

SemanticErrorMode

SemanticErrorReason

SemanticSearchResultsType

VectorFilterMode

VectorizableTextQuery

VectorQueryKind

További források