Time Series Instances - Suggest

Service:

Time Series Insights

API Version:

2020-07-31

Kulcsszavakat javasol a keresési példányokban később használni kívánt idősorpéldány-attribútumok alapján.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
environmentFqdn	path	True	string	Környezeti teljes tartománynévként, például 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Ezt a tartománynevet a Get Environments API, a Azure Portal vagy az Azure Resource Manager válaszából szerezheti be.
api-version	query	True	string	Az ügyfélkéréshez használni kívánt API verziója. Jelenleg a "2020-07-31" támogatott verzió.

Kérelem fejléce

Name	Kötelező	Típus	Description
x-ms-client-request-id		string	Nem kötelező ügyfélkérés azonosítója. A szolgáltatás ezt az értéket rögzíti. Lehetővé teszi, hogy a szolgáltatás nyomon kövesse a műveletet a szolgáltatások között, és lehetővé teszi, hogy az ügyfél kapcsolatba lépjen az ügyfélszolgálattal egy adott kéréssel kapcsolatban.
x-ms-client-session-id		string	Nem kötelező ügyfélmunkamenet-azonosító. A szolgáltatás ezt az értéket rögzíti. Lehetővé teszi, hogy a szolgáltatás nyomon kövesse a kapcsolódó műveletek egy csoportját a szolgáltatások között, és lehetővé teszi, hogy az ügyfél kapcsolatba lépjen az ügyfélszolgálattal egy adott kéréscsoporttal kapcsolatban.

Kérelem törzse

Name	Kötelező	Típus	Description
searchString	True	string	Keresési sztring, amelyhez javaslatok szükségesek. Az üres érték megengedett, de null érték nem.
take		integer	Az eredményben várt javaslatok maximális száma. Alapértelmezés szerint 10, ha nincs beállítva.

Válaszok

Name	Típus	Description
200 OK	InstancesSuggestResponse	Sikeres művelet. Headers x-ms-request-id: string
Other Status Codes	TsiError	Váratlan hiba. Headers x-ms-request-id: string

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

InstancesSuggest

Sample Request

HTTP

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

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

Sample Response

Status code:

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"
    }
  ]
}

Definíciók

Name	Description
InstancesSearchStringSuggestion	Javasolt keresési sztring az idősorpéldányok további kereséséhez.
InstancesSuggestRequest	Kérés a keresési sztringjavaslatok lekérésére az idősorpéldányok előtagszöveg alapján történő kereséséhez.
InstancesSuggestResponse	Válasz az idősorpéldányok keresésére vonatkozó javaslatokra.
TsiError	Api-hibával kapcsolatos információk.
TsiErrorBody	Egy adott API-hiba hibakóddal és üzenettel.
TsiErrorDetails	További hibainformációk.

InstancesSearchStringSuggestion

Javasolt keresési sztring az idősorpéldányok további kereséséhez.

Name	Típus	Description
highlightedSearchString	string	Kiemelt javasolt keresési sztring, amelyet a felhasználó megjeleníthet. Beszúrások és címkék kiemelése a keresési sztringnek megfelelő szövegrészekben. Ne használjon kiemelt keresési sztringet további keresési hívásokhoz.
searchString	string	Javasolt keresési sztring. Az idősorpéldányok további kereséséhez használható.

InstancesSuggestRequest

Kérés a keresési sztringjavaslatok lekérésére az idősorpéldányok előtagszöveg alapján történő kereséséhez.

Name	Típus	Description
searchString	string	Keresési sztring, amelyhez javaslatok szükségesek. Az üres érték megengedett, de null érték nem.
take	integer	Az eredményben várt javaslatok maximális száma. Alapértelmezés szerint 10, ha nincs beállítva.

InstancesSuggestResponse

Válasz az idősorpéldányok keresésére vonatkozó javaslatokra.

Name	Típus	Description
suggestions	InstancesSearchStringSuggestion[]	Az idősormodellek keresésére vonatkozó példányjavaslatok listája.

TsiError

Api-hibával kapcsolatos információk.

Name	Típus	Description
error	TsiErrorBody	Egy adott API-hiba hibakóddal és üzenettel.

TsiErrorBody

Egy adott API-hiba hibakóddal és üzenettel.

Name	Típus	Description
code	string	Nyelvfüggetlen, emberi olvasásra alkalmas sztring, amely szolgáltatásspecifikus hibakódot definiál. Ez a kód a válaszban megadott HTTP-hibakód pontosabb jelzőjeként szolgál. Adott hibaesetek programozott kezelésére használható.
details	TsiErrorDetails[]	További hibainformációkat tartalmaz. Lehet, hogy null értékű.
innerError	TsiErrorBody	Pontosabb hibát tartalmaz, amely szűkíti az okot. Lehet, hogy null értékű.
message	string	A hiba ember által olvasható, nyelvfüggetlen ábrázolása. A fejlesztőknek szánt támogatás, és nem alkalmas a végfelhasználóknak való kitettségre.
target	string	Az adott hiba célja (például a hiba tulajdonságának neve). Lehet, hogy null értékű.

TsiErrorDetails

További hibainformációk.

Name	Típus	Description
code	string	Nyelvfüggetlen, emberi olvasásra alkalmas sztring, amely szolgáltatásspecifikus hibakódot definiál. Ez a kód a válaszban megadott HTTP-hibakód pontosabb jelzőjeként szolgál. Adott hibaesetek programozott kezelésére használható.
message	string	A hiba ember által olvasható, nyelvfüggetlen ábrázolása. A fejlesztőknek szánt támogatás, és nem alkalmas a végfelhasználóknak való kitettségre.