Documents - Suggest Get

Služba:: Search Service

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

Navrhne dokumenty v indexu, které odpovídají danému částečnému textu dotazu.

GET {endpoint}/indexes('{indexName}')/docs/search.suggest?api-version=2025-11-01-preview&search={search}&suggesterName={suggesterName}

S volitelnými parametry:

GET {endpoint}/indexes('{indexName}')/docs/search.suggest?api-version=2025-11-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.
indexName	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ů.
suggesterName	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ů OData $orderby, podle kterých se mají výsledky seřadit. Každý výraz může být buď názvem pole, nebo voláním funkcí geo.distance() nebo search.score(). Za každým výrazem může následovat asc pro označení vzestupného 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í.
$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 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ů.
highlightPostTag	query		string	Značka řetězce, která je připojena ke zvýraznění polí. Musí být nastaveno pomocí highlightPreTag. Pokud je vynechán, zvýraznění návrhů je zakázáno.
highlightPreTag	query		string	Značka řetězce, která je předřazena tak, aby dosáhla na světla. Musí být nastaveno pomocí highlightPostTag. Pokud je vynechán, zvýraznění návrhů je zakázáno.
minimumCoverage	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 pouze jednou replikou. Výchozí hodnota je 80.
searchFields	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		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	SuggestDocumentsResult	Požadavek byl úspěšný.
Other Status Codes	ErrorResponse	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

HTTP

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

Stavový kód:: 200

{
  "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.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
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.)
SuggestDocumentsResult	Odpověď obsahující výsledky návrhového dotazu z indexu
SuggestResult	Výsledek obsahující dokument nalezený dotazem návrhu a přidruženými metadaty.

Accept

Výčet

Hlavička Accept.

Hodnota	Description
application/json;odata.metadata=none

ErrorAdditionalInfo

Objekt

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

Name	Typ	Description
info		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

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	ErrorDetail	Objekt chyby.

SuggestDocumentsResult

Objekt

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	SuggestResult[]	Posloupnost výsledků vrácených dotazem.

SuggestResult

Objekt

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.