Documents - Suggest Post

Služba:: Search Service

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

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

POST {endpoint}/indexes('{indexName}')/docs/search.post.suggest?api-version=2025-08-01-preview

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 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 ne více než 100 znaků.
suggesterName	True	string	Název modulu pro návrhy, jak je uvedeno v kolekci pro návrhy
filter		string	Výraz OData, který filtruje dokumenty zvažované pro návrhy.
fuzzy		boolean	Hodnota označující, zda se má pro dotaz návrhu použít přibližná shoda. Výchozí hodnota je False. Pokud je nastavená hodnota true, dotaz najde návrhy 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í, je to za cenu nákladů na výkon, protože vyhledávání přibližných návrhů je pomalejší a spotřebovává více prostředků.
highlightPostTag		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		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		number (double)	Číslo mezi 0 a 100 označující procento indexu, které musí být pokryto dotazem na návrh, 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.
orderby		string	Seznam OData oddělených čá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 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í.
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 určeném modulu pro návrhy.
select		string	Seznam polí oddělených čárkami, která se mají načíst. Pokud není zadáno, bude do výsledků zahrnuto pouze klíčové pole.
top		integer (int32)	Počet návrhů k načtení. 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://previewexampleservice.search.windows.net/indexes('preview-test')/docs/search.post.suggest?api-version=2025-08-01-preview


{
  "filter": "ownerId eq 'sam' and id lt '15'",
  "fuzzy": true,
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": 80,
  "orderby": "id desc",
  "search": "p",
  "searchFields": "category",
  "select": "id,name,category,ownerId",
  "suggesterName": "sg",
  "top": 10
}

Ukázková odpověď

Stavový kód:: 200

{
  "@search.coverage": 100,
  "value": [
    {
      "@search.text": "<em>pu</em>rple",
      "id": "14",
      "name": "test",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.text": "<em>pu</em>rple",
      "id": "13",
      "name": "test",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.text": "<em>pu</em>rple",
      "id": "11",
      "name": "test",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.text": "<em>pu</em>rple",
      "id": "1",
      "name": "test",
      "category": "purple",
      "ownerId": "sam"
    }
  ]
}

Definice

Name	Description
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
SuggestDocumentsResult	Odpověď obsahující dotaz na návrh je výsledkem 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 na návrh a přidružená metadata.

ErrorAdditionalInfo

Objekt

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

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

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

SuggestDocumentsResult

Objekt

Odpověď obsahující dotaz na návrh je výsledkem 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.

SuggestRequest

Objekt

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 zvažované pro návrhy.
fuzzy	boolean	Hodnota označující, zda se má pro dotaz návrhu použít přibližná shoda. Výchozí hodnota je False. Pokud je nastavená hodnota true, dotaz najde návrhy 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í, je to za cenu nákladů na výkon, protože vyhledávání přibližných návrhů je pomalejší a spotřebovává více prostředků.
highlightPostTag	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	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	number (double)	Číslo mezi 0 a 100 označující procento indexu, které musí být pokryto dotazem na návrh, 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.
orderby	string	Seznam OData oddělených čá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 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í.
search	string	Hledaný text, který se má použít k navrhování dokumentů. Musí mít alespoň 1 znak a ne více 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 určeném modulu pro návrhy.
select	string	Seznam polí oddělených čárkami, která se mají načíst. Pokud není zadáno, bude do výsledků zahrnuto pouze klíčové pole.
suggesterName	string	Název modulu pro návrhy, jak je uvedeno v kolekci pro návrhy
top	integer (int32)	Počet návrhů k načtení. Musí to být hodnota mezi 1 a 100. Výchozí hodnota je 5.

SuggestResult

Objekt

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

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