Documents - Suggest Get

Reference

Služba:: Search Service

Verze rozhraní API:: 2024-07-01

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

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

S volitelnými parametry:

GET {endpoint}/indexes('{indexName}')/docs/search.suggest?search={search}&suggesterName={suggesterName}&$filter={$filter}&fuzzy={fuzzy}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&$orderby={$orderby}&searchFields={searchFields}&$select={$select}&$top={$top}&api-version=2024-07-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.
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 považované za 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, do výsledků se zahrne jenom pole klíče.
$top	query		integer int32	Počet návrhů, které se mají načíst. Hodnota musí být číslo od 1 do 100. Výchozí hodnota je 5.
fuzzy	query		boolean	Hodnota označující, jestli se má použít přibližná shoda pro dotaz návrhy. Výchozí hodnota je false. Pokud je nastavená hodnota true, dotaz najde termíny i v případě, že je ve hledaném textu nahrazený nebo chybějící znak. I když to poskytuje lepší prostředí v některých scénářích, přináší náklady na výkon, protože dotazy na návrhy přibližných shod jsou pomalejší a spotřebovávají více prostředků.
highlightPostTag	query		string	Značka řetězce, která se připojí k zvýraznění. Je nutné nastavit zvýrazněníPreTag. Pokud tento parametr vynecháte, je zvýraznění návrhů zakázané.
highlightPreTag	query		string	Značka řetězce, která je předem zvýrazněná. Musí být nastavena značka highlightPostTag. Pokud tento parametr vynecháte, je zvýraznění návrhů zakázané.
minimumCoverage	query		number double	Číslo mezi 0 a 100 označující procento indexu, které musí být pokryto dotazem návrhů, 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 80.
searchFields	query		string[]	Seznam názvů polí, které chcete vyhledat zadaný hledaný text. Cílová pole musí být zahrnuta v zadaném sugestivním nástroji.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
x-ms-client-request-id		string uuid	ID sledování odeslané s požadavkem, které vám pomůže s laděním.

Odpovědi

Name	Typ	Description
200 OK	SuggestDocumentsResult	Odpověď obsahující navrhované dokumenty, které odpovídají částečnému vstupu.
Other Status Codes	ErrorResponse	Chybová odpověď.

Příklady

SearchIndexSuggestDocumentsGet

Ukázkový požadavek

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs/search.suggest?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&api-version=2024-07-01

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
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
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.

ErrorAdditionalInfo

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

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

ErrorDetail

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

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

SuggestDocumentsResult

Odpověď obsahující výsledky návrhového dotazu z indexu

Name	Typ	Description
@search.coverage	number	Hodnota označující procento indexu zahrnutého v dotazu nebo hodnotu null, pokud v požadavku nebyla nastavena minimální konfigurace.
value	SuggestResult[]	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

Sdílet prostřednictvím