Documents - Search Post
Vyhledá dokumenty v rejstříku.
POST {endpoint}/indexes('{indexName}')/docs/search.post.search?api-version=2026-08-01-preview
Parametry identifikátoru URI
| Name | V | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Adresa URL koncového bodu vyhledávací služby. |
|
index
|
path | True |
string |
Název indexu. |
|
api-version
|
query | True |
string minLength: 1 |
Verze rozhraní API, která se má použít pro tuto operaci. |
Hlavička požadavku
| Name | Vyžadováno | Typ | Description |
|---|---|---|---|
| Accept |
Hlavička Accept. |
||
| 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ů. |
|
| x-ms-enable-elevated-read |
boolean |
Hodnota, která umožňuje zvýšené čtení a obejde kontrolu oprávnění na úrovni dokumentu pro dotazovací operaci. |
|
| x-ms-client-request-id |
string (uuid) |
Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek. |
Text požadavku
| Name | Typ | Description |
|---|---|---|
| answers |
Hodnota, která určuje, jestli se odpovědi mají vrátit jako součást odpovědi hledání. |
|
| captions |
Hodnota, která určuje, zda mají být titulky vráceny jako součást odpovědi hledání. |
|
| count |
boolean |
Hodnota, která určuje, zda se má načíst celkový počet výsledků. Výchozí hodnota je nastavená na false. Nastavení této hodnoty na hodnotu True může mít vliv na výkon. Všimněte si, že vrácený počet představuje aproximaci. |
| debug |
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 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 <>. |
| 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 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 |
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ázev pole, nebo volání funkce geo.distance() nebo search.score(). Za každým výrazem může následovat asc, který označuje vzestupně, nebo desc označují sestupně. Výchozí hodnota je vzestupné pořadí. Vazby budou přerušeny skóre shody dokumentů. Pokud není zadán žádný $orderby, výchozí pořadí řazení je sestupné podle skóre shody dokumentu. Může existovat maximálně 32 $orderby klauzulí. |
| queryLanguage |
Hodnota, která určuje jazyk vyhledávacího dotazu. |
|
| queryRewrites |
Hodnota, která určuje, zda mají být generovány přepisy dotazu pro rozšíření vyhledávacího dotazu. |
|
| queryType |
Hodnota, která určuje syntaxi vyhledávacího dotazu. Výchozí hodnota je 'simple'. 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 |
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é 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 |
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 |
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 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á 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žije stejné ID relace, provede se pokus o dosažení maximálního úsilí, aby cílil na stejnou sadu replik. Buďte opatrní, že opakované použití stejných hodnot SESSIONID může narušit vyrovnávání zatížení požadavků napříč replikami a nepříznivě ovlivnit výkon vyhledávací služby. Hodnota použitá jako sessionId nemůže začínat znakem _. |
| skip |
integer (int32) |
Počet výsledků hledání, které chcete přeskočit. Tato hodnota nemůže být větší než 100 000. Pokud potřebujete skenovat dokumenty v posloupnosti, ale kvůli tomuto omezení nemůžete použít přeskočení, zvažte použití orderby u zcela seřazeného klíče a filtrování pomocí dotazu rozsahu. |
| speller |
Hodnota, která určuje typ hláskovatele, který má být použit k opravě jednotlivých vyhledávacích dotazů. |
|
| top |
integer (int32) |
Počet výsledků hledání, které se mají načíst. To lze použít ve spojení s $skip k implementaci stránkování výsledků hledání na straně klienta. Pokud se výsledky zkrátí kvůli stránkování na straně serveru, odpověď bude obsahovat pokračovací token, který se dá použít k vydání další žádosti o vyhledávání na další stránce výsledků. |
| vectorFilterMode |
Určuje, zda se filtry aplikují před nebo po vektorovém vyhledávání. Výchozí je 'preFilter' pro nové indexy. |
|
| vectorQueries | VectorQuery[]: |
Parametry dotazu pro vektorové a hybridní vyhledávací dotazy. |
Odpovědi
| Name | Typ | Description |
|---|---|---|
| 200 OK |
Požadavek byl úspěšný. |
|
| Other Status Codes |
Úspěšný |
|
| Other Status Codes |
Neočekávaná chybová odpověď |
Zabezpečení
api-key
Typ:
apiKey
V:
header
OAuth2Auth
Typ:
oauth2
Tok:
implicit
URL autorizace:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Rozsahy
| Name | Description |
|---|---|
| https://search.azure.com/.default |
Příklady
|
Search |
|
Search |
|
Search |
SearchIndexSearchDocumentsPost
Ukázkový požadavek
POST https://typespecpreviewexampleservice.search.windows.net/indexes('preview-test')/docs/search.post.search?api-version=2026-08-01-preview
{
"count": true,
"facets": [
"ownerId",
"price,metric:sum,default:10"
],
"filter": "category eq 'purple' or category eq 'pink'",
"highlight": "category",
"highlightPostTag": "</em>",
"highlightPreTag": "</em>",
"minimumCoverage": 100,
"orderby": "",
"queryType": "semantic",
"scoringStatistics": "global",
"sessionId": "mysessionid",
"scoringParameters": [
"categoryTag:desiredCategoryValue"
],
"scoringProfile": "stringFieldBoost",
"debug": "vector",
"search": "purple",
"searchFields": "id,name,description,category,ownerId",
"searchMode": "any",
"queryLanguage": "en-us",
"speller": "lexicon",
"select": "id,name,description,category,ownerId",
"skip": 0,
"top": 10,
"semanticConfiguration": "testconfig",
"semanticErrorHandling": "partial",
"semanticMaxWaitInMilliseconds": 5000,
"semanticQuery": "find all purple",
"answers": "extractive",
"captions": "extractive",
"queryRewrites": "generative",
"semanticFields": "",
"vectorQueries": [
{
"k": 50,
"fields": "vector22, vector1b",
"oversampling": 20,
"weight": 1,
"threshold": {
"kind": "vectorSimilarity",
"value": 0.984
},
"filterOverride": "ownerId eq 'sam'",
"kind": "vector",
"vector": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
]
}
],
"vectorFilterMode": "preFilter",
"hybridSearch": {
"maxTextRecallSize": 100,
"countAndFacetMode": "countAllResults"
}
}
Ukázková odpověď
{
"@odata.count": 27,
"@search.coverage": 100,
"@search.facets": {
"ownerId": [
{
"count": 16,
"value": "sam"
},
{
"count": 8,
"value": "ryan"
},
{
"count": 3,
"value": "benny"
}
],
"price": [
{
"sum": 320
}
]
},
"@search.answers": [],
"value": [
{
"@search.score": 0.015625,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7178425788879395,
"@search.rerankerBoostedScore": 1.7178425788879395,
"@search.captions": [
{
"text": "test10 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 27.725889205932617
},
"vectors": [
{}
]
}
}
},
"id": "10",
"name": "test",
"description": "test10 hello",
"category": "purple",
"ownerId": "benny"
},
{
"@search.score": 0.012820512987673283,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7107532024383545,
"@search.rerankerBoostedScore": 1.7107532024383545,
"@search.captions": [
{
"text": "no vector.",
"highlights": "</em>no vector.</em>"
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 21.559860229492188
},
"vectors": [
{}
]
}
}
},
"id": "empty-vectors",
"name": "test",
"description": "no vector",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.011627906933426857,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7107532024383545,
"@search.rerankerBoostedScore": 1.7107532024383545,
"@search.captions": [
{
"text": "no vector.",
"highlights": "</em>no vector.</em>"
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 6.500757217407227
},
"vectors": [
{}
]
}
}
},
"id": "no-vectors",
"name": "test",
"description": "no vector",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.011904762126505375,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6990556716918945,
"@search.rerankerBoostedScore": 1.6990556716918945,
"@search.captions": [
{
"text": "test4 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 6.500757217407227
},
"vectors": [
{}
]
}
}
},
"id": "4",
"name": "test",
"description": "test4 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.012345679104328156,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6951565742492676,
"@search.rerankerBoostedScore": 1.6951565742492676,
"@search.captions": [
{
"text": "test2 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 6.500757217407227
},
"vectors": [
{}
]
}
}
},
"id": "2",
"name": "test",
"description": "test2 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.0117647061124444,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.693029761314392,
"@search.rerankerBoostedScore": 1.693029761314392,
"@search.captions": [
{
"text": "test5 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 6.500757217407227
},
"vectors": [
{}
]
}
}
},
"id": "5",
"name": "test",
"description": "test5 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.01666666753590107,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6909029483795166,
"@search.rerankerBoostedScore": 1.6909029483795166,
"@search.captions": [
{
"text": "test7 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 39.23316955566406
},
"vectors": [
{}
]
}
}
},
"id": "7",
"name": "test",
"description": "test7 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.013698630034923553,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6777875423431396,
"@search.rerankerBoostedScore": 1.6777875423431396,
"@search.captions": [
{
"text": "test0 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 21.559860229492188
},
"vectors": [
{}
]
}
}
},
"id": "0",
"name": "test",
"description": "test0 hello",
"category": "purple",
"ownerId": "benny"
},
{
"@search.score": 0.013888888992369175,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6650266647338867,
"@search.rerankerBoostedScore": 1.6650266647338867,
"@search.captions": [
{
"text": "test8 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 23.01456642150879
},
"vectors": [
{}
]
}
}
},
"id": "8",
"name": "test",
"description": "test8 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.012658228166401386,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6607730388641357,
"@search.rerankerBoostedScore": 1.6607730388641357,
"@search.captions": [
{
"text": "test11 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 6.500757217407227
},
"vectors": [
{}
]
}
}
},
"id": "11",
"name": "test",
"description": "test11 hello",
"category": "purple",
"ownerId": "sam"
}
]
}
{
"@odata.count": 27,
"@search.coverage": 100,
"@search.facets": {
"ownerId": [
{
"count": 16,
"value": "sam"
},
{
"count": 8,
"value": "ryan"
},
{
"count": 3,
"value": "benny"
}
],
"price": [
{
"sum": 320
}
]
},
"@search.answers": [],
"value": [
{
"@search.score": 0.015625,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7178425788879395,
"@search.rerankerBoostedScore": 1.7178425788879395,
"@search.captions": [
{
"text": "test10 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 27.725889205932617
},
"vectors": [
{}
]
}
}
},
"id": "10",
"name": "test",
"description": "test10 hello",
"category": "purple",
"ownerId": "benny"
},
{
"@search.score": 0.012820512987673283,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7107532024383545,
"@search.rerankerBoostedScore": 1.7107532024383545,
"@search.captions": [
{
"text": "no vector.",
"highlights": "</em>no vector.</em>"
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 21.559860229492188
},
"vectors": [
{}
]
}
}
},
"id": "empty-vectors",
"name": "test",
"description": "no vector",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.011627906933426857,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7107532024383545,
"@search.rerankerBoostedScore": 1.7107532024383545,
"@search.captions": [
{
"text": "no vector.",
"highlights": "</em>no vector.</em>"
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 6.500757217407227
},
"vectors": [
{}
]
}
}
},
"id": "no-vectors",
"name": "test",
"description": "no vector",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.011904762126505375,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6990556716918945,
"@search.rerankerBoostedScore": 1.6990556716918945,
"@search.captions": [
{
"text": "test4 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 6.500757217407227
},
"vectors": [
{}
]
}
}
},
"id": "4",
"name": "test",
"description": "test4 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.012345679104328156,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6951565742492676,
"@search.rerankerBoostedScore": 1.6951565742492676,
"@search.captions": [
{
"text": "test2 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 6.500757217407227
},
"vectors": [
{}
]
}
}
},
"id": "2",
"name": "test",
"description": "test2 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.0117647061124444,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.693029761314392,
"@search.rerankerBoostedScore": 1.693029761314392,
"@search.captions": [
{
"text": "test5 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 6.500757217407227
},
"vectors": [
{}
]
}
}
},
"id": "5",
"name": "test",
"description": "test5 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.01666666753590107,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6909029483795166,
"@search.rerankerBoostedScore": 1.6909029483795166,
"@search.captions": [
{
"text": "test7 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 39.23316955566406
},
"vectors": [
{}
]
}
}
},
"id": "7",
"name": "test",
"description": "test7 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.013698630034923553,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6777875423431396,
"@search.rerankerBoostedScore": 1.6777875423431396,
"@search.captions": [
{
"text": "test0 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 21.559860229492188
},
"vectors": [
{}
]
}
}
},
"id": "0",
"name": "test",
"description": "test0 hello",
"category": "purple",
"ownerId": "benny"
},
{
"@search.score": 0.013888888992369175,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6650266647338867,
"@search.rerankerBoostedScore": 1.6650266647338867,
"@search.captions": [
{
"text": "test8 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 23.01456642150879
},
"vectors": [
{}
]
}
}
},
"id": "8",
"name": "test",
"description": "test8 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.012658228166401386,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6607730388641357,
"@search.rerankerBoostedScore": 1.6607730388641357,
"@search.captions": [
{
"text": "test11 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 6.500757217407227
},
"vectors": [
{}
]
}
}
},
"id": "11",
"name": "test",
"description": "test11 hello",
"category": "purple",
"ownerId": "sam"
}
]
}
SearchIndexSearchDocumentsPostOsV2
Ukázkový požadavek
POST https://previewexampleservice.search.windows.net/indexes('preview-test')/docs/search.post.search?api-version=2026-08-01-preview
{
"count": true,
"facets": [
"ownerId",
"price,metric:sum,default:10"
],
"filter": "category eq 'purple' or category eq 'pink'",
"highlight": "category",
"highlightPostTag": "</em>",
"highlightPreTag": "</em>",
"minimumCoverage": 100,
"queryType": "semantic",
"scoringStatistics": "global",
"sessionId": "mysessionid",
"scoringParameters": [
"categoryTag:desiredCategoryValue"
],
"scoringProfile": "stringFieldBoost",
"debug": "vector",
"search": "purple",
"searchFields": "id,name,description,category,ownerId",
"searchMode": "any",
"queryLanguage": "en-us",
"speller": "lexicon",
"select": "id,name,description,category,ownerId",
"skip": 0,
"top": 10,
"semanticConfiguration": "testconfig",
"semanticErrorHandling": "partial",
"semanticMaxWaitInMilliseconds": 5000,
"semanticQuery": "find all purple",
"answers": "extractive",
"captions": "extractive",
"queryRewrites": "generative",
"vectorQueries": [
{
"vector": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
],
"kind": "vector",
"k": 50,
"fields": "vector22, vector1b",
"oversampling": 20,
"weight": 1,
"threshold": {
"value": 0.984,
"kind": "vectorSimilarity"
},
"filterOverride": "ownerId eq 'sam'"
}
],
"vectorFilterMode": "preFilter",
"hybridSearch": {
"maxTextRecallSize": 100,
"countAndFacetMode": "countAllResults"
}
}
Ukázková odpověď
{
"@odata.count": 27,
"@search.coverage": 100,
"@search.facets": {
"ownerId": [
{
"count": 16,
"value": "sam"
},
{
"count": 8,
"value": "ryan"
},
{
"count": 3,
"value": "benny"
}
],
"price": [
{
"sum": 320
}
]
},
"@search.answers": [],
"value": [
{
"@search.score": 0.012987012974917889,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7178425788879395,
"@search.rerankerBoostedScore": 1.7178425788879395,
"@search.captions": [
{
"text": "test10 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 15.319689750671387
},
"vectors": [
{}
]
}
}
},
"id": "10",
"name": "test",
"description": "test10 hello",
"category": "purple",
"ownerId": "benny"
},
{
"@search.score": 0.013333333656191826,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7079174518585205,
"@search.rerankerBoostedScore": 1.7079174518585205,
"@search.captions": [
{
"text": "no vector.",
"highlights": "</em>no vector.</em>"
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 18.800146102905273
},
"vectors": [
{}
]
}
}
},
"id": "no-vectors",
"name": "test",
"description": "no vector",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.012195121496915817,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7079174518585205,
"@search.rerankerBoostedScore": 1.7079174518585205,
"@search.captions": [
{
"text": "no vector.",
"highlights": "</em>no vector.</em>"
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 15.319689750671387
},
"vectors": [
{}
]
}
}
},
"id": "empty-vectors",
"name": "test",
"description": "no vector",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.012345679104328156,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6994102001190186,
"@search.rerankerBoostedScore": 1.6994102001190186,
"@search.captions": [
{
"text": "test4 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 15.319689750671387
},
"vectors": [
{}
]
}
}
},
"id": "4",
"name": "test",
"description": "test4 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.0117647061124444,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6937386989593506,
"@search.rerankerBoostedScore": 1.6937386989593506,
"@search.captions": [
{
"text": "test2 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 11.507283210754395
},
"vectors": [
{}
]
}
}
},
"id": "2",
"name": "test",
"description": "test2 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.013698630034923553,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6923208236694336,
"@search.rerankerBoostedScore": 1.6923208236694336,
"@search.captions": [
{
"text": "test5 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 21.559860229492188
},
"vectors": [
{}
]
}
}
},
"id": "5",
"name": "test",
"description": "test5 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.013513513840734959,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.691611886024475,
"@search.rerankerBoostedScore": 1.691611886024475,
"@search.captions": [
{
"text": "test7 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 18.800146102905273
},
"vectors": [
{}
]
}
}
},
"id": "7",
"name": "test",
"description": "test7 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.01315789483487606,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6781420707702637,
"@search.rerankerBoostedScore": 1.6781420707702637,
"@search.captions": [
{
"text": "test0 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 15.319689750671387
},
"vectors": [
{}
]
}
}
},
"id": "0",
"name": "test",
"description": "test0 hello",
"category": "purple",
"ownerId": "benny"
},
{
"@search.score": 0.015625,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6653810739517212,
"@search.rerankerBoostedScore": 1.6653810739517212,
"@search.captions": [
{
"text": "test8 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 33.067142486572266
},
"vectors": [
{}
]
}
}
},
"id": "8",
"name": "test",
"description": "test8 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.016393441706895828,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6618363857269287,
"@search.rerankerBoostedScore": 1.6618363857269287,
"@search.captions": [
{
"text": "test11 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 33.067142486572266
},
"vectors": [
{}
]
}
}
},
"id": "11",
"name": "test",
"description": "test11 hello",
"category": "purple",
"ownerId": "sam"
}
]
}
{
"value": []
}
SearchIndexSearchDocumentsSemanticPost
Ukázkový požadavek
POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2026-08-01-preview
{
"count": true,
"highlightPostTag": "</em>",
"highlightPreTag": "<em>",
"queryType": "semantic",
"search": "how do clouds form",
"semanticConfiguration": "my-semantic-config",
"answers": "extractive|count-3",
"captions": "extractive|highlight-true",
"semanticErrorHandling": "partial",
"semanticMaxWaitInMilliseconds": 780
}
Ukázková odpověď
{
"@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
}
],
"@search.nextPageParameters": {
"count": true,
"highlightPostTag": "</em>",
"highlightPreTag": "<em>",
"queryType": "semantic",
"search": "how do clouds form",
"semanticConfiguration": "my-semantic-config",
"answers": "extractive|count-3",
"captions": "extractive|highlight-true",
"semanticErrorHandling": "partial",
"semanticMaxWaitInMilliseconds": 780,
"skip": 2,
"top": 8
},
"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"
]
}
],
"@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2025-05-01-preview"
}
{
"@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
}
],
"@search.nextPageParameters": {
"count": true,
"highlightPostTag": "</em>",
"highlightPreTag": "<em>",
"queryType": "semantic",
"search": "how do clouds form",
"semanticConfiguration": "my-semantic-config",
"answers": "extractive|count-3",
"captions": "extractive|highlight-true",
"semanticErrorHandling": "partial",
"semanticMaxWaitInMilliseconds": 780,
"skip": 2,
"top": 8
},
"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"
]
}
],
"@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2025-05-01-preview"
}
Definice
| Name | Description |
|---|---|
| Accept |
Hlavička Accept. |
|
Debug |
Obsahuje informace o ladění, které lze použít k dalšímu zkoumání výsledků hledání. |
|
Document |
Obsahuje informace o ladění, které lze použít k dalšímu zkoumání výsledků hledání. |
|
Error |
Další informace o chybě při správě prostředků |
|
Error |
Podrobnosti o chybě. |
|
Error |
Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.) |
|
Hybrid |
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'. |
|
Hybrid |
Parametry dotazu pro konfiguraci hybridního chování vyhledávání. |
|
Query |
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. |
|
Query |
Tento parametr je platný pouze v případě, že typ dotazu je |
|
Query |
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 |
|
Query |
Tento parametr je platný pouze v případě, že typ dotazu je |
|
Query |
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. |
|
Query |
Jazyk dotazu. |
|
Query |
Nezpracované zřetězené řetězce odeslané do sémantického procesu rozšiřování. |
|
Query |
Popis polí odeslaných do procesu sémantického rozšiřování a způsobu jejich použití |
|
Query |
Rozpis dílčích jader mezi částmi textového a vektorového dotazu vyhledávacího dotazu pro tento dokument. Každý vektorový dotaz se zobrazí jako samostatný objekt ve stejném pořadí, v jakém byl přijat. |
|
Query |
Obsahuje informace o ladění specifické pro přepisování dotazů. |
|
Query |
Tento parametr je platný pouze v případě, že typ dotazu je |
|
Query |
Obsahuje informace o ladění specifické pro přepisování dotazů. |
|
Query |
Vylepšete zapamatování vyhledávání opravou pravopisu jednotlivých hledaných dotazů. |
|
Query |
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á". |
|
Scoring |
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 |
Odpověď obsahující výsledky hledání z indexu |
|
Search |
Určuje, zda musí být některé nebo všechny hledané výrazy shodné, aby se dokument započítal jako shodný. |
|
Search |
Parametry pro filtrování, řazení, fasetování, stránkování a další chování vyhledávacích dotazů |
|
Search |
Obsahuje dokument nalezený vyhledávacím dotazem a přidruženými metadaty. |
|
Search |
Výsledky vektorového dotazu budou filtrovány podle ' |
|
Semantic |
Obsahuje informace o ladění specifické pro požadavky na sémantické řazení. |
|
Semantic |
Umožňuje uživateli zvolit, zda má sémantický hovor zcela selhat, nebo zda vrátí částečné výsledky. |
|
Semantic |
Důvod, proč byla vrácena částečná odpověď na žádost o sémantické řazení. |
|
Semantic |
Způsob, jakým bylo pole využíváno pro proces sémantického obohacení. |
|
Semantic |
Typ přepsání dotazu, který byl použit pro tento požadavek. |
|
Semantic |
Typ částečné odpovědi, která byla vrácena pro požadavek na sémantické řazení. |
|
Single |
Výsledek jednoho vektorového pole. Oboje |
|
Text |
Skóre BM25 nebo Classic pro text v dotazu. |
|
Vector |
Určuje, zda se filtry aplikují před nebo po vektorovém vyhledávání. |
|
Vectorizable |
Parametry dotazu, které se mají použít pro vektorové vyhledávání, když je k dispozici binární soubor s kódováním base 64 obrázku, který je potřeba vektorizovat. |
|
Vectorizable |
Parametry dotazu, které se mají použít pro vektorové vyhledávání, pokud je k dispozici adresa URL představující hodnotu obrázku, kterou je potřeba vektorizovat. |
|
Vectorizable |
Parametry dotazu, které se mají použít pro vektorové vyhledávání, pokud je k dispozici textová hodnota, která musí být vektorizována. |
|
Vectorized |
Parametry dotazu, které se mají použít pro vektorové vyhledávání při zadání nezpracované hodnoty vektoru. |
|
Vector |
Druh prováděného vektorového dotazu. |
|
Vectors |
"Obsahuje ladicí informace specifické pro vektorové a hybridní vyhledávání.") |
|
Vector |
Výsledky vektorového dotazu budou filtrovány na základě metriky podobnosti vektoru. Všimněte si, že se jedná o kanonickou definici metriky podobnosti, nikoli verzi "vzdálenosti". Směr prahové hodnoty (větší nebo menší) se vybere automaticky podle metriky používané polem. |
|
Vector |
Typ prahu používaný pro filtrování vektorových dotazů. |
Accept
Hlavička Accept.
| Hodnota | Description |
|---|---|
| application/json;odata.metadata=none |
DebugInfo
Obsahuje informace o ladění, které lze použít k dalšímu zkoumání výsledků hledání.
| Name | Typ | Description |
|---|---|---|
| queryRewrites |
Obsahuje informace o ladění specifické pro přepisování dotazů. |
DocumentDebugInfo
Obsahuje informace o ladění, které lze použít k dalšímu zkoumá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 |
Obsahuje informace o ladění specifické pro požadavky na sémantické řazení. |
|
| vectors |
Obsahuje informace o ladění specifické pro vektorové a hybridní vyhledávání. |
ErrorAdditionalInfo
Další informace o chybě při správě prostředků
| Name | Typ | Description |
|---|---|---|
| info |
Další informace. |
|
| type |
string |
Další typ informací. |
ErrorDetail
Podrobnosti o chybě.
| Name | Typ | Description |
|---|---|---|
| additionalInfo |
Další informace o chybě. |
|
| code |
string |
Kód chyby. |
| details |
Podrobnosti o chybě. |
|
| message |
string |
Chybová zpráva. |
| target |
string |
Cíl chyby. |
ErrorResponse
Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)
| Name | Typ | Description |
|---|---|---|
| error |
Objekt chyby. |
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'.
| 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
Parametry dotazu pro konfiguraci hybridního chování vyhledávání.
| Name | Typ | Description |
|---|---|---|
| countAndFacetMode |
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. |
QueryAnswerResult
Odpověď je textový úsek extrahovaný z obsahu nejrelevavantnějších dokumentů, které odpovídají dotazu. Odpovědi se extrahují z nejlepších výsledků hledání. Kandidáti na odpovědi jsou hodnoceni a vyberou se hlavní odpovědi.
| Name | Typ | Description |
|---|---|---|
| highlights |
string |
Stejný textový úsek jako ve vlastnosti Text se zvýrazněnými textovými frázemi, které jsou pro dotaz nejrelevantní. |
| key |
string |
Klíč dokumentu, ze které byla odpověď extrahována. |
| score |
number (double) |
Hodnota skóre představuje, jak relevantní je odpověď na dotaz vzhledem k jiným odpovědím vrácených pro dotaz. |
| text |
string |
Textová část extrahovaná z obsahu dokumentu jako odpověď. |
QueryAnswerType
Tento parametr je platný pouze v případě, že typ dotazu je 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 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'.
| Hodnota | Description |
|---|---|
| none |
Nevracet odpovědi na dotaz. |
| extractive |
Extrahuje kandidáty odpovědí z obsahu dokumentů vrácených v reakci na dotaz vyjádřený jako otázka v přirozeném jazyce. |
QueryCaptionResult
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ší. |
QueryCaptionType
Tento parametr je platný pouze v případě, že typ dotazu je semantic. Pokud je tato možnost nastavená, dotaz vrátí titulky extrahované z klíčových pasáží v nejřadivějších dokumentech. 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'.
| Hodnota | Description |
|---|---|
| none |
Nevracet titulky dotazu. |
| extractive |
Extrahuje titulky z odpovídajících dokumentů, které obsahují pasáže relevantní pro vyhledávací dotaz. |
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.
| Hodnota | Description |
|---|---|
| disabled |
Nebudou vráceny žádné informace o ladění dotazů. |
| semantic |
Umožňuje uživateli dále prozkoumat výsledky seřazené podle pořadí. |
| vector |
Umožňuje uživateli dále prozkoumat výsledky hybridního a vektorového dotazu. |
| queryRewrites |
Umožňuje uživateli prozkoumat seznam přepisů dotazů vygenerovaných pro svoji žádost o 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
Jazyk dotazu.
| Hodnota | Description |
|---|---|
| none |
Dotazovací jazyk není specifikován. |
| en-us |
Dotaz na hodnotu jazyka pro angličtinu (USA). |
| 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
Nezpracované zřetězené řetězce odeslané do sémantického procesu rozšiřování.
| Name | Typ | Description |
|---|---|---|
| content |
string |
Nezpracované zřetězené řetězce pro pole obsahu, která byla použita pro sémantické 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
Popis polí odeslaných do procesu sémantického rozšiřování a způsobu jejich použití
| Name | Typ | Description |
|---|---|---|
| name |
string |
Název pole, které bylo odesláno do procesu sémantického rozšiřování |
| state |
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
Rozpis dílčích jader mezi částmi textového a vektorového dotazu vyhledávacího dotazu pro tento dokument. Každý vektorový dotaz se zobrazí 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 text v dotazu. |
| text |
Skóre BM25 nebo Classic pro text v dotazu. |
|
| vectors |
<string,
Single |
Vektorová podobnost a |
QueryRewritesDebugInfo
Obsahuje informace o ladění specifické pro přepisování dotazů.
| Name | Typ | Description |
|---|---|---|
| text |
Seznam přepisů dotazu vygenerovaných pro textový dotaz. |
|
| vectors |
Seznam přepisů dotazů generovaných pro vektorizovatelné textové dotazy. |
QueryRewritesType
Tento parametr je platný pouze v případě, že typ dotazu je semantic. Pokud je parametr QueryRewrites nastaven na generativehodnotu , 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.
| 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
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
Vylepšete zapamatování vyhledávání opravou pravopisu jednotlivých hledaných dotazů.
| Hodnota | Description |
|---|---|
| none |
Speller není povolen. |
| lexicon |
Speller opravuje jednotlivé termíny dotazu pomocí statického lexikonu pro jazyk určený parametrem queryLanguage. |
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á".
| 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. |
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ů.
| 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
Odpověď obsahující výsledky hledání z indexu
| Name | Typ | Description |
|---|---|---|
| @odata.count |
integer (int64) |
Celkový počet výsledků nalezených operací hledání nebo hodnota null, pokud se počet nepožadoval. Pokud existuje, může být počet větší než počet výsledků v této odpovědi. K tomu může dojít, pokud použijete parametry $top nebo $skip nebo pokud dotaz nemůže vrátit všechny požadované dokumenty v jedné odpovědi. |
| @odata.nextLink |
string |
Adresa URL 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 |
Výsledky dotazu pro operaci hledání; Null, pokud nebyl zadán parametr dotazu odpovědi nebo nastaven na hodnotu none. |
|
| @search.coverage |
number (double) |
Hodnota označující procento indexu zahrnutého v dotazu nebo hodnotu null, pokud v požadavku nebylo zadáno minimumCoverage. |
| @search.debug |
Ladicí informace, které platí pro výsledky hledání jako celek. |
|
| @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 |
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 JSON můžete použít spolu s |
|
| @search.semanticPartialResponseReason |
Důvod, proč byla vrácena částečná odpověď na žádost o sémantické řazení. |
|
| @search.semanticPartialResponseType |
Typ částečné odpovědi, která byla vrácena pro požadavek na sémantické řazení. |
|
| @search.semanticQueryRewritesResultType |
Typ přepsání dotazu, který byl použit k načtení dokumentů. |
|
| value |
Posloupnost výsledků vrácených dotazem. |
SearchMode
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
Parametry pro filtrování, řazení, fasetování, stránkování a další chování vyhledávacích dotazů
| Name | Typ | Description |
|---|---|---|
| answers |
Hodnota, která určuje, jestli se odpovědi mají vrátit jako součást odpovědi hledání. |
|
| captions |
Hodnota, která určuje, zda mají být titulky vráceny jako součást odpovědi hledání. |
|
| count |
boolean |
Hodnota, která určuje, zda se má načíst celkový počet výsledků. Výchozí hodnota je nastavená na false. Nastavení této hodnoty na hodnotu True může mít vliv na výkon. Všimněte si, že vrácený počet představuje aproximaci. |
| debug |
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 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 <>. |
| 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 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 |
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ázev pole, nebo volání funkce geo.distance() nebo search.score(). Za každým výrazem může následovat asc, který označuje vzestupně, nebo desc označují sestupně. Výchozí hodnota je vzestupné pořadí. Vazby budou přerušeny skóre shody dokumentů. Pokud není zadán žádný $orderby, výchozí pořadí řazení je sestupné podle skóre shody dokumentu. Může existovat maximálně 32 $orderby klauzulí. |
| queryLanguage |
Hodnota, která určuje jazyk vyhledávacího dotazu. |
|
| queryRewrites |
Hodnota, která určuje, zda mají být generovány přepisy dotazu pro rozšíření vyhledávacího dotazu. |
|
| queryType |
Hodnota, která určuje syntaxi vyhledávacího dotazu. Výchozí hodnota je 'simple'. 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 |
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é 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 |
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 |
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 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á 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žije stejné ID relace, provede se pokus o dosažení maximálního úsilí, aby cílil na stejnou sadu replik. Buďte opatrní, že opakované použití stejných hodnot SESSIONID může narušit vyrovnávání zatížení požadavků napříč replikami a nepříznivě ovlivnit výkon vyhledávací služby. Hodnota použitá jako sessionId nemůže začínat znakem _. |
| skip |
integer (int32) |
Počet výsledků hledání, které chcete přeskočit. Tato hodnota nemůže být větší než 100 000. Pokud potřebujete skenovat dokumenty v posloupnosti, ale kvůli tomuto omezení nemůžete použít přeskočení, zvažte použití orderby u zcela seřazeného klíče a filtrování pomocí dotazu rozsahu. |
| speller |
Hodnota, která určuje typ hláskovatele, který má být použit k opravě jednotlivých vyhledávacích dotazů. |
|
| top |
integer (int32) |
Počet výsledků hledání, které se mají načíst. To lze použít ve spojení s $skip k implementaci stránkování výsledků hledání na straně klienta. Pokud se výsledky zkrátí kvůli stránkování na straně serveru, odpověď bude obsahovat pokračovací token, který se dá použít k vydání další žádosti o vyhledávání na další stránce výsledků. |
| vectorFilterMode |
Určuje, zda se filtry aplikují před nebo po vektorovém vyhledávání. Výchozí je 'preFilter' pro nové indexy. |
|
| vectorQueries | VectorQuery[]: |
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 |
Titulky jsou nejvýraznější pasáže z dokumentu relativně do vyhledávacího dotazu. Často se používají jako souhrn dokumentů. Titulky se vracejí pouze u dotazů typu sémantika. |
|
| @search.documentDebugInfo |
Obsahuje informace o ladění, které lze použít k dalšímu zkoumá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 vyhledávání jsou seřazeny podle RerankerScore/RerankerBoostedScore na základě useScoringProfileBoostedRanking v Sémantické konfiguraci. RerankerBoostedScore se vrací pouze pro dotazy 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
Výsledky vektorového dotazu budou filtrovány podle '
| Name | Typ | Description |
|---|---|---|
| kind |
string:
search |
Typ prahu. |
| value |
number (double) |
Práh bude filtrován podle ' |
SemanticDebugInfo
Obsahuje informace o ladění specifické pro požadavky na sémantické řazení.
| Name | Typ | Description |
|---|---|---|
| contentFields |
Pole obsahu, která byla odeslána do procesu sémantického rozšiřování, a způsob jejich použití |
|
| keywordFields |
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 |
Nezpracované zřetězené řetězce odeslané do sémantického procesu rozšiřování. |
|
| titleField |
Pole názvu, které bylo odesláno do procesu sémantického rozšiřování, a způsob jeho použití |
SemanticErrorMode
Umožňuje uživateli zvolit, zda má sémantický hovor zcela selhat, nebo zda vrátí částečné výsledky.
| Hodnota | Description |
|---|---|
| partial |
Pokud se sémantické zpracování nezdaří, částečné výsledky se stále vrátí. Definice částečných výsledků závisí na tom, jaký sémantický krok selhal a jaký byl důvod selhání. |
| fail |
Pokud během kroku sémantického zpracování dojde k výjimce, dotaz selže a vrátí odpovídající kód HTTP v závislosti na chybě. |
SemanticErrorReason
Důvod, proč byla vrácena částečná odpověď na žádost o sémantické řazení.
| Hodnota | Description |
|---|---|
| maxWaitExceeded |
Pokud |
| capacityOverloaded |
Žádost byla omezena. Vrátily se pouze základní výsledky. |
| transient |
Nejméně jeden krok sémantického procesu se nezdařil. |
SemanticFieldState
Způsob, jakým bylo pole využíváno pro proces sémantického obohacení.
| 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
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
Typ částečné odpovědi, která byla vrácena pro požadavek na sémantické řazení.
| Hodnota | Description |
|---|---|
| baseResults |
Výsledky bez sémantického rozšiřování nebo přeřazení. |
| rerankedResults |
Výsledky byly znovu seřazeny pomocí modelu reranker a budou obsahovat sémantické titulky. Nebudou obsahovat žádné odpovědi, zvýraznění odpovědí ani zvýraznění titulků. |
SingleVectorFieldResult
Výsledek jednoho vektorového pole. Oboje
| Name | Typ | Description |
|---|---|---|
| searchScore |
number (double) |
Prostředek |
| vectorSimilarity |
number (double) |
Skóre vektorové podobnosti pro tento dokument. Všimněte si, že se jedná o kanonickou definici metriky podobnosti, nikoli verzi "vzdálenosti". Například kosinová podobnost místo kosinové vzdálenosti. |
TextResult
Skóre BM25 nebo Classic pro text v dotazu.
| Name | Typ | Description |
|---|---|---|
| searchScore |
number (double) |
Skóre BM25 nebo Classic pro text v dotazu. |
VectorFilterMode
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 výsledků vektoru. V závislosti na selektivitě filtru to může vést k menšímu počtu výsledků, než požaduje parametr "k". |
| preFilter |
Filtr se použije před vyhledávacím dotazem. |
| 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
Parametry dotazu, které se mají použít pro vektorové vyhledávání, když je k dispozici binární soubor s kódováním base 64 obrázku, který je potřeba vektorizovat.
| Name | Typ | Description |
|---|---|---|
| base64Image |
string |
Binární soubor v kódování Base 64 obrázku, který má být vektorizován k provedení vektorového vyhledávacího dotazu. |
| 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í. |
| filterOverride |
string |
Výraz filtru OData, který se má použít pro tento konkrétní vektorový dotaz. Pokud není na úrovni vektoru definován žádný výraz filtru, použije se místo toho výraz definovaný v parametru filtru nejvyšší úrovně. |
| k |
integer (int32) |
Početnejbližších |
| kind |
string:
image |
Typ 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ří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. |
| 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: |
Prahová hodnota použitá pro vektorové dotazy. Všimněte si, že tuto možnost 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ý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. |
VectorizableImageUrlQuery
Parametry dotazu, které se mají použít pro vektorové vyhledávání, pokud je k dispozici adresa URL představující hodnotu obrázku, kterou je potřeba vektorizovat.
| 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í. |
| filterOverride |
string |
Výraz filtru OData, který se má použít pro tento konkrétní vektorový dotaz. Pokud není na úrovni vektoru definován žádný výraz filtru, použije se místo toho výraz definovaný v parametru filtru nejvyšší úrovně. |
| k |
integer (int32) |
Početnejbližších |
| kind |
string:
image |
Typ 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ří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. |
| 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: |
Prahová hodnota použitá pro vektorové dotazy. Všimněte si, že tuto možnost lze nastavit pouze v případě, že všechna pole používají stejnou metriku podobnosti. |
| url |
string |
Adresa URL obrázku, který se má vektorizovat za účelem provedení vektorového vyhledávacího dotazu. |
| weight |
number (float) |
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. |
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í. |
| filterOverride |
string |
Výraz filtru OData, který se má použít pro tento konkrétní vektorový dotaz. Pokud není na úrovni vektoru definován žádný výraz filtru, použije se místo toho výraz definovaný v parametru filtru nejvyšší úrovně. |
| k |
integer (int32) |
Početnejbližších |
| kind |
string:
text |
Typ 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ří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. |
| 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 |
Je možné nakonfigurovat tak, aby před odesláním vektorizovaného modelu přepsal dotaz generující model. |
|
| text |
string |
Text, který má být vektorizován k provedení vektorového vyhledávacího dotazu. |
| threshold | VectorThreshold: |
Prahová hodnota použitá pro vektorové dotazy. Všimněte si, že tuto možnost 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ý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. |
VectorizedQuery
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í. |
| filterOverride |
string |
Výraz filtru OData, který se má použít pro tento konkrétní vektorový dotaz. Pokud není na úrovni vektoru definován žádný výraz filtru, použije se místo toho výraz definovaný v parametru filtru nejvyšší úrovně. |
| k |
integer (int32) |
Početnejbližších |
| kind |
string:
vector |
Typ 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ří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. |
| 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: |
Prahová hodnota použitá pro vektorové dotazy. Všimněte si, že tuto možnost lze nastavit pouze v případě, že všechna pole používají stejnou metriku podobnosti. |
| vector |
number[] (float) |
Vektorové znázornění vyhledávacího dotazu. |
| weight |
number (float) |
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 prováděného vektorového dotazu.
| Hodnota | Description |
|---|---|
| vector |
Vektorový dotaz, kde je zadaná nezpracovaná hodnota vektoru. |
| text |
Vektorový dotaz, kde je k dispozici textová hodnota, kterou je potřeba vektorizovat. |
| 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
"Obsahuje ladicí informace specifické pro vektorové a hybridní vyhledávání.")
| Name | Typ | Description |
|---|---|---|
| subscores |
Rozpis dílčích skóre dokumentu před zvolenou metodou fúze/kombinace sady výsledků, jako je RRF. |
VectorSimilarityThreshold
Výsledky vektorového dotazu budou filtrovány na základě metriky podobnosti vektoru. Všimněte si, že se jedná o kanonickou definici metriky podobnosti, nikoli verzi "vzdálenosti". Směr prahové hodnoty (větší nebo menší) se vybere automaticky podle metriky používané polem.
| Name | Typ | Description |
|---|---|---|
| kind |
string:
vector |
Typ prahu. |
| value |
number (double) |
Prahová hodnota se bude filtrovat na základě hodnoty metriky podobnosti. Všimněte si, že se jedná o kanonickou definici metriky podobnosti, nikoli verzi "vzdálenosti". Směr prahové hodnoty (větší nebo menší) se vybere automaticky podle metriky používané polem. |
VectorThresholdKind
Typ prahu používaný pro filtrování vektorových dotazů.
| Hodnota | Description |
|---|---|
| vectorSimilarity |
Výsledky vektorového dotazu budou filtrovány na základě metriky podobnosti vektoru. Všimněte si, že se jedná o kanonickou definici metriky podobnosti, nikoli verzi "vzdálenosti". Směr prahové hodnoty (větší nebo menší) se vybere automaticky podle metriky používané polem. |
| searchScore |
Výsledky vektorového dotazu se budou filtrovat 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. |