Documents - Search Get
Vyhledá dokumenty v indexu.
GET {endpoint}/indexes('{indexName}')/docs?api-version=2024-05-01-preview
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-05-01-preview&semanticConfiguration={semanticConfiguration}&semanticErrorHandling={semanticErrorHandling}&semanticMaxWaitInMilliseconds={semanticMaxWaitInMilliseconds}&answers={answers}&captions={captions}&semanticQuery={semanticQuery}&debug={debug}&queryLanguage={queryLanguage}&speller={speller}&semanticFields={semanticFields}
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
Adresa URL koncového bodu vyhledávací služby. |
index
|
path | True |
string |
Název indexu. |
api-version
|
query | True |
string |
Verze rozhraní API klienta. |
$count
|
query |
boolean |
Hodnota, která určuje, zda se má načíst celkový počet výsledků. Výchozí hodnota je false. Nastavení této hodnoty na true může mít vliv na výkon. Všimněte si, že vrácený počet je přibližný. |
|
$filter
|
query |
string |
OData $filter výraz, který se má použít u vyhledávacího dotazu. |
|
$orderby
|
query |
string[] |
Seznam OData $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ě, a desc pro označení sestupného. Výchozí hodnota je vzestupné pořadí. Vazby budou přerušeny skóre shody dokumentů. Pokud není zadán žádný OrderBy, výchozí pořadí řazení je sestupné podle skóre shody dokumentu. Může existovat maximálně 32 $orderby klauzulí. |
|
$select
|
query |
string[] |
Seznam polí, která se mají načíst. Pokud není zadáno, budou zahrnuta všechna pole označená jako načístelná ve schématu. |
|
$skip
|
query |
integer int32 |
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 nemůžete kvůli tomuto omezení použít $skip, zvažte použití $orderby u zcela seřazeného klíče a $filter s dotazem na rozsah. |
|
$top
|
query |
integer int32 |
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ů. |
|
answers
|
query |
Tento parametr je platný pouze v případě, že je |
||
captions
|
query |
Tento parametr je platný pouze v případě, že je |
||
debug
|
query |
Umožňuje ladicí nástroj, který můžete použít k dalšímu prozkoumání výsledků hledání. |
||
facet
|
query |
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 čárkami oddělený seznam párů název:hodnota. |
|
highlight
|
query |
string[] |
Seznam názvů polí, které se mají použít pro zvýraznění přístupů. Ke zvýraznění přístupů je možné použít pouze prohledávatelná pole. |
|
highlight
|
query |
string |
Značka řetězce, která je připojena k dosažení zvýraznění. Musí být nastaven pomocí highlightPreTag. Výchozí hodnota je </em>. |
|
highlight
|
query |
string |
Značka řetězce, která je předem připravená k dosažení zvýraznění. Musí být nastaven pomocí highlightPostTag. Výchozí hodnota je <em>. |
|
minimum
|
query |
number double |
Číslo mezi 0 a 100 označující procento indexu, které musí být pokryto vyhledávacím dotazem, aby byl dotaz nahlášen 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. |
|
query
|
query |
Jazyk dotazu. |
||
query
|
query |
Hodnota, která určuje syntaxi vyhledávacího dotazu. Výchozí hodnota je "jednoduchá". Pokud dotaz používá syntaxi dotazu Lucene, použijte "full". |
||
scoring
|
query |
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). |
|
scoring
|
query |
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. |
|
scoring
|
query |
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. |
||
search
|
query |
string |
Výraz fulltextového vyhledávacího dotazu; Pokud chcete spárovat všechny dokumenty, použijte "*" nebo tento parametr vyněžte. |
|
search
|
query |
string[] |
Seznam názvů polí, 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. |
|
search
|
query |
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. |
||
semantic
|
query |
string |
Název sémantické konfigurace se seznamem polí, která se mají použít pro sémantické řazení, titulky, zvýraznění a odpovědi |
|
semantic
|
query |
Umožňuje uživateli zvolit, jestli má sémantické volání zcela selhat, nebo vrátit částečné výsledky (výchozí). |
||
semantic
|
query |
string[] |
Seznam názvů polí používaných pro sémantické řazení. |
|
semantic
|
query |
integer int32 |
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. |
|
semantic
|
query |
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. |
|
session
|
query |
string |
Hodnota, která se má použít k vytvoření rychlé relace, 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é 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 _. |
|
speller
|
query |
Zlepšete úplnost vyhledávání opravou pravopisu jednotlivých výrazů hledaných dotazů. |
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. |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
Odpověď obsahující dokumenty, které odpovídají kritériím hledání. |
|
Other Status Codes |
Odpověď na chybu. |
Příklady
SearchIndexSearchDocumentsGet
Ukázkový požadavek
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-05-01-preview&speller={speller}
Ukázková odpověď
{
"@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"
}
]
}
Definice
Name | Description |
---|---|
Answer |
Odpověď je textová pasáž extrahovaná z obsahu nejdůležitějších dokumentů, které odpovídají dotazu. Odpovědi se extrahují z hlavních výsledků hledání. Kandidáti odpovědí jsou ohodnocení a vyberou se nejlepší odpovědi. |
Caption |
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é. |
Document |
Obsahuje informace o ladění, které lze použít k dalšímu prozkoumání výsledků hledání. |
Error |
Další informace o chybě správy prostředků |
Error |
Podrobnosti o chybě |
Error |
Odpověď na chybu |
Hybrid |
Určuje, zda počet a omezující vlastnosti mají zahrnovat všechny dokumenty, které odpovídají vyhledávacímu dotazu, nebo pouze dokumenty, které jsou načteny v okně maxTextRecallSize. Výchozí hodnota je countAllResults. |
Hybrid |
Parametry dotazu pro konfiguraci chování hybridního vyhledávání. |
Query |
Hodnota, která určuje, zda mají být odpovědi vráceny jako součást odpovědi hledání. |
Query |
Hodnota, která určuje, zda mají být titulky vráceny jako součást odpovědi hledání. |
Query |
Umožňuje ladicí nástroj, který můžete použít k dalšímu prozkoumání výsledků hledání. |
Query |
Jazyk dotazu. |
Query |
Nezpracované zřetězené řetězce, které byly odeslány do procesu sémantického obohacení. |
Query |
Popis polí, která byla odeslána do procesu sémantického obohacení, a také způsob jejich použití |
Query |
Hodnota, která určila typ kontroly pravopisu, který se má použít ke kontrole pravopisu jednotlivých výrazů hledaného dotazu. |
Query |
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. |
Raw |
Parametry dotazu, které se mají použít pro vektorové vyhledávání, když je zadaná nezpracovaná hodnota vektoru. |
Scoring |
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í po celém světě před bodováním. Použití statistik globálního bodování může zvýšit latenci vyhledávacích dotazů. |
Search |
Odpověď obsahující výsledky hledání z indexu |
Search |
Určuje, zda musí být některé nebo všechny hledané termíny shodné, aby bylo možné dokument spočítat jako shodu. |
Search |
Parametry pro filtrování, řazení, fasetování, stránkování a další chování vyhledávacích dotazů |
Search |
Obsahuje dokument nalezený vyhledávacím dotazem a přidružená metadata. |
Search |
Výsledky vektorového dotazu se vyfiltruje na základě hodnoty @search.score. Všimněte si, že se jedná o vrácenou @search.score jako součást odpovědi hledání. Směr prahové hodnoty bude zvolen pro vyšší @search.scorehodnotu . |
Semantic |
|
Semantic |
Umožňuje uživateli zvolit, jestli má sémantické volání zcela selhat, nebo vrátit částečné výsledky (výchozí). |
Semantic |
Důvod, proč se pro požadavek na sémantické hodnocení vrátila částečná odpověď |
Semantic |
Způsob použití pole pro proces sémantického obohacování (plně využité, částečně použité nebo nepoužité) |
Semantic |
Typ částečné odpovědi, která byla vrácena pro požadavek na sémantické řazení. |
Speller |
Zlepšete úplnost vyhledávání opravou pravopisu jednotlivých výrazů hledaných dotazů. |
Vector |
Určuje, zda jsou použity filtry před nebo po provedení vektorového vyhledávání. |
Vectorizable |
Parametry dotazu, které se mají použít pro vektorové vyhledávání, pokud je zadán binární soubor s kódováním base 64 obrázku, který je potřeba vektorizovat. |
Vectorizable |
Parametry dotazu, které se mají použít pro vektorové vyhledávání, když je zadaná adresa URL, která představuje hodnotu obrázku, která je třeba vektorizovat. |
Vectorizable |
Parametry dotazu, které se mají použít pro vektorové vyhledávání, když je zadaná textová hodnota, kterou je potřeba vektorizovat. |
Vector |
Druh vektorového dotazu, který se provádí. |
Vector |
Výsledky vektorového dotazu budou filtrovány na základě metriky podobnosti vektorů. Všimněte si, že toto je kanonická definice metriky podobnosti, nikoli verze distance. Směr prahové hodnoty (větší nebo menší) bude zvolen automaticky podle metriky použité polem. |
Vector |
Druh vektorového dotazu, který se provádí. |
AnswerResult
Odpověď je textová pasáž extrahovaná z obsahu nejdůležitějších dokumentů, které odpovídají dotazu. Odpovědi se extrahují z hlavních výsledků hledání. Kandidáti odpovědí jsou ohodnocení a vyberou se nejlepší odpovědi.
Name | Typ | Description |
---|---|---|
highlights |
string |
Stejná textová pasáž 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 extrahována odpověď. |
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 |
Obsahuje informace o ladění specifické pro žádosti o sémantické řazení. |
ErrorAdditionalInfo
Další informace o chybě správy prostředků
Name | Typ | Description |
---|---|---|
info |
object |
Další informace. |
type |
string |
Typ další informace. |
ErrorDetail
Podrobnosti o chybě
Name | Typ | Description |
---|---|---|
additionalInfo |
Další informace o chybě. |
|
code |
string |
Kód chyby |
details |
Podrobnosti o chybě. |
|
message |
string |
Chybová zpráva |
target |
string |
Cíl chyby. |
ErrorResponse
Odpověď na chybu
Name | Typ | Description |
---|---|---|
error |
Objekt chyby. |
HybridCountAndFacetMode
Určuje, zda počet a omezující vlastnosti mají zahrnovat všechny dokumenty, které odpovídají vyhledávacímu dotazu, nebo pouze dokumenty, které jsou načteny v okně maxTextRecallSize. Výchozí hodnota je countAllResults.
Name | Typ | Description |
---|---|---|
countAllResults |
string |
Zahrnout všechny dokumenty, které byly spárovány vyhledávacím dotazem při výpočtu "count" a "facets", bez ohledu na to, zda se tyto dokumenty nacházejí v okně načítání "maxTextRecallSize". |
countRetrievableResults |
string |
Při výpočtu hodnot count a facets zahrňte pouze dokumenty, které byly v okně načítání maxTextRecallSize shodovány. |
HybridSearch
Parametry dotazu pro konfiguraci chování hybridního vyhledávání.
Name | Typ | Description |
---|---|---|
countAndFacetMode |
Určuje, zda počet a omezující vlastnosti mají zahrnovat všechny dokumenty, které odpovídaly vyhledávacímu dotazu, nebo pouze dokumenty, které jsou načteny v okně maxTextRecallSize. |
|
maxTextRecallSize |
integer |
Určuje maximální počet dokumentů, které mají být načteny částí textového dotazu požadavku hybridního vyhledávání. Tyto dokumenty se zkombinují s dokumenty odpovídajícími vektorovým dotazům a vytvoří se jediný konečný seznam výsledků. Volba větší hodnoty maxTextRecallSize umožní načtení a stránkování více dokumentů (pomocí parametrů top a skip) za cenu vyššího využití prostředků a vyšší latence. Hodnota musí být mezi 1 a 10 000. Výchozí hodnota je 1000. |
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 odpovědí 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 |
Nevracejte titulky dotazu. |
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 výsledky, které se přeřadily. |
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štinu (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štinu (Estonsko). |
eu-es |
string |
Hodnota jazyka dotazu pro baskičtina |
fa-ae |
string |
Hodnota jazyka dotazu pro perštinu (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štinu (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štinu (Maďarsko) |
hy-am |
string |
Hodnota jazyka dotazu pro arménštinu (Arménie) |
id-id |
string |
Hodnota jazyka dotazu pro indonéštinu (Indonésie). |
is-is |
string |
Hodnota jazyka dotazu pro islandštinu (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 jazyka dotazu pro lotyštinu (Lotyšsko). |
ml-in |
string |
Hodnota jazyka dotazu pro Malajálam (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 |
Dotazovací jazyk není zadaný. |
pa-in |
string |
Hodnota jazyka dotazu pro Padžábština (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štinu (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štinu (Bosna a Hercegovina) |
sr-me |
string |
Hodnota jazyka dotazu pro Srbštinu (Černá Hora) |
sr-rs |
string |
Hodnota jazyka dotazu pro Srbštinu (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štinu (Ukrajina). |
ur-pk |
string |
Hodnota jazyka dotazu pro Urdu (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 obohacení.
Name | Typ | Description |
---|---|---|
content |
string |
Nezpracované zřetězené řetězce pro pole obsahu, která byla použita pro sémantické obohacení. |
keywords |
string |
Nezpracované zřetězené řetězce pro pole klíčových slov, která byla použita pro sémantické obohacení. |
title |
string |
Nezpracovaný řetězec pro pole názvu, které se použilo k sémantickému obohacení. |
QueryResultDocumentSemanticField
Popis polí, která byla odeslána do procesu sémantického obohacení, a také způsob jejich použití
Name | Typ | Description |
---|---|---|
name |
string |
Název pole odeslaného procesu sémantického obohacení |
state |
Způsob použití pole pro proces sémantického obohacování (plně využité, částečně použ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 |
Pro hledání se používá úplná syntaxe dotazů Lucene. 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 hlavní výsledky hledání pomocí modelu řazení natrénovaného na webovém korpusu. |
simple |
string |
Pro hledání se používá jednoduchá syntaxe dotazu. Hledaný text se interpretuje pomocí jednoduchého dotazovacího jazyka, který umožňuje symboly jako +, * a "". Dotazy se ve výchozím nastavení vyhodnocují ve všech prohledávatelných polích, 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í. |
oversampling |
number |
Faktor převzorkování. Minimální hodnota je 1. Přepíše parametr defaultOversampling nakonfigurovaný v definici indexu. Dá se nastavit jenom v případech, kdy má parametr rerankWithOriginalVectors hodnotu true. Tento parametr je povolen pouze v případě, že se metoda komprese používá v podkladovém vektorovém poli. |
threshold | VectorThreshold: |
Prahová hodnota používaná pro vektorové dotazy. Tuto možnost je možné nastavit pouze v případě, že všechna pole používají stejnou metriku podobnosti. |
vector |
number[] |
Vektorové znázornění vyhledávacího dotazu. |
weight |
number |
Relativní váha vektorového dotazu v porovnání s jinými vektorovými dotazy nebo textovým dotazem v rámci stejného požadavku vyhledávání Tato hodnota se používá při kombinování výsledků více seznamů hodnocení vytvořených různými vektorovými dotazy nebo výsledky načtenými prostřednictvím textového dotazu. Čím vyšší je váha, tím vyšší budou dokumenty odpovídající danému dotazu v konečném pořadí. Výchozí hodnota je 1,0 a hodnota musí být kladné číslo větší než nula. |
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í po celém světě před bodováním. Použití statistik globálního 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 bodování konzistentnější. |
local |
string |
Statistika bodování se vypočítá místně kvůli 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átila, když dotaz nemůže vrátit všechny požadované výsledky v jedné odpovědi. Tuto adresu URL můžete použít k formulaci dalšího požadavku GET nebo POST Search, abyste získali další část odpovědi hledání. Nezapomeňte použít stejnou operaci (GET nebo POST) jako požadavek, který vytvořil tuto odpověď. |
@search.answers |
Výsledky dotazu odpovědi pro operaci hledání; null, pokud parametr dotazu answers nebyl zadán nebo nastaven na hodnotu none. |
|
@search.coverage |
number |
Hodnota označující procento indexu zahrnutého do dotazu nebo hodnotu null, pokud v požadavku nebyla zadána hodnota minimumCoverage. |
@search.facets |
object |
Výsledky fasetového dotazu pro operaci hledání uspořádané jako kolekce kbelíků pro každé pole s fasetou; null, pokud dotaz neobsadoval žádné výrazy omezující vlastnosti. |
@search.nextPageParameters |
Datová část JSON 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 k formulaci dalšího požadavku POST Search, abyste získali další část odpovědi hledání. |
|
@search.semanticPartialResponseReason |
Důvod vrácení částečné odpovědi pro požadavek na sémantické řazení |
|
@search.semanticPartialResponseType |
Typ částečné odpovědi, která byla vrácena pro požadavek na sémantické řazení. |
|
value |
Posloupnost výsledků vrácených dotazem |
SearchMode
Určuje, zda musí být některé nebo všechny hledané termíny shodné, aby bylo možné dokument spočítat jako shodu.
Name | Typ | Description |
---|---|---|
all |
string |
Všechny hledané termíny musí být spárované, aby bylo možné dokument spočítat jako shodu. |
any |
string |
Všechny hledané termíny musí být spárované, 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ů
Name | Typ | Description |
---|---|---|
answers |
Hodnota, která určuje, zda mají být odpovědi vráceny jako součást odpovědi hledání. |
|
captions |
Hodnota, která určuje, zda mají být titulky vráceny jako součást odpovědi hledání. |
|
count |
boolean |
Hodnota, která určuje, zda se má načíst celkový počet výsledků. Výchozí hodnota je false. Nastavení této hodnoty na true může mít vliv na výkon. Všimněte si, že vrácený počet je přibližný. |
debug |
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 čárkami oddělený seznam párů název:hodnota. |
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á je připojena k dosažení zvýraznění. Musí být nastaven pomocí highlightPreTag. Výchozí hodnota je </em>. |
highlightPreTag |
string |
Značka řetězce, která je předem připravená k dosažení zvýraznění. Musí být nastaven pomocí highlightPostTag. Výchozí hodnota je <em>. |
hybridSearch |
Parametry dotazu pro konfiguraci chování hybridního vyhledávání |
|
minimumCoverage |
number |
Číslo mezi 0 a 100 označující procento indexu, které musí být pokryto vyhledávacím dotazem, aby byl dotaz nahlášen 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 desc pro označení sestupně. Výchozí hodnota je vzestupné pořadí. Vazby budou přerušeny skóre shody dokumentů. Pokud není zadána žádná $orderby, výchozí pořadí řazení je sestupné podle skóre shody dokumentu. Může existovat maximálně 32 $orderby klauzulí. |
queryLanguage |
Hodnota, která určuje jazyk vyhledávacího dotazu. |
|
queryType |
Hodnota, která určuje syntaxi vyhledávacího dotazu. Výchozí hodnota je "jednoduchá". Pokud dotaz používá syntaxi dotazu 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 |
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í po celém světě před bodováním. Použití statistik globálního 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 |
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 |
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í rychlé relace, 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é 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 |
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 |
Určuje, zda jsou filtry použity před nebo po provedení vektorového vyhledávání. Výchozí hodnota je preFilter. |
|
vectorQueries | VectorQuery[]: |
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 |
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 |
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. |
SearchScoreThreshold
Výsledky vektorového dotazu se vyfiltruje na základě hodnoty @search.score. Všimněte si, že se jedná o vrácenou @search.score jako součást odpovědi hledání. Směr prahové hodnoty bude zvolen pro vyšší @search.scorehodnotu .
Name | Typ | Description |
---|---|---|
kind |
string:
search |
Druh prahové hodnoty používané k filtrování vektorových dotazů |
value |
number |
Prahová hodnota se vyfiltruje na základě hodnoty @search.score. Všimněte si, že se jedná o vrácenou @search.score jako součást odpovědi hledání. Směr prahové hodnoty bude zvolen pro vyšší @search.scorehodnotu . |
SemanticDebugInfo
Name | Typ | Description |
---|---|---|
contentFields |
Pole obsahu, která byla odeslána do procesu sémantického obohacení, a také způsob jejich použití |
|
keywordFields |
Pole klíčových slov, která byla odeslána do procesu sémantického obohacení, a také způsob jejich použití |
|
rerankerInput |
Nezpracované zřetězené řetězce, které byly odeslány do procesu sémantického obohacení. |
|
titleField |
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í zcela selhat, 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 jaký byl důvod 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 použití pole pro proces sémantického obohacování (plně využité, částečně použité nebo nepoužité)
Name | Typ | Description |
---|---|---|
partial |
string |
Pole bylo částečně použito pro sémantické obohacení. |
unused |
string |
Pole nebylo použito pro sémantické obohacení. |
used |
string |
Pole bylo plně využito k sémantickému obohacení. |
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í. |
Speller
Zlepšete úplnost vyhledávání opravou pravopisu jednotlivých výrazů hledaných dotazů.
Name | Typ | Description |
---|---|---|
lexicon |
string |
Nástroj speller opravuje jednotlivé termíny dotazu pomocí statického lexikonu pro jazyk určený parametrem queryLanguage. |
none |
string |
Kontrola pravopisu není povolena. |
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. |
VectorizableImageBinaryQuery
Parametry dotazu, které se mají použít pro vektorové vyhledávání, pokud je zadán binární soubor s kódováním base 64 obrázku, který je potřeba vektorizovat.
Name | Typ | Description |
---|---|---|
base64Image |
string |
Binární soubor s kódováním base 64 obrázku, který má být vektorizován k provedení vektorového vyhledávacího dotazu. |
exhaustive |
boolean |
Pokud je true, aktivuje vyčerpávající hledání k-nejbližšího souseda napříč všemi vektory v indexu vektorů. Užitečné pro scénáře, ve kterých jsou přesné shody kritické, jako je určování hodnot základní pravdy. |
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 nejvyšší počet přístupů |
kind |
string:
image |
Druh vektorového dotazu, který se provádí. |
oversampling |
number |
Faktor převzorkování. Minimální hodnota je 1. Přepíše parametr defaultOversampling nakonfigurovaný v definici indexu. Lze ji nastavit pouze v případech, kdy má hodnota "rerankWithOriginalVectors" hodnotu true. Tento parametr je povolen pouze v případě, že se v podkladovém vektorovém poli používá metoda komprese. |
threshold | VectorThreshold: |
Prahová hodnota používaná pro vektorové dotazy. Toto nastavení lze nastavit pouze v případě, že všechna pole používají stejnou metriku podobnosti. |
weight |
number |
Relativní váha vektorového dotazu v porovnání s jinými vektorovými dotazy a/nebo textovým dotazem v rámci stejného požadavku vyhledávání Tato hodnota se používá při kombinování výsledků z více seznamů řazení vytvořených různými vektorovými dotazy nebo výsledky načtenými prostřednictvím textového dotazu. Čím vyšší je váha, tím vyšší budou v konečném pořadí dokumenty, které odpovídají danému dotazu. Výchozí hodnota je 1,0 a hodnota musí být kladné číslo větší než nula. |
VectorizableImageUrlQuery
Parametry dotazu, které se mají použít pro vektorové vyhledávání, když je zadaná adresa URL, která představuje hodnotu obrázku, která je tř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:
image |
Druh vektorového dotazu, který se provádí. |
oversampling |
number |
Faktor převzorkování. Minimální hodnota je 1. Přepíše parametr defaultOversampling nakonfigurovaný v definici indexu. Dá se nastavit jenom v případech, kdy má parametr rerankWithOriginalVectors hodnotu true. Tento parametr je povolen pouze v případě, že se metoda komprese používá v podkladovém vektorovém poli. |
threshold | VectorThreshold: |
Prahová hodnota používaná pro vektorové dotazy. Toto nastavení lze nastavit pouze v případě, že všechna pole používají stejnou metriku podobnosti. |
url |
string |
Adresa URL obrázku, který má být vektorizován za účelem provedení dotazu vektorového vyhledávání. |
weight |
number |
Relativní váha vektorového dotazu v porovnání s jinými vektorovými dotazy nebo textovým dotazem v rámci stejného požadavku vyhledávání Tato hodnota se používá při kombinování výsledků více seznamů hodnocení vytvořených různými vektorovými dotazy nebo výsledky načtenými prostřednictvím textového dotazu. Čím vyšší je váha, tím vyšší budou v konečném pořadí dokumenty, které odpovídají danému dotazu. Výchozí hodnota je 1,0 a hodnota musí být kladné číslo větší než nula. |
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í. |
oversampling |
number |
Faktor převzorkování. Minimální hodnota je 1. Přepíše parametr defaultOversampling nakonfigurovaný v definici indexu. Dá se nastavit jenom v případech, kdy má parametr rerankWithOriginalVectors hodnotu true. Tento parametr je povolen pouze v případě, že se metoda komprese používá v podkladovém vektorovém poli. |
text |
string |
Text, který má být vektorizován k provedení vektorového vyhledávacího dotazu. |
threshold | VectorThreshold: |
Prahová hodnota používaná pro vektorové dotazy. Tuto možnost je možné nastavit pouze v případě, že všechna pole používají stejnou metriku podobnosti. |
weight |
number |
Relativní váha vektorového dotazu v porovnání s jinými vektorovými dotazy nebo textovým dotazem v rámci stejného požadavku vyhledávání Tato hodnota se používá při kombinování výsledků více seznamů hodnocení vytvořených různými vektorovými dotazy nebo výsledky načtenými prostřednictvím textového dotazu. Čím vyšší je váha, tím vyšší budou dokumenty odpovídající danému dotazu v konečném pořadí. Výchozí hodnota je 1,0 a hodnota musí být kladné číslo větší než nula. |
VectorQueryKind
Druh vektorového dotazu, který se provádí.
Name | Typ | Description |
---|---|---|
imageBinary |
string |
Vektorový dotaz, kde je k dispozici binární soubor s kódováním base 64 obrázku, který je potřeba vektorizovat. |
imageUrl |
string |
Vektorový dotaz, kde je k dispozici adresa URL představující hodnotu obrázku, kterou je třeba vektorizovat. |
text |
string |
Vektorový dotaz, kde je k dispozici textová hodnota, kterou je potřeba vektorizovat. |
vector |
string |
Vektorový dotaz, kde je k dispozici nezpracovaná hodnota vektoru. |
VectorSimilarityThreshold
Výsledky vektorového dotazu budou filtrovány na základě metriky podobnosti vektorů. Všimněte si, že toto je kanonická definice metriky podobnosti, nikoli verze distance. Směr prahové hodnoty (větší nebo menší) bude zvolen automaticky podle metriky použité polem.
Name | Typ | Description |
---|---|---|
kind |
string:
vector |
Druh prahové hodnoty používané k filtrování vektorových dotazů |
value |
number |
Prahová hodnota bude filtrovat na základě hodnoty metriky podobnosti. Všimněte si, že toto je kanonická definice metriky podobnosti, nikoli verze distance. Směr prahové hodnoty (větší nebo menší) bude zvolen automaticky podle metriky použité polem. |
VectorThresholdKind
Druh vektorového dotazu, který se provádí.
Name | Typ | Description |
---|---|---|
searchScore |
string |
Výsledky vektorového dotazu se vyfiltruje na základě hodnoty @search.score. Všimněte si, že se jedná o vrácenou @search.score jako součást odpovědi hledání. Směr prahové hodnoty bude zvolen pro vyšší @search.scorehodnotu . |
vectorSimilarity |
string |
Výsledky vektorového dotazu budou filtrovány na základě metriky podobnosti vektorů. Všimněte si, že toto je kanonická definice metriky podobnosti, nikoli verze distance. Směr prahové hodnoty (větší nebo menší) bude zvolen automaticky podle metriky použité polem. |