Documents - Search Post

Služba:

Search Service

Verze rozhraní API:

2023-10-01-Preview

Vyhledá dokumenty v indexu.

POST {endpoint}/indexes('{indexName}')/docs/search.post.search?api-version=2023-10-01-Preview

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string	Adresa URL koncového bodu vyhledávací služby.
indexName	path	True	string	Název indexu.
api-version	query	True	string	Verze rozhraní API klienta.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
x-ms-client-request-id		string uuid	ID sledování odeslané spolu s požadavkem na pomoc s laděním.

Text požadavku

Name	Typ	Description
answers	QueryAnswerType	Hodnota, která určuje, zda mají být odpovědi vráceny jako součást odpovědi hledání.
captions	QueryCaptionType	Hodnota, která určuje, zda mají být titulky vráceny jako součást odpovědi hledání.
count	boolean	Hodnota, která určuje, jestli se má načíst celkový počet výsledků. Výchozí hodnota je false. Nastavení této hodnoty na true může mít dopad na výkon. Všimněte si, že vrácený počet je aproximace.
debug	QueryDebugMode	Umožňuje ladicí nástroj, který můžete použít k dalšímu prozkoumání výsledků, které jste přeřadili.
facets	string[]	Seznam výrazů omezujících vlastností, které se mají použít u vyhledávacího dotazu. Každý výraz omezující vlastnosti obsahuje název pole, za kterým volitelně následuje seznam dvojic název:hodnota oddělený čárkami.
filter	string	OData $filter výraz, který se má použít u vyhledávacího dotazu.
highlight	string	Seznam názvů polí oddělených čárkami, který se má použít pro zvýraznění přístupů. Ke zvýraznění přístupů je možné použít pouze prohledávatelná pole.
highlightPostTag	string	Značka řetězce, která se připojí ke zvýraznění přístupů. Musí být nastaven pomocí highlightPreTag. Výchozí hodnota je </em>.
highlightPreTag	string	Značka řetězce, která je předpřipená k dosažení zvýraznění. Musí být nastavený s highlightPostTag. Výchozí hodnota je <em>.
minimumCoverage	number	Číslo mezi 0 a 100 určující procento indexu, které musí vyhledávací dotaz pokrýt, aby se dotaz ohlásil jako úspěšný. Tento parametr může být užitečný pro zajištění dostupnosti vyhledávání i pro služby, které mají jenom jednu repliku. Výchozí hodnota je 100.
orderby	string	Seznam OData oddělený čárkami $orderby výrazy, podle kterých se mají výsledky seřadit. Každý výraz může být buď názvem pole, nebo voláním funkcí geo.distance() nebo search.score(). Za každým výrazem může následovat asc, který označuje vzestupně, nebo výraz desc, který označuje sestupně. Výchozí hodnota je vzestupné pořadí. Vazby se přeruší skóre shody dokumentů. Pokud není zadána žádná $orderby, je výchozí pořadí řazení sestupné podle skóre shody dokumentu. Může existovat maximálně 32 $orderby klauzulí.
queryLanguage	QueryLanguage	Hodnota, která určuje jazyk vyhledávacího dotazu.
queryType	QueryType	Hodnota, která určuje syntaxi vyhledávacího dotazu. Výchozí hodnota je "jednoduchá". Pokud dotaz používá syntaxi dotazů Lucene, použijte full.
scoringParameters	string[]	Seznam hodnot parametrů, které se mají použít v bodovacích funkcích (například referencePointParameter) s použitím formátu name-values. Pokud například bodovací profil definuje funkci s parametrem s názvem "mylocation", řetězec parametru bude "mylocation--122.2;44.8" (bez uvozovek).
scoringProfile	string	Název profilu bodování, který má vyhodnotit skóre shody pro odpovídající dokumenty, aby bylo možné výsledky seřadit.
scoringStatistics	ScoringStatistics	Hodnota, která určuje, jestli chceme vypočítat statistiku bodování (například četnost dokumentů) globálně pro konzistentnější bodování, nebo místně pro nižší latenci. Výchozí hodnota je local. Globální použijte k globální agregaci statistik bodování před vyhodnocením. Použití globálních statistik bodování může zvýšit latenci vyhledávacích dotazů.
search	string	Výraz fulltextového vyhledávacího dotazu; Pokud chcete spárovat všechny dokumenty, použijte "*" nebo tento parametr vyněžte.
searchFields	string	Seznam názvů polí oddělených čárkami, na které se má nastavit rozsah fulltextového vyhledávání. Při použití hledání v polích (fieldName:searchExpression) v úplném dotazu Lucene mají názvy polí jednotlivých výrazů hledání v polích přednost před názvy polí uvedených v tomto parametru.
searchMode	SearchMode	Hodnota, která určuje, jestli se musí některé nebo všechny hledané termíny shodovat, aby bylo možné dokument spočítat jako shodu.
select	string	Seznam polí oddělených čárkami, která se mají načíst. Pokud není zadáno, budou zahrnuta všechna pole označená jako načístelná ve schématu.
semanticConfiguration	string	Název sémantické konfigurace, která se použije při zpracování dokumentů pro sémantické dotazy typu.
semanticErrorHandling	SemanticErrorMode	Umožňuje uživateli zvolit, jestli má sémantické volání zcela selhat, nebo vrátit částečné výsledky (výchozí).
semanticFields	string	Seznam názvů polí oddělených čárkami, který se používá pro sémantické řazení.
semanticMaxWaitInMilliseconds	integer	Umožňuje uživateli nastavit horní mez na dobu potřebnou k dokončení zpracování sémantického obohacení, než požadavek selže.
semanticQuery	string	Umožňuje nastavit samostatný vyhledávací dotaz, který se bude používat výhradně pro sémantické řazení, sémantické titulky a sémantické odpovědi. Je užitečný ve scénářích, kdy je potřeba použít různé dotazy mezi fází základního načtení a řazení a sémantickou fází L2.
sessionId	string	Hodnota, která se má použít k vytvoření relace sticky, což může pomoct získat konzistentnější výsledky. Pokud se použije stejné ID relace, provede se pokus o cílení na stejnou sadu replik. Buďte opatrní, že opakované použití stejných hodnot sessionID může narušovat vyrovnávání zatížení požadavků napříč replikami a nepříznivě ovlivnit výkon vyhledávací služby. Hodnota použitá jako sessionId nemůže začínat znakem _.
skip	integer	Počet výsledků hledání, které se mají přeskočit. Tato hodnota nesmí být větší než 100 000. Pokud potřebujete skenovat dokumenty v posloupnosti, ale kvůli tomuto omezení nemůžete použít funkci skip, zvažte použití orderby u zcela seřazeného klíče a filtrování pomocí dotazu na rozsah.
speller	QuerySpellerType	Hodnota, která určila typ pravopisu, který se má použít k opravě pravopisu jednotlivých výrazů vyhledávacího dotazu.
top	integer	Počet výsledků hledání, které se mají načíst. To se dá použít ve spojení s $skip k implementaci stránkování výsledků hledání na straně klienta. Pokud jsou výsledky zkráceny kvůli stránkování na straně serveru, odpověď bude obsahovat pokračovací token, který lze použít k vydání dalšího požadavku hledání na další stránku výsledků.
vectorFilterMode	VectorFilterMode	Určuje, zda jsou filtry použity před nebo po provedení vektorového vyhledávání. Výchozí hodnota je preFilter.
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	Parametry dotazu pro vektorové a hybridní vyhledávací dotazy.

Odpovědi

Name	Typ	Description
200 OK	SearchDocumentsResult	Odpověď obsahující dokumenty, které odpovídají kritériím hledání.
Other Status Codes	SearchError	Odpověď na chybu.

Příklady

SearchIndexSearchDocumentsPost

Ukázkový požadavek

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2023-10-01-Preview

{
  "count": true,
  "facets": [
    "category,count:10,sort:count"
  ],
  "filter": "rating gt 4.0",
  "highlight": "description",
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": null,
  "orderby": "rating desc",
  "queryType": "simple",
  "scoringParameters": [
    "currentLocation--122.123,44.77233"
  ],
  "scoringProfile": "sp",
  "search": "nice hotels",
  "searchFields": "category,description",
  "searchMode": "any",
  "sessionId": "mysessionid",
  "scoringStatistics": "global",
  "select": "hotelId,description",
  "skip": 0,
  "top": 10,
  "vectorQueries": [
    {
      "kind": "vector",
      "vector": [
        0.103,
        0.0712,
        0.0852,
        0.1547,
        0.1183
      ],
      "fields": "descriptionEmbedding",
      "k": 5,
      "exhaustive": true
    }
  ],
  "vectorFilterMode": "preFilter"
}

Ukázková odpověď

Stavový kód:

200

{
  "@odata.count": 25,
  "@search.facets": {
    "category": [
      {
        "count": 1,
        "value": "Economy"
      },
      {
        "count": 1,
        "value": "Luxury"
      }
    ]
  },
  "@search.nextPageParameters": {
    "count": true,
    "facets": [
      "category,count:10,sort:count"
    ],
    "filter": "rating gt 4.0",
    "highlight": "title",
    "highlightPostTag": "</em>",
    "highlightPreTag": "<em>",
    "minimumCoverage": null,
    "orderby": "search.score() desc,rating desc",
    "queryType": "simple",
    "sessionId": "mysessionid",
    "scoringStatistics": "global",
    "scoringParameters": [
      "currentLocation--122.123,44.77233"
    ],
    "scoringProfile": "sp",
    "search": "nice hotels",
    "searchFields": "title,description",
    "searchMode": "any",
    "select": "docId,title,description",
    "skip": 2,
    "top": 8
  },
  "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"
    }
  ],
  "@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2023-10-01-Preview"
}

Definice

Name	Description
AnswerResult	Odpověď je textová pasáž extrahovaná z obsahu nejdůležitějších dokumentů, které odpovídaly dotazu. Odpovědi se extrahují z nejlepších výsledků hledání. Kandidáti odpovědí jsou hodnoceni a vyberou se nejlepší odpovědi.
CaptionResult	Titulky jsou nejreprezentativnější pasáže z dokumentu relativně k vyhledávacímu dotazu. Často se používají jako souhrn dokumentů. Titulky se vrátí pouze pro dotazy typu sémantické.
DocumentDebugInfo	Obsahuje informace o ladění, které lze použít k dalšímu prozkoumání výsledků hledání.
QueryAnswerType	Hodnota, která určuje, zda mají být odpovědi vráceny jako součást odpovědi hledání.
QueryCaptionType	Hodnota, která určuje, zda mají být titulky vráceny jako součást odpovědi hledání.
QueryDebugMode	Umožňuje ladicí nástroj, který můžete použít k dalšímu prozkoumání výsledků hledání.
QueryLanguage	Jazyk dotazu.
QueryResultDocumentRerankerInput	Nezpracované zřetězené řetězce, které byly odeslány do procesu sémantického rozšiřování.
QueryResultDocumentSemanticField	Popis polí odeslaných do procesu sémantického rozšiřování a způsob jejich použití
QuerySpellerType	Hodnota, která určila typ kontroly pravopisu, který se má použít ke kontrole pravopisu jednotlivých výrazů hledaného dotazu.
QueryType	Určuje syntaxi vyhledávacího dotazu. Výchozí hodnota je "jednoduchá". Pokud váš dotaz používá syntaxi dotazu Lucene, použijte "úplné", a "sémantické", pokud syntaxi dotazu nepotřebujete.
RawVectorQuery	Parametry dotazu, které se mají použít pro vektorové vyhledávání, když je zadaná nezpracovaná hodnota vektoru.
ScoringStatistics	Hodnota, která určuje, jestli chceme vypočítat statistiku bodování (například četnost dokumentů) globálně pro konzistentnější bodování, nebo místně pro nižší latenci. Výchozí hodnota je local. Globální použijte k globální agregaci statistik bodování před vyhodnocením. Použití globálních statistik bodování může zvýšit latenci vyhledávacích dotazů.
SearchDocumentsResult	Odpověď obsahující výsledky hledání z indexu
SearchError	Popisuje chybovou podmínku rozhraní API.
SearchMode	Určuje, jestli se některé nebo všechny hledané termíny musí shodovat, aby bylo možné dokument spočítat jako shodu.
SearchRequest	Parametry pro filtrování, řazení, fasetování, stránkování a další chování vyhledávacích dotazů
SearchResult	Obsahuje dokument nalezený vyhledávacím dotazem a přidružená metadata.
SemanticDebugInfo
SemanticErrorMode	Umožňuje uživateli zvolit, jestli má sémantické volání selhat úplně, nebo vrátit částečné výsledky (výchozí).
SemanticErrorReason	Důvod, proč se pro požadavek na sémantické hodnocení vrátila částečná odpověď
SemanticFieldState	Způsob, jakým bylo pole použito pro proces sémantického rozšiřování (plně využité, částečně využité nebo nepoužité)
SemanticSearchResultsType	Typ částečné odpovědi, která byla vrácena pro požadavek na sémantické řazení.
VectorFilterMode	Určuje, zda jsou použity filtry před nebo po provedení vektorového vyhledávání.
VectorizableTextQuery	Parametry dotazu, které se mají použít pro vektorové vyhledávání, když je zadaná textová hodnota, kterou je potřeba vektorizovat.
VectorQueryKind	Druh vektorového dotazu, který se provádí.

AnswerResult

Odpověď je textová pasáž extrahovaná z obsahu nejdůležitějších dokumentů, které odpovídaly dotazu. Odpovědi se extrahují z nejlepších výsledků hledání. Kandidáti odpovědí jsou hodnoceni a vyberou se nejlepší odpovědi.

Name	Typ	Description
highlights	string	Stejná pasáž textu jako ve vlastnosti Text se zvýrazněnými textovými frázemi, které jsou pro dotaz nejrelevantní.
key	string	Klíč dokumentu, ze které byla odpověď extrahována.
score	number	Hodnota skóre představuje, jak relevantní je odpověď na dotaz vzhledem k ostatním odpovědím vrácených pro dotaz.
text	string	Textová pasáž extrahovaná z obsahu dokumentu jako odpověď

CaptionResult

Titulky jsou nejreprezentativnější pasáže z dokumentu relativně k vyhledávacímu dotazu. Často se používají jako souhrn dokumentů. Titulky se vrátí pouze pro dotazy typu sémantické.

Name	Typ	Description
highlights	string	Stejný text jako ve vlastnosti Text se zvýrazněnými frázemi, které jsou pro dotaz nejrelevantní.
text	string	Reprezentativní textová pasáž extrahovaná z dokumentu, který je pro vyhledávací dotaz nejrelevativnější.

DocumentDebugInfo

Obsahuje informace o ladění, které lze použít k dalšímu prozkoumání výsledků hledání.

Name	Typ	Description
semantic	SemanticDebugInfo	Obsahuje informace o ladění specifické pro žádosti o sémantické řazení.

QueryAnswerType

Hodnota, která určuje, zda mají být odpovědi vráceny jako součást odpovědi hledání.

Name	Typ	Description
extractive	string	Extrahuje kandidáty na odpovědi z obsahu dokumentů vrácených jako odpověď na dotaz vyjádřený jako otázka v přirozeném jazyce.
none	string	Nevracejte odpovědi na dotaz.

QueryCaptionType

Hodnota, která určuje, zda mají být titulky vráceny jako součást odpovědi hledání.

Name	Typ	Description
extractive	string	Extrahuje titulky z odpovídajících dokumentů, které obsahují pasáže relevantní pro vyhledávací dotaz.
none	string	Nevrací titulky pro dotaz.

QueryDebugMode

Umožňuje ladicí nástroj, který můžete použít k dalšímu prozkoumání výsledků hledání.

Name	Typ	Description
disabled	string	Nebudou vráceny žádné informace o ladění dotazů.
semantic	string	Umožňuje uživateli dále prozkoumat jeho přeřaděné výsledky.

QueryLanguage

Jazyk dotazu.

Name	Typ	Description
ar-eg	string	Hodnota jazyka dotazu pro arabštinu (Egypt).
ar-jo	string	Hodnota jazyka dotazu pro arabštinu (Jordánsko)
ar-kw	string	Hodnota jazyka dotazu pro arabštinu (Kuvajt)
ar-ma	string	Hodnota jazyka dotazu pro arabštinu (Maroko)
ar-sa	string	Hodnota jazyka dotazu pro arabštinu (Saúdská Arábie)
bg-bg	string	Hodnota jazyka dotazu pro bulharštinu (Bulharsko)
bn-in	string	Hodnota jazyka dotazu pro Bengálština (Indie)
ca-es	string	Hodnota jazyka dotazu pro katalánštinu
cs-cz	string	Hodnota jazyka dotazu pro češtinu (Česká republika).
da-dk	string	Hodnota jazyka dotazu pro dánštinu (Dánsko).
de-de	string	Hodnota jazyka dotazu pro němčinu (Německo).
el-gr	string	Hodnota jazyka dotazu pro řečtinu (Řecko)
en-au	string	Hodnota jazyka dotazu pro angličtinu (Austrálie)
en-ca	string	Hodnota jazyka dotazu pro angličtinu (Kanada)
en-gb	string	Hodnota jazyka dotazu pro angličtinu (Velká Británie)
en-in	string	Hodnota jazyka dotazu pro angličtinu (Indie)
en-us	string	Hodnota jazyka dotazu pro angličtinu (USA).
es-es	string	Hodnota jazyka dotazu pro španělštinu (Španělsko).
es-mx	string	Hodnota jazyka dotazu pro španělštinu (Mexiko)
et-ee	string	Hodnota jazyka dotazu pro Estonština (Estonsko)
eu-es	string	Hodnota jazyka dotazu pro baskicko
fa-ae	string	Hodnota jazyka dotazu perština (USA)
fi-fi	string	Hodnota jazyka dotazu pro finštinu (Finsko)
fr-ca	string	Hodnota jazyka dotazu pro francouzštinu (Kanada)
fr-fr	string	Hodnota jazyka dotazu pro francouzštinu (Francie)
ga-ie	string	Hodnota jazyka dotazu pro Irština (Irsko).
gl-es	string	Hodnota jazyka dotazu pro galicijštinu
gu-in	string	Hodnota jazyka dotazu pro Gudžarátština (Indie)
he-il	string	Hodnota jazyka dotazu pro hebrejštinu (Izrael)
hi-in	string	Hodnota jazyka dotazu pro hindštinu (Indie)
hr-ba	string	Hodnota jazyka dotazu pro chorvatštinu (Bosna a Hercegovina)
hr-hr	string	Hodnota jazyka dotazu pro chorvatštinu (Chorvatsko)
hu-hu	string	Hodnota jazyka dotazu pro maďarština (Maďarsko)
hy-am	string	Hodnota jazyka dotazu pro Arménština (Arménie)
id-id	string	Hodnota jazyka dotazu pro indonéštinu (Indonésie).
is-is	string	Hodnota jazyka dotazu pro Island (Island)
it-it	string	Hodnota jazyka dotazu pro italštinu (Itálie)
ja-jp	string	Hodnota jazyka dotazu pro japonštinu (Japonsko)
kn-in	string	Hodnota jazyka dotazu pro Kannadu (Indie)
ko-kr	string	Hodnota jazyka dotazu pro korejštinu (Korea)
lt-lt	string	Hodnota jazyka dotazu pro litevštinu (Litva).
lv-lv	string	Hodnota dotazovacího jazyka pro lotyštinu (Lotyšsko).
ml-in	string	Hodnota jazyka dotazu pro Malayalam (Indie)
mr-in	string	Hodnota jazyka dotazu pro Marathi (Indie)
ms-bn	string	Hodnota jazyka dotazu pro Malajština (Brunej Darussalam)
ms-my	string	Hodnota jazyka dotazu pro Malajština (Malajsie)
nb-no	string	Hodnota jazyka dotazu pro norštinu (Norsko)
nl-be	string	Hodnota jazyka dotazu pro nizozemštinu (Belgie).
nl-nl	string	Hodnota jazyka dotazu pro holandštinu (Nizozemsko)
no-no	string	Hodnota jazyka dotazu pro norštinu (Norsko)
none	string	Nebyl zadán dotazovací jazyk.
pa-in	string	Hodnota jazyka dotazu pro Punjabi (Indie)
pl-pl	string	Hodnota jazyka dotazu pro polštinu (Polsko).
pt-br	string	Hodnota jazyka dotazu pro portugalštinu (Brazílie)
pt-pt	string	Hodnota jazyka dotazu pro portugalštinu (Portugalsko)
ro-ro	string	Hodnota jazyka dotazu pro rumunština (Rumunsko)
ru-ru	string	Hodnota jazyka dotazu pro ruštinu (Rusko)
sk-sk	string	Hodnota jazyka dotazu pro slovenštinu (Slovensko).
sl-sl	string	Hodnota jazyka dotazu pro slovinštinu (Slovinsko)
sr-ba	string	Hodnota jazyka dotazu pro Srbština (Bosna a Hercegovina)
sr-me	string	Hodnota jazyka dotazu pro Srbština (Černá Hora)
sr-rs	string	Hodnota jazyka dotazu pro Srbština (Srbsko).
sv-se	string	Hodnota jazyka dotazu pro švédštinu (Švédsko)
ta-in	string	Hodnota jazyka dotazu pro tamilštinu (Indie)
te-in	string	Hodnota jazyka dotazu pro Telugu (Indie)
th-th	string	Hodnota jazyka dotazu pro thajštinu (Thajsko)
tr-tr	string	Hodnota jazyka dotazu pro turečtinu (Turecko)
uk-ua	string	Hodnota jazyka dotazu pro Ukrajinština (Ukrajina)
ur-pk	string	Hodnota jazyka dotazu urdština (Pákistán)
vi-vn	string	Hodnota jazyka dotazu pro vietnamštinu (vietnamština)
zh-cn	string	Hodnota jazyka dotazu pro čínštinu (Čína).
zh-tw	string	Hodnota jazyka dotazu pro čínštinu (Tchaj-wan)

QueryResultDocumentRerankerInput

Nezpracované zřetězené řetězce, které byly odeslány do procesu sémantického rozšiřování.

Name	Typ	Description
content	string	Nezpracované zřetězené řetězce pro pole obsahu, která byla použita pro sémantické rozšiřování.
keywords	string	Nezpracované zřetězené řetězce pro pole klíčových slov, která byla použita pro sémantické rozšiřování.
title	string	Nezpracovaný řetězec pro pole názvu, které bylo použito pro sémantické rozšiřování.

QueryResultDocumentSemanticField

Popis polí odeslaných do procesu sémantického rozšiřování a způsob jejich použití

Name	Typ	Description
name	string	Název pole odeslaného do procesu sémantického obohacení
state	SemanticFieldState	Způsob, jakým bylo pole použito pro proces sémantického rozšiřování (plně využité, částečně využité nebo nepoužité)

QuerySpellerType

Hodnota, která určila typ kontroly pravopisu, který se má použít ke kontrole pravopisu jednotlivých výrazů hledaného dotazu.

Name	Typ	Description
lexicon	string	Kontrola pravopisu opravuje jednotlivé termíny dotazu pomocí statického lexikonu pro jazyk určený parametrem queryLanguage.
none	string	Kontrola pravopisu není povolena.

QueryType

Určuje syntaxi vyhledávacího dotazu. Výchozí hodnota je "jednoduchá". Pokud váš dotaz používá syntaxi dotazu Lucene, použijte "úplné", a "sémantické", pokud syntaxi dotazu nepotřebujete.

Name	Typ	Description
full	string	Používá úplnou syntaxi dotazů Lucene pro vyhledávání. Hledaný text se interpretuje pomocí dotazovacího jazyka Lucene, který umožňuje vyhledávání specifické pro pole a vážené vyhledávání a další pokročilé funkce.
semantic	string	Nejvhodnější pro dotazy vyjádřené v přirozeném jazyce na rozdíl od klíčových slov. Zlepšuje přesnost výsledků hledání tím, že přehodnocuje nejlepší výsledky hledání pomocí modelu řazení natrénovaného na webovém korpusu.
simple	string	Používá jednoduchou syntaxi dotazu pro hledání. Hledaný text se interpretuje pomocí jednoduchého dotazovacího jazyka, který umožňuje používat symboly jako +, * a "". Dotazy se ve výchozím nastavení vyhodnocují napříč všemi prohledávatelnými poli, pokud není zadaný parametr searchFields.

RawVectorQuery

Parametry dotazu, které se mají použít pro vektorové vyhledávání, když je zadaná nezpracovaná hodnota vektoru.

Name	Typ	Description
exhaustive	boolean	Pokud je hodnota true, aktivuje vyčerpávající vyhledávání k-nejbližších sousedů napříč všemi vektory v rámci indexu vektoru. Užitečné ve scénářích, kde jsou přesné shody kritické, jako je například určení základní hodnoty pravdivosti.
fields	string	Vektorová pole typu Collection(Edm.Single), která mají být zahrnuta do hledaného vektoru.
k	integer	Počet nejbližších sousedů, které se mají vrátit jako první hity
kind	string: vector	Druh vektorového dotazu, který se provádí.
vector	number[]	Vektorové znázornění vyhledávacího dotazu.

ScoringStatistics

Hodnota, která určuje, jestli chceme vypočítat statistiku bodování (například četnost dokumentů) globálně pro konzistentnější bodování, nebo místně pro nižší latenci. Výchozí hodnota je local. Globální použijte k globální agregaci statistik bodování před vyhodnocením. Použití globálních statistik bodování může zvýšit latenci vyhledávacích dotazů.

Name	Typ	Description
global	string	Statistiky bodování se počítají globálně, aby bylo skóre konzistentnější.
local	string	Statistika bodování se vypočítá místně pro nižší latenci.

SearchDocumentsResult

Odpověď obsahující výsledky hledání z indexu

Name	Typ	Description
@odata.count	integer	Celkový počet výsledků nalezených operací hledání nebo hodnota null, pokud počet nebyl požadován. Pokud je k dispozici, může být počet větší než počet výsledků v této odpovědi. K tomu může dojít, pokud použijete parametry $top nebo $skip nebo pokud dotaz nemůže vrátit všechny požadované dokumenty v jedné odpovědi.
@odata.nextLink	string	Adresa URL pro pokračování se vrátí, když dotaz nemůže vrátit všechny požadované výsledky v jedné odpovědi. Tuto adresu URL můžete použít k formulování dalšího požadavku GET nebo POST Search, abyste získali další část odpovědi hledání. Ujistěte se, že používáte stejnou operaci (GET nebo POST) jako požadavek, který vytvořil tuto odpověď.
@search.answers	AnswerResult[]	Výsledky dotazu odpovědí pro operaci hledání; null, pokud nebyl parametr dotazu answers zadán nebo nastaven na hodnotu none.
@search.coverage	number	Hodnota označující procento indexu, které bylo zahrnuto do dotazu, nebo hodnotu null, pokud nebyla v požadavku zadána hodnota minimumCoverage.
@search.facets	object	Výsledky fazety dotazu pro operaci vyhledávání, uspořádané jako kolekce kbelíků pro každou fasetovou pole; null, pokud dotaz neobsažil výrazy omezující vlastnosti.
@search.nextPageParameters	SearchRequest	Datová část JSON pro pokračování se vrátí, když dotaz nemůže vrátit všechny požadované výsledky v jedné odpovědi. Tento kód JSON můžete použít společně s @odata.nextLink nástrojem k formulování dalšího požadavku POST Search, abyste získali další část odpovědi hledání.
@search.semanticPartialResponseReason	SemanticErrorReason	Důvod, proč se pro požadavek na sémantické hodnocení vrátila částečná odpověď
@search.semanticPartialResponseType	SemanticSearchResultsType	Typ částečné odpovědi, která byla vrácena pro požadavek na sémantické řazení.
value	SearchResult[]	Posloupnost výsledků vrácených dotazem

SearchError

Popisuje chybovou podmínku rozhraní API.

Name	Typ	Description
code	string	Jeden ze serverem definovaných chybových kódů.
details	SearchError[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
message	string	Lidsky čitelná reprezentace chyby.

SearchMode

Určuje, jestli se některé nebo všechny hledané termíny musí shodovat, aby bylo možné dokument spočítat jako shodu.

Name	Typ	Description
all	string	Všechny hledané termíny se musí shodovat, aby bylo možné dokument spočítat jako shodu.
any	string	Aby bylo možné dokument spočítat jako shodu, musí se shodovat všechny hledané termíny.

SearchRequest

Parametry pro filtrování, řazení, fasetování, stránkování a další chování vyhledávacích dotazů

Name	Typ	Description
answers	QueryAnswerType	Hodnota, která určuje, zda mají být odpovědi vráceny jako součást odpovědi hledání.
captions	QueryCaptionType	Hodnota, která určuje, zda mají být titulky vráceny jako součást odpovědi hledání.
count	boolean	Hodnota, která určuje, jestli se má načíst celkový počet výsledků. Výchozí hodnota je false. Nastavení této hodnoty na true může mít dopad na výkon. Všimněte si, že vrácený počet je aproximace.
debug	QueryDebugMode	Umožňuje ladicí nástroj, který můžete použít k dalšímu prozkoumání výsledků, které jste seřadili.
facets	string[]	Seznam výrazů omezujících vlastností, které se mají použít u vyhledávacího dotazu. Každý výraz omezující vlastnosti obsahuje název pole, za kterým volitelně následuje seznam dvojic název:hodnota oddělený čárkami.
filter	string	OData $filter výraz, který se má použít u vyhledávacího dotazu.
highlight	string	Seznam názvů polí oddělených čárkami, který se má použít pro zvýraznění přístupů. Ke zvýraznění přístupů je možné použít pouze prohledávatelná pole.
highlightPostTag	string	Značka řetězce, která se připojí ke zvýraznění přístupů. Musí být nastaven pomocí highlightPreTag. Výchozí hodnota je </em>.
highlightPreTag	string	Značka řetězce, která je předpřipená k dosažení zvýraznění. Musí být nastavený s highlightPostTag. Výchozí hodnota je <em>.
minimumCoverage	number	Číslo mezi 0 a 100 určující procento indexu, které musí vyhledávací dotaz pokrýt, aby se dotaz ohlásil jako úspěšný. Tento parametr může být užitečný pro zajištění dostupnosti vyhledávání i pro služby, které mají jenom jednu repliku. Výchozí hodnota je 100.
orderby	string	Seznam OData oddělený čárkami $orderby výrazy, podle kterých se mají výsledky seřadit. Každý výraz může být buď názvem pole, nebo voláním funkcí geo.distance() nebo search.score(). Za každým výrazem může následovat asc, který označuje vzestupně, nebo výraz desc, který označuje sestupně. Výchozí hodnota je vzestupné pořadí. Vazby se přeruší skóre shody dokumentů. Pokud není zadána žádná $orderby, je výchozí pořadí řazení sestupné podle skóre shody dokumentu. Může existovat maximálně 32 $orderby klauzulí.
queryLanguage	QueryLanguage	Hodnota, která určuje jazyk vyhledávacího dotazu.
queryType	QueryType	Hodnota, která určuje syntaxi vyhledávacího dotazu. Výchozí hodnota je "jednoduchá". Pokud dotaz používá syntaxi dotazů Lucene, použijte full.
scoringParameters	string[]	Seznam hodnot parametrů, které se mají použít ve funkcích bodování (například referencePointParameter) pomocí formátu name-values. Pokud například profil bodování definuje funkci s parametrem s názvem "mylocation", řetězec parametru bude "moje_poloha--122.2,44.8" (bez uvozovek).
scoringProfile	string	Název hodnoticího profilu pro vyhodnocení skóre shody pro odpovídající dokumenty, aby bylo možné výsledky seřadit.
scoringStatistics	ScoringStatistics	Hodnota, která určuje, jestli chceme vypočítat statistiku bodování (například četnost dokumentů) globálně pro konzistentnější bodování, nebo místně pro nižší latenci. Výchozí hodnota je local. Globální použijte k globální agregaci statistik bodování před vyhodnocením. Použití globálních statistik bodování může zvýšit latenci vyhledávacích dotazů.
search	string	Výraz dotazu fulltextového vyhledávání; Pokud chcete porovnat všechny dokumenty, použijte "*" nebo tento parametr vyněžte.
searchFields	string	Seznam názvů polí oddělených čárkami, na který chcete nastavit obor fulltextového vyhledávání. Při použití vyhledávání v polích (fieldName:searchExpression) v úplném dotazu Lucene mají názvy polí jednotlivých výrazů hledání v polích přednost před názvy polí uvedenými v tomto parametru.
searchMode	SearchMode	Hodnota, která určuje, jestli se musí shodovat některé nebo všechny hledané termíny, aby bylo možné počítat dokument jako shodu.
select	string	Seznam polí oddělených čárkami, která se mají načíst. Pokud není zadáno, budou zahrnuta všechna pole označená jako zobrazitelná ve schématu.
semanticConfiguration	string	Název sémantické konfigurace, která se použije při zpracování dokumentů pro sémantické dotazy typu.
semanticErrorHandling	SemanticErrorMode	Umožňuje uživateli zvolit, jestli má sémantické volání selhat úplně, nebo vrátit částečné výsledky (výchozí).
semanticFields	string	Seznam názvů polí oddělených čárkami, který se používá pro sémantické řazení.
semanticMaxWaitInMilliseconds	integer	Umožňuje uživateli nastavit horní mez doby, kterou trvá sémantické obohacení k dokončení zpracování, než požadavek selže.
semanticQuery	string	Umožňuje nastavit samostatný vyhledávací dotaz, který se bude používat výhradně pro sémantické řazení, sémantické titulky a sémantické odpovědi. Je užitečná ve scénářích, kdy je potřeba použít různé dotazy mezi základní fází načítání a řazení a sémantickou fází L2.
sessionId	string	Hodnota, která se má použít k vytvoření relace sticky, což může pomoct získat konzistentnější výsledky. Pokud se použije stejné ID relace, provede se pokus o cílení na stejnou sadu replik. Buďte opatrní, že opakované použití stejných hodnot sessionID může narušovat vyrovnávání zatížení požadavků napříč replikami a nepříznivě ovlivnit výkon vyhledávací služby. Hodnota použitá jako sessionId nemůže začínat znakem _.
skip	integer	Počet výsledků hledání, které se mají přeskočit. Tato hodnota nesmí být větší než 100 000. Pokud potřebujete skenovat dokumenty v pořadí, ale kvůli tomuto omezení nemůžete použít funkci skip, zvažte použití orderby u klíče s úplným pořadím a místo toho použijte k filtrování dotaz na rozsah.
speller	QuerySpellerType	Hodnota, která určila typ kontroly pravopisu, který se má použít ke kontrole pravopisu jednotlivých výrazů hledaného dotazu.
top	integer	Počet výsledků hledání, které se mají načíst. To lze použít ve spojení s $skip k implementaci stránkování výsledků hledání na straně klienta. Pokud jsou výsledky zkráceny kvůli stránkování na straně serveru, odpověď bude obsahovat pokračovací token, který lze použít k vydání dalšího požadavku vyhledávání na další stránku výsledků.
vectorFilterMode	VectorFilterMode	Určuje, zda jsou použity filtry před nebo po provedení vektorového vyhledávání. Výchozí hodnota je preFilter.
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	Parametry dotazu pro vektorové a hybridní vyhledávací dotazy.

SearchResult

Obsahuje dokument nalezený vyhledávacím dotazem a přidružená metadata.

Name	Typ	Description
@search.captions	CaptionResult[]	Titulky jsou nejreprezentativnější pasáže z dokumentu relativně k vyhledávacímu dotazu. Často se používají jako souhrn dokumentů. Titulky se vrátí pouze pro dotazy typu sémantické.
@search.documentDebugInfo	DocumentDebugInfo[]	Obsahuje informace o ladění, které lze použít k dalšímu prozkoumání výsledků hledání.
@search.highlights	object	Fragmenty textu z dokumentu, které označují odpovídající hledané termíny uspořádané podle jednotlivých příslušných polí; null, pokud pro dotaz nebylo povolené zvýrazňování přístupů.
@search.rerankerScore	number	Skóre relevance vypočítané sémantickým rankerem pro nejlepší výsledky hledání. Výsledky hledání se nejprve seřadí podle skóre RerankerScore a pak podle skóre. RerankerScore se vrátí pouze pro dotazy typu sémantické.
@search.score	number	Skóre relevance dokumentu v porovnání s jinými dokumenty vrácenými dotazem.

SemanticDebugInfo

Name	Typ	Description
contentFields	QueryResultDocumentSemanticField[]	Pole obsahu odeslaná do procesu sémantického rozšiřování a způsob jejich použití
keywordFields	QueryResultDocumentSemanticField[]	Pole klíčových slov odeslaná do procesu sémantického rozšiřování a způsob jejich použití
rerankerInput	QueryResultDocumentRerankerInput	Nezpracované zřetězené řetězce, které byly odeslány do procesu sémantického rozšiřování.
titleField	QueryResultDocumentSemanticField	Pole názvu, které bylo odesláno do procesu sémantického obohacení, a také způsob jeho použití

SemanticErrorMode

Umožňuje uživateli zvolit, jestli má sémantické volání selhat úplně, nebo vrátit částečné výsledky (výchozí).

Name	Typ	Description
fail	string	Pokud během kroku sémantického zpracování dojde k výjimce, dotaz selže a v závislosti na chybě vrátí příslušný kód HTTP.
partial	string	Pokud se sémantické zpracování nezdaří, částečné výsledky se přesto vrátí. Definice částečných výsledků závisí na tom, jaký sémantický krok selhal a co bylo důvodem selhání.

SemanticErrorReason

Důvod, proč se pro požadavek na sémantické hodnocení vrátila částečná odpověď

Name	Typ	Description
capacityOverloaded	string	Požadavek se omezil. Vrátily se jenom základní výsledky.
maxWaitExceeded	string	Pokud byla nastavena hodnota "semanticMaxWaitInMilliseconds" a doba trvání sémantického zpracování překročila danou hodnotu. Vrátily se jenom základní výsledky.
transient	string	Nejméně jeden krok sémantického procesu selhal.

SemanticFieldState

Způsob, jakým bylo pole použito pro proces sémantického rozšiřování (plně využité, částečně využité nebo nepoužité)

Name	Typ	Description
partial	string	Pole bylo částečně použito pro sémantické rozšiřování.
unused	string	Pole nebylo použito pro sémantické rozšiřování.
used	string	Pole bylo plně použito pro sémantické rozšiřování.

SemanticSearchResultsType

Typ částečné odpovědi, která byla vrácena pro požadavek na sémantické řazení.

Name	Typ	Description
baseResults	string	Výsledky bez sémantického obohacení nebo změna pořadí.
rerankedResults	string	Výsledky byly přeřazené s modelem rerankeru a budou obsahovat sémantické titulky. Nebudou obsahovat žádné odpovědi, zvýraznění odpovědí ani popis zvýraznění.

VectorFilterMode

Určuje, zda jsou použity filtry před nebo po provedení vektorového vyhledávání.

Name	Typ	Description
postFilter	string	Filtr se použije po vrácení kandidátské sady výsledků vektoru. V závislosti na selektivitě filtru to může vést k menšímu počtu výsledků, než požaduje parametr k.
preFilter	string	Filtr se použije před vyhledávacím dotazem.

VectorizableTextQuery

Parametry dotazu, které se mají použít pro vektorové vyhledávání, když je zadaná textová hodnota, kterou je potřeba vektorizovat.

Name	Typ	Description
exhaustive	boolean	Pokud je hodnota true, aktivuje vyčerpávající vyhledávání k-nejbližších sousedů napříč všemi vektory v rámci indexu vektoru. Užitečné ve scénářích, kde jsou přesné shody kritické, jako je například určení základní hodnoty pravdivosti.
fields	string	Vektorová pole typu Collection(Edm.Single), která mají být zahrnuta do hledaného vektoru.
k	integer	Počet nejbližších sousedů, které se mají vrátit jako první hity
kind	string: text	Druh vektorového dotazu, který se provádí.
text	string	Text, který má být vektorizován k provedení vektorového vyhledávacího dotazu.

VectorQueryKind

Druh vektorového dotazu, který se provádí.

Name	Typ	Description
text	string	Vektorový dotaz, ve kterém je zadaná textová hodnota, kterou je potřeba vektorizovat.
vector	string	Vektorový dotaz, ve kterém je zadaná nezpracovaná hodnota vektoru.