Documents - Search Post
Vyhledá dokumenty v rejstříku.
POST {endpoint}/indexes('{indexName}')/docs/search.post.search?api-version=2026-04-01
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-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 <>. |
| 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í. |
| 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. |
|
| 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. |
| 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 |
SearchIndexSearchDocumentsPost
Ukázkový požadavek
POST https://exampleservice.search.windows.net/indexes('test-index')/docs/search.post.search?api-version=2026-04-01
{
"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",
"select": "id,name,description,category,ownerId",
"skip": 0,
"top": 10,
"semanticConfiguration": "testconfig",
"semanticErrorHandling": "partial",
"semanticMaxWaitInMilliseconds": 5000,
"semanticQuery": "find all purple",
"answers": "extractive",
"captions": "extractive",
"vectorQueries": [
{
"vector": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
],
"kind": "vector",
"k": 50,
"fields": "vector22, vector1b",
"oversampling": 20,
"weight": 1
}
],
"vectorFilterMode": "preFilter"
}
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": ""
}
],
"id": "10",
"name": "test",
"description": "test10 hello",
"category": "purple",
"ownerId": "benny"
},
{
"@search.score": 0.012820512987673283,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7079174518585205,
"@search.rerankerBoostedScore": 1.7079174518585205,
"@search.captions": [
{
"text": "no vector.",
"highlights": "</em>no vector.</em>"
}
],
"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.7079174518585205,
"@search.rerankerBoostedScore": 1.7079174518585205,
"@search.captions": [
{
"text": "no vector.",
"highlights": "</em>no vector.</em>"
}
],
"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.6994102001190186,
"@search.rerankerBoostedScore": 1.6994102001190186,
"@search.captions": [
{
"text": "test4 hello.",
"highlights": ""
}
],
"id": "4",
"name": "test",
"description": "test4 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.012345679104328156,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6937386989593506,
"@search.rerankerBoostedScore": 1.6937386989593506,
"@search.captions": [
{
"text": "test2 hello.",
"highlights": ""
}
],
"id": "2",
"name": "test",
"description": "test2 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.0117647061124444,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6923208236694336,
"@search.rerankerBoostedScore": 1.6923208236694336,
"@search.captions": [
{
"text": "test5 hello.",
"highlights": ""
}
],
"id": "5",
"name": "test",
"description": "test5 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.01666666753590107,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.691611886024475,
"@search.rerankerBoostedScore": 1.691611886024475,
"@search.captions": [
{
"text": "test7 hello.",
"highlights": ""
}
],
"id": "7",
"name": "test",
"description": "test7 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.013698630034923553,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6781420707702637,
"@search.rerankerBoostedScore": 1.6781420707702637,
"@search.captions": [
{
"text": "test0 hello.",
"highlights": ""
}
],
"id": "0",
"name": "test",
"description": "test0 hello",
"category": "purple",
"ownerId": "benny"
},
{
"@search.score": 0.013888888992369175,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6653810739517212,
"@search.rerankerBoostedScore": 1.6653810739517212,
"@search.captions": [
{
"text": "test8 hello.",
"highlights": ""
}
],
"id": "8",
"name": "test",
"description": "test8 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.012658228166401386,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6618363857269287,
"@search.rerankerBoostedScore": 1.6618363857269287,
"@search.captions": [
{
"text": "test11 hello.",
"highlights": ""
}
],
"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": ""
}
],
"id": "10",
"name": "test",
"description": "test10 hello",
"category": "purple",
"ownerId": "benny"
},
{
"@search.score": 0.012820512987673283,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7079174518585205,
"@search.rerankerBoostedScore": 1.7079174518585205,
"@search.captions": [
{
"text": "no vector.",
"highlights": "</em>no vector.</em>"
}
],
"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.7079174518585205,
"@search.rerankerBoostedScore": 1.7079174518585205,
"@search.captions": [
{
"text": "no vector.",
"highlights": "</em>no vector.</em>"
}
],
"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.6994102001190186,
"@search.rerankerBoostedScore": 1.6994102001190186,
"@search.captions": [
{
"text": "test4 hello.",
"highlights": ""
}
],
"id": "4",
"name": "test",
"description": "test4 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.012345679104328156,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6937386989593506,
"@search.rerankerBoostedScore": 1.6937386989593506,
"@search.captions": [
{
"text": "test2 hello.",
"highlights": ""
}
],
"id": "2",
"name": "test",
"description": "test2 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.0117647061124444,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6923208236694336,
"@search.rerankerBoostedScore": 1.6923208236694336,
"@search.captions": [
{
"text": "test5 hello.",
"highlights": ""
}
],
"id": "5",
"name": "test",
"description": "test5 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.01666666753590107,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.691611886024475,
"@search.rerankerBoostedScore": 1.691611886024475,
"@search.captions": [
{
"text": "test7 hello.",
"highlights": ""
}
],
"id": "7",
"name": "test",
"description": "test7 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.013698630034923553,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6781420707702637,
"@search.rerankerBoostedScore": 1.6781420707702637,
"@search.captions": [
{
"text": "test0 hello.",
"highlights": ""
}
],
"id": "0",
"name": "test",
"description": "test0 hello",
"category": "purple",
"ownerId": "benny"
},
{
"@search.score": 0.013888888992369175,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6653810739517212,
"@search.rerankerBoostedScore": 1.6653810739517212,
"@search.captions": [
{
"text": "test8 hello.",
"highlights": ""
}
],
"id": "8",
"name": "test",
"description": "test8 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.012658228166401386,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6618363857269287,
"@search.rerankerBoostedScore": 1.6618363857269287,
"@search.captions": [
{
"text": "This is a caption from the document.",
"highlights": "This is a <em>caption</em> from the document."
}
],
"id": "11",
"name": "test",
"description": "test11 hello",
"category": "purple",
"ownerId": "sam"
}
]
}
SearchIndexSearchDocumentsSemanticPost
Ukázkový požadavek
POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2026-04-01
{
"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=2026-04-01"
}
{
"@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=2026-04-01"
}
Definice
| Name | Description |
|---|---|
| Accept |
Hlavička Accept. |
|
Document |
Obsahuje informace o ladění, které lze použít k dalšímu zkoumání výsledků hledání. |
|
Error |
Další informace o chybě správy 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.) |
|
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 |
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 |
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. |
|
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 |
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í.") |
Accept
Hlavička Accept.
| Hodnota | Description |
|---|---|
| application/json;odata.metadata=none |
DocumentDebugInfo
Obsahuje informace o ladění, které lze použít k dalšímu zkoumání výsledků hledání.
| Name | Typ | Description |
|---|---|---|
| vectors |
Obsahuje informace o ladění specifické pro vektorové a hybridní vyhledávání. |
ErrorAdditionalInfo
Další informace o chybě správy 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. |
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í. |
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 |
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.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í. |
|
| 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 <>. |
| 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í. |
| 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. |
|
| 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. |
| 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. |
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. |
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í. |
| 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. |
| 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í. |
| 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. |
| 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í. |
| 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. |
| text |
string |
Text, který má být vektorizován k 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. |
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í. |
| 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. |
| 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. |