Documents - Search Get

Referencia

Service:: Search Service

API Version:: 2023-11-01

Dokumentumokat keres az indexben.

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

With optional parameters:

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=2023-11-01&semanticConfiguration={semanticConfiguration}&semanticErrorHandling={semanticErrorHandling}&semanticMaxWaitInMilliseconds={semanticMaxWaitInMilliseconds}&answers={answers}&captions={captions}

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 a false (hamis). Ha ezt az értéket true (igaz) értékre állítja, az hatással lehet a teljesítményre. Vegye figyelembe, hogy a visszaadott darabszám közelítés.
$filter	query		string	A keresési lekérdezésre alkalmazandó OData $filter kifejezés.
$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. Minden kifejezést követhet az asc, amely növekvő, a desc pedig csökkenő értéket jelez. Az alapértelmezett érték a növekvő sorrend. A dokumentumok egyezési pontszáma megszakítja a kötelékeket. Ha nincs megadva OrderBy érték, az alapértelmezett rendezési sorrend a dokumentumegyeztetési pontszám alapján csökkenő lesz. Legfeljebb 32 $orderby záradék lehet.
$select	query		string[]	A beolvasandó 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 használatát egy teljesen rendezett kulcson, és $filter 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 csonkulnak a kiszolgálóoldali lapozás miatt, a válasz tartalmaz egy folytatási jogkivonatot, amellyel egy másik keresési kérést adhat ki a következő találati laphoz.
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 konfigurálható a cső karakterének `\|` hozzáfűzésével, majd a `count-<number of answers>` válasz paraméterérték utáni beállítással, például `extractive\|count-3`: . Az alapértelmezett szám 1. A megbízhatósági küszöbérték konfigurálható a cső karakterének `\|` hozzáfűzésével, majd a `threshold-<confidence threshold>` válasz paraméterérték utáni beállítással, 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 értékre van állítva `extractive`, a kiemelés alapértelmezés szerint engedélyezve van, és konfigurálható a cső karakterének `\|` hozzáfűzésével, majd a `highlight-<true/false>` következő beállítással: `extractive\|highlight-true`. Alapértelmezés szerint a értékre van kapcsolva `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. A találatok kiemeléséhez csak kereshető mezők használhatók.
highlightPostTag	query		string	A kiemelt találatokhoz hozzáfűzött sztringcímke. A highlightPreTag paraméterrel kell beállítani. Az alapértelmezett érték az </em>.
highlightPreTag	query		string	Egy sztringcímke, amely a kiemelések eléréséhez van előtagként felfűzve. A highlightPostTag paraméterrel kell beállítani. Az alapértelmezett érték az <em>.
minimumCoverage	query		number double	Egy 0 és 100 közötti szám, amely azt jelzi, hogy a keresési lekérdezésnek hány százalékát kell lefednie az indexnek ahhoz, hogy a lekérdezés sikeresként legyen jelentve. Ez a paraméter akkor is hasznos lehet, ha csak egy replikával rendelkező szolgáltatások esetében is biztosítja a keresések rendelkezésre állását. Az alapértelmezett érték 100.
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" (teljes) értéket, ha a lekérdezés a Lucene lekérdezési szintaxist használja.
scoringParameter	query		string[]	A pontozófüggvényekben (például a referencePointParameterben) használandó paraméterértékek listája a név-értékek formátumával. Ha például a pontozási profil egy "mylocation" nevű paraméterrel definiál egy függvényt, a paraméter sztringje "mylocation--122.2,44.8" lesz (idézőjelek nélkül).
scoringProfile	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áshoz, vagy helyileg az alacsonyabb késés érdekében.
search	query		string	Egy teljes szöveges keresési lekérdezési kifejezés; Használja a "*" paramétert, vagy hagyja ki ezt a paramétert az összes dokumentum egyeztetéséhez.
searchFields	query		string[]	Azon mezőnevek listája, amelyekre a teljes szöveges keresés hatóköre kiterjed. Ha mezőalapú keresést (fieldName:searchExpression) használ egy teljes Lucene-lekérdezésben, az egyes mezőalapú keresési kifejezések mezőnevei elsőbbséget élveznek az ebben a paraméterben felsorolt mezőnevekkel szemben.
searchMode	query		SearchMode	Egy érték, amely meghatározza, hogy a keresési kifejezések bármelyikét vagy mindegyikét egyezésnek kell-e tekinteni a dokumentum egyezésként való megszámlálásához.
semanticConfiguration	query		string	Annak a szemantikai konfigurációnak a neve, amely felsorolja, hogy mely mezőket kell használni a szemantikai rangsoroláshoz, feliratokhoz, kiemelésekhez és 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 kell-e visszaadnia.
semanticMaxWaitInMilliseconds	query		integer int32	Lehetővé teszi a felhasználó számára, hogy felső korlátot állítson be arra az időre, amíg a szemantikai bővítés befejeződik, mielőtt a kérés meghiúsul.
sessionId	query		string	A ragadós munkamenet létrehozásához használandó érték, amely segíthet a konzisztensebb eredmények eléréséhez. Ha ugyanazt a munkamenet-azonosítót használja, a rendszer minden tőle telhetőt megtesz, hogy ugyanazt a replikakészletet célozza meg. Legyen óvatos, ha ugyanazokat a sessionID-értékeket ismételten használja fel, az megzavarhatja a kérések terheléselosztását a replikák között, és hátrányosan befolyásolhatja a keresési szolgáltatás teljesítményét. A sessionIdként használt érték nem kezdődhet _karakterrel.

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	SearchError	Hibaválasz.

Példák

SearchIndexSearchDocumentsGet

SearchIndexSearchDocumentsSemanticGet

SearchIndexSearchDocumentsGet

Sample Request

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=2023-11-01

Sample Response

Status code:: 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

Sample Request

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=2023-11-01&semanticConfiguration=my-semantic-config&semanticErrorHandling=partial&semanticMaxWaitInMilliseconds=780&answers=extractive|count-3&captions=extractive|highlight-true

Sample Response

Status code:: 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 lesznek kinyerve. A válaszjelöltek pontozása és a legjobb válaszok kiválasztása.
CaptionResult	A feliratok a dokumentum és a keresési lekérdezés közötti legreprezentesebb szakaszok. Ezeket gyakran használják dokumentum-összefoglalásként. A rendszer csak a típusú `semantic`lekérdezésekhez ad vissza feliratokat.
QueryAnswerType	Egy érték, amely meghatározza, hogy a válaszok a keresési válasz részeként legyenek-e visszaadva.
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" (teljes) értéket, ha a lekérdezés a Lucene lekérdezési szintaxist 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áshoz, vagy helyileg az alacsonyabb késés érdekében. Az alapértelmezett érték a "local" (helyi). A "global" használatával globálisan összesítheti a pontozási statisztikákat a pontozás előtt. A globális pontozási statisztikák használata növelheti a keresési lekérdezések késését.
SearchDocumentsResult	Egy index keresési eredményeit tartalmazó válasz.
SearchError	Az API hibafeltételét ismerteti.
SearchMode	Itt adhatja meg, hogy a keresési kifejezések bármelyikének vagy mindegyikének egyeznie kell-e ahhoz, hogy a dokumentumot egyezésnek számítsa.
SearchRequest	Szűrési, rendezési, arculati, lapozási és egyéb keresési lekérdezési viselkedések paraméterei.
SearchResult	Egy keresési lekérdezés által talált dokumentumot és a kapcsolódó metaadatokat tartalmazza.
SemanticErrorMode	Lehetővé teszi, hogy a felhasználó eldöntse, hogy egy szemantikai hívás teljesen meghiúsuljon-e (alapértelmezett/aktuális viselkedés), vagy részleges eredményeket adjon vissza.
SemanticErrorReason	Annak oka, hogy a rendszer részleges választ adott vissza egy 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ők alkalmazása a vektorkeresés előtt vagy után történjen-e.
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 lesznek kinyerve. A válaszjelöltek pontozása és a legjobb válaszok kiválasztása.

Name	Típus	Description
highlights	string	Ugyanaz a szövegrész, mint a Text tulajdonságban a lekérdezés szempontjából legrelevánsabb kiemelt szöveges kifejezésekkel.
key	string	A dokumentum kulcsa, amelyből a választ kinyerték.
score	number	A pontszám értéke azt jelzi, hogy mennyire releváns a válasz a lekérdezésre a lekérdezéshez visszaadott egyéb válaszokhoz képest.
text	string	Válaszként a dokumentum tartalmából kinyert szövegrész.

CaptionResult

A feliratok a dokumentum és a keresési lekérdezés közötti legreprezentesebb szakaszok. Ezeket gyakran használják dokumentum-összefoglalásként. A rendszer csak a típusú semanticlekérdezésekhez ad vissza feliratokat.

Name	Típus	Description
highlights	string	Ugyanaz a szövegrész, mint a Text tulajdonságban a lekérdezés szempontjából legrelevánsabb kiemelt kifejezésekkel.
text	string	A keresési lekérdezés szempontjából legrelevánsabb dokumentumból kinyert reprezentatív szövegrészlet.

QueryAnswerType

Egy érték, amely meghatározza, hogy a válaszok a keresési válasz részeként legyenek-e visszaadva.

Name	Típus	Description
extractive	string	Kinyeri a válaszjelölteket a természetes nyelvű kérdésként kifejezett lekérdezésre adott válaszként visszaadott dokumentumok tartalmából.
none	string	Ne adjon vissza válaszokat a lekérdezéshez.

QueryCaptionType

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

Name	Típus	Description
extractive	string	Feliratokat nyer ki az egyező dokumentumokból, amelyek a keresési lekérdezés szempontjából releváns részeket tartalmaznak.
none	string	Ne adja vissza a lekérdezés feliratait.

QueryType

A keresési lekérdezés szintaxisát adja meg. Az alapértelmezett érték az "egyszerű". Használja a "full" (teljes) értéket, ha a lekérdezés a Lucene lekérdezési szintaxist használja.

Name	Típus	Description
full	string	A teljes Lucene lekérdezési szintaxist használja a keresésekhez. 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 ideális, nem pedig kulcsszavakhoz. A webes korpuszon betanított rangsorolási modell használatával javítja a keresési eredmények pontosságát a legjobb keresési eredmények ismételt rangsorolásával.
simple	string	Az egyszerű lekérdezési szintaxist használja a keresésekhez. A keresési szöveg értelmezése egyszerű lekérdezési nyelvvel történik, amely lehetővé teszi az olyan szimbólumok használatát, mint a +, a * és a "". A lekérdezések kiértékelése alapértelmezés szerint az összes kereshető mezőben történik, kivéve, ha a searchFields paraméter meg van adva.

RawVectorQuery

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

Name	Típus	Description
exhaustive	boolean	Ha igaz, a teljes k-legközelebbi szomszédkeresést aktiválja a vektorindex összes vektorában. Olyan helyzetekben hasznos, ahol a pontos egyezések kritikus fontosságúak, például az alapvető igazságértékek meghatározásához.
fields	string	A keresett vektorban szerepeltetni kívánt Collection(Edm.Single) típusú vektormezők.
k	integer	Azoknak a legközelebbi szomszédoknak a száma, ahányszor a legtöbb találatot vissza szeretné adni.
kind	string: vector	A végrehajtott vektoros lekérdezés típusa.
vector	number[]	A keresési lekérdezés vektoros ábrázolása.

ScoringStatistics

Egy érték, amely meghatározza, hogy globálisan ki szeretnénk-e számítani a pontozási statisztikákat (például a dokumentum gyakoriságát) a konzisztensebb pontozáshoz, vagy helyileg az alacsonyabb késés érdekében. Az alapértelmezett érték a "local" (helyi). A "global" használatával globálisan összesítheti a pontozási statisztikákat a pontozás előtt. A globális pontozási statisztikák használata növelheti a keresési lekérdezések késését.

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

SearchDocumentsResult

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 ad vissza, 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 eredményező kérés.
@search.answers	AnswerResult[]	A keresési műveletre adott válaszok lekérdezési eredményei; null értékű, ha az answers lekérdezési paraméter nincs megadva, vagy nincs értékre van állítva.
@search.coverage	number	A lekérdezésben szereplő index százalékos arányát jelző érték, vagy null érték, ha a kérelemben nem volt megadva a minimális átvétel.
@search.facets	object	A keresési művelet aspektusalapú lekérdezési eredményei, gyűjtők gyűjteményeként rendezve az egyes aspektusmezőkhöz; null értékű, ha a lekérdezés nem tartalmaz aspektuskifejezéseket.
@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. Ezzel a JSON-val egy @odata.nextLink másik POST Search-kérést is összeállíthat 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 vissza egy 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.

SearchError

Az API hibafeltételét ismerteti.

Name	Típus	Description
code	string	A kiszolgáló által definiált hibakódok egyike.
details	SearchError[]	A jelentett hibához vezető konkrét hibák részleteinek tömbje.
message	string	A hiba emberi olvasásra alkalmas ábrázolása.

SearchMode

Itt adhatja meg, hogy a keresési kifejezések bármelyikének vagy mindegyikének egyeznie kell-e ahhoz, hogy a dokumentumot egyezésnek számítsa.

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

SearchRequest

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

Name	Típus	Description
answers	QueryAnswerType	Egy érték, amely meghatározza, hogy a válaszok a keresési válasz részeként legyenek-e visszaadva.
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 a false (hamis). Ha ezt az értéket true (igaz) értékre állítja, az hatással lehet a teljesítményre. Vegye figyelembe, hogy a visszaadott darabszám közelítés.
facets	string[]	A keresési lekérdezésre alkalmazandó aspektuskifejezések listája. Minden aspektuskifejezés tartalmaz egy mezőnevet, amelyet opcionálisan a név:érték párok vesszővel tagolt listája követ.
filter	string	A keresési lekérdezésre alkalmazandó OData $filter kifejezés.
highlight	string	A találatok kiemeléséhez használandó mezőnevek vesszővel tagolt listája. A találatok kiemeléséhez csak kereshető mezők használhatók.
highlightPostTag	string	A kiemelt találatokhoz hozzáfűzött sztringcímke. A highlightPreTag paraméterrel kell beállítani. Az alapértelmezett érték az </em>.
highlightPreTag	string	Egy sztringcímke, amely a kiemelések eléréséhez van előtagként felfűzve. A highlightPostTag paraméterrel kell beállítani. Az alapértelmezett érték az <em>.
minimumCoverage	number	Egy 0 és 100 közötti szám, amely azt jelzi, hogy a keresési lekérdezésnek hány százalékát kell lefednie az indexnek ahhoz, hogy a lekérdezés sikeresként legyen jelentve. Ez a paraméter akkor is hasznos lehet, ha csak egy replikával rendelkező szolgáltatások esetében is biztosítja a keresések rendelkezésre állását. Az alapértelmezett érték 100.
orderby	string	Az OData vesszővel tagolt listája $orderby kifejezéseket, amelyek alapján rendezheti az eredményeket. Minden kifejezés lehet mezőnév vagy a geo.distance() vagy a search.score() függvény hívása. Minden kifejezést követhet az asc, amely növekvő, a desc pedig csökkenő értéket jelez. Az alapértelmezett érték a növekvő sorrend. A dokumentumok egyezési pontszáma megszakítja a kötelékeket. Ha nincs megadva $orderby, az alapértelmezett rendezési sorrend a dokumentumegyezés pontszáma szerint csökkenő lesz. Legfeljebb 32 $orderby záradék lehet.
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" (teljes) értéket, ha a lekérdezés a Lucene lekérdezési szintaxist használja.
scoringParameters	string[]	A pontozófüggvényekben (például a referencePointParameterben) használandó paraméterértékek listája a név-értékek formátumával. Ha például a pontozási profil egy "mylocation" nevű paraméterrel definiál egy függvényt, a paraméter sztringje "mylocation--122.2,44.8" lesz (idézőjelek nélkül).
scoringProfile	string	Egy pontozási profil neve, amely kiértékeli az egyező dokumentumok egyező pontszámait az eredmények rendezése érdekében.
scoringStatistics	ScoringStatistics	Egy érték, amely meghatározza, hogy globálisan ki szeretnénk-e számítani a pontozási statisztikákat (például a dokumentum gyakoriságát) a konzisztensebb pontozáshoz, vagy helyileg az alacsonyabb késés érdekében. Az alapértelmezett érték a "local" (helyi). A "global" használatával globálisan összesítheti a pontozási statisztikákat a pontozás előtt. A globális pontozási statisztikák használata növelheti a keresési lekérdezések késését.
search	string	Egy teljes szöveges keresési lekérdezési kifejezés; Használja a "*" paramétert, vagy hagyja ki ezt a paramétert az összes dokumentum egyeztetéséhez.
searchFields	string	Azoknak a mezőneveknek a vesszővel tagolt listája, amelyekre a teljes szöveges keresés hatóköre kiterjed. Ha mezőalapú keresést (fieldName:searchExpression) használ egy teljes Lucene-lekérdezésben, az egyes mezőalapú keresési kifejezések mezőnevei elsőbbséget élveznek az ebben a paraméterben felsorolt mezőnevekkel szemben.
searchMode	SearchMode	Egy érték, amely meghatározza, hogy a keresési kifejezések bármelyikét vagy mindegyikét egyezésnek kell-e tekinteni a dokumentum egyezésként való megszámlálásához.
select	string	A beolvasandó mezők vesszővel tagolt listája. Ha nincs meghatározva, a rendszer a sémában lekérdezhetőként megjelölt összes mezőt tartalmazza.
semanticConfiguration	string	Egy szemantikai konfiguráció neve, amelyet a dokumentumok szemantikai típusú lekérdezések feldolgozásához használnak.
semanticErrorHandling	SemanticErrorMode	Lehetővé teszi, hogy a felhasználó eldöntse, hogy egy szemantikai hívás teljesen meghiúsuljon-e (alapértelmezett/aktuális viselkedés), vagy részleges eredményeket adjon vissza.
semanticMaxWaitInMilliseconds	integer	Lehetővé teszi a felhasználó számára, hogy felső határt állítson be arra az időre, amellyel a szemantikai bővítés befejeződik, mielőtt a kérés meghiúsul.
sessionId	string	A ragadós munkamenet létrehozásához használandó érték, amely segíthet a konzisztensebb eredmények eléréséhez. Ha ugyanazt a munkamenet-azonosítót használja, a rendszer minden tőle telhetőt megtesz, hogy ugyanazt a replikakészletet célozza meg. Legyen óvatos, ha ugyanazokat a sessionID-értékeket ismételten használja fel, az megzavarhatja a kérések terheléselosztását a replikák között, és hátrányosan befolyásolhatja a keresési szolgáltatás teljesítményét. A sessionIdként használt érték nem kezdődhet _karakterrel.
skip	integer	A kihagyandó keresési eredmények száma. Ez az érték nem lehet nagyobb 100 000-nél. Ha egymás után kell beolvasnia a dokumentumokat, de a korlátozás miatt nem tudja használni a kihagyást, fontolja meg az orderby használatát egy teljesen rendezett kulcson, és szűrjön inkább egy tartomány-lekérdezéssel.
top	integer	A lekérendő keresési eredmények száma. Ez a $skip együtt használható a keresési eredmények ügyféloldali lapozásának megvalósításához. Ha a kiszolgálóoldali lapozás miatt csonkulnak az eredmények, a válasz tartalmaz egy folytatási jogkivonatot, amellyel egy másik keresési kérést adhat ki a következő találati lapra.
vectorFilterMode	VectorFilterMode	Meghatározza, hogy a szűrők alkalmazása a vektorkeresés előtt vagy után történjen-e. Az alapértelmezett érték a "preFilter" az új indexekhez.
vectorQueries	VectorQuery[]: RawVectorQuery[]	A vektoros és hibrid keresési lekérdezések lekérdezési paraméterei.

SearchResult

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

Name	Típus	Description
@search.captions	CaptionResult[]	A feliratok a dokumentum és a keresési lekérdezés közötti legreprezentesebb szakaszok. Ezeket gyakran használják dokumentum-összefoglalásként. A rendszer csak a típusú `semantic`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 találatok kiemelése nem volt engedélyezve a lekérdezéshez.
@search.rerankerScore	number	A legfontosabb keresési eredmények szemantikai rangsorolója által kiszámított relevanciapontszám. A keresési eredményeket először a RerankerScore, majd a Pontszám szerint rendezi. A rerankerScore csak a típusú `semantic`lekérdezések esetén lesz visszaadva.
@search.score	number	A dokumentum relevanciapontszáma a lekérdezés által visszaadott többi dokumentumhoz képest.

SemanticErrorMode

Lehetővé teszi, hogy a felhasználó eldöntse, hogy egy szemantikai hívás teljesen meghiúsuljon-e (alapértelmezett/aktuális viselkedés), vagy részleges eredményeket adjon 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 hibától függően visszaadja a megfelelő HTTP-kódot.
partial	string	Ha a szemantikai feldolgozás sikertelen, a részleges eredmények továbbra is visszatérnek. A részleges eredmények definíciója attól függ, hogy melyik szemantikai lépés meghiúsult, és mi volt a hiba oka.

SemanticErrorReason

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

Name	Típus	Description
capacityOverloaded	string	A rendszer szabályozta a kérelmet. Csak az alaperedmények lettek visszaadva.
maxWaitExceeded	string	Ha `semanticMaxWaitInMilliseconds` be lett állítva, és a szemantikai feldolgozás időtartama túllépte ezt az értéket. Csak az alaperedmények lettek visszaadva.
transient	string	A szemantikai folyamat legalább egy lépése sikertelen volt.

SemanticSearchResultsType

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

Name	Típus	Description
baseResults	string	Szemantikai bővítés vagy reranking nélküli eredmények.
rerankedResults	string	A reranker modell eredményei szemantikai feliratokat tartalmaznak. Nem tartalmaznak válaszokat, válaszokat és képaláírás kiemeléseket.

VectorFilterMode

Meghatározza, hogy a szűrők alkalmazása a vektorkeresés előtt vagy után történjen-e.

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

VectorQueryKind

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

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

Sample Request

Sample Response

SearchIndexSearchDocumentsSemanticGet

Sample Request

Sample Response

Definíciók

AnswerResult

CaptionResult

QueryAnswerType

QueryCaptionType

QueryType

RawVectorQuery

ScoringStatistics

SearchDocumentsResult

SearchError

SearchMode

SearchRequest

SearchResult

SemanticErrorMode

SemanticErrorReason

SemanticSearchResultsType

VectorFilterMode

VectorQueryKind

További források