Documents - Search Post

Služba:

Search Service

Verze rozhraní API:

2025-09-01

Vyhledá dokumenty v rejstříku.

POST {endpoint}/indexes('{indexName}')/docs/search.post.search?api-version=2025-09-01

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string	Adresa URL koncového bodu vyhledávací služby.
indexName	path	True	string	Název indexu.
api-version	query	True	string	Verze rozhraní API klienta.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
x-ms-client-request-id		string (uuid)	ID sledování odeslané s požadavkem na pomoc s laděním.

Text požadavku

Name	Typ	Description
answers	QueryAnswerType	Hodnota, která určuje, zda mají být odpovědi vráceny jako součást odpovědi na hledání.
captions	QueryCaptionType	Hodnota, která určuje, zda mají být titulky vráceny jako součást odpovědi hledání.
count	boolean	Hodnota, která určuje, zda se má načíst celkový počet výsledků. Výchozí hodnota je False. Nastavení této hodnoty na hodnotu true může mít vliv na výkon. Všimněte si, že vrácený počet je přibližný.
debug	QueryDebugMode	Aktivuje ladicí nástroj, který lze použít k dalšímu prozkoumání vašich znovu seřazených výsledků.
facets	string[]	Seznam výrazů omezujících vlastností, které se mají použít na vyhledávací dotaz. Každý fasetový výraz obsahuje název pole, volitelně následovaný čárkami odděleným seznamem párů název:hodnota.
filter	string	Výraz OData $filter, který se má použít na vyhledávací dotaz.
highlight	string	Čárkami oddělený seznam názvů polí, která se mají použít pro zvýraznění požadavků na server. Ke zvýraznění požadavků na server lze použít pouze prohledávatelná pole.
highlightPostTag	string	Značka řetězce, která je připojena ke zvýraznění polí. Musí být nastaveno pomocí highlightPreTag. Výchozí hodnota je </em>.
highlightPreTag	string	Značka řetězce, která je předřazena tak, aby dosáhla na světla. Musí být nastaveno pomocí highlightPostTag. Výchozí je <em>.
minimumCoverage	number (double)	Číslo mezi 0 a 100 označující procento indexu, které musí být pokryto vyhledávacím dotazem, aby byl dotaz vykázán jako úspěšný. Tento parametr může být užitečný pro zajištění dostupnosti vyhledávání i pro služby s pouze jednou replikou. Výchozí hodnota je 100.
orderby	string	Seznam OData oddělených čárkami $orderby výrazy, podle kterých se mají výsledky seřadit. Každý výraz může být buď názvem pole, nebo voláním funkcí geo.distance() nebo search.score(). Za každým výrazem může následovat asc pro označení vzestupného výrazu nebo desc pro označení sestupného. Výchozí je vzestupné pořadí. Nerozhodné výsledky budou přerušeny skóre shody v dokumentech. Pokud není zadána žádná $orderby, výchozí pořadí řazení je sestupné podle skóre shody dokumentu. Může existovat maximálně 32 $orderby klauzulí.
queryType	QueryType	Hodnota, která určuje syntaxi vyhledávacího dotazu. Výchozí hodnota je 'simple'. Pokud dotaz používá syntaxi dotazu Lucene, použijte hodnotu "full".
scoringParameters	string[]	Seznam hodnot parametrů, které se mají použít při bodovacích funkcích (například referencePointParameter) pomocí formátu name-values. Pokud například profil bodování definuje funkci s parametrem s názvem "mylocation", řetězec parametru by byl "mylocation--122.2,44.8" (bez uvozovek).
scoringProfile	string	Název profilu hodnocení pro vyhodnocení skóre shody pro odpovídající dokumenty za účelem seřazení výsledků.
scoringStatistics	ScoringStatistics	Hodnota, která určuje, zda chceme vypočítat statistiky bodování (například frekvenci dokumentů) globálně pro konzistentnější bodování, nebo místně pro nižší latenci. Výchozí je 'local'. Pomocí výrazu "globální" můžete před vyhodnocením globálně agregovat statistiky hodnocení. Použití globálních statistik bodování může zvýšit latenci vyhledávacích dotazů.
search	string	Výraz fulltextového vyhledávacího dotazu; Použijte "*" nebo tento parametr vynechejte, aby se vyhledaly všechny dokumenty.
searchFields	string	Čárkami oddělený seznam názvů polí, na které se má fulltextové vyhledávání zaměřit. Při použití hledání v poli (fieldName:searchExpression) v úplném dotazu Lucene mají názvy polí každého vyhledávacího výrazu v poli přednost před názvy polí uvedenými v tomto parametru.
searchMode	SearchMode	Hodnota, která určuje, zda se musí shodovat některé nebo všechny hledané výrazy, aby se dokument započítal jako shoda.
select	string	Seznam polí oddělených čárkami, která se mají načíst. Pokud není zadaný, zahrnou se všechna pole označená ve schématu jako zobrazitelná.
semanticConfiguration	string	Název sémantické konfigurace, která bude použita při zpracování dokumentů pro dotazy typu sémantika.
semanticErrorHandling	SemanticErrorMode	Umožňuje uživateli zvolit, zda má sémantické volání zcela selhat (výchozí/aktuální chování), nebo vrátit částečné výsledky.
semanticMaxWaitInMilliseconds	integer (int32) minimum: 700	Umožňuje uživateli nastavit horní mez doby, kterou trvá dokončení zpracování sémantického obohacení, než se požadavek nezdaří.
semanticQuery	string	Umožňuje nastavit samostatný vyhledávací dotaz, který se bude používat výhradně pro sémantické přeřazení, sémantické titulky a sémantické odpovědi. Je užitečná pro scénáře, kdy je potřeba použít různé dotazy mezi fází základního načítání a hodnocení a sémantickou fází L2.
sessionId	string	Hodnota, která má být použita k vytvoření relace vždy navždy navždy a která může pomoci dosáhnout konzistentnějších výsledků. Pokud se používá stejné ID relace, bude proveden pokus s maximálním úsilím o cílení na stejnou sadu replik. Mějte na paměti, že opakované použití stejných hodnot sessionID může narušit vyrovnávání zatížení požadavků napříč replikami a nepříznivě ovlivnit výkon vyhledávací služby. Hodnota použitá jako sessionId nemůže začínat znakem '_'.
skip	integer (int32)	Počet výsledků hledání, které chcete přeskočit. Tato hodnota nesmí být větší než 100 000. Pokud potřebujete skenovat dokumenty v sekvenci, ale kvůli tomuto omezení nemůžete použít funkci přeskočit, zvažte použití orderby u zcela uspořádaného klíče a místo toho filtrujte pomocí dotazu na rozsah.
top	integer (int32)	Počet výsledků hledání, které se mají načíst. To lze použít ve spojení s $skip k implementaci stránkování výsledků vyhledávání na straně klienta. Pokud jsou výsledky zkráceny z důvodu stránkování na straně serveru, bude odpověď obsahovat token pro pokračování, který lze použít k vydání dalšího požadavku na vyhledávání pro další stránku výsledků.
vectorFilterMode	VectorFilterMode	Určuje, zda se filtry aplikují před nebo po vektorovém vyhledávání. Výchozí je 'preFilter' pro nové indexy.
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	Parametry dotazu pro vektorové a hybridní vyhledávací dotazy.

Odpovědi

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

Příklady

SearchIndexSearchDocumentsPost

SearchIndexSearchDocumentsSemanticPost

SearchIndexSearchDocumentsPost

Ukázkový požadavek

HTTP

POST https://stableexampleservice.search.windows.net/indexes('stable-test')/docs/search.post.search?api-version=2025-09-01


{
  "count": true,
  "facets": [
    "ownerId"
  ],
  "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",
      "exhaustive": true,
      "weight": 1
    }
  ],
  "vectorFilterMode": "preFilter"
}

Ukázková odpověď

Stavový kód:

200

{
  "@odata.count": 42,
  "@search.coverage": 100,
  "@search.facets": {
    "ownerId": [
      {
        "count": 26,
        "value": "sam"
      },
      {
        "count": 12,
        "value": "ryan"
      },
      {
        "count": 4,
        "value": "benny"
      }
    ]
  },
  "@search.answers": [],
  "value": [
    {
      "@search.score": 0.04419642686843872,
      "@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": 1.3862943649291992
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00011109876504633576,
                  "vectorSimilarity": 94.86833055544514
                },
                "vector1b": {
                  "searchScore": 0.0002499375259503722,
                  "vectorSimilarity": 63.24555189615253
                }
              }
            ]
          }
        }
      },
      "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>"
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 1.0779930353164673
            },
            "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.7079174518585205,
      "@search.rerankerBoostedScore": 1.7079174518585205,
      "@search.captions": [
        {
          "text": "no vector.",
          "highlights": "</em>no vector.</em>"
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 0.3250378668308258
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "no-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.0431547611951828,
      "@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": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00017358097829855978,
                  "vectorSimilarity": 75.89466323761327
                },
                "vector1b": {
                  "searchScore": 0.0005099439295008779,
                  "vectorSimilarity": 44.27188622909418
                }
              }
            ]
          }
        }
      },
      "id": "4",
      "name": "test",
      "description": "test4 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04460374265909195,
      "@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": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00020656888955272734,
                  "vectorSimilarity": 69.5701087211589
                },
                "vector1b": {
                  "searchScore": 0.0006939625018276274,
                  "vectorSimilarity": 37.947332584023194
                }
              }
            ]
          }
        }
      },
      "id": "2",
      "name": "test",
      "description": "test2 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.042533937841653824,
      "@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": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00015997439913917333,
                  "vectorSimilarity": 79.0569427290381
                },
                "vector1b": {
                  "searchScore": 0.0004442470089998096,
                  "vectorSimilarity": 47.43416449302081
                }
              }
            ]
          }
        }
      },
      "id": "5",
      "name": "test",
      "description": "test5 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04651741310954094,
      "@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": 1.9616584777832031
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00013715539535041898,
                  "vectorSimilarity": 85.38149735825786
                },
                "vector1b": {
                  "searchScore": 0.00034590106224641204,
                  "vectorSimilarity": 53.758721003860366
                }
              }
            ]
          }
        }
      },
      "id": "7",
      "name": "test",
      "description": "test7 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04703196510672569,
      "@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": 1.0779930353164673
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.0002499375259503722,
                  "vectorSimilarity": 63.24555189615253
                },
                "vector1b": {
                  "searchScore": 0.0009990009712055326,
                  "vectorSimilarity": 31.622777042048124
                }
              }
            ]
          }
        }
      },
      "id": "0",
      "name": "test",
      "description": "test0 hello",
      "category": "purple",
      "ownerId": "benny"
    },
    {
      "@search.score": 0.043300654739141464,
      "@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": 1.1507283449172974
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00012753476039506495,
                  "vectorSimilarity": 88.5437719937623
                },
                "vector1b": {
                  "searchScore": 0.0003085467324126512,
                  "vectorSimilarity": 56.92099902893652
                }
              }
            ]
          }
        }
      },
      "id": "8",
      "name": "test",
      "description": "test8 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04082724079489708,
      "@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": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00010404744534753263,
                  "vectorSimilarity": 98.03060760075451
                },
                "vector1b": {
                  "searchScore": 0.00022670596081297845,
                  "vectorSimilarity": 66.40783109116562
                }
              }
            ]
          }
        }
      },
      "id": "11",
      "name": "test",
      "description": "test11 hello",
      "category": "purple",
      "ownerId": "sam"
    }
  ]
}

Stavový kód:

206

{
  "@odata.count": 42,
  "@search.coverage": 100,
  "@search.facets": {
    "ownerId": [
      {
        "count": 26,
        "value": "sam"
      },
      {
        "count": 12,
        "value": "ryan"
      },
      {
        "count": 4,
        "value": "benny"
      }
    ]
  },
  "@search.answers": [],
  "value": [
    {
      "@search.score": 0.04419642686843872,
      "@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": 1.3862943649291992
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00011109876504633576,
                  "vectorSimilarity": 94.86833055544514
                },
                "vector1b": {
                  "searchScore": 0.0002499375259503722,
                  "vectorSimilarity": 63.24555189615253
                }
              }
            ]
          }
        }
      },
      "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>"
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 1.0779930353164673
            },
            "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.7079174518585205,
      "@search.rerankerBoostedScore": 1.7079174518585205,
      "@search.captions": [
        {
          "text": "no vector.",
          "highlights": "</em>no vector.</em>"
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 0.3250378668308258
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "no-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.0431547611951828,
      "@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": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00017358097829855978,
                  "vectorSimilarity": 75.89466323761327
                },
                "vector1b": {
                  "searchScore": 0.0005099439295008779,
                  "vectorSimilarity": 44.27188622909418
                }
              }
            ]
          }
        }
      },
      "id": "4",
      "name": "test",
      "description": "test4 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04460374265909195,
      "@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": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00020656888955272734,
                  "vectorSimilarity": 69.5701087211589
                },
                "vector1b": {
                  "searchScore": 0.0006939625018276274,
                  "vectorSimilarity": 37.947332584023194
                }
              }
            ]
          }
        }
      },
      "id": "2",
      "name": "test",
      "description": "test2 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.042533937841653824,
      "@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": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00015997439913917333,
                  "vectorSimilarity": 79.0569427290381
                },
                "vector1b": {
                  "searchScore": 0.0004442470089998096,
                  "vectorSimilarity": 47.43416449302081
                }
              }
            ]
          }
        }
      },
      "id": "5",
      "name": "test",
      "description": "test5 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04651741310954094,
      "@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": 1.9616584777832031
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00013715539535041898,
                  "vectorSimilarity": 85.38149735825786
                },
                "vector1b": {
                  "searchScore": 0.00034590106224641204,
                  "vectorSimilarity": 53.758721003860366
                }
              }
            ]
          }
        }
      },
      "id": "7",
      "name": "test",
      "description": "test7 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04703196510672569,
      "@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": 1.0779930353164673
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.0002499375259503722,
                  "vectorSimilarity": 63.24555189615253
                },
                "vector1b": {
                  "searchScore": 0.0009990009712055326,
                  "vectorSimilarity": 31.622777042048124
                }
              }
            ]
          }
        }
      },
      "id": "0",
      "name": "test",
      "description": "test0 hello",
      "category": "purple",
      "ownerId": "benny"
    },
    {
      "@search.score": 0.043300654739141464,
      "@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": 1.1507283449172974
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00012753476039506495,
                  "vectorSimilarity": 88.5437719937623
                },
                "vector1b": {
                  "searchScore": 0.0003085467324126512,
                  "vectorSimilarity": 56.92099902893652
                }
              }
            ]
          }
        }
      },
      "id": "8",
      "name": "test",
      "description": "test8 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04082724079489708,
      "@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": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00010404744534753263,
                  "vectorSimilarity": 98.03060760075451
                },
                "vector1b": {
                  "searchScore": 0.00022670596081297845,
                  "vectorSimilarity": 66.40783109116562
                }
              }
            ]
          }
        }
      },
      "id": "11",
      "name": "test",
      "description": "test11 hello",
      "category": "purple",
      "ownerId": "sam"
    }
  ]
}

SearchIndexSearchDocumentsSemanticPost

Ukázkový požadavek

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2025-09-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ěď

Stavový kód:

200

{
  "@odata.count": 25,
  "@search.answers": [
    {
      "key": "4123",
      "text": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form where air is ascending (over land in this case),   but not where it is descending (over the river).",
      "highlights": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form<em> where air is ascending</em> (over land in this case),   but not where it is<em> descending</em> (over the river).",
      "score": 0.94639826
    }
  ],
  "@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=2024-07-01"
}

Stavový kód:

206

{
  "@odata.count": 25,
  "@search.answers": [
    {
      "key": "4123",
      "text": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form where air is ascending (over land in this case),   but not where it is descending (over the river).",
      "highlights": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form<em> where air is ascending</em> (over land in this case),   but not where it is<em> descending</em> (over the river).",
      "score": 0.94639826
    }
  ],
  "@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=2024-07-01"
}

Definice

Name	Description
AnswerResult	Odpověď je textová pasáž extrahovaná z obsahu nejrelevantnějších dokumentů, které odpovídají dotazu. Odpovědi jsou extrahovány z horních výsledků vyhledávání. Kandidáti odpovědí jsou bodováni a jsou vybrány nejlepší odpovědi.
CaptionResult	Titulky jsou nejreprezentativnější pasáže z dokumentu ve vztahu k vyhledávacímu dotazu. Často se používají jako souhrn dokumentu. Popisky jsou vráceny pouze pro dotazy typu semantic.
DocumentDebugInfo	Obsahuje informace o ladění, které lze použít k dalšímu prozkoumání výsledků hledání.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
QueryAnswerType	Hodnota, která určuje, zda mají být odpovědi vráceny jako součást odpovědi na hledání.
QueryCaptionType	Hodnota, která určuje, zda mají být titulky vráceny jako součást odpovědi hledání.
QueryDebugMode	Povolí ladicí nástroj, který lze použít k dalšímu prozkoumání výsledků hledání.
QueryResultDocumentSubscores	Rozpis dílčích skóre mezi komponentami textového a vektorového dotazu vyhledávacího dotazu pro tento dokument. Každý vektorový dotaz je zobrazen jako samostatný objekt ve stejném pořadí, v jakém byl přijat.
QueryType	Určuje syntaxi vyhledávacího dotazu. Výchozí hodnota je 'simple'. Pokud dotaz používá syntaxi dotazu Lucene, použijte hodnotu "full".
RawVectorQuery	Parametry dotazu, které se mají použít pro vektorové vyhledávání, pokud je zadána nezpracovaná vektorová hodnota.
ScoringStatistics	Hodnota, která určuje, zda chceme vypočítat statistiky bodování (například frekvenci dokumentů) globálně pro konzistentnější bodování, nebo místně pro nižší latenci. Výchozí je 'local'. Pomocí výrazu "globální" můžete před vyhodnocením globálně agregovat statistiky hodnocení. Použití globálních statistik bodování může zvýšit latenci vyhledávacích dotazů.
SearchDocumentsResult	Odpověď obsahující výsledky hledání z indexu.
SearchMode	Určuje, zda musí být některé nebo všechny hledané výrazy shodné, aby se dokument započítal jako shodný.
SearchRequest	Parametry pro filtrování, řazení, omezující vlastnosti, stránkování a další chování vyhledávacích dotazů.
SearchResult	Obsahuje dokument nalezený vyhledávacím dotazem a přidružená metadata.
SemanticErrorMode	Umožňuje uživateli zvolit, zda má sémantické volání zcela selhat (výchozí/aktuální chování), nebo vrátit částečné výsledky.
SemanticErrorReason	Důvod, proč byla vrácena částečná odpověď na žádost o sémantické řazení.
SemanticSearchResultsType	Typ částečné odpovědi, která byla vrácena pro požadavek na sémantické řazení.
SingleVectorFieldResult	Výsledek z jednoho vektorového pole. Vrátí @search.score se hodnoty podobnosti obou i vektorů. Vektorová podobnost je spojena s @search.score rovnicí.
TextResult	Skóre BM25 nebo Classic pro textovou část dotazu.
VectorFilterMode	Určuje, zda se filtry aplikují před nebo po vektorovém vyhledávání.
VectorizableTextQuery	Parametry dotazu, které se mají použít pro vektorové vyhledávání, když je zadána textová hodnota, kterou je třeba vektorizovat.
VectorQueryKind	Druh prováděného vektorového dotazu.
VectorsDebugInfo

AnswerResult

Objekt

Odpověď je textová pasáž extrahovaná z obsahu nejrelevantnějších dokumentů, které odpovídají dotazu. Odpovědi jsou extrahovány z horních výsledků vyhledávání. Kandidáti odpovědí jsou bodováni a jsou vybrány nejlepší odpovědi.

Name	Typ	Description
highlights	string	Stejná pasáž textu jako ve vlastnosti Text se zvýrazněnými textovými frázemi, které jsou pro dotaz nejrelevantnější.
key	string	Klíč dokumentu, ze kterého byla odpověď extrahována.
score	number (double)	Hodnota skóre vyjadřuje, jak relevantní je odpověď na dotaz ve vztahu k ostatním odpovědím vráceným pro dotaz.
text	string	Pasáž textu extrahovaná z obsahu dokumentu jako odpověď.

CaptionResult

Objekt

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

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

DocumentDebugInfo

Objekt

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

Name	Typ	Description
vectors	VectorsDebugInfo	Obsahuje informace o ladění specifické pro vektorové a hybridní vyhledávání.

ErrorAdditionalInfo

Objekt

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

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

ErrorDetail

Objekt

Podrobnosti o chybě.

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

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

QueryAnswerType

Výčet

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

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

QueryCaptionType

Výčet

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

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

QueryDebugMode

Výčet

Povolí ladicí nástroj, který lze použít k dalšímu prozkoumání výsledků hledání.

Hodnota	Description
disabled	Nebudou vráceny žádné informace o ladění dotazu.
vector	Umožňuje uživateli dále prozkoumat výsledky hybridních a vektorových dotazů.

QueryResultDocumentSubscores

Objekt

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

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

QueryType

Výčet

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

Hodnota	Description
simple	Pro vyhledávání používá jednoduchou syntaxi dotazu. Hledaný text je interpretován pomocí jednoduchého dotazovacího jazyka, který umožňuje symboly jako +, * a "". Dotazy jsou ve výchozím nastavení vyhodnocovány ve všech prohledávatelných polích, pokud není zadán parametr searchFields.
full	Pro vyhledávání používá úplnou syntaxi dotazu Lucene. Hledaný text je interpretován pomocí dotazovacího jazyka Lucene, který umožňuje vyhledávání specifické pro dané pole a vážené a další pokročilé funkce.
semantic	Nejvhodnější pro dotazy vyjádřené v přirozeném jazyce na rozdíl od klíčových slov. Zlepšuje přesnost výsledků vyhledávání změnou pořadí nejlepších výsledků vyhledávání pomocí modelu hodnocení natrénovaného na webovém korpusu.

RawVectorQuery

Objekt

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

Name	Typ	Description
exhaustive	boolean	Je-li true, spustí vyčerpávající hledání k-nejbližších sousedů ve všech vektorech v indexu vektoru. Užitečné pro scénáře, kde jsou přesné shody kritické, jako je například určení základních pravdivostních hodnot.
fields	string	Vektorová pole typu Collection(Edm.Single), která mají být zahrnuta do prohledávaného vektoru.
k	integer (int32)	Počet nejbližších sousedů, kteří se vrátí jako nejvyšší hity.
kind	string: vector	Druh prováděného vektorového dotazu.
oversampling	number (double)	Faktor převzorkování. Minimální hodnota je 1. Přepíše parametr defaultOversampling nakonfigurovaný v definici indexu. Lze ji nastavit pouze v případě, že je parametr 'rerankWithOriginalVectors' pravdivý. Tento parametr je povolen pouze v případě, že je pro podkladové vektorové pole použita metoda komprese.
vector	number[] (float)	Vektorová reprezentace vyhledávacího dotazu.
weight	number (float)	Relativní váha vektorového dotazu ve srovnání s jiným vektorovým dotazem a/nebo textovým dotazem v rámci stejného vyhledávacího požadavku. Tato hodnota se používá při kombinování výsledků více žebříčků vytvořených různými vektorovými dotazy a/nebo výsledků načtených prostřednictvím textového dotazu. Čím vyšší je váha, tím vyšší budou dokumenty, které odpovídaly danému dotazu, v konečném pořadí. Výchozí hodnota je 1.0 a hodnota musí být kladné číslo větší než nula.

ScoringStatistics

Výčet

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

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

SearchDocumentsResult

Objekt

Odpověď obsahující výsledky hledání z indexu.

Name	Typ	Description
@odata.count	integer (int64)	Celkový počet výsledků nalezených operací vyhledávání nebo null, pokud počet nebyl požadován. Pokud je k dispozici, může být počet větší než počet výsledků v této odpovědi. K tomu může dojít, pokud použijete parametry $top nebo $skip nebo pokud dotaz nemůže vrátit všechny požadované dokumenty v jedné odpovědi.
@odata.nextLink	string	Adresa URL pro pokračování se vrátí, když dotaz nemůže vrátit všechny požadované výsledky v jedné odpovědi. Tuto adresu URL můžete použít k formulaci dalšího požadavku GET nebo POST Search, abyste získali další část odpovědi na vyhledávání. Ujistěte se, že používáte stejné sloveso (GET nebo POST) jako požadavek, který vytvořil tuto odpověď.
@search.answers	AnswerResult[]	Výsledky dotazu answers pro operaci vyhledávání. null, pokud parametr dotazu answers nebyl zadán nebo nastaven na hodnotu 'none'.
@search.coverage	number (double)	Hodnota označující procento indexu, který byl zahrnut do dotazu, nebo null, pokud v požadavku nebylo uvedeno minimumCoverage.
@search.facets	object	Výsledky dotazu omezující vlastnosti pro operaci vyhledávání, uspořádané jako kolekce kbelíků pro každé omezující pole. null, pokud dotaz neobsahoval žádné výrazy omezující vlastnosti.
@search.nextPageParameters	SearchRequest	Datová část JSON pro pokračování se vrátí, když dotaz nemůže vrátit všechny požadované výsledky v jedné odpovědi. Tento kód JSON můžete použít spolu s @odata.nextLink k formulaci dalšího požadavku POST Search, abyste získali další část odpovědi na vyhledávání.
@search.semanticPartialResponseReason	SemanticErrorReason	Důvod, proč byla vrácena částečná odpověď na žádost o sémantické řazení.
@search.semanticPartialResponseType	SemanticSearchResultsType	Typ částečné odpovědi, která byla vrácena pro požadavek na sémantické řazení.
value	SearchResult[]	Posloupnost výsledků vrácených dotazem.

SearchMode

Výčet

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

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

SearchRequest

Objekt

Parametry pro filtrování, řazení, omezující vlastnosti, stránkování a další chování vyhledávacích dotazů.

Name	Typ	Description
answers	QueryAnswerType	Hodnota, která určuje, zda mají být odpovědi vráceny jako součást odpovědi na hledání.
captions	QueryCaptionType	Hodnota, která určuje, zda mají být titulky vráceny jako součást odpovědi hledání.
count	boolean	Hodnota, která určuje, zda se má načíst celkový počet výsledků. Výchozí hodnota je False. Nastavení této hodnoty na hodnotu true může mít vliv na výkon. Všimněte si, že vrácený počet je přibližný.
debug	QueryDebugMode	Aktivuje ladicí nástroj, který lze použít k dalšímu prozkoumání vašich znovu seřazených výsledků.
facets	string[]	Seznam výrazů omezujících vlastností, které se mají použít na vyhledávací dotaz. Každý fasetový výraz obsahuje název pole, volitelně následovaný čárkami odděleným seznamem párů název:hodnota.
filter	string	Výraz OData $filter, který se má použít na vyhledávací dotaz.
highlight	string	Čárkami oddělený seznam názvů polí, která se mají použít pro zvýraznění požadavků na server. Ke zvýraznění požadavků na server lze použít pouze prohledávatelná pole.
highlightPostTag	string	Značka řetězce, která je připojena ke zvýraznění polí. Musí být nastaveno pomocí highlightPreTag. Výchozí hodnota je </em>.
highlightPreTag	string	Značka řetězce, která je předřazena tak, aby dosáhla na světla. Musí být nastaveno pomocí highlightPostTag. Výchozí je <em>.
minimumCoverage	number (double)	Číslo mezi 0 a 100 označující procento indexu, které musí být pokryto vyhledávacím dotazem, aby byl dotaz vykázán jako úspěšný. Tento parametr může být užitečný pro zajištění dostupnosti vyhledávání i pro služby s pouze jednou replikou. Výchozí hodnota je 100.
orderby	string	Seznam OData oddělených čárkami $orderby výrazy, podle kterých se mají výsledky seřadit. Každý výraz může být buď názvem pole, nebo voláním funkcí geo.distance() nebo search.score(). Za každým výrazem může následovat asc pro označení vzestupného výrazu nebo desc pro označení sestupného. Výchozí je vzestupné pořadí. Nerozhodné výsledky budou přerušeny skóre shody v dokumentech. Pokud není zadána žádná $orderby, výchozí pořadí řazení je sestupné podle skóre shody dokumentu. Může existovat maximálně 32 $orderby klauzulí.
queryType	QueryType	Hodnota, která určuje syntaxi vyhledávacího dotazu. Výchozí hodnota je 'simple'. Pokud dotaz používá syntaxi dotazu Lucene, použijte hodnotu "full".
scoringParameters	string[]	Seznam hodnot parametrů, které se mají použít při bodovacích funkcích (například referencePointParameter) pomocí formátu name-values. Pokud například profil bodování definuje funkci s parametrem s názvem "mylocation", řetězec parametru by byl "mylocation--122.2,44.8" (bez uvozovek).
scoringProfile	string	Název profilu hodnocení pro vyhodnocení skóre shody pro odpovídající dokumenty za účelem seřazení výsledků.
scoringStatistics	ScoringStatistics	Hodnota, která určuje, zda chceme vypočítat statistiky bodování (například frekvenci dokumentů) globálně pro konzistentnější bodování, nebo místně pro nižší latenci. Výchozí je 'local'. Pomocí výrazu "globální" můžete před vyhodnocením globálně agregovat statistiky hodnocení. Použití globálních statistik bodování může zvýšit latenci vyhledávacích dotazů.
search	string	Výraz fulltextového vyhledávacího dotazu; Použijte "*" nebo tento parametr vynechejte, aby se vyhledaly všechny dokumenty.
searchFields	string	Čárkami oddělený seznam názvů polí, na které se má fulltextové vyhledávání zaměřit. Při použití hledání v poli (fieldName:searchExpression) v úplném dotazu Lucene mají názvy polí každého vyhledávacího výrazu v poli přednost před názvy polí uvedenými v tomto parametru.
searchMode	SearchMode	Hodnota, která určuje, zda se musí shodovat některé nebo všechny hledané výrazy, aby se dokument započítal jako shoda.
select	string	Seznam polí oddělených čárkami, která se mají načíst. Pokud není zadaný, zahrnou se všechna pole označená ve schématu jako zobrazitelná.
semanticConfiguration	string	Název sémantické konfigurace, která bude použita při zpracování dokumentů pro dotazy typu sémantika.
semanticErrorHandling	SemanticErrorMode	Umožňuje uživateli zvolit, zda má sémantické volání zcela selhat (výchozí/aktuální chování), nebo vrátit částečné výsledky.
semanticMaxWaitInMilliseconds	integer (int32) minimum: 700	Umožňuje uživateli nastavit horní mez doby, kterou trvá dokončení zpracování sémantického obohacení, než se požadavek nezdaří.
semanticQuery	string	Umožňuje nastavit samostatný vyhledávací dotaz, který se bude používat výhradně pro sémantické přeřazení, sémantické titulky a sémantické odpovědi. Je užitečná pro scénáře, kdy je potřeba použít různé dotazy mezi fází základního načítání a hodnocení a sémantickou fází L2.
sessionId	string	Hodnota, která má být použita k vytvoření relace vždy navždy navždy a která může pomoci dosáhnout konzistentnějších výsledků. Pokud se používá stejné ID relace, bude proveden pokus s maximálním úsilím o cílení na stejnou sadu replik. Mějte na paměti, že opakované použití stejných hodnot sessionID může narušit vyrovnávání zatížení požadavků napříč replikami a nepříznivě ovlivnit výkon vyhledávací služby. Hodnota použitá jako sessionId nemůže začínat znakem '_'.
skip	integer (int32)	Počet výsledků hledání, které chcete přeskočit. Tato hodnota nesmí být větší než 100 000. Pokud potřebujete skenovat dokumenty v sekvenci, ale kvůli tomuto omezení nemůžete použít funkci přeskočit, zvažte použití orderby u zcela uspořádaného klíče a místo toho filtrujte pomocí dotazu na rozsah.
top	integer (int32)	Počet výsledků hledání, které se mají načíst. To lze použít ve spojení s $skip k implementaci stránkování výsledků vyhledávání na straně klienta. Pokud jsou výsledky zkráceny z důvodu stránkování na straně serveru, bude odpověď obsahovat token pro pokračování, který lze použít k vydání dalšího požadavku na vyhledávání pro další stránku výsledků.
vectorFilterMode	VectorFilterMode	Určuje, zda se filtry aplikují před nebo po vektorovém vyhledávání. Výchozí je 'preFilter' pro nové indexy.
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	Parametry dotazu pro vektorové a hybridní vyhledávací dotazy.

SearchResult

Objekt

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

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

SemanticErrorMode

Výčet

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

Hodnota	Description
partial	Pokud se sémantické zpracování nezdaří, částečné výsledky se stále vrátí. Definice dílčích výsledků závisí na tom, jaký sémantický krok selhal a jaký byl důvod selhání.
fail	Pokud během kroku sémantického zpracování dojde k výjimce, dotaz selže a vrátí příslušný kód HTTP v závislosti na chybě.

SemanticErrorReason

Výčet

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

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

SemanticSearchResultsType

Výčet

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

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

SingleVectorFieldResult

Objekt

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

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

TextResult

Objekt

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

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

VectorFilterMode

Výčet

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

Hodnota	Description
postFilter	Filtr se použije po vrácení kandidátské sady vektorových výsledků. V závislosti na selektivitě filtru to může vést k menšímu počtu výsledků, než požaduje parametr 'k'.
preFilter	Filtr bude aplikován před vyhledávacím dotazem.

VectorizableTextQuery

Objekt

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

Name	Typ	Description
exhaustive	boolean	Je-li true, spustí vyčerpávající hledání k-nejbližších sousedů ve všech vektorech v indexu vektoru. Užitečné pro scénáře, kde jsou přesné shody kritické, jako je například určení základních pravdivostních hodnot.
fields	string	Vektorová pole typu Collection(Edm.Single), která mají být zahrnuta do prohledávaného vektoru.
k	integer (int32)	Počet nejbližších sousedů, kteří se vrátí jako nejvyšší hity.
kind	string: text	Druh prováděného vektorového dotazu.
oversampling	number (double)	Faktor převzorkování. Minimální hodnota je 1. Přepíše parametr defaultOversampling nakonfigurovaný v definici indexu. Lze ji nastavit pouze v případě, že je parametr 'rerankWithOriginalVectors' pravdivý. Tento parametr je povolen pouze v případě, že je pro podkladové vektorové pole použita metoda komprese.
text	string	Text, který má být vektorizován za účelem provedení vektorového vyhledávacího dotazu.
weight	number (float)	Relativní váha vektorového dotazu ve srovnání s jiným vektorovým dotazem a/nebo textovým dotazem v rámci stejného vyhledávacího požadavku. Tato hodnota se používá při kombinování výsledků více žebříčků vytvořených různými vektorovými dotazy a/nebo výsledků načtených prostřednictvím textového dotazu. Čím vyšší je váha, tím vyšší budou dokumenty, které odpovídaly danému dotazu, v konečném pořadí. Výchozí hodnota je 1.0 a hodnota musí být kladné číslo větší než nula.

VectorQueryKind

Výčet

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

Hodnota	Description
vector	Vektorový dotaz, kde je zadána nezpracovaná vektorová hodnota.
text	Vektorový dotaz, kde je zadána textová hodnota, kterou je třeba vektorizovat.

VectorsDebugInfo

Objekt

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