Documents - Suggest Post

Reference

Služba:: Search Service

Verze rozhraní API:: 2023-11-01

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

POST {endpoint}/indexes('{indexName}')/docs/search.post.suggest?api-version=2023-11-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é spolu s požadavkem na pomoc s laděním.

Text požadavku

Name	Vyžadováno	Typ	Description
search	True	string	Hledaný text, který se má použít k navrhování dokumentů. Musí mít alespoň 1 znak a nesmí být delší než 100 znaků.
suggesterName	True	string	Název návrhu zadaný v kolekci návrhy, která je součástí definice indexu.
filter		string	Výraz OData, který filtruje dokumenty, které se považují za návrhy.
fuzzy		boolean	Hodnota označující, jestli se má pro návrhový dotaz použít přibližné párování. Výchozí hodnota je false. Pokud je nastavená hodnota true, dotaz najde návrhy i v případě, že je ve hledaném textu nahrazený nebo chybí znak. I když to v některých scénářích poskytuje lepší prostředí, má to náklady na výkon, protože vyhledávání přibližných návrhů je pomalejší a spotřebovávají více prostředků.
highlightPostTag		string	Značka řetězce, která je připojena k dosažení zvýraznění. Musí být nastaven pomocí highlightPreTag. Pokud ho vynecháte, je zvýraznění návrhů zakázané.
highlightPreTag		string	Značka řetězce, která je předem připravená k dosažení zvýraznění. Musí být nastaven pomocí highlightPostTag. Pokud ho vynecháte, je zvýraznění návrhů zakázané.
minimumCoverage		number	Číslo mezi 0 a 100 označující procento indexu, které musí být pokryto návrhový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, které mají jenom jednu repliku. Výchozí hodnota je 80.
orderby		string	Seznam OData oddělený čá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, který označuje vzestupně, nebo desc pro označení sestupně. Výchozí hodnota je vzestupné pořadí. Vazby budou přerušeny skóre shody dokumentů. 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í.
searchFields		string	Seznam názvů polí oddělených čárkami pro vyhledání zadaného hledaného textu. Cílová pole musí být zahrnuta v zadaném návrhu.
select		string	Seznam polí oddělených čárkami, která se mají načíst. Pokud není zadáno, bude do výsledků zahrnuto pouze pole s klíčem.
top		integer	Počet návrhů, které se mají načíst. Musí se jednat o hodnotu mezi 1 a 100. Výchozí hodnota je 5.

Odpovědi

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

Příklady

SearchIndexSuggestDocumentsPost

Ukázkový požadavek

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.suggest?api-version=2023-11-01

{
  "filter": "rating gt 4.0",
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": 80,
  "orderby": "rating desc",
  "search": "hote",
  "searchFields": "title",
  "select": "docId,title,description",
  "suggesterName": "sg",
  "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
SearchError	Popisuje chybový stav rozhraní API.
SuggestDocumentsResult	Odpověď obsahující výsledky návrhu dotazu z indexu
SuggestRequest	Parametry pro filtrování, řazení, přibližné porovnávání a další návrhy chování dotazů.
SuggestResult	Výsledek obsahující dokument nalezený dotazem návrhu a přidružená metadata.

SearchError

Popisuje chybový stav rozhraní API.

Name	Typ	Description
code	string	Jeden ze serverem definované sady kódů chyb.
details	SearchError[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
message	string	Lidsky čitelná reprezentace chyby.

SuggestDocumentsResult

Odpověď obsahující výsledky návrhu dotazu z indexu

Name	Typ	Description
@search.coverage	number	Hodnota označující procento indexu zahrnutého v dotazu nebo hodnotu null, pokud nebyla v požadavku nastavena hodnota minimumCoverage.
value	SuggestResult[]	Posloupnost výsledků vrácených dotazem

SuggestRequest

Parametry pro filtrování, řazení, přibližné porovnávání a další návrhy chování dotazů.

Name	Typ	Description
filter	string	Výraz OData, který filtruje dokumenty, které se považují za návrhy.
fuzzy	boolean	Hodnota označující, jestli se má pro návrhový dotaz použít přibližné párování. Výchozí hodnota je false. Pokud je nastavená hodnota true, dotaz najde návrhy i v případě, že je ve hledaném textu nahrazený nebo chybí znak. I když to v některých scénářích poskytuje lepší prostředí, má to náklady na výkon, protože vyhledávání přibližných návrhů je pomalejší a spotřebovávají více prostředků.
highlightPostTag	string	Značka řetězce, která je připojena k dosažení zvýraznění. Musí být nastaven pomocí highlightPreTag. Pokud ho vynecháte, je zvýraznění návrhů zakázané.
highlightPreTag	string	Značka řetězce, která je předem připravená k dosažení zvýraznění. Musí být nastaven pomocí highlightPostTag. Pokud ho vynecháte, je zvýraznění návrhů zakázané.
minimumCoverage	number	Číslo mezi 0 a 100 označující procento indexu, které musí být pokryto návrhový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, které mají jenom jednu repliku. Výchozí hodnota je 80.
orderby	string	Seznam OData oddělený čá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, který označuje vzestupně, nebo desc pro označení sestupně. Výchozí hodnota je vzestupné pořadí. Vazby budou přerušeny skóre shody dokumentů. 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í.
search	string	Hledaný text, který se má použít k navrhování dokumentů. Musí mít alespoň 1 znak a nesmí být delší než 100 znaků.
searchFields	string	Seznam názvů polí oddělených čárkami pro vyhledání zadaného hledaného textu. Cílová pole musí být zahrnuta v zadaném návrhu.
select	string	Seznam polí oddělených čárkami, která se mají načíst. Pokud není zadáno, bude do výsledků zahrnuto pouze pole s klíčem.
suggesterName	string	Název návrhu zadaný v kolekci návrhy, která je součástí definice indexu.
top	integer	Počet návrhů, které se mají načíst. Musí se jednat o hodnotu mezi 1 a 100. Výchozí hodnota je 5.

SuggestResult

Výsledek obsahující dokument nalezený dotazem návrhu a přidružená metadata.

Name	Typ	Description
@search.text	string	Text výsledku návrhu

Sdílet prostřednictvím