Documents - Suggest Get

Reference

Služba:: Search Service

Verze rozhraní API:: 2024-05-01-preview

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

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

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-05-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.
search	query	True	string	Hledaný text, který se má použít k návrhu dokumentů. Musí obsahovat alespoň 1 znak a nesmí být delší než 100 znaků.
suggesterName	query	True	string	Název navrhovatele zadaný v kolekci navrhovatelů, která je součástí definice indexu.
$filter	query		string	Výraz OData, který filtruje zvažovaný dokument pro návrhy.
$orderby	query		string[]	Seznam OData $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 výraz desc, který označuje sestupně. Výchozí hodnota je vzestupné pořadí. Vazby se přeruší skóre shody dokumentů. Pokud není zadána žádná $orderby, je výchozí pořadí řazení 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 pole s klíčem.
$top	query		integer int32	Počet návrhů, které se mají načíst. Hodnota musí být číslo mezi 1 a 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ávrhů. Výchozí hodnota je false. Pokud je nastavená hodnota true, dotaz vyhledá termíny i v případě, že hledaný text obsahuje nahrazený nebo chybějící znak. I když to v některých scénářích poskytuje lepší prostředí, má to náklady na výkon, 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á se připojí ke zvýraznění přístupů. Musí být nastaven pomocí highlightPreTag. Pokud ho vynecháte, možnost zvýrazňování návrhů je zakázaná.
highlightPreTag	query		string	Značka řetězce, která je předpřipená k dosažení zvýraznění. Musí být nastavený s highlightPostTag. Pokud ho vynecháte, možnost zvýrazňování návrhů je 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, které mají jenom jednu repliku. 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 zahrnutá v zadaném navrhovateli.

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.

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-05-01-preview

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ý návrhovým dotazem a přidružená metadata.

ErrorAdditionalInfo

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

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

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, které bylo zahrnuto do dotazu, nebo hodnotu null, pokud v požadavku nebyla nastavena hodnota minimumCoverage.
value	SuggestResult[]	Posloupnost výsledků vrácených dotazem

SuggestResult

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

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

Sdílet prostřednictvím