Time Series Instances - Suggest

Služba:

Time Series Insights

Verze rozhraní API:

2020-07-31

Navrhuje klíčová slova na základě atributů instance časové řady, které se později použijí v instancích vyhledávání.

POST https://{environmentFqdn}/timeseries/instances/suggest?api-version=2020-07-31

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
environmentFqdn	path	True	string	Plně kvalifikovaný název domény prostředí, například 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Tento název domény můžete získat z odpovědi rozhraní API pro získání prostředí, Azure Portal nebo azure Resource Manager.
api-version	query	True	string	Verze rozhraní API, která se má použít s požadavkem klienta. Aktuálně podporovaná verze je 2020-07-31.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
x-ms-client-request-id		string	Volitelné ID požadavku klienta Služba tuto hodnotu zaznamená. Umožňuje službě trasovat operace napříč službami a umožňuje zákazníkovi kontaktovat podporu ohledně konkrétního požadavku.
x-ms-client-session-id		string	Volitelné ID relace klienta. Služba tuto hodnotu zaznamená. Umožňuje službě trasovat skupinu souvisejících operací napříč službami a umožňuje zákazníkovi kontaktovat podporu ohledně konkrétní skupiny žádostí.

Text požadavku

Name	Vyžadováno	Typ	Description
searchString	True	string	Hledaný řetězec, pro který se vyžadují návrhy. Prázdné je povoleno, ale není null.
take		integer	Maximální počet návrhů očekávaných ve výsledku Výchozí hodnota je 10, pokud není nastavená.

Odpovědi

Name	Typ	Description
200 OK	InstancesSuggestResponse	Operace byla úspěšná. Hlavičky x-ms-request-id: string
Other Status Codes	TsiError	Neočekávaná chyba. Hlavičky x-ms-request-id: string

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

InstancesSuggest

Ukázkový požadavek

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances/suggest?api-version=2020-07-31

{
  "searchString": "flo",
  "take": 3
}

Ukázková odpověď

Stavový kód:

200

{
  "suggestions": [
    {
      "searchString": "floor 100",
      "highlightedSearchString": "<hit>flo</hit>or 100"
    },
    {
      "searchString": "sensor on floor 0",
      "highlightedSearchString": "sensor on <hit>flo</hit>or 0"
    },
    {
      "searchString": "sensor on floor 1",
      "highlightedSearchString": "sensor on <hit>flo</hit>or 1"
    }
  ]
}

Definice

Name	Description
InstancesSearchStringSuggestion	Navrhovaný hledaný řetězec, který se má použít k dalšímu hledání instancí časových řad.
InstancesSuggestRequest	Žádost o získání návrhů hledaných řetězců pro vyhledávání instancí časové řady na základě textu předpony
InstancesSuggestResponse	Odpověď na získání návrhů pro hledání instancí časové řady
TsiError	Informace o chybě rozhraní API
TsiErrorBody	Konkrétní chyba rozhraní API s kódem chyby a zprávou
TsiErrorDetails	Další informace o chybě.

InstancesSearchStringSuggestion

Navrhovaný hledaný řetězec, který se má použít k dalšímu hledání instancí časových řad.

Name	Typ	Description
highlightedSearchString	string	Zvýrazněný navrhovaný hledaný řetězec, který se má uživateli zobrazit. Zvýrazněním se vloží a značek v částech textu, které odpovídají hledanému řetězci. K dalším voláním hledání nepoužívejte zvýrazněný hledaný řetězec.
searchString	string	Navrhovaný hledaný řetězec Dá se použít k dalšímu hledání instancí časových řad.

InstancesSuggestRequest

Žádost o získání návrhů hledaných řetězců pro vyhledávání instancí časové řady na základě textu předpony

Name	Typ	Description
searchString	string	Hledaný řetězec, pro který se vyžadují návrhy. Prázdné je povoleno, ale není null.
take	integer	Maximální počet návrhů očekávaných ve výsledku Výchozí hodnota je 10, pokud není nastavená.

InstancesSuggestResponse

Odpověď na získání návrhů pro hledání instancí časové řady

Name	Typ	Description
suggestions	InstancesSearchStringSuggestion[]	Seznam návrhů instancí pro vyhledávání modelů časových řad

TsiError

Informace o chybě rozhraní API

Name	Typ	Description
error	TsiErrorBody	Konkrétní chyba rozhraní API s kódem chyby a zprávou

TsiErrorBody

Konkrétní chyba rozhraní API s kódem chyby a zprávou

Name	Typ	Description
code	string	Jazykově nezávislý řetězec čitelný pro člověka, který definuje kód chyby specifické pro službu. Tento kód slouží jako konkrétnější indikátor pro kód chyby HTTP zadaný v odpovědi. Dá se použít ke zpracování konkrétních případů chyb prostřednictvím kódu programu.
details	TsiErrorDetails[]	Obsahuje další informace o chybách. Může mít hodnotu null.
innerError	TsiErrorBody	Obsahuje konkrétnější chybu, která zpřesní příčinu. Může mít hodnotu null.
message	string	Člověkem čitelná reprezentace chyby nezávislá na jazyce. Je určena jako pomoc vývojářům a není vhodná pro vystavení koncovým uživatelům.
target	string	Cíl konkrétní chyby (například název vlastnosti v chybě). Může mít hodnotu null.

TsiErrorDetails

Další informace o chybě.

Name	Typ	Description
code	string	Jazykově nezávislý řetězec čitelný pro člověka, který definuje kód chyby specifické pro službu. Tento kód slouží jako konkrétnější indikátor pro kód chyby HTTP zadaný v odpovědi. Dá se použít ke zpracování konkrétních případů chyb prostřednictvím kódu programu.
message	string	Člověkem čitelná reprezentace chyby nezávislá na jazyce. Je určena jako pomoc vývojářům a není vhodná pro vystavení koncovým uživatelům.