Documents - Suggest Get
Navrhne dokumenty v indexu, které odpovídají danému částečnému textu dotazu.
GET {endpoint}/indexes('{indexName}')/docs/search.suggest?api-version=2026-05-01-preview&search={search}&suggesterName={suggesterName}GET {endpoint}/indexes('{indexName}')/docs/search.suggest?api-version=2026-05-01-preview&search={search}&suggesterName={suggesterName}&$filter={$filter}&fuzzy={fuzzy}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&$orderby={$orderby}&searchFields={searchFields}&$select={$select}&$top={$top}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. |
|
search
|
query | True |
string |
Hledaný text, který se má použít k návrhu dokumentů. Musí mít alespoň 1 znak a nesmí být delší než 100 znaků. |
|
suggester
|
query | True |
string |
Název navrhujícího, jak je uvedeno v kolekci pro návrhy, která je součástí definice indexu. |
|
$filter
|
query |
string |
Výraz OData, který filtruje dokumenty zvažované pro návrhy. |
|
|
$orderby
|
query |
string[] |
Seznam výrazů $orderby OData, podle kterých se mají výsledky seřadit. Každý výraz může být buď název pole, nebo volání funkce geo.distance() nebo search.score(). Za každým výrazem může následovat asc, který označuje vzestupně, 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í. |
|
|
$select
|
query |
string[] |
Seznam polí, která se mají načíst. Pokud není zadáno, bude do výsledků zahrnuto pouze klíčové pole. |
|
|
$top
|
query |
integer (int32) |
Počet návrhů k načtení. Hodnota musí být číslo mezi 1 a 100. Výchozí hodnota je 5. |
|
|
fuzzy
|
query |
boolean |
Hodnota označující, zda se má použít přibližná shoda pro dotaz na návrhy. Výchozí hodnota je nastavená na false. Pokud je nastavená hodnota true, dotaz najde výrazy i v případě, že ve vyhledávaném textu je nahrazený nebo chybějící znak. I když to v některých scénářích poskytuje lepší prostředí, přichází to za cenu výkonu, protože dotazy přibližných návrhů jsou pomalejší a spotřebovávají více prostředků. |
|
|
highlight
|
query |
string |
Značka řetězce, která se připojí k zvýraznění. Je nutné nastavit zvýrazněníPreTag. Pokud je vynechán, zvýraznění návrhů je zakázáno. |
|
|
highlight
|
query |
string |
Značka řetězce, která je předem zvýrazněná. Musí být nastavena značka highlightPostTag. Pokud je vynechán, zvýraznění návrhů je zakázáno. |
|
|
minimum
|
query |
number (double) |
Číslo mezi 0 a 100 označující procento indexu, které musí být pokryto dotazem na návrhy, aby byl dotaz hlášen 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 80. |
|
|
search
|
query |
string[] |
Seznam názvů polí pro vyhledání zadaného hledaného textu. Cílová pole musí být zahrnuta v určeném modulu pro návrhy. |
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. |
Odpovědi
| Name | Typ | Description |
|---|---|---|
| 200 OK |
Požadavek byl ú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
SearchIndexSuggestDocumentsGet
Ukázkový požadavek
GET https://myservice.search.windows.net/indexes('myindex')/docs/search.suggest?api-version=2026-05-01-preview&search=hote&suggesterName=sg&$filter=rating gt 10&fuzzy=False&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&$orderby=search.score() desc,rating desc&searchFields=title&$select=docId,title,description&$top=10
Ukázková odpověď
{
"value": [
{
"@search.text": "Nice <em>Hotel</em>",
"description": "Cheapest hotel in town",
"docId": "1",
"title": "Nice Hotel"
},
{
"@search.text": "Fancy <em>Hotel</em>",
"description": "Best hotel in town",
"docId": "2",
"title": "Fancy Hotel"
}
]
}Definice
| Name | Description |
|---|---|
| Accept |
Hlavička Accept. |
|
Error |
Další informace o chybě při správě prostředků |
|
Error |
Podrobnosti o chybě. |
|
Error |
Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.) |
|
Suggest |
Odpověď obsahující výsledky návrhového dotazu z indexu |
|
Suggest |
Výsledek obsahující dokument nalezený dotazem návrhu a přidruženými metadaty. |
Accept
Hlavička Accept.
| Hodnota | Description |
|---|---|
| application/json;odata.metadata=none |
ErrorAdditionalInfo
Další informace o chybě při správě prostředků
| Name | Typ | Description |
|---|---|---|
| info |
Další informace. |
|
| type |
string |
Další typ informací. |
ErrorDetail
Podrobnosti o chybě.
| Name | Typ | Description |
|---|---|---|
| additionalInfo |
Další informace o chybě. |
|
| code |
string |
Kód chyby. |
| details |
Podrobnosti o chybě. |
|
| message |
string |
Chybová zpráva. |
| target |
string |
Cíl chyby. |
ErrorResponse
Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)
| Name | Typ | Description |
|---|---|---|
| error |
Objekt chyby. |
SuggestDocumentsResult
Odpověď obsahující výsledky návrhového dotazu z indexu
| Name | Typ | Description |
|---|---|---|
| @search.coverage |
number (double) |
Hodnota označující procento indexu, který byl zahrnut do dotazu, nebo null, pokud v požadavku nebylo nastaveno minimumCoverage. |
| value |
Posloupnost výsledků vrácených dotazem. |
SuggestResult
Výsledek obsahující dokument nalezený dotazem návrhu a přidruženými metadaty.
| Name | Typ | Description |
|---|---|---|
| @search.text |
string |
Text výsledku návrhu. |