Time Series Instances - Suggest

Service:

Time Series Insights

Version d'API:

2020-07-31

Suggère des mots clés basés sur les attributs d’instance de série chronologique à utiliser ultérieurement dans les instances de recherche.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
environmentFqdn	path	True	string	Par nom de domaine complet d’environnement, par exemple 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Vous pouvez obtenir ce nom de domaine à partir de la réponse de l’API Get Environments, du portail Azure ou d’Azure Resource Manager.
api-version	query	True	string	Version de l’API à utiliser avec la demande cliente. La version actuellement prise en charge est « 2020-07-31 ».

En-tête de la demande

Nom	Obligatoire	Type	Description
x-ms-client-request-id		string	ID de demande client facultatif. Le service enregistre cette valeur. Permet au service de suivre l’opération entre les services et permet au client de contacter le support technique concernant une demande particulière.
x-ms-client-session-id		string	ID de session client facultatif. Le service enregistre cette valeur. Permet au service de suivre un groupe d’opérations connexes entre les services et permet au client de contacter le support technique concernant un groupe particulier de demandes.

Corps de la demande

Nom	Obligatoire	Type	Description
searchString	True	string	Chaîne de recherche pour laquelle des suggestions sont requises. Vide est autorisé, mais pas null.
take		integer (int32)	Nombre maximal de suggestions attendues dans le résultat. La valeur par défaut est 10 lorsqu’elle n’est pas définie.

Réponses

Nom	Type	Description
200 OK	InstancesSuggestResponse	Opération réussie. En-têtes x-ms-request-id: string
Other Status Codes	TsiError	Erreur inattendue. En-têtes x-ms-request-id: string

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

InstancesSuggest

Exemple de requête

HTTP

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

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

Exemple de réponse

Code d’état:

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

Définitions

Nom	Description
InstancesSearchStringSuggestion	Chaîne de recherche suggérée à utiliser pour rechercher davantage d’instances de série chronologique.
InstancesSuggestRequest	Demande d’obtenir des suggestions de chaîne de recherche pour la recherche d’instances de série chronologique en fonction du texte de préfixe.
InstancesSuggestResponse	Réponse d’obtention de suggestions pour la recherche d’instances de série chronologique.
TsiError	Informations sur une erreur d’API.
TsiErrorBody	Erreur d’API particulière avec un code d’erreur et un message.
TsiErrorDetails	Informations d’erreur supplémentaires.

InstancesSearchStringSuggestion

Object

Chaîne de recherche suggérée à utiliser pour rechercher davantage d’instances de série chronologique.

Nom	Type	Description
highlightedSearchString	string	Mise en surbrillance de la chaîne de recherche suggérée à afficher à l’utilisateur. Mise en surbrillance des insertions et balises dans les parties du texte correspondant à la chaîne de recherche. N’utilisez pas la chaîne de recherche mise en surbrillance pour effectuer d’autres appels de recherche.
searchString	string	Chaîne de recherche suggérée. Peut être utilisé pour rechercher davantage d’instances de série chronologique.

InstancesSuggestRequest

Object

Demande d’obtenir des suggestions de chaîne de recherche pour la recherche d’instances de série chronologique en fonction du texte de préfixe.

Nom	Type	Description
searchString	string	Chaîne de recherche pour laquelle des suggestions sont requises. Vide est autorisé, mais pas null.
take	integer (int32)	Nombre maximal de suggestions attendues dans le résultat. La valeur par défaut est 10 lorsqu’elle n’est pas définie.

InstancesSuggestResponse

Object

Réponse d’obtention de suggestions pour la recherche d’instances de série chronologique.

Nom	Type	Description
suggestions	InstancesSearchStringSuggestion[]	Liste des suggestions d’instance pour la recherche de modèles de série chronologique.

TsiError

Object

Informations sur une erreur d’API.

Nom	Type	Description
error	TsiErrorBody	Erreur d’API particulière avec un code d’erreur et un message.

TsiErrorBody

Object

Erreur d’API particulière avec un code d’erreur et un message.

Nom	Type	Description
code	string	Chaîne lisible par la langue qui définit un code d’erreur spécifique au service. Ce code sert d’indicateur plus spécifique pour le code d’erreur HTTP spécifié dans la réponse. Peut être utilisé pour gérer par programmation des cas d’erreur spécifiques.
details	TsiErrorDetails[]	Contient des informations d’erreur supplémentaires. Peut être null.
innerError	TsiErrorBody	Contient une erreur plus spécifique qui limite la cause. Peut être null.
message	string	Représentation accessible en lecture humaine et indépendante du langage de l’erreur. Il est destiné à aider les développeurs et n’est pas adapté à l’exposition aux utilisateurs finaux.
target	string	Cible de l’erreur particulière (par exemple, le nom de la propriété en erreur). Peut être null.

TsiErrorDetails

Object

Informations d’erreur supplémentaires.

Nom	Type	Description
code	string	Chaîne lisible par la langue qui définit un code d’erreur spécifique au service. Ce code sert d’indicateur plus spécifique pour le code d’erreur HTTP spécifié dans la réponse. Peut être utilisé pour gérer par programmation des cas d’erreur spécifiques.
message	string	Représentation accessible en lecture humaine et indépendante du langage de l’erreur. Il est destiné à aider les développeurs et n’est pas adapté à l’exposition aux utilisateurs finaux.