Time Series Instances - Suggest

Tjänst:

Time Series Insights

API-version:

2020-07-31

Föreslår att nyckelord baserat på tidsserieinstansattribut ska användas senare i sökinstanser.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
environmentFqdn	path	True	string	FQDN per miljö, till exempel 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Du kan hämta det här domännamnet från svaret från Get Environments API, Azure Portal eller Azure Resource Manager.
api-version	query	True	string	Version av API:et som ska användas med klientbegäran. Den version som stöds för närvarande är "2020-07-31".

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-request-id		string	Valfritt klientbegärande-ID. Tjänsten registrerar det här värdet. Gör att tjänsten kan spåra åtgärder mellan tjänster och gör att kunden kan kontakta supporten för en viss begäran.
x-ms-client-session-id		string	Valfritt klientsessions-ID. Tjänsten registrerar det här värdet. Gör att tjänsten kan spåra en grupp relaterade åtgärder mellan tjänster och gör det möjligt för kunden att kontakta supporten för en viss grupp med begäranden.

Begärandetext

Name	Obligatorisk	Typ	Description
searchString	True	string	Söksträng för vilka förslag som krävs. Tomt tillåts, men inte null.
take		integer	Maximalt antal förslag som förväntas i resultatet. Standardvärdet är 10 när det inte har angetts.

Svar

Name	Typ	Description
200 OK	InstancesSuggestResponse	Åtgärden lyckades. Sidhuvuden x-ms-request-id: string
Other Status Codes	TsiError	Oväntat fel. Sidhuvuden x-ms-request-id: string

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

InstancesSuggest

Exempelbegäran

HTTP

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

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

Exempelsvar

Statuskod:

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

Definitioner

Name	Description
InstancesSearchStringSuggestion	Föreslagna söksträngar som ska användas för ytterligare sökning efter tidsserieinstanser.
InstancesSuggestRequest	Begär att få förslag på söksträngar för sökning efter tidsserieinstanser baserat på prefixtext.
InstancesSuggestResponse	Svar på att få förslag på sökning efter tidsserieinstanser.
TsiError	Information om ett API-fel.
TsiErrorBody	Ett visst API-fel med en felkod och ett meddelande.
TsiErrorDetails	Ytterligare felinformation.

InstancesSearchStringSuggestion

Föreslagna söksträngar som ska användas för ytterligare sökning efter tidsserieinstanser.

Name	Typ	Description
highlightedSearchString	string	Markerad föreslagen söksträng som ska visas för användaren. Markera infogningar och taggar i de delar av texten som matchade söksträngen. Använd inte markerad söksträng för att utföra ytterligare sökanrop.
searchString	string	Föreslagen söksträng. Kan användas för ytterligare sökning efter tidsserieinstanser.

InstancesSuggestRequest

Begär att få förslag på söksträngar för sökning efter tidsserieinstanser baserat på prefixtext.

Name	Typ	Description
searchString	string	Söksträng för vilka förslag som krävs. Tomt tillåts, men inte null.
take	integer	Maximalt antal förslag som förväntas i resultatet. Standardvärdet är 10 när det inte har angetts.

InstancesSuggestResponse

Svar på att få förslag på sökning efter tidsserieinstanser.

Name	Typ	Description
suggestions	InstancesSearchStringSuggestion[]	Lista över instansförslag för att söka efter tidsseriemodeller.

TsiError

Information om ett API-fel.

Name	Typ	Description
error	TsiErrorBody	Ett visst API-fel med en felkod och ett meddelande.

TsiErrorBody

Ett visst API-fel med en felkod och ett meddelande.

Name	Typ	Description
code	string	Språkoberoende, läsbar sträng som definierar en tjänstspecifik felkod. Den här koden fungerar som en mer specifik indikator för HTTP-felkoden som anges i svaret. Kan användas för att programmatiskt hantera specifika felfall.
details	TsiErrorDetails[]	Innehåller ytterligare felinformation. Kan vara null.
innerError	TsiErrorBody	Innehåller mer specifika fel som begränsar orsaken. Kan vara null.
message	string	Mänsklig läsbar, språkoberoende representation av felet. Det är avsett som ett stöd för utvecklare och är inte lämpligt för exponering för slutanvändare.
target	string	Målet för det specifika felet (till exempel namnet på egenskapen i fel). Kan vara null.

TsiErrorDetails

Ytterligare felinformation.

Name	Typ	Description
code	string	Språkoberoende, läsbar sträng som definierar en tjänstspecifik felkod. Den här koden fungerar som en mer specifik indikator för HTTP-felkoden som anges i svaret. Kan användas för att programmatiskt hantera specifika felfall.
message	string	Mänsklig läsbar, språkoberoende representation av felet. Det är avsett som ett stöd för utvecklare och är inte lämpligt för exponering för slutanvändare.