Time Series Instances - Suggest

Servicio:

Time Series Insights

Versión de la API:

2020-07-31

Sugiere palabras clave basadas en atributos de instancia de serie temporal que se usarán más adelante en Instancias de búsqueda.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
environmentFqdn	path	True	string	Por FQDN de entorno, por ejemplo, 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Puede obtener este nombre de dominio de la respuesta de Get Environments API, Azure Portal o Azure Resource Manager.
api-version	query	True	string	Versión de la API que se va a usar con la solicitud de cliente. La versión admitida actualmente es "2020-07-31".

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
x-ms-client-request-id		string	Identificador de solicitud de cliente opcional. El servicio registra este valor. Permite al servicio realizar un seguimiento de la operación entre servicios y permite al cliente ponerse en contacto con el soporte técnico con respecto a una solicitud determinada.
x-ms-client-session-id		string	Identificador de sesión de cliente opcional. El servicio registra este valor. Permite al servicio realizar un seguimiento de un grupo de operaciones relacionadas entre servicios y permite al cliente ponerse en contacto con el soporte técnico con respecto a un grupo determinado de solicitudes.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
searchString	True	string	Cadena de búsqueda para la que se requieren sugerencias. Se permite vacío, pero no null.
take		integer	Número máximo de sugerencias esperadas en el resultado. El valor predeterminado es 10 cuando no se establece.

Respuestas

Nombre	Tipo	Description
200 OK	InstancesSuggestResponse	Operación correcta. Encabezados x-ms-request-id: string
Other Status Codes	TsiError	error inesperado. Encabezados x-ms-request-id: string

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

InstancesSuggest

Solicitud de ejemplo

HTTP

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

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

Respuesta de muestra

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

Definiciones

Nombre	Description
InstancesSearchStringSuggestion	Cadena de búsqueda sugerida que se usará para buscar más instancias de serie temporal.
InstancesSuggestRequest	Solicite obtener sugerencias de cadena de búsqueda para la búsqueda de instancias de serie temporal en función del texto del prefijo.
InstancesSuggestResponse	Respuesta de la obtención de sugerencias para la búsqueda de instancias de serie temporal.
TsiError	Información sobre un error de API.
TsiErrorBody	Un error de API determinado con un código de error y un mensaje.
TsiErrorDetails	Información adicional de error.

InstancesSearchStringSuggestion

Cadena de búsqueda sugerida que se usará para buscar más instancias de serie temporal.

Nombre	Tipo	Description
highlightedSearchString	string	Cadena de búsqueda sugerida resaltada que se mostrará al usuario. Resaltado de inserciones y etiquetas en las partes del texto que coinciden con la cadena de búsqueda. No use la cadena de búsqueda resaltada para realizar más llamadas de búsqueda.
searchString	string	Cadena de búsqueda sugerida. Se puede usar para buscar más instancias de serie temporal.

InstancesSuggestRequest

Solicite obtener sugerencias de cadena de búsqueda para la búsqueda de instancias de serie temporal en función del texto del prefijo.

Nombre	Tipo	Description
searchString	string	Cadena de búsqueda para la que se requieren sugerencias. Se permite vacío, pero no null.
take	integer	Número máximo de sugerencias esperadas en el resultado. El valor predeterminado es 10 cuando no se establece.

InstancesSuggestResponse

Respuesta de la obtención de sugerencias para la búsqueda de instancias de serie temporal.

Nombre	Tipo	Description
suggestions	InstancesSearchStringSuggestion[]	Lista de sugerencias de instancia para buscar modelos de serie temporal.

TsiError

Información sobre un error de API.

Nombre	Tipo	Description
error	TsiErrorBody	Un error de API determinado con un código de error y un mensaje.

TsiErrorBody

Un error de API determinado con un código de error y un mensaje.

Nombre	Tipo	Description
code	string	Cadena legible e independiente del lenguaje que define un código de error específico del servicio. Este código actúa como un indicador más específico para el código de error HTTP especificado en la respuesta. Se puede usar para controlar mediante programación casos de error específicos.
details	TsiErrorDetails[]	Contiene información de error adicional. Su valor puede ser null.
innerError	TsiErrorBody	Contiene un error más específico que limita la causa. Su valor puede ser null.
message	string	Representación independiente del idioma y legible del error. Está pensado como ayuda para los desarrolladores y no es adecuado para la exposición a los usuarios finales.
target	string	Destino del error determinado (por ejemplo, el nombre de la propiedad en error). Su valor puede ser null.

TsiErrorDetails

Información adicional de error.

Nombre	Tipo	Description
code	string	Cadena legible e independiente del lenguaje que define un código de error específico del servicio. Este código actúa como un indicador más específico para el código de error HTTP especificado en la respuesta. Se puede usar para controlar mediante programación casos de error específicos.
message	string	Representación independiente del idioma y legible del error. Está pensado como ayuda para los desarrolladores y no es adecuado para la exposición a los usuarios finales.