Documents - Search Get

Služba:: Search Service

Verze rozhraní API:: 2025-08-01-preview

Vyhledá dokumenty v rejstříku.

GET {endpoint}/indexes('{indexName}')/docs?api-version=2025-08-01-preview

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=2025-08-01-preview&semanticConfiguration={semanticConfiguration}&semanticErrorHandling={semanticErrorHandling}&semanticMaxWaitInMilliseconds={semanticMaxWaitInMilliseconds}&answers={answers}&captions={captions}&semanticQuery={semanticQuery}&queryRewrites={queryRewrites}&debug={debug}&queryLanguage={queryLanguage}&speller={speller}&semanticFields={semanticFields}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string	Adresa URL koncového bodu vyhledávací služby.
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 je přibližný.
$filter	query		string	Výraz OData $filter, který se má použít na vyhledávací dotaz.
$orderby	query		string[]	Seznam výrazů OData $orderby, 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 pro označení vzestupného a desc pro označení sestupného. Výchozí je vzestupné pořadí. Nerozhodné výsledky budou přerušeny skóre shody v dokumentech. Pokud není zadána žádná hodnota 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í zadaný, zahrnou se všechna pole označená ve schématu jako zobrazitelná.
$skip	query		integer (int32)	Počet výsledků hledání, které chcete přeskočit. Tato hodnota nesmí být větší než 100 000. Pokud potřebujete skenovat dokumenty v sekvenci, ale kvůli tomuto omezení nemůžete použít $skip, zvažte použití $orderby u zcela uspořádaného klíče a místo toho $filter s dotazem na rozsah.
$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ů vyhledávání na straně klienta. Pokud jsou výsledky zkráceny z důvodu stránkování na straně serveru, bude odpověď obsahovat token pro pokračování, který lze použít k vydání dalšího požadavku na vyhledávání pro další stránku výsledků.
answers	query		QueryAnswerType	Tento parametr je platný pouze v případě, že typ dotazu je `semantic`. Pokud je nastaveno, dotaz vrátí odpovědi extrahované z klíčových pasáží v dokumentech s nejvyšším hodnocením. Počet vrácených odpovědí lze nakonfigurovat připojením znaku `\|` svislé čáry následovaného parametrem za hodnotu parametru `count-<number of answers>` answers, například `extractive\|count-3`. Výchozí počet je 1. Prahovou hodnotu spolehlivosti lze nakonfigurovat připojením znaku `\|` svislé čáry následovaného `threshold-<confidence threshold>` možností za hodnotou parametru odpovědi, například `extractive\|threshold-0.9`. Výchozí prahová hodnota je 0,7. Maximální délku znaků odpovědí lze nakonfigurovat připojením znaku svislé čáry '\|' následovaného 'počet-počet< maximální délky> znaku', například 'extractive\|maxcharlength-600'.
captions	query		QueryCaptionType	Tento parametr je platný pouze v případě, že typ dotazu je `semantic`. Pokud je nastaveno, dotaz vrátí titulky extrahované z klíčových pasáží v dokumentech s nejvyšším hodnocením. Když je možnost Titulky nastavena na `extractive`, zvýraznění je ve výchozím nastavení povoleno a lze jej nakonfigurovat připojením znaku `\|` svislé čáry následovaného touto `highlight-<true/false>` volbou, například `extractive\|highlight-true`. Výchozí hodnota je `None`. Maximální délku znaků titulků lze nakonfigurovat připojením znaku svislé čáry '\|' následovaného znakem 'počet-číslo< maximální délky> znaku', například 'extractive\|maxcharlength-600'.
debug	query		QueryDebugMode	Povolí ladicí nástroj, který lze použít k dalšímu prozkoumání výsledků hledání.
facet	query		string[]	Seznam výrazů omezujících vlastností, které se mají použít na vyhledávací dotaz. Každý fasetový výraz obsahuje název pole, volitelně následovaný čárkami odděleným seznamem 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í požadavků na server lze použít pouze prohledávatelná pole.
highlightPostTag	query		string	Značka řetězce, která je připojena ke zvýraznění polí. Musí být nastaveno pomocí highlightPreTag. Výchozí hodnota je </em>.
highlightPreTag	query		string	Značka řetězce, která je předřazena tak, aby dosáhla na světla. Musí být nastaveno pomocí highlightPostTag. Výchozí 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 vykázán 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 pouze jednou replikou. Výchozí hodnota je 100.
queryLanguage	query		QueryLanguage	Jazyk dotazu.
queryRewrites	query		QueryRewritesType	Pokud je parametr QueryRewrites nastaven na `generative`hodnotu , termíny dotazu se odesílají do modelu generování, který vytvoří 10 (výchozích) přepisů, které vám pomůžou zvýšit odvolání požadavku. Požadovaný počet lze nakonfigurovat připojením znaku `\|` svislé čáry následovaného možností `count-<number of rewrites>` , například `generative\|count-3`. Výchozí hodnota je `None`. Tento parametr je platný pouze v případě, že typ dotazu je `semantic`.
queryType	query		QueryType	Hodnota, která určuje syntaxi vyhledávacího dotazu. Výchozí hodnota je 'simple'. Pokud dotaz používá syntaxi dotazu Lucene, použijte hodnotu "full".
scoringParameter	query		string[]	Seznam hodnot parametrů, které se mají použít při bodovacích funkcích (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 by byl "mylocation--122.2,44.8" (bez uvozovek).
scoringProfile	query		string	Název profilu hodnocení pro vyhodnocení skóre shody pro odpovídající dokumenty za účelem seřazení výsledků.
scoringStatistics	query		ScoringStatistics	Hodnota, která určuje, zda chceme vypočítat statistiky bodování (například frekvenci 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; Použijte "*" nebo tento parametr vynechejte, aby se vyhledaly všechny dokumenty.
searchFields	query		string[]	Seznam názvů polí, na které se má fulltextové vyhledávání zaměřit. Při použití hledání v poli (fieldName:searchExpression) v úplném dotazu Lucene mají názvy polí každého vyhledávacího výrazu v poli přednost před názvy polí uvedenými v tomto parametru.
searchMode	query		SearchMode	Hodnota, která určuje, zda se musí shodovat některé nebo všechny hledané výrazy, aby se dokument započítal jako shoda.
semanticConfiguration	query		string	Název sémantické konfigurace, který uvádí, která pole by měla být použita pro sémantické řazení, titulky, zvýraznění a odpovědi
semanticErrorHandling	query		SemanticErrorMode	Umožňuje uživateli zvolit, zda má sémantické volání zcela selhat, nebo vrátit částečné výsledky (výchozí).
semanticFields	query		string[]	Seznam názvů polí používaných pro sémantické řazení.
semanticMaxWaitInMilliseconds	query		integer (int32) minimum: 700	Umožňuje uživateli nastavit horní mez doby, kterou trvá dokončení zpracování sémantického obohacení, než se požadavek nezdaří.
semanticQuery	query		string	Umožňuje nastavit samostatný vyhledávací dotaz, který se bude používat výhradně pro sémantické přeřazení, sémantické titulky a sémantické odpovědi. Je užitečná pro scénáře, kdy je potřeba použít různé dotazy mezi fází základního načítání a hodnocení a sémantickou fází L2.
sessionId	query		string	Hodnota, která má být použita k vytvoření rychlé relace, která může pomoci získat konzistentnější výsledky. Pokud se používá stejné ID relace, bude proveden pokus s maximálním úsilím o cílení na stejnou sadu replik. Mějte na paměti, ž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 '_'.
speller	query		QuerySpellerType	Vylepšete zapamatování vyhledávání opravou pravopisu jednotlivých hledaných dotazů.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
x-ms-client-request-id		string (uuid)	ID sledování odeslané s požadavkem na pomoc s laděním.
x-ms-query-source-authorization		string	Token identifikující uživatele, pro kterého je dotaz prováděn. Tento token se používá k vynucení bezpečnostních omezení dokumentů.

Odpovědi

Name	Typ	Description
200 OK	SearchDocumentsResult	Odpověď obsahující dokumenty, které odpovídají kritériím vyhledávání.
Other Status Codes	SearchDocumentsResult	Odpověď obsahující částečné dokumenty, které odpovídají kritériím vyhledává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=2025-08-01-preview&speller={speller}

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"
    }
  ]
}

Stavový kód:: 206

{
  "@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=2025-08-01-preview&semanticConfiguration=my-semantic-config&semanticErrorHandling=partial&semanticMaxWaitInMilliseconds=780&answers=extractive|count-3&captions=extractive|highlight-true&semanticQuery={semanticQuery}&semanticFields={semanticFields}

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"
      ]
    }
  ]
}

Stavový kód:: 206

{
  "@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 nejrelevantnějších dokumentů, které odpovídají dotazu. Odpovědi jsou extrahovány z horních výsledků vyhledávání. Kandidáti odpovědí jsou bodováni a jsou vybrány nejlepší odpovědi.
CaptionResult	Titulky jsou nejreprezentativnější pasáže z dokumentu ve vztahu k vyhledávacímu dotazu. Často se používají jako souhrn dokumentu. Popisky jsou vráceny pouze pro dotazy typu `semantic`.
DebugInfo	Obsahuje informace o ladění, které lze použít k dalšímu prozkoumání výsledků hledání.
DocumentDebugInfo	Obsahuje informace o ladění, které lze použít k dalšímu prozkoumání výsledků hledání.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
HybridCountAndFacetMode	Určuje, zda má počet a omezující vlastnosti zahrnovat všechny dokumenty, které odpovídají vyhledávacímu dotazu, nebo pouze dokumenty, které jsou načteny v okně maxTextRecallSize. Výchozí hodnota je 'countAllResults'.
HybridSearch	Parametry dotazu slouží ke konfiguraci hybridního chování vyhledávání.
QueryAnswerType	Hodnota, která určuje, zda mají být odpovědi vráceny jako součást odpovědi na hledání.
QueryCaptionType	Hodnota, která určuje, zda mají být titulky vráceny jako součást odpovědi hledání.
QueryDebugMode	Povolí ladicí nástroj, který lze použít k dalšímu prozkoumání výsledků hledání. Můžete povolit více režimů ladění současně jejich oddělením pomocí znaku \| znak, například: semantic\|queryRewrites.
QueryLanguage	Jazyk dotazu.
QueryResultDocumentRerankerInput	Surové zřetězené řetězce, které byly odeslány do procesu sémantického obohacení.
QueryResultDocumentSemanticField	Popis polí, která byla odeslána do procesu sémantického rozšiřování, a způsob jejich použití
QueryResultDocumentSubscores	Rozpis dílčích skóre mezi komponentami textového a vektorového dotazu vyhledávacího dotazu pro tento dokument. Každý vektorový dotaz je zobrazen jako samostatný objekt ve stejném pořadí, v jakém byl přijat.
QueryRewritesDebugInfo	Obsahuje informace o ladění specifické pro přepisování dotazů.
QueryRewritesType	Hodnota, která určuje, zda mají být generovány přepisy dotazu pro rozšíření vyhledávacího dotazu.
QueryRewritesValuesDebugInfo	Obsahuje informace o ladění specifické pro přepisování dotazů.
QuerySpellerType	Hodnota, která určuje typ spelleru, který se má použít k opravě pravopisu jednotlivých hledaných výrazů.
QueryType	Určuje syntaxi vyhledávacího dotazu. Výchozí hodnota je 'simple'. Pokud dotaz používá syntaxi dotazu Lucene, použijte hodnotu "úplná", pokud syntaxi dotazu nepotřebujete, použijte hodnotu "sémantická".
RawVectorQuery	Parametry dotazu, které se mají použít pro vektorové vyhledávání, pokud je zadána nezpracovaná vektorová hodnota.
ScoringStatistics	Hodnota, která určuje, zda chceme vypočítat statistiky bodování (například frekvenci dokumentů) globálně pro konzistentnější bodování, nebo místně pro nižší latenci. Výchozí je 'local'. Pomocí výrazu "globální" můžete před vyhodnocením globálně agregovat statistiky hodnocení. 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, zda musí být některé nebo všechny hledané výrazy shodné, aby se dokument započítal jako shodný.
SearchRequest	Parametry pro filtrování, řazení, omezující vlastnosti, stránkování a další chování vyhledávacích dotazů.
SearchResult	Obsahuje dokument nalezený vyhledávacím dotazem a přidružená metadata.
SearchScoreThreshold	Výsledky vektorového dotazu se filtrují na základě hodnoty '@search.score'. Všimněte si, že se jedná o vrácenou @search.score hodnotu jako součást odpovědi na hledání. Směr prahu bude zvolen pro vyšší @search.score.
SemanticDebugInfo
SemanticErrorMode	Umožňuje uživateli zvolit, zda má sémantické volání zcela selhat (výchozí/aktuální chování), nebo vrátit částečné výsledky.
SemanticErrorReason	Důvod, proč byla vrácena částečná odpověď na žádost o sémantické řazení.
SemanticFieldState	Způsob, jakým bylo pole použito pro proces sémantického obohacování (plně použito, částečně použito nebo nevyužito)
SemanticQueryRewritesResultType	Typ přepsání dotazu, který byl použit pro tento požadavek.
SemanticSearchResultsType	Typ částečné odpovědi, která byla vrácena pro požadavek na sémantické řazení.
SingleVectorFieldResult	Výsledek z jednoho vektorového pole. Vrátí @search.score se hodnoty podobnosti obou i vektorů. Vektorová podobnost je spojena s @search.score rovnicí.
TextResult	Skóre BM25 nebo Classic pro textovou část dotazu.
VectorFilterMode	Určuje, zda se filtry aplikují před nebo po vektorovém vyhledávání.
VectorizableImageBinaryQuery	Parametry dotazu, které se mají použít pro vektorové vyhledávání, když je k dispozici binární soubor obrázku, který je třeba vektorizovat, v kódování Base 64.
VectorizableImageUrlQuery	Parametry dotazu, které se mají použít pro vektorové vyhledávání, když je zadána adresa URL představující hodnotu obrázku, kterou je třeba vektorizovat.
VectorizableTextQuery	Parametry dotazu, které se mají použít pro vektorové vyhledávání, když je zadána textová hodnota, kterou je třeba vektorizovat.
VectorQueryKind	Druh prováděného vektorového dotazu.
VectorsDebugInfo
VectorSimilarityThreshold	Výsledky vektorového dotazu budou filtrovány na základě metriky podobnosti vektorů. Všimněte si, že toto je kanonická definice metriky podobnosti, nikoli verze "vzdálenost". Směr prahové hodnoty (větší nebo menší) bude vybrán automaticky podle metriky použité polem.
VectorThresholdKind	Druh prováděného vektorového dotazu.

AnswerResult

Objekt

Odpověď je textová pasáž extrahovaná z obsahu nejrelevantnějších dokumentů, které odpovídají dotazu. Odpovědi jsou extrahovány z horních výsledků vyhledávání. Kandidáti odpovědí jsou bodováni a jsou vybrány 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ější.
key	string	Klíč dokumentu, ze kterého byla odpověď extrahována.
score	number (double)	Hodnota skóre vyjadřuje, jak relevantní je odpověď na dotaz ve vztahu k ostatním odpovědím vráceným pro dotaz.
text	string	Pasáž textu extrahovaná z obsahu dokumentu jako odpověď.

CaptionResult

Objekt

Titulky jsou nejreprezentativnější pasáže z dokumentu ve vztahu k vyhledávacímu dotazu. Často se používají jako souhrn dokumentu. Popisky jsou vráceny pouze pro dotazy typu semantic.

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

DebugInfo

Objekt

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

Name	Typ	Description
queryRewrites	QueryRewritesDebugInfo	Obsahuje informace o ladění specifické pro přepisování dotazů.

DocumentDebugInfo

Objekt

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

Name	Typ	Description
innerHits	object	Obsahuje informace o ladění specifické pro vektory odpovídající v rámci kolekce komplexních typů.
semantic	SemanticDebugInfo	Obsahuje informace o ladění specifické pro požadavky na sémantické řazení.
vectors	VectorsDebugInfo	Obsahuje informace o ladění specifické pro vektorové a hybridní vyhledávání.

ErrorAdditionalInfo

Objekt

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

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

ErrorDetail

Objekt

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

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

HybridCountAndFacetMode

Výčet

Určuje, zda má počet a omezující vlastnosti zahrnovat všechny dokumenty, které odpovídají vyhledávacímu dotazu, nebo pouze dokumenty, které jsou načteny v okně maxTextRecallSize. Výchozí hodnota je 'countAllResults'.

Hodnota	Description
countRetrievableResults	Zahrňte pouze dokumenty, které byly spárovány v okně načtení maxTextRecallSize při výpočtu počtu a omezujících vlastností.
countAllResults	Při výpočtu počtu a fazet zahrňte všechny dokumenty, které odpovídaly vyhledávacímu dotazu, bez ohledu na to, zda jsou tyto dokumenty v okně načítání maxTextRecallSize.

HybridSearch

Objekt

Parametry dotazu slouží ke konfiguraci hybridního chování vyhledávání.

Name	Typ	Description
countAndFacetMode	HybridCountAndFacetMode	Určuje, zda má počet a omezující vlastnosti zahrnovat všechny dokumenty, které odpovídají vyhledávacímu dotazu, nebo pouze dokumenty, které jsou načteny v okně maxTextRecallSize.
maxTextRecallSize	integer (int32)	Určuje maximální počet dokumentů, které mají být načteny částí hybridního požadavku s textovým dotazem. Tyto dokumenty budou zkombinovány s dokumenty odpovídajícími vektorovým dotazům a vytvoří jeden konečný seznam výsledků. Volba větší hodnoty maxTextRecallSize umožní načítání a stránkování více dokumentů (pomocí parametrů top a skip) za cenu vyššího využití zdrojů a vyšší latence. Hodnota musí být mezi 1 a 10 000. Výchozí hodnota je 1000.

QueryAnswerType

Výčet

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

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

QueryCaptionType

Výčet

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

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

QueryDebugMode

Výčet

Povolí ladicí nástroj, který lze použít k dalšímu prozkoumání výsledků hledání. Můžete povolit více režimů ladění současně jejich oddělením pomocí znaku | znak, například: semantic|queryRewrites.

Hodnota	Description
disabled	Nebudou vráceny žádné informace o ladění dotazu.
semantic	Umožňuje uživateli dále prozkoumávat své přehodnocené výsledky.
vector	Umožňuje uživateli dále prozkoumat výsledky hybridních a vektorových dotazů.
queryRewrites	Umožňuje uživateli prozkoumat seznam přepisů dotazů vygenerovaných pro jeho požadavek na vyhledávání.
innerHits	Umožňuje uživateli získat informace o bodování týkající se vektorů odpovídajících v kolekci komplexních typů.
all	Zapněte všechny možnosti ladění.

QueryLanguage

Výčet

Jazyk dotazu.

Hodnota	Description
none	Dotazovací jazyk není specifikován.
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 jazyka dotazu pro angličtinu (Indie).
en-ca	Hodnota dotazovacího jazyka pro angličtinu (Kanada).
en-au	Hodnota jazyka dotazu pro angličtinu (Austrálie).
fr-fr	Hodnota jazyka dotazu pro francouzštinu (Francie).
fr-ca	Hodnota jazyka dotazu pro francouzštinu (Kanada).
de-de	Hodnota dotazovacího jazyka pro němčinu (Německo).
es-es	Hodnota jazyka dotazu pro španělštinu (Španělsko).
es-mx	Hodnota dotazovacího jazyka pro španělštinu (Mexiko).
zh-cn	Hodnota jazyka dotazu 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 jazyka dotazu 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 jazyka dotazu pro nizozemštinu (Belgie).
nl-nl	Hodnota jazyka dotazu pro nizozemš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 jazyka dotazu pro turečtinu (Turecko).
hi-in	Hodnota jazyka dotazu 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 jazyka dotazu pro dánštinu (Dánsko).
no-no	Hodnota jazyka dotazu pro norštinu (Norsko).
bg-bg	Hodnota jazyka dotazu pro bulharštinu (Bulharsko).
hr-hr	Hodnota jazyka dotazu 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 jazyka dotazu pro tamilštinu (Indie).
vi-vn	Hodnota dotazovacího jazyka pro vietnamštinu (Vietnamština).
el-gr	Hodnota jazyka dotazu pro řečtinu (Řecko).
ro-ro	Hodnota dotazovacího jazyka pro rumunštinu (Rumunsko).
is-is	Hodnota dotazovacího jazyka pro islandštinu (Island).
id-id	Hodnota jazyka dotazu pro indonéštinu (Indonésie).
th-th	Hodnota jazyka dotazu pro thajštinu (Thajsko).
lt-lt	Hodnota dotazovacího jazyka pro litevštinu (Litva).
uk-ua	Hodnota jazyka dotazu pro ukrajinštinu (Ukrajina).
lv-lv	Hodnota jazyka dotazu pro lotyštinu (Latvian).
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 jazyka dotazu pro norštinu (Norsko).
hy-am	Hodnota dotazovacího jazyka pro arménštinu (Arménie).
bn-in	Hodnota jazyka dotazu pro bengálštinu (Indie).
eu-es	Hodnota dotazovacího jazyka pro baskičtinu.
gl-es	Hodnota dotazovacího jazyka pro galicijštinu.
gu-in	Hodnota dotazovacího jazyka pro gudžarátštinu (Indie).
he-il	Hodnota dotazovacího jazyka pro hebrejštinu (Izrael).
ga-ie	Hodnota jazyka dotazu pro irštinu (Irsko).
kn-in	Hodnota dotazovacího jazyka pro kannadštinu (Indie).
ml-in	Hodnota dotazovacího jazyka pro Malayalam (Indie).
mr-in	Hodnota dotazovacího jazyka pro maráthštinu (Indie).
fa-ae	Hodnota dotazovacího jazyka pro perštinu (U.A.E.).
pa-in	Hodnota dotazovacího jazyka pro paňdžábštinu (Indie).
te-in	Hodnota dotazovacího jazyka pro telugštinu (Indie).
ur-pk	Hodnota dotazovacího jazyka pro urdštinu (Pákistán).

QueryResultDocumentRerankerInput

Objekt

Surové zřetězené řetězce, které byly odeslány do procesu sémantického obohacení.

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

QueryResultDocumentSemanticField

Objekt

Popis polí, která byla odeslána do procesu sémantického rozšiřování, a způsob jejich použití

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

QueryResultDocumentSubscores

Objekt

Rozpis dílčích skóre mezi komponentami textového a vektorového dotazu vyhledávacího dotazu pro tento dokument. Každý vektorový dotaz je zobrazen jako samostatný objekt ve stejném pořadí, v jakém byl přijat.

Name	Typ	Description
documentBoost	number (double)	Skóre BM25 nebo Classic pro textovou část dotazu.
text	TextResult	Skóre BM25 nebo Classic pro textovou část dotazu.
vectors	<string, SingleVectorFieldResult>	Vektorová podobnost a @search.score hodnoty pro každý vektorový dotaz.

QueryRewritesDebugInfo

Objekt

Obsahuje informace o ladění specifické pro přepisování dotazů.

Name	Typ	Description
text	QueryRewritesValuesDebugInfo	Seznam přepisů dotazu vygenerovaných pro textový dotaz.
vectors	QueryRewritesValuesDebugInfo[]	Seznam přepisů dotazů generovaných pro vektorizovatelné textové dotazy.

QueryRewritesType

Výčet

Hodnota, která určuje, zda mají být generovány přepisy dotazu pro rozšíření vyhledávacího dotazu.

Hodnota	Description
none	Negenerujte další přepisy dotazů pro tento dotaz.
generative	Vygenerujte alternativní termíny dotazu, abyste zvýšili úplnost požadavku na vyhledávání.

QueryRewritesValuesDebugInfo

Objekt

Obsahuje informace o ladění specifické pro přepisování dotazů.

Name	Typ	Description
inputQuery	string	Vstupní text do modelu přepisování generativních dotazů. Mohou nastat případy, kdy dotaz uživatele a vstup do generativního modelu nejsou totožné.
rewrites	string[]	Seznam přepisů dotazů.

QuerySpellerType

Výčet

Hodnota, která určuje typ spelleru, který se má použít k opravě pravopisu jednotlivých hledaných výrazů.

Hodnota	Description
none	Speller není povolen.
lexicon	Speller opravuje 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 'simple'. Pokud dotaz používá syntaxi dotazu Lucene, použijte hodnotu "úplná", pokud syntaxi dotazu nepotřebujete, použijte hodnotu "sémantická".

Hodnota	Description
simple	Pro vyhledávání používá jednoduchou syntaxi dotazu. Hledaný text je interpretován pomocí jednoduchého dotazovacího jazyka, který umožňuje symboly jako +, * a "". Dotazy jsou ve výchozím nastavení vyhodnocovány ve všech prohledávatelných polích, pokud není zadán parametr searchFields.
full	Pro vyhledávání používá úplnou syntaxi dotazu Lucene. Hledaný text je interpretován pomocí dotazovacího jazyka Lucene, který umožňuje vyhledávání specifické pro dané pole a vážené a 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ů vyhledávání změnou pořadí nejlepších výsledků vyhledávání pomocí modelu hodnocení natrénovaného na webovém korpusu.

RawVectorQuery

Objekt

Parametry dotazu, které se mají použít pro vektorové vyhledávání, pokud je zadána nezpracovaná vektorová hodnota.

Name	Typ	Description
exhaustive	boolean	Je-li true, spustí vyčerpávající hledání k-nejbližších sousedů ve všech vektorech v indexu vektoru. Užitečné pro scénáře, kde jsou přesné shody kritické, jako je například určení základních pravdivostních hodnot.
fields	string	Vektorová pole typu Collection(Edm.Single), která mají být zahrnuta do prohledávaného vektoru.
filterOverride	string	Výraz filtru OData, který se má použít pro tento konkrétní vektorový dotaz. Pokud není na vektorové úrovni definován žádný výraz filtru, použije se místo něj výraz definovaný v parametru filtru nejvyšší úrovně.
k	integer (int32)	Počet nejbližších sousedů, kteří se vrátí jako nejvyšší hity.
kind	string: vector	Druh prováděného vektorového dotazu.
oversampling	number (double)	Faktor převzorkování. Minimální hodnota je 1. Přepíše parametr defaultOversampling nakonfigurovaný v definici indexu. Lze ji nastavit pouze v případě, že je parametr 'rerankWithOriginalVectors' pravdivý. Tento parametr je povolen pouze v případě, že je pro podkladové vektorové pole použita metoda komprese.
perDocumentVectorLimit	integer (int32)	Určuje, kolik vektorů může být nalezeno v každém dokumentu ve vektorovém vyhledávacím dotazu. Nastavením na hodnotu 1 zajistíte, že se v každém dokumentu shoduje maximálně jeden vektor, což zaručuje, že výsledky pocházejí z různých dokumentů. Nastavení na hodnotu 0 (neomezeno) umožňuje porovnávání více relevantních vektorů ze stejného dokumentu. Výchozí hodnota je 0.
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	Prahová hodnota používaná pro vektorové dotazy. Všimněte si, že toto lze nastavit pouze v případě, že všechna "pole" používají stejnou metriku podobnosti.
vector	number[] (float)	Vektorová reprezentace vyhledávacího dotazu.
weight	number (float)	Relativní váha vektorového dotazu ve srovnání s jiným vektorovým dotazem a/nebo textovým dotazem v rámci stejného vyhledávacího požadavku. Tato hodnota se používá při kombinování výsledků více žebříčků vytvořených různými vektorovými dotazy a/nebo výsledků načtených prostřednictvím textového dotazu. Čím vyšší je váha, tím vyšší budou dokumenty, které odpovídaly 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

Výčet

Hodnota, která určuje, zda chceme vypočítat statistiky bodování (například frekvenci dokumentů) globálně pro konzistentnější bodování, nebo místně pro nižší latenci. Výchozí je 'local'. Pomocí výrazu "globální" můžete před vyhodnocením globálně agregovat statistiky hodnocení. Použití globálních statistik bodování může zvýšit latenci vyhledávacích dotazů.

Hodnota	Description
local	Statistiky bodování se budou počítat místně pro nižší latenci.
global	Statistiky bodování se budou počítat globálně, aby bylo skóre konzistentnější.

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í vyhledávání nebo 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 formulaci dalšího požadavku GET nebo POST Search, abyste získali další část odpovědi na vyhledávání. Ujistěte se, že používáte stejné sloveso (GET nebo POST) jako požadavek, který vytvořil tuto odpověď.
@search.answers	AnswerResult[]	Výsledky dotazu answers pro operaci vyhledávání. null, pokud parametr dotazu answers nebyl zadán nebo nastaven na hodnotu 'none'.
@search.coverage	number (double)	Hodnota označující procento indexu, který byl zahrnut do dotazu, nebo null, pokud v požadavku nebylo uvedeno minimumCoverage.
@search.debug	DebugInfo	Ladit informace, které se vztahují k výsledkům hledání jako celku.
@search.facets	object	Výsledky dotazu omezující vlastnosti pro operaci vyhledávání, uspořádané jako kolekce kbelíků pro každé omezující pole. null, pokud dotaz neobsahoval žádné 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 spolu s @odata.nextLink k formulaci dalšího požadavku POST Search, abyste získali další část odpovědi na vyhledávání.
@search.semanticPartialResponseReason	SemanticErrorReason	Důvod, proč byla vrácena částečná odpověď na žádost o sémantické řazení.
@search.semanticPartialResponseType	SemanticSearchResultsType	Typ částečné odpovědi, která byla vrácena pro požadavek na sémantické řazení.
@search.semanticQueryRewritesResultType	SemanticQueryRewritesResultType	Typ přepsání dotazu, který byl použit k načtení dokumentů.
value	SearchResult[]	Posloupnost výsledků vrácených dotazem.

SearchMode

Výčet

Určuje, zda musí být některé nebo všechny hledané výrazy shodné, aby se dokument započítal jako shodný.

Hodnota	Description
any	Aby se dokument započítal jako vyhovující, musí se shodovat kterýkoli z hledaných výrazů.
all	Aby se dokument započítal jako vyhovující, musí se shodovat všechny hledané výrazy.

SearchRequest

Objekt

Parametry pro filtrování, řazení, omezující vlastnosti, 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 na 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 je přibližný.
debug	QueryDebugMode	Aktivuje ladicí nástroj, který lze použít k dalšímu prozkoumání vašich znovu seřazených výsledků.
facets	string[]	Seznam výrazů omezujících vlastností, které se mají použít na vyhledávací dotaz. Každý fasetový výraz obsahuje název pole, volitelně následovaný čárkami odděleným seznamem párů název:hodnota.
filter	string	Výraz OData $filter, který se má použít na vyhledávací dotaz.
highlight	string	Čárkami oddělený seznam názvů polí, která se mají použít pro zvýraznění požadavků na server. Ke zvýraznění požadavků na server lze použít pouze prohledávatelná pole.
highlightPostTag	string	Značka řetězce, která je připojena ke zvýraznění polí. Musí být nastaveno pomocí highlightPreTag. Výchozí hodnota je </em>.
highlightPreTag	string	Značka řetězce, která je předřazena tak, aby dosáhla na světla. Musí být nastaveno pomocí highlightPostTag. Výchozí je <em>.
hybridSearch	HybridSearch	Parametry dotazu pro konfiguraci hybridního chování vyhledávání.
minimumCoverage	number (double)	Číslo mezi 0 a 100 označující procento indexu, které musí být pokryto vyhledávacím dotazem, aby byl dotaz vykázán 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 pouze jednou replikou. Výchozí hodnota je 100.
orderby	string	Seznam OData oddělených čá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 pro označení vzestupného výrazu nebo desc pro označení sestupného. Výchozí je vzestupné pořadí. Nerozhodné výsledky budou přerušeny skóre shody v dokumentech. Pokud není zadána žádná $orderby, výchozí pořadí řazení je sestupné podle skóre shody dokumentu. Může existovat maximálně 32 $orderby klauzulí.
queryLanguage	QueryLanguage	Hodnota, která určuje jazyk vyhledávacího dotazu.
queryRewrites	QueryRewritesType	Hodnota, která určuje, zda mají být generovány přepisy dotazu pro rozšíření vyhledávacího dotazu.
queryType	QueryType	Hodnota, která určuje syntaxi vyhledávacího dotazu. Výchozí hodnota je 'simple'. Pokud dotaz používá syntaxi dotazu Lucene, použijte hodnotu "full".
scoringParameters	string[]	Seznam hodnot parametrů, které se mají použít při bodovacích funkcích (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 by byl "mylocation--122.2,44.8" (bez uvozovek).
scoringProfile	string	Název profilu hodnocení pro vyhodnocení skóre shody pro odpovídající dokumenty za účelem seřazení výsledků.
scoringStatistics	ScoringStatistics	Hodnota, která určuje, zda chceme vypočítat statistiky bodování (například frekvenci dokumentů) globálně pro konzistentnější bodování, nebo místně pro nižší latenci. Výchozí je 'local'. Pomocí výrazu "globální" můžete před vyhodnocením globálně agregovat statistiky hodnocení. Použití globálních statistik bodování může zvýšit latenci vyhledávacích dotazů.
search	string	Výraz fulltextového vyhledávacího dotazu; Použijte "*" nebo tento parametr vynechejte, aby se vyhledaly všechny dokumenty.
searchFields	string	Čárkami oddělený seznam názvů polí, na které se má fulltextové vyhledávání zaměřit. Při použití hledání v poli (fieldName:searchExpression) v úplném dotazu Lucene mají názvy polí každého vyhledávacího výrazu v poli přednost před názvy polí uvedenými v tomto parametru.
searchMode	SearchMode	Hodnota, která určuje, zda se musí shodovat některé nebo všechny hledané výrazy, aby se dokument započítal jako shoda.
select	string	Seznam polí oddělených čárkami, která se mají načíst. Pokud není zadaný, zahrnou se všechna pole označená ve schématu jako zobrazitelná.
semanticConfiguration	string	Název sémantické konfigurace, která bude použita při zpracování dokumentů pro dotazy typu sémantika.
semanticErrorHandling	SemanticErrorMode	Umožňuje uživateli zvolit, zda má sémantické volání zcela selhat (výchozí/aktuální chování), nebo vrátit částečné výsledky.
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 obohacení, než se požadavek nezdaří.
semanticQuery	string	Umožňuje nastavit samostatný vyhledávací dotaz, který se bude používat výhradně pro sémantické přeřazení, sémantické titulky a sémantické odpovědi. Je užitečná pro scénáře, kdy je potřeba použít různé dotazy mezi fází základního načítání a hodnocení a sémantickou fází L2.
sessionId	string	Hodnota, která má být použita k vytvoření relace vždy navždy navždy a která může pomoci dosáhnout konzistentnějších výsledků. Pokud se používá stejné ID relace, bude proveden pokus s maximálním úsilím o cílení na stejnou sadu replik. Mějte na paměti, ž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 nesmí být větší než 100 000. Pokud potřebujete skenovat dokumenty v sekvenci, ale kvůli tomuto omezení nemůžete použít funkci přeskočit, zvažte použití orderby u zcela uspořádaného klíče a místo toho filtrujte pomocí dotazu na rozsah.
speller	QuerySpellerType	Hodnota, která určuje typ spelleru, který se má použít k opravě pravopisu jednotlivých hledaných výrazů.
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ů vyhledávání na straně klienta. Pokud jsou výsledky zkráceny z důvodu stránkování na straně serveru, bude odpověď obsahovat token pro pokračování, který lze použít k vydání dalšího požadavku na vyhledávání pro další stránku výsledků.
vectorFilterMode	VectorFilterMode	Určuje, zda se filtry aplikují před nebo po vektorovém vyhledávání. Výchozí je 'preFilter' pro nové indexy.
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableImageBinaryQuery[] VectorizableImageUrlQuery[] VectorizableTextQuery[]	Parametry dotazu pro vektorové a hybridní vyhledávací dotazy.

SearchResult

Objekt

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

Name	Typ	Description
@search.captions	CaptionResult[]	Titulky jsou nejreprezentativnější pasáže z dokumentu ve vztahu k vyhledávacímu dotazu. Často se používají jako souhrn dokumentu. Titulky se vracejí pouze u dotazů typu sémantika.
@search.documentDebugInfo	DocumentDebugInfo	Obsahuje informace o ladění, které lze použít k dalšímu prozkoumání výsledků hledání.
@search.highlights	object	Části textu z dokumentu, které označují odpovídající hledané výrazy, uspořádané podle každého použitelného pole; Null, pokud pro dotaz nebylo povoleno zvýrazňování přístupů.
@search.rerankerBoostedScore	number (double)	Skóre relevance vypočítané zvýšením skóre Rerankeru. Výsledky hledání jsou seřazeny podle hodnoty RerankerScore/RerankerBoostedScore na základě atributu useScoringProfileBoostedRanking v sémantické konfiguraci. RerankerBoostedScore se vrátí pouze u dotazů typu "sémantický".
@search.rerankerScore	number (double)	Skóre relevance vypočítané sémantickým hodnotitelem pro nejlepší výsledky vyhledávání. Výsledky hledání jsou seřazeny nejprve podle RerankerScore a poté podle Score. Hodnota RerankerScore se vrátí pouze u dotazů typu sémantika.
@search.score	number (double)	Skóre relevantnosti dokumentu ve srovnání s jinými dokumenty vrácenými dotazem.

SearchScoreThreshold

Objekt

Výsledky vektorového dotazu se filtrují na základě hodnoty '@search.score'. Všimněte si, že se jedná o vrácenou @search.score hodnotu jako součást odpovědi na hledání. Směr prahu bude zvolen pro vyšší @search.score.

Name	Typ	Description
kind	string: searchScore	Druh prahové hodnoty používané k filtrování vektorových dotazů
value	number (double)	Prahová hodnota se filtruje na základě hodnoty '@search.score'. Všimněte si, že se jedná o vrácenou @search.score hodnotu jako součást odpovědi na hledání. Směr prahu bude zvolen pro vyšší @search.score.

SemanticDebugInfo

Objekt

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

SemanticErrorMode

Výčet

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

Hodnota	Description
partial	Pokud se sémantické zpracování nezdaří, částečné výsledky se stále vrátí. Definice dílčí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í příslušný kód HTTP v závislosti na chybě.

SemanticErrorReason

Výčet

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

Hodnota	Description
maxWaitExceeded	Pokud `semanticMaxWaitInMilliseconds` bylo nastaveno a doba trvání sémantického zpracování překročila tuto hodnotu. Byly vráceny pouze základní výsledky.
capacityOverloaded	Požadavek byl omezen. Byly vráceny pouze základní výsledky.
transient	Nejméně jeden krok sémantického procesu selhal.

SemanticFieldState

Výčet

Způsob, jakým bylo pole použito pro proces sémantického obohacování (plně použito, částečně použito nebo nevyužito)

Hodnota	Description
used	Pole bylo plně využito pro sémantické obohacení.
unused	Pole nebylo použito pro sémantické obohacení.
partial	Pole bylo částečně využito pro sémantické obohacení.

SemanticQueryRewritesResultType

Výčet

Typ přepsání dotazu, který byl použit pro tento požadavek.

Hodnota	Description
originalQueryOnly	Přepisy dotazů nebyly pro tento požadavek úspěšně vygenerovány. K načtení výsledků byl použit pouze původní dotaz.

SemanticSearchResultsType

Výčet

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

Hodnota	Description
baseResults	Výsledky bez jakéhokoli sémantického obohacení nebo změny pořadí.
rerankedResults	Výsledky byly znovu seřazeny pomocí modelu reranker a budou zahrnovat sémantické titulky. Nebudou obsahovat žádné odpovědi, zvýraznění odpovědí ani zvýraznění titulků.

SingleVectorFieldResult

Objekt

Výsledek z jednoho vektorového pole. Vrátí @search.score se hodnoty podobnosti obou i vektorů. Vektorová podobnost je spojena s @search.score rovnicí.

Name	Typ	Description
searchScore	number (double)	Hodnota @search.score , která se vypočítá ze skóre podobnosti vektorů. Jedná se o skóre, které je viditelné v čistě jednopolovém dotazu s jedním vektorem.
vectorSimilarity	number (double)	Skóre vektorové podobnosti pro tento dokument. Všimněte si, že toto je kanonická definice metriky podobnosti, nikoli verze "vzdálenost". Například kosinová podobnost místo kosinové vzdálenosti.

TextResult

Objekt

Skóre BM25 nebo Classic pro textovou část dotazu.

Name	Typ	Description
searchScore	number (double)	Skóre BM25 nebo Classic pro textovou část dotazu.

VectorFilterMode

Výčet

Určuje, zda se filtry aplikují před nebo po vektorovém vyhledávání.

Hodnota	Description
postFilter	Filtr se použije po vrácení kandidátské sady vektorových výsledků. 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 bude aplikován před vyhledávacím dotazem.
strictPostFilter	Filtr se použije po vrácení globální sady vektorových výsledků top-k, kandidátů. Výsledkem bude méně výsledků, než požaduje parametr 'k'.

VectorizableImageBinaryQuery

Objekt

Parametry dotazu, které se mají použít pro vektorové vyhledávání, když je k dispozici binární soubor obrázku, který je třeba vektorizovat, v kódování Base 64.

Name	Typ	Description
base64Image	string	Binární soubor v kódování Base 64 obrázku, který má být vektorizován k provedení vektorového vyhledávacího dotazu.
exhaustive	boolean	Je-li true, spustí vyčerpávající hledání k-nejbližších sousedů ve všech vektorech v indexu vektoru. Užitečné pro scénáře, kde jsou přesné shody kritické, jako je například určení základních pravdivostních hodnot.
fields	string	Vektorová pole typu Collection(Edm.Single), která mají být zahrnuta do prohledávaného vektoru.
filterOverride	string	Výraz filtru OData, který se má použít pro tento konkrétní vektorový dotaz. Pokud není na vektorové úrovni definován žádný výraz filtru, použije se místo něj výraz definovaný v parametru filtru nejvyšší úrovně.
k	integer (int32)	Počet nejbližších sousedů, kteří se vrátí jako nejvyšší hity.
kind	string: imageBinary	Druh prováděného vektorového dotazu.
oversampling	number (double)	Faktor převzorkování. Minimální hodnota je 1. Přepíše parametr defaultOversampling nakonfigurovaný v definici indexu. Lze ji nastavit pouze v případě, že je parametr 'rerankWithOriginalVectors' pravdivý. Tento parametr je povolen pouze v případě, že je pro podkladové vektorové pole použita metoda komprese.
perDocumentVectorLimit	integer (int32)	Určuje, kolik vektorů může být nalezeno v každém dokumentu ve vektorovém vyhledávacím dotazu. Nastavením na hodnotu 1 zajistíte, že se v každém dokumentu shoduje maximálně jeden vektor, což zaručuje, že výsledky pocházejí z různých dokumentů. Nastavení na hodnotu 0 (neomezeno) umožňuje porovnávání více relevantních vektorů ze stejného dokumentu. Výchozí hodnota je 0.
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	Prahová hodnota používaná pro vektorové dotazy. Všimněte si, že toto lze nastavit pouze v případě, že všechna "pole" používají stejnou metriku podobnosti.
weight	number (float)	Relativní váha vektorového dotazu ve srovnání s jiným vektorovým dotazem a/nebo textovým dotazem v rámci stejného vyhledávacího požadavku. Tato hodnota se používá při kombinování výsledků více žebříčků vytvořených různými vektorovými dotazy a/nebo výsledků načtených prostřednictvím textového dotazu. Čím vyšší je váha, tím vyšší budou dokumenty, které odpovídaly 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.

VectorizableImageUrlQuery

Objekt

Parametry dotazu, které se mají použít pro vektorové vyhledávání, když je zadána adresa URL představující hodnotu obrázku, kterou je třeba vektorizovat.

Name	Typ	Description
exhaustive	boolean	Je-li true, spustí vyčerpávající hledání k-nejbližších sousedů ve všech vektorech v indexu vektoru. Užitečné pro scénáře, kde jsou přesné shody kritické, jako je například určení základních pravdivostních hodnot.
fields	string	Vektorová pole typu Collection(Edm.Single), která mají být zahrnuta do prohledávaného vektoru.
filterOverride	string	Výraz filtru OData, který se má použít pro tento konkrétní vektorový dotaz. Pokud není na vektorové úrovni definován žádný výraz filtru, použije se místo něj výraz definovaný v parametru filtru nejvyšší úrovně.
k	integer (int32)	Počet nejbližších sousedů, kteří se vrátí jako nejvyšší hity.
kind	string: imageUrl	Druh prováděného vektorového dotazu.
oversampling	number (double)	Faktor převzorkování. Minimální hodnota je 1. Přepíše parametr defaultOversampling nakonfigurovaný v definici indexu. Lze ji nastavit pouze v případě, že je parametr 'rerankWithOriginalVectors' pravdivý. Tento parametr je povolen pouze v případě, že je pro podkladové vektorové pole použita metoda komprese.
perDocumentVectorLimit	integer (int32)	Určuje, kolik vektorů může být nalezeno v každém dokumentu ve vektorovém vyhledávacím dotazu. Nastavením na hodnotu 1 zajistíte, že se v každém dokumentu shoduje maximálně jeden vektor, což zaručuje, že výsledky pocházejí z různých dokumentů. Nastavení na hodnotu 0 (neomezeno) umožňuje porovnávání více relevantních vektorů ze stejného dokumentu. Výchozí hodnota je 0.
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	Prahová hodnota používaná pro vektorové dotazy. Všimněte si, že toto lze nastavit pouze v případě, že všechna "pole" používají stejnou metriku podobnosti.
url	string	Adresa URL obrázku, který má být vektorizován za účelem provedení vektorového vyhledávacího dotazu.
weight	number (float)	Relativní váha vektorového dotazu ve srovnání s jiným vektorovým dotazem a/nebo textovým dotazem v rámci stejného vyhledávacího požadavku. Tato hodnota se používá při kombinování výsledků více žebříčků vytvořených různými vektorovými dotazy a/nebo výsledků načtených prostřednictvím textového dotazu. Čím vyšší je váha, tím vyšší budou dokumenty, které odpovídaly 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.

VectorizableTextQuery

Objekt

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

Name	Typ	Description
exhaustive	boolean	Je-li true, spustí vyčerpávající hledání k-nejbližších sousedů ve všech vektorech v indexu vektoru. Užitečné pro scénáře, kde jsou přesné shody kritické, jako je například určení základních pravdivostních hodnot.
fields	string	Vektorová pole typu Collection(Edm.Single), která mají být zahrnuta do prohledávaného vektoru.
filterOverride	string	Výraz filtru OData, který se má použít pro tento konkrétní vektorový dotaz. Pokud není na vektorové úrovni definován žádný výraz filtru, použije se místo něj výraz definovaný v parametru filtru nejvyšší úrovně.
k	integer (int32)	Počet nejbližších sousedů, kteří se vrátí jako nejvyšší hity.
kind	string: text	Druh prováděného vektorového dotazu.
oversampling	number (double)	Faktor převzorkování. Minimální hodnota je 1. Přepíše parametr defaultOversampling nakonfigurovaný v definici indexu. Lze ji nastavit pouze v případě, že je parametr 'rerankWithOriginalVectors' pravdivý. Tento parametr je povolen pouze v případě, že je pro podkladové vektorové pole použita metoda komprese.
perDocumentVectorLimit	integer (int32)	Určuje, kolik vektorů může být nalezeno v každém dokumentu ve vektorovém vyhledávacím dotazu. Nastavením na hodnotu 1 zajistíte, že se v každém dokumentu shoduje maximálně jeden vektor, což zaručuje, že výsledky pocházejí z různých dokumentů. Nastavení na hodnotu 0 (neomezeno) umožňuje porovnávání více relevantních vektorů ze stejného dokumentu. Výchozí hodnota je 0.
queryRewrites	QueryRewritesType	Lze ji nakonfigurovat tak, aby umožnila generativnímu modelu přepsat dotaz před jeho odesláním do vektorizace.
text	string	Text, který má být vektorizován za účelem provedení vektorového vyhledávacího dotazu.
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	Prahová hodnota používaná pro vektorové dotazy. Všimněte si, že toto lze nastavit pouze v případě, že všechna "pole" používají stejnou metriku podobnosti.
weight	number (float)	Relativní váha vektorového dotazu ve srovnání s jiným vektorovým dotazem a/nebo textovým dotazem v rámci stejného vyhledávacího požadavku. Tato hodnota se používá při kombinování výsledků více žebříčků vytvořených různými vektorovými dotazy a/nebo výsledků načtených prostřednictvím textového dotazu. Čím vyšší je váha, tím vyšší budou dokumenty, které odpovídaly 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

Výčet

Druh prováděného vektorového dotazu.

Hodnota	Description
vector	Vektorový dotaz, kde je zadána nezpracovaná vektorová hodnota.
text	Vektorový dotaz, kde je zadána textová hodnota, kterou je třeba vektorizovat.
imageUrl	Vektorový dotaz, kde je zadána adresa URL představující hodnotu obrázku, kterou je třeba vektorizovat.
imageBinary	Vektorový dotaz, kde je k dispozici binární soubor obrázku, který je třeba vektorizovat, v kódování base 64.

VectorsDebugInfo

Objekt

Name	Typ	Description
subscores	QueryResultDocumentSubscores	Rozpis dílčích skóre dokumentu před zvolenou metodou fúze/kombinace sady výsledků, jako je RRF.

VectorSimilarityThreshold

Objekt

Výsledky vektorového dotazu budou filtrovány na základě metriky podobnosti vektorů. Všimněte si, že toto je kanonická definice metriky podobnosti, nikoli verze "vzdálenost". Směr prahové hodnoty (větší nebo menší) bude vybrán automaticky podle metriky použité polem.

Name	Typ	Description
kind	string: vectorSimilarity	Druh prahové hodnoty používané k filtrování vektorových dotazů
value	number (double)	Prahová hodnota se bude filtrovat na základě hodnoty metriky podobnosti. Všimněte si, že toto je kanonická definice metriky podobnosti, nikoli verze "vzdálenost". Směr prahové hodnoty (větší nebo menší) bude vybrán automaticky podle metriky použité polem.

VectorThresholdKind

Výčet

Druh prováděného vektorového dotazu.

Hodnota	Description
vectorSimilarity	Výsledky vektorového dotazu budou filtrovány na základě metriky podobnosti vektorů. Všimněte si, že toto je kanonická definice metriky podobnosti, nikoli verze "vzdálenost". Směr prahové hodnoty (větší nebo menší) bude vybrán automaticky podle metriky použité polem.
searchScore	Výsledky vektorového dotazu se filtrují na základě hodnoty '@search.score'. Všimněte si, že se jedná o vrácenou @search.score hodnotu jako součást odpovědi na hledání. Směr prahu bude zvolen pro vyšší @search.score.