Documents - Search Get

Reference

Služba:: Search Service

Verze rozhraní API:: 2024-07-01

Vyhledá dokumenty v indexu.

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

S volitelnými parametry:

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

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 hodnotu True může mít vliv na výkon. Všimněte si, že vrácený počet představuje aproximaci.
$filter	query		string	Výraz $filter OData, který se má použít pro vyhledávací dotaz.
$orderby	query		string[]	Seznam výrazů $orderby OData, 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ě, a desc označuje sestupně. Výchozí hodnota je vzestupné pořadí. Vazby budou přerušeny skóre shody dokumentů. Pokud není zadána žádná položka 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, jsou zahrnuta všechna pole označená jako načítaná ve schématu.
$skip	query		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 sekvenci, 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 rozsahu.
$top	query		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ů.
answers	query		QueryAnswerType	Tento parametr je platný pouze v případě, že je typ dotazu `semantic`. Pokud je tato možnost nastavená, dotaz vrátí odpovědi extrahované z klíčových pasáží v nejřadivějších dokumentech. Počet vrácených odpovědí lze nakonfigurovat tak, že za hodnotou parametru odpovědi, například `extractive\|count-3`, připojíte znak kanálu `\|` následovanou možností `count-<number of answers>` . Výchozí počet je 1. Prahovou hodnotu spolehlivosti lze nakonfigurovat připojením znaku svislé roury `\|` následovanou možností `threshold-<confidence threshold>` za hodnotou parametru odpovědi, 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 typ dotazu `semantic`. Pokud je tato možnost nastavená, dotaz vrátí titulky extrahované z klíčových pasáží v nejřadivějších dokumentech. Pokud jsou titulky nastavené na `extractive`, zvýraznění je ve výchozím nastavení povolené a lze ho nakonfigurovat připojením znaku kanálu `\|` následovanou možností `highlight-<true/false>`, 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, volitelně následovaný čárkami odděleným seznamem párů name:value.
highlight	query		string[]	Seznam názvů polí, které se mají použít pro zvýraznění hitů Ke zvýraznění hitů se dají použít jenom prohledávatelná pole.
highlightPostTag	query		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	query		string	Značka řetězce, která je předem zvýrazněná. Musí být nastavena značka highlightPostTag. Výchozí hodnota je <>.
minimumCoverage	query		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.
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) 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	query		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	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 dotazu fulltextového vyhledávání; Pokud chcete shodovat všechny dokumenty, použijte *nebo tento parametr vynecháte.
searchFields	query		string[]	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	query		SearchMode	Hodnota, která určuje, jestli se musí některé nebo všechny hledané termíny shodovat, aby se dokument spočítal jako shoda.
semanticConfiguration	query		string	Název sémantické konfigurace, která obsahuje seznam 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í selhat úplně, nebo vrátit částečné výsledky (výchozí).
semanticMaxWaitInMilliseconds	query		integer int32	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	query		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	query		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 _.

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.

Odpovědi

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

Příklady

SearchIndexSearchDocumentsGet

SearchIndexSearchDocumentsSemanticGet

SearchIndexSearchDocumentsGet

Ukázkový požadavek

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=2024-07-01

Ukázková odpověď

Stavový kód:: 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

Ukázkový požadavek

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=2024-07-01&semanticConfiguration=my-semantic-config&semanticErrorHandling=partial&semanticMaxWaitInMilliseconds=780&answers=extractive|count-3&captions=extractive|highlight-true&semanticQuery={semanticQuery}

Ukázková odpověď

Stavový kód:: 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ý ú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 jsou vráceny pouze pro dotazy typu `semantic`.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
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í.
QueryType	Určuje syntaxi vyhledávacího dotazu. Výchozí hodnota je "jednoduchá". Pokud dotaz používá syntaxi dotazu 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 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
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.
SemanticErrorMode	Umožňuje uživateli zvolit, jestli má sémantické volání selhat úplně (výchozí nebo aktuální chování) nebo vrátit částečné výsledky.
SemanticErrorReason	Důvod, proč byla vrácena částečná odpověď pro sémantickou žádost o řazení.
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

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	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

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

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ší.

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

QueryAnswerType

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

Name	Typ	Description
extractive	string	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.
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 pro dotaz.

QueryType

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

Name	Typ	Description
full	string	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	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í opětovným řazením nejlepších výsledků hledání pomocí modelu řazení natrénovaného na webovém korpusu.
simple	string	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.

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 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	Početnejbližších
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. Lze ji nastavit pouze v případech, kdy je true rerankWithOriginalVectors. Tento parametr je povolen pouze v případě, že se metoda komprese použije v podkladovém vektorovém poli.
vector	number[]	Vektorové znázornění vyhledávacího dotazu.
weight	number	Relativní váha vektorového dotazu ve srovnání s jinými vektorovými dotazy nebo textovým dotazem ve stejném požadavku hledání. Tato hodnota se používá při kombinování výsledků 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 dokumenty, které odpovídají 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 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ů.

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

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 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	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.

SearchMode

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

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

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, 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.
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	Čí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í.
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ě (výchozí nebo aktuální chování) nebo vrátit částečné výsledky.
semanticMaxWaitInMilliseconds	integer	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	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.
top	integer	Počet výsledků hledání, které se mají načíst. To lze použít ve spojení s $skip k implementaci stránkování výsledků hledání na straně klienta. Pokud 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 pro nové indexy.
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	Parametry dotazu pro vektorové a hybridní vyhledávací dotazy.

SearchResult

Obsahuje dokument nalezený vyhledávacím dotazem a přidružený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.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	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	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í selhat úplně (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 vrátí odpovídající kód HTTP v závislosti na chybě.
partial	string	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í.

SemanticErrorReason

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

Name	Typ	Description
capacityOverloaded	string	Žádost byla omezena. Vrátily se 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. Vrátily se pouze základní výsledky.
transient	string	Nejméně jeden krok sémantického procesu se nezdařil.

SemanticSearchResultsType

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

Name	Typ	Description
baseResults	string	Výsledky bez sémantického rozšiřování nebo přeřazení.
rerankedResults	string	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

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.

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.

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	Početnejbližších
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. Lze ji nastavit pouze v případech, kdy je true rerankWithOriginalVectors. Tento parametr je povolen pouze v případě, že se metoda komprese použije v podkladovém vektorovém poli.
text	string	Text, který má být vektorizován k provedení vektorového vyhledávacího dotazu.
weight	number	Relativní váha vektorového dotazu ve srovnání s jinými vektorovými dotazy nebo textovým dotazem ve stejném požadavku hledání. Tato hodnota se používá při kombinování výsledků 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 dokumenty, které odpovídají 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
text	string	Vektorový dotaz, kde je k dispozici textová hodnota, kterou je potřeba vektorizovat.
vector	string	Vektorový dotaz, kde je zadaná nezpracovaná hodnota vektoru.

Sdílet prostřednictvím

Documents - Search Get

Parametry identifikátoru URI

Hlavička požadavku

Odpovědi

Příklady

SearchIndexSearchDocumentsGet

Ukázkový požadavek

Ukázková odpověď

SearchIndexSearchDocumentsSemanticGet

Ukázkový požadavek

Ukázková odpověď

Definice

AnswerResult

CaptionResult

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

QueryAnswerType

QueryCaptionType

QueryType

RawVectorQuery

ScoringStatistics

SearchDocumentsResult

SearchMode

SearchRequest

SearchResult

SemanticErrorMode

SemanticErrorReason

SemanticSearchResultsType

VectorFilterMode

VectorizableTextQuery

VectorQueryKind

Další materiály