Time Series Instances - Suggest

Service:

Time Series Insights

API Version:

2020-07-31

Sugere palavras-chave com base em atributos de instância de série temporal a serem usados posteriormente em Instâncias de Pesquisa.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
environmentFqdn	path	True	string	Por FQDN de ambiente, por exemplo, 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Você pode obter esse nome de domínio da resposta da API Obter Ambientes, portal do Azure ou Resource Manager do Azure.
api-version	query	True	string	Versão da API a ser usada com a solicitação do cliente. Atualmente, a versão com suporte é "2020-07-31".

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-request-id		string	ID de solicitação de cliente opcional. O serviço registra esse valor. Permite que o serviço rastreie a operação entre os serviços e permite que o cliente entre em contato com o suporte em relação a uma solicitação específica.
x-ms-client-session-id		string	ID opcional da sessão do cliente. O serviço registra esse valor. Permite que o serviço rastreie um grupo de operações relacionadas entre serviços e permite que o cliente entre em contato com o suporte em relação a um grupo específico de solicitações.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
searchString	True	string	Cadeia de caracteres de pesquisa para a qual as sugestões são necessárias. Vazio é permitido, mas não nulo.
take		integer	Número máximo de sugestões esperadas no resultado. O padrão é 10 quando não definido.

Respostas

Nome	Tipo	Description
200 OK	InstancesSuggestResponse	Operação com êxito. Headers x-ms-request-id: string
Other Status Codes	TsiError	Erro inesperado. Headers x-ms-request-id: string

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

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

Definições

Nome	Description
InstancesSearchStringSuggestion	Cadeia de caracteres de pesquisa sugerida a ser usada para pesquisa adicional de instâncias de série temporal.
InstancesSuggestRequest	Solicitação para obter sugestões de cadeia de caracteres de pesquisa para a pesquisa de instâncias de série temporal com base no texto do prefixo.
InstancesSuggestResponse	Resposta de obter sugestões de pesquisa para instâncias de série temporal.
TsiError	Informações sobre um erro de API.
TsiErrorBody	Um erro de API específico com um código de erro e uma mensagem.
TsiErrorDetails	Informações adicionais de erro.

InstancesSearchStringSuggestion

Cadeia de caracteres de pesquisa sugerida a ser usada para pesquisa adicional de instâncias de série temporal.

Nome	Tipo	Description
highlightedSearchString	string	Cadeia de caracteres de pesquisa sugerida realçada a ser exibida para o usuário. Realçando inserções e marcas nas partes do texto que corresponderam à cadeia de caracteres de pesquisa. Não use a cadeia de caracteres de pesquisa realçada para fazer mais chamadas de pesquisa.
searchString	string	Cadeia de caracteres de pesquisa sugerida. Pode ser usado para pesquisa adicional de instâncias de série temporal.

InstancesSuggestRequest

Solicitação para obter sugestões de cadeia de caracteres de pesquisa para a pesquisa de instâncias de série temporal com base no texto do prefixo.

Nome	Tipo	Description
searchString	string	Cadeia de caracteres de pesquisa para a qual as sugestões são necessárias. Vazio é permitido, mas não nulo.
take	integer	Número máximo de sugestões esperadas no resultado. O padrão é 10 quando não definido.

InstancesSuggestResponse

Resposta de obter sugestões de pesquisa para instâncias de série temporal.

Nome	Tipo	Description
suggestions	InstancesSearchStringSuggestion[]	Lista de sugestões de instância para pesquisar modelos de série temporal.

TsiError

Informações sobre um erro de API.

Nome	Tipo	Description
error	TsiErrorBody	Um erro de API específico com um código de erro e uma mensagem.

TsiErrorBody

Um erro de API específico com um código de erro e uma mensagem.

Nome	Tipo	Description
code	string	Cadeia de caracteres legível e independente de linguagem que define um código de erro específico do serviço. Esse código serve como um indicador mais específico para o código de erro HTTP especificado na resposta. Pode ser usado para lidar programaticamente com casos de erro específicos.
details	TsiErrorDetails[]	Contém informações de erro adicionais. Pode ser nulo.
innerError	TsiErrorBody	Contém um erro mais específico que restringe a causa. Pode ser nulo.
message	string	Representação independente de idioma e legível por humanos do erro. Ele se destina como um auxílio aos desenvolvedores e não é adequado para exposição aos usuários finais.
target	string	Destino do erro específico (por exemplo, o nome da propriedade em erro). Pode ser nulo.

TsiErrorDetails

Informações adicionais de erro.

Nome	Tipo	Description
code	string	Cadeia de caracteres legível e independente de linguagem que define um código de erro específico do serviço. Esse código serve como um indicador mais específico para o código de erro HTTP especificado na resposta. Pode ser usado para lidar programaticamente com casos de erro específicos.
message	string	Representação independente de idioma e legível por humanos do erro. Ele se destina como um auxílio aos desenvolvedores e não é adequado para exposição aos usuários finais.