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é s požadavkem, které vám pomůže s laděním.

Text požadavku

Name	Typ	Description
answers	QueryAnswerType	Hodnota, která určuje, jestli se odpovědi mají vrátit 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, zda se má načíst celkový počet výsledků. Výchozí hodnota je false. Nastavení této hodnoty na hodnotu True může mít vliv na výkon. Všimněte si, že vrácený počet představuje aproximaci.
debug	QueryDebugMode	Umožňuje nástroj pro ladění, který se dá použít k dalšímu prozkoumání výsledků v pořadí.
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, volitelně následovaný čárkami odděleným seznamem párů name:value.
filter	string	Výraz $filter OData, který se má použít pro vyhledávací dotaz.
highlight	string	Seznam názvů polí oddělených čárkami, které se mají použít pro zvýraznění hitů. Ke zvýraznění hitů se dají použít jenom prohledávatelná pole.
highlightPostTag	string	Značka řetězce, která se připojí k zvýraznění. Je nutné nastavit zvýrazněníPreTag. Výchozí hodnota je </em>.
highlightPreTag	string	Značka řetězce, která je předem zvýrazněná. Musí být nastavena značka highlightPostTag. Výchozí hodnota je <>.
minimumCoverage	number (double)	Číslo mezi 0 a 100 označující procento indexu, které musí být pokryto vyhledávacím dotazem, 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 s jedinou replikou. Výchozí hodnota je 100.
orderby	string	Čárkami oddělený seznam výrazů OData $orderby, podle kterých se mají výsledky seřadit. Každý výraz může být buď název pole, nebo volání funkce geo.distance() nebo search.score(). Za každým výrazem může následovat asc, který označuje vzestupně, nebo desc označují sestupně. 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í.
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 dotazu Lucene, použijte "full".
scoringParameters	string[]	Seznam hodnot parametrů, které se mají použít v bodovacích funkcích (například referencePointParameter) pomocí hodnot názvu formátu. Pokud například profil bodování definuje funkci s parametrem "mylocation", řetězec parametru by byl "mylocation--122.2,44.8" (bez uvozovek).
scoringProfile	string	Název bodujícího profilu, který má vyhodnotit skóre shody pro odpovídající dokumenty, aby se výsledky seřadily.
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 místní. Před vyhodnocením můžete použít globální agregaci statistik bodování. 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 shodovat všechny dokumenty, použijte *nebo tento parametr vynecháte.
searchFields	string	Čárkami oddělený seznam názvů polí, na které chcete nastavit obor fulltextového vyhledávání. Při použití vyhledávacího pole (fieldName:searchExpression) v úplném dotazu Lucene mají názvy polí každého hledaného výrazu 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 se dokument spočítal jako shoda.
select	string	Seznam polí oddělených čárkami, která se mají načíst. Pokud není zadáno, jsou zahrnuta všechna pole označená jako načítaná ve schématu.
semanticConfiguration	string	Název sémantické konfigurace, která se použije při zpracování dokumentů pro dotazy sémantického 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	Čárkami oddělený seznam názvů polí používaných pro sémantické řazení.
semanticMaxWaitInMilliseconds	integer (int32) minimum: 700	Umožňuje uživateli nastavit horní mez doby, kterou trvá dokončení zpracování sémantického rozšiřová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é reranking, sémantické titulky a sémantické odpovědi. Je užitečné ve scénářích, kdy je potřeba používat 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í rychlé relace, která může pomoct získat konzistentnější výsledky. Pokud se použije stejné ID relace, provede se pokus o dosažení maximálního úsilí, aby cílil na stejnou sadu replik. Buďte opatrní, že opakované použití stejných hodnot SESSIONID může narušit 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 (int32)	Počet výsledků hledání, které chcete přeskočit. Tato hodnota nemůže být větší než 100 000. Pokud potřebujete skenovat dokumenty v posloupnosti, ale kvůli tomuto omezení nemůžete použít přeskočení, zvažte použití orderby u zcela seřazeného klíče a filtrování pomocí dotazu rozsahu.
speller	QuerySpellerType	Hodnota, která určila typ kontroly pravopisu, která se má použít ke kontrole pravopisu jednotlivých hledaných termínů dotazu.
top	integer (int32)	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 se výsledky zkrátí kvůli stránkování na straně serveru, odpověď bude obsahovat pokračovací token, který se dá použít k vydání další žádosti o vyhledávání na další stránce 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	Chybová odpověď.

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ý úsek extrahovaný z obsahu nejrelevavantnějších dokumentů, které odpovídají dotazu. Odpovědi se extrahují z nejlepších výsledků hledání. Kandidáti na odpovědi jsou hodnoceni a vyberou se hlavní odpovědi.
CaptionResult	Titulky jsou nejvýraznější pasáže z dokumentu relativně do vyhledávacího 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 zkoumání výsledků hledání.
QueryAnswerType	Hodnota, která určuje, jestli se odpovědi mají vrátit 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 nástroj pro ladění, který se dá použít k dalšímu zkoumání výsledků hledání.
QueryLanguage	Jazyk dotazu.
QueryResultDocumentRerankerInput	Nezpracované zřetězené řetězce odeslané do sémantického procesu rozšiřování.
QueryResultDocumentSemanticField	Popis polí odeslaných do procesu sémantického rozšiřování a způsobu jejich použití
QuerySpellerType	Hodnota, která určila typ kontroly pravopisu, která se má použít ke kontrole pravopisu jednotlivých hledaných termínů dotazu.
QueryType	Určuje syntaxi vyhledávacího dotazu. Výchozí hodnota je "jednoduchá". Pokud dotaz používá syntaxi dotazu Lucene a sémantickou syntaxi, použijte full, pokud syntaxe dotazu není nutná.
RawVectorQuery	Parametry dotazu, které se mají použít pro vektorové vyhledávání při zadání nezpracované hodnoty 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 místní. Před vyhodnocením můžete použít globální agregaci statistik bodování. 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 chybový stav rozhraní API.
SearchMode	Určuje, jestli se musí některé nebo všechny hledané termíny shodovat, aby se dokument spočítal jako shoda.
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ými metadaty.
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č byla vrácena částečná odpověď pro sémantickou žádost o řazení.
SemanticFieldState	Způsob použití pole pro sémantický proces rozšiřování (plně používaný, částečně použitý nebo nepoužitý)
SemanticSearchResultsType	Typ částečné odpovědi, která byla vrácena pro sémantickou žádost o řazení.
VectorFilterMode	Určuje, zda jsou filtry použity před nebo po provedení vektorového vyhledávání.
VectorizableTextQuery	Parametry dotazu, které se mají použít pro vektorové vyhledávání, pokud je k dispozici textová hodnota, která musí být vektorizována.
VectorQueryKind	Druh vektorového dotazu, který se provádí.

AnswerResult

Objekt

Odpověď je textový úsek extrahovaný z obsahu nejrelevavantnějších dokumentů, které odpovídají dotazu. Odpovědi se extrahují z nejlepších výsledků hledání. Kandidáti na odpovědi jsou hodnoceni a vyberou se hlavní odpovědi.

Name	Typ	Description
highlights	string	Stejný textový úsek 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 (double)	Hodnota skóre představuje, jak relevantní je odpověď na dotaz vzhledem k jiným odpovědím vrácených pro dotaz.
text	string	Textová část extrahovaná z obsahu dokumentu jako odpověď.

CaptionResult

Objekt

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

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

DocumentDebugInfo

Objekt

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

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

QueryAnswerType

Výčet

Hodnota, která určuje, jestli se odpovědi mají vrátit jako součást odpovědi hledání.

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

QueryCaptionType

Výčet

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

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

QueryDebugMode

Výčet

Umožňuje nástroj pro ladění, který se dá použít k dalšímu zkoumání výsledků hledání.

Hodnota	Description
disabled	Nebudou vráceny žádné informace o ladění dotazů.
semantic	Umožňuje uživateli dále prozkoumat výsledky seřazené podle pořadí.

QueryLanguage

Výčet

Jazyk dotazu.

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

QueryResultDocumentRerankerInput

Objekt

Nezpracované zřetězené řetězce odeslané do sémantického procesu 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é se použilo pro sémantické rozšiřování.

QueryResultDocumentSemanticField

Objekt

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

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

QuerySpellerType

Výčet

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

Hodnota	Description
none	Kontrola pravopisu není povolená.
lexicon	Kontrola pravopisu opraví jednotlivé termíny dotazu pomocí statického lexikonu pro jazyk určený parametrem queryLanguage.

QueryType

Výčet

Určuje syntaxi vyhledávacího dotazu. Výchozí hodnota je "jednoduchá". Pokud dotaz používá syntaxi dotazu Lucene a sémantickou syntaxi, použijte full, pokud syntaxe dotazu není nutná.

Hodnota	Description
simple	Používá jednoduchou syntaxi dotazu pro vyhledávání. 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.
full	Používá úplnou syntaxi dotazu Lucene pro hledá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 také další pokročilé funkce.
semantic	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í opětovným řazením nejlepších výsledků hledání pomocí modelu řazení natrénovaného na webovém korpusu.

RawVectorQuery

Objekt

Parametry dotazu, které se mají použít pro vektorové vyhledávání při zadání nezpracované hodnoty vektoru.

Name	Typ	Description
exhaustive	boolean	Pokud je hodnota true, aktivuje vyčerpávající hledání k-nejbližšího souseda napříč všemi vektory v indexu vektoru. Užitečné pro scénáře, ve kterých jsou přesné shody kritické, například určení hodnot základní pravdy.
fields	string	Vektorová pole typu Collection(Edm.Single), která mají být zahrnuta do vektorového vyhledávání.
k	integer (int32)	Početnejbližších
kind	string: vector	Druh vektorového dotazu, který se provádí.
vector	number[] (float)	Vektorové znázornění vyhledávacího dotazu.

ScoringStatistics

Výčet

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 místní. Před vyhodnocením můžete použít globální agregaci statistik bodování. Použití globálních statistik bodování může zvýšit latenci vyhledávacích dotazů.

Hodnota	Description
local	Statistiky vyhodnocování se počítají místně, aby se snížila latence.
global	Statistiky vyhodnocování se počítají globálně pro konzistentnější bodování.

SearchDocumentsResult

Objekt

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

Name	Typ	Description
@odata.count	integer (int64)	Celkový počet výsledků nalezených operací hledání nebo hodnota null, pokud se počet nepožadoval. Pokud existuje, 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 pokračování vrácená, když dotaz nemůže vrátit všechny požadované výsledky v jedné odpovědi. Pomocí této adresy URL můžete formulovat jiný požadavek GET nebo POST Search a získat další část odpovědi hledání. Ujistěte se, že používáte stejný příkaz (GET nebo POST) jako požadavek, který tuto odpověď vytvořil.
@search.answers	AnswerResult[]	Výsledky dotazu pro operaci hledání; Null, pokud nebyl zadán parametr dotazu odpovědi nebo nastaven na hodnotu none.
@search.coverage	number (double)	Hodnota označující procento indexu zahrnutého v dotazu nebo hodnotu null, pokud v požadavku nebylo zadáno minimumCoverage.
@search.facets	object	Výsledky fasetového dotazu pro operaci hledání uspořádané jako kolekce kontejnerů pro každé omezující pole; null pokud dotaz neobsahuje žádné omezující vlastnosti výrazy.
@search.nextPageParameters	SearchRequest	Datová část JSON pro pokračování vrácená, když dotaz nemůže vrátit všechny požadované výsledky v jedné odpovědi. Tento JSON můžete použít společně s @odata.nextLink k vytvoření dalšího požadavku POST Search, který získá další část odpovědi hledání.
@search.semanticPartialResponseReason	SemanticErrorReason	Důvod, proč byla vrácena částečná odpověď pro sémantickou žádost o řazení.
@search.semanticPartialResponseType	SemanticSearchResultsType	Typ částečné odpovědi, která byla vrácena pro sémantickou žádost o řazení.
value	SearchResult[]	Posloupnost výsledků vrácených dotazem.

SearchError

Objekt

Popisuje chybový stav rozhraní API.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
details	SearchError[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
message	string	Čitelné znázornění chyby člověkem.

SearchMode

Výčet

Určuje, jestli se musí některé nebo všechny hledané termíny shodovat, aby se dokument spočítal jako shoda.

Hodnota	Description
any	Aby bylo možné spočítat dokument jako shodu, musí se shodovat kterýkoli z hledaných termínů.
all	Aby bylo možné spočítat dokument jako shodu, musí se všechny hledané termíny shodovat.

SearchRequest

Objekt

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, jestli se odpovědi mají vrátit 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, zda se má načíst celkový počet výsledků. Výchozí hodnota je false. Nastavení této hodnoty na hodnotu True může mít vliv na výkon. Všimněte si, že vrácený počet představuje aproximaci.
debug	QueryDebugMode	Umožňuje nástroj pro ladění, který se dá použít k dalšímu prozkoumání výsledků v pořadí.
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, volitelně následovaný čárkami odděleným seznamem párů name:value.
filter	string	Výraz $filter OData, který se má použít pro vyhledávací dotaz.
highlight	string	Seznam názvů polí oddělených čárkami, které se mají použít pro zvýraznění hitů. Ke zvýraznění hitů se dají použít jenom prohledávatelná pole.
highlightPostTag	string	Značka řetězce, která se připojí k zvýraznění. Je nutné nastavit zvýrazněníPreTag. Výchozí hodnota je </em>.
highlightPreTag	string	Značka řetězce, která je předem zvýrazněná. Musí být nastavena značka highlightPostTag. Výchozí hodnota je <>.
minimumCoverage	number (double)	Číslo mezi 0 a 100 označující procento indexu, které musí být pokryto vyhledávacím dotazem, 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 s jedinou replikou. Výchozí hodnota je 100.
orderby	string	Čárkami oddělený seznam výrazů OData $orderby, podle kterých se mají výsledky seřadit. Každý výraz může být buď název pole, nebo volání funkce geo.distance() nebo search.score(). Za každým výrazem může následovat asc, který označuje vzestupně, nebo desc označují sestupně. 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í.
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 dotazu Lucene, použijte "full".
scoringParameters	string[]	Seznam hodnot parametrů, které se mají použít v bodovacích funkcích (například referencePointParameter) pomocí hodnot názvu formátu. Pokud například profil bodování definuje funkci s parametrem "mylocation", řetězec parametru by byl "mylocation--122.2,44.8" (bez uvozovek).
scoringProfile	string	Název bodujícího profilu, který má vyhodnotit skóre shody pro odpovídající dokumenty, aby se výsledky seřadily.
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 místní. Před vyhodnocením můžete použít globální agregaci statistik bodování. 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 shodovat všechny dokumenty, použijte *nebo tento parametr vynecháte.
searchFields	string	Čárkami oddělený seznam názvů polí, na které chcete nastavit obor fulltextového vyhledávání. Při použití vyhledávacího pole (fieldName:searchExpression) v úplném dotazu Lucene mají názvy polí každého hledaného výrazu 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 se dokument spočítal jako shoda.
select	string	Seznam polí oddělených čárkami, která se mají načíst. Pokud není zadáno, jsou zahrnuta všechna pole označená jako načítaná ve schématu.
semanticConfiguration	string	Název sémantické konfigurace, která se použije při zpracování dokumentů pro dotazy sémantického 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	Čárkami oddělený seznam názvů polí používaných pro sémantické řazení.
semanticMaxWaitInMilliseconds	integer (int32) minimum: 700	Umožňuje uživateli nastavit horní mez doby, kterou trvá dokončení zpracování sémantického rozšiřová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é reranking, sémantické titulky a sémantické odpovědi. Je užitečné ve scénářích, kdy je potřeba používat 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í rychlé relace, která může pomoct získat konzistentnější výsledky. Pokud se použije stejné ID relace, provede se pokus o dosažení maximálního úsilí, aby cílil na stejnou sadu replik. Buďte opatrní, že opakované použití stejných hodnot SESSIONID může narušit 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 (int32)	Počet výsledků hledání, které chcete přeskočit. Tato hodnota nemůže být větší než 100 000. Pokud potřebujete skenovat dokumenty v posloupnosti, ale kvůli tomuto omezení nemůžete použít přeskočení, zvažte použití orderby u zcela seřazeného klíče a filtrování pomocí dotazu rozsahu.
speller	QuerySpellerType	Hodnota, která určila typ kontroly pravopisu, která se má použít ke kontrole pravopisu jednotlivých hledaných termínů dotazu.
top	integer (int32)	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 se výsledky zkrátí kvůli stránkování na straně serveru, odpověď bude obsahovat pokračovací token, který se dá použít k vydání další žádosti o vyhledávání na další stránce 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.

SearchResult

Objekt

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

Name	Typ	Description
@search.captions	CaptionResult[]	Titulky jsou nejvýraznější pasáže z dokumentu relativně do vyhledávacího dotazu. Často se používají jako souhrn dokumentů. Titulky se vrátí jenom pro dotazy typu sémantické.
@search.documentDebugInfo	DocumentDebugInfo[]	Obsahuje informace o ladění, které lze použít k dalšímu zkoumání výsledků hledání.
@search.highlights	object	Textové fragmenty z dokumentu, které označují odpovídající hledané termíny uspořádané podle každého příslušného pole; Null, pokud pro dotaz nebylo povoleno zvýrazňování hitů.
@search.rerankerScore	number (double)	Skóre relevance vypočítané sémantickým rankerem pro nejlepší výsledky hledání. Výsledky hledání se nejprve seřadí podle rerankerScore a pak podle skóre. Funkce RerankerScore se vrátí pouze pro dotazy typu sémantické.
@search.score	number (double)	Skóre relevance dokumentu ve srovnání s jinými dokumenty vrácenými dotazem.

SemanticDebugInfo

Objekt

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

SemanticErrorMode

Výčet

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

Hodnota	Description
partial	Pokud se sémantické zpracování nezdaří, částečné výsledky se stále vrátí. Definice částečných výsledků závisí na tom, jaký sémantický krok selhal a jaký byl důvod selhání.
fail	Pokud během kroku sémantického zpracování dojde k výjimce, dotaz selže a vrátí odpovídající kód HTTP v závislosti na chybě.

SemanticErrorReason

Výčet

Důvod, proč byla vrácena částečná odpověď pro sémantickou žádost o řazení.

Hodnota	Description
maxWaitExceeded	Pokud byl nastaven sémanticMaxWaitInMilliseconds a sémantická doba zpracování překročila danou hodnotu. Vrátily se pouze základní výsledky.
capacityOverloaded	Žádost byla omezena. Vrátily se pouze základní výsledky.
transient	Nejméně jeden krok sémantického procesu se nezdařil.

SemanticFieldState

Výčet

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

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

SemanticSearchResultsType

Výčet

Typ částečné odpovědi, která byla vrácena pro sémantickou žádost o řazení.

Hodnota	Description
baseResults	Výsledky bez sémantického rozšiřování nebo přeřazení.
rerankedResults	Výsledky byly znovu seřazeny pomocí modelu reranker a budou obsahovat sémantické titulky. Nebudou obsahovat žádné odpovědi, zvýraznění odpovědí ani zvýraznění titulků.

VectorFilterMode

Výčet

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

Hodnota	Description
postFilter	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	Filtr se použije před vyhledávacím dotazem.

VectorizableTextQuery

Objekt

Parametry dotazu, které se mají použít pro vektorové vyhledávání, pokud je k dispozici textová hodnota, která musí být vektorizována.

Name	Typ	Description
exhaustive	boolean	Pokud je hodnota true, aktivuje vyčerpávající hledání k-nejbližšího souseda napříč všemi vektory v indexu vektoru. Užitečné pro scénáře, ve kterých jsou přesné shody kritické, například určení hodnot základní pravdy.
fields	string	Vektorová pole typu Collection(Edm.Single), která mají být zahrnuta do vektorového vyhledávání.
k	integer (int32)	Početnejbližších
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

Výčet

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

Hodnota	Description
vector	Vektorový dotaz, kde je zadaná nezpracovaná hodnota vektoru.
text	Vektorový dotaz, kde je k dispozici textová hodnota, kterou je potřeba vektorizovat.