Documents - Search Get

Reference

Service:: Search Service

API Version:: 2023-11-01

Vyhledá dokumenty v indexu.

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

With optional parameters:

GET {endpoint}/indexes('{indexName}')/docs?search={search}&$count={$count}&facet={facet}&$filter={$filter}&highlight={highlight}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&$orderby={$orderby}&queryType={queryType}&scoringParameter={scoringParameter}&scoringProfile={scoringProfile}&searchFields={searchFields}&searchMode={searchMode}&scoringStatistics={scoringStatistics}&sessionId={sessionId}&$select={$select}&$skip={$skip}&$top={$top}&api-version=2023-11-01&semanticConfiguration={semanticConfiguration}&semanticErrorHandling={semanticErrorHandling}&semanticMaxWaitInMilliseconds={semanticMaxWaitInMilliseconds}&answers={answers}&captions={captions}

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.
$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		QueryAnswerType	Tento parametr je platný pouze v případě, že je `semantic`typ dotazu . Pokud je tato možnost nastavená, dotaz vrátí odpovědi extrahované z klíčových pasáží v nejvýše hodnocených dokumentech. Počet vrácených odpovědí lze nakonfigurovat tak, že připojíte znak `\|` potrubí následovaný `count-<number of answers>` možností za hodnotou parametru answers, například `extractive\|count-3`. Výchozí počet je 1. Prahovou hodnotu spolehlivosti lze nakonfigurovat tak, že připojíte znak `\|` kanálu následovaný `threshold-<confidence threshold>` možností za hodnotou parametru answers, například `extractive\|threshold-0.9`. Výchozí prahová hodnota je 0,7.
captions	query		QueryCaptionType	Tento parametr je platný pouze v případě, že je `semantic`typ dotazu . Pokud je tato možnost nastavená, dotaz vrátí titulky extrahované z klíčových pasáží v dokumentech s nejvyšším pořadím. Pokud je možnost Titulky nastavená na `extractive`, je zvýraznění ve výchozím nastavení povolené a dá se nakonfigurovat tak, že připojíte znak `\|` kanálu následovaný `highlight-<true/false>` možností, například `extractive\|highlight-true`. Výchozí hodnota je `None`.
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.
highlightPostTag	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>.
highlightPreTag	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>.
minimumCoverage	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.
queryType	query		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".
scoringParameter	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).
scoringProfile	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.
scoringStatistics	query		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.
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.
searchFields	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.
searchMode	query		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.
semanticConfiguration	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
semanticErrorHandling	query		SemanticErrorMode	Umožňuje uživateli zvolit, jestli má sémantické volání zcela selhat, nebo vrátit částečné výsledky.
semanticMaxWaitInMilliseconds	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.
sessionId	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 _.

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	SearchDocumentsResult	Odpověď obsahující dokumenty, které odpovídají kritériím hledání.
Other Status Codes	SearchError	Odpověď na chybu.

Příklady

SearchIndexSearchDocumentsGet

SearchIndexSearchDocumentsSemanticGet

SearchIndexSearchDocumentsGet

Sample Request

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs?search=nice hotels&$count=True&facet=category,count:10,sort:count&$filter=rating gt 10&highlight=title&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&$orderby=search.score() desc,rating desc&queryType=simple&scoringProfile=sp&searchFields=title,description&searchMode=any&scoringStatistics=global&sessionId=mysessionid&$select=docId,title,description&$skip=100&$top=10&api-version=2023-11-01

Sample Response

Status code:: 200

{
  "@odata.count": 25,
  "@search.coverage": 80,
  "@search.facets": {
    "category": [
      {
        "count": 1,
        "value": "Economy"
      },
      {
        "count": 1,
        "value": "Luxury"
      }
    ]
  },
  "value": [
    {
      "@search.score": 1.5,
      "@search.highlights": {
        "title": [
          "<em>Nice</em> <em>Hotel</em>"
        ]
      },
      "description": "Cheapest hotel in town",
      "docId": "1",
      "title": "Nice Hotel"
    },
    {
      "@search.score": 0.7,
      "@search.highlights": {
        "title": [
          "Fancy <em>Hotel</em>"
        ]
      },
      "description": "Best hotel in town",
      "docId": "2",
      "title": "Fancy Hotel"
    }
  ]
}

SearchIndexSearchDocumentsSemanticGet

Sample Request

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs?search=how do clouds form&$count=True&highlightPostTag=</em>&highlightPreTag=<em>&queryType=semantic&api-version=2023-11-01&semanticConfiguration=my-semantic-config&semanticErrorHandling=partial&semanticMaxWaitInMilliseconds=780&answers=extractive|count-3&captions=extractive|highlight-true

Sample Response

Status code:: 200

{
  "@odata.count": 25,
  "@search.answers": [
    {
      "key": "4123",
      "text": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form where air is ascending (over land in this case),   but not where it is descending (over the river).",
      "highlights": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form<em> where air is ascending</em> (over land in this case),   but not where it is<em> descending</em> (over the river).",
      "score": 0.94639826
    }
  ],
  "value": [
    {
      "@search.score": 0.5479723,
      "@search.rerankerScore": 1.0321671911515296,
      "@search.captions": [
        {
          "text": "Like all clouds, it forms when the air reaches its dew point—the temperature at which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley fog, which is common in the Pacific Northwest of North America.",
          "highlights": "Like all<em> clouds</em>, it<em> forms</em> when the air reaches its dew point—the temperature at    which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley<em> fog</em>, which is common in the Pacific Northwest of North America."
        }
      ],
      "id": "4123",
      "title": "Earth Atmosphere",
      "content": "Fog is essentially a cloud lying on the ground. Like all clouds, it forms when the air reaches its dew point—the temperature at  \n\nwhich an air mass is cool enough for its water vapor to condense into liquid droplets.\n\nThis false-color image shows valley fog, which is common in the Pacific Northwest of North America. On clear winter nights, the \n\nground and overlying air cool off rapidly, especially at high elevations. Cold air is denser than warm air, and it sinks down into the \n\nvalleys. The moist air in the valleys gets chilled to its dew point, and fog forms. If undisturbed by winds, such fog may persist for \n\ndays. The Terra satellite captured this image of foggy valleys northeast of Vancouver in February 2010.\n\n\n",
      "locations": [
        "Pacific Northwest",
        "North America",
        "Vancouver"
      ]
    }
  ]
}

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šími pasážemi z dokumentu relativně k vyhledávacímu dotazu. Často se používají jako souhrn dokumentů. Titulky se vrací pouze pro dotazy typu `semantic`.
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í.
QueryType	Určuje syntaxi vyhledávacího dotazu. Výchozí hodnota je "jednoduchá". Pokud dotaz používá syntaxi dotazů Lucene, použijte full.
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 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.
SemanticErrorMode	Umožňuje uživateli zvolit, jestli má sémantické volání zcela selhat (výchozí nebo aktuální chování), nebo vrátit částečné výsledky.
SemanticErrorReason	Důvod vrácení částečné odpovědi pro požadavek na sémantické řazení
SemanticSearchResultsType	Typ částečné odpovědi, která byla vrácena pro požadavek na sémantické řazení.
VectorFilterMode	Určuje, zda jsou filtry použity před nebo po provedení vektorového vyhledávání.
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šími pasážemi z dokumentu relativně k vyhledávacímu dotazu. Často se používají jako souhrn dokumentů. Titulky se vrací pouze pro dotazy typu semantic.

Name	Typ	Description
highlights	string	Stejná textová pasáž 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ší.

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.

QueryType

Určuje syntaxi vyhledávacího dotazu. Výchozí hodnota je "jednoduchá". Pokud dotaz používá syntaxi dotazů Lucene, použijte full.

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í při zadání nezpracované hodnoty vektoru.

Name	Typ	Description
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: vector	Druh vektorového dotazu, který se provádí.
vector	number[]	Vektorová reprezentace 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.
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í.
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 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 (výchozí nebo aktuální chování), nebo vrátit částečné výsledky.
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.
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.
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 preFiltr pro nové indexy.
vectorQueries	VectorQuery[]: RawVectorQuery[]	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šími pasážemi z dokumentu relativně k vyhledávacímu dotazu. Často se používají jako souhrn dokumentů. Titulky se vrací pouze pro dotazy typu `semantic`.
@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ýrazně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 `semantic`.
@search.score	number	Skóre relevance dokumentu ve srovnání s jinými dokumenty vrácenými dotazem.

SemanticErrorMode

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

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 vrácení částečné odpovědi pro požadavek na sémantické řazení

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

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 přeřazení.
rerankedResults	string	Výsledky byly znovu seřazeny 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 filtry použity 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.

VectorQueryKind

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

Name	Typ	Description
vector	string	Vektorový dotaz, kde je k dispozici nezpracovaná hodnota vektoru.

Documents - Search Get

Parametry identifikátoru URI

Hlavička požadavku

Odpovědi

Příklady

SearchIndexSearchDocumentsGet

Sample Request

Sample Response

SearchIndexSearchDocumentsSemanticGet

Sample Request

Sample Response

Definice

AnswerResult

CaptionResult

QueryAnswerType

QueryCaptionType

QueryType

RawVectorQuery

ScoringStatistics

SearchDocumentsResult

SearchError

SearchMode

SearchRequest

SearchResult

SemanticErrorMode

SemanticErrorReason

SemanticSearchResultsType

VectorFilterMode

VectorQueryKind

Další materiály