Documents - Suggest Post

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.

POST {endpoint}/indexes('{indexName}')/docs/search.post.suggest?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.

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.

Text požadavku

Name	Vyžadováno	Typ	Description
search	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	True	string	Název navrhujícího, jak je uvedeno v kolekci pro návrhy, která je součástí definice indexu.
filter		string	Výraz OData, který filtruje dokumenty považované za návrhy.
fuzzy		boolean	Hodnota označující, jestli se má použít přibližná shoda pro návrhový dotaz. 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ějící znak. I když to poskytuje lepší prostředí v některých scénářích, má náklady na výkon, protože vyhledávání návrhů přibližných návrhů je pomalejší a spotřebovává více prostředků.
highlightPostTag		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		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		number	Číslo v rozsahu 0 až 100 označující procento indexu, na které se musí vztahuje návrhový dotaz, 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.
orderby		string	Čárkami oddělený seznam výrazů OData $orderby, 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í.
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 sugestivním nástroji.
select		string	Seznam polí oddělených čárkami, která se mají načíst. Pokud není zadáno, do výsledků se zahrne jenom pole klíče.
top		integer	Počet návrhů, které se mají načíst. Musí to být hodnota 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	ErrorResponse	Chybová odpověď.

Příklady

SearchIndexSuggestDocumentsPost

Ukázkový požadavek

HTTP

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

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 považované za návrhy.
fuzzy	boolean	Hodnota označující, jestli se má použít přibližná shoda pro návrhový dotaz. 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ějící znak. I když to poskytuje lepší prostředí v některých scénářích, má náklady na výkon, protože vyhledávání návrhů přibližných návrhů je pomalejší a spotřebovává více prostředků.
highlightPostTag	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	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	number	Číslo v rozsahu 0 až 100 označující procento indexu, na které se musí vztahuje návrhový dotaz, 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.
orderby	string	Čárkami oddělený seznam výrazů OData $orderby, 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í.
search	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ů.
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 sugestivním nástroji.
select	string	Seznam polí oddělených čárkami, která se mají načíst. Pokud není zadáno, do výsledků se zahrne jenom pole klíče.
suggesterName	string	Název navrhujícího, jak je uvedeno v kolekci pro návrhy, která je součástí definice indexu.
top	integer	Počet návrhů, které se mají načíst. Musí to být hodnota mezi 1 a 100. Výchozí hodnota je 5.

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