Time Series Instances - Suggest

Service:

Time Series Insights

API Version:

2020-07-31

Предлагает ключевые слова на основе атрибутов экземпляра временных рядов для последующего использования в экземплярах поиска.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
environmentFqdn	path	True	string	Полное доменное имя среды, например 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Это доменное имя можно получить из ответа API получения сред, портал Azure или azure Resource Manager.
api-version	query	True	string	Версия API для использования с клиентским запросом. В настоящее время поддерживается версия 2020-07-31.

Заголовок запроса

Имя	Обязательно	Тип	Описание
x-ms-client-request-id		string	Необязательный идентификатор запроса клиента. Служба записывает это значение. Позволяет службе отслеживать операции между службами и позволяет клиенту обращаться в службу поддержки по конкретному запросу.
x-ms-client-session-id		string	Необязательный идентификатор сеанса клиента. Служба записывает это значение. Позволяет службе отслеживать группу связанных операций между службами и позволяет клиенту обращаться в службу поддержки по поводу определенной группы запросов.

Текст запроса

Имя	Обязательно	Тип	Описание
searchString	True	string	Строка поиска, для которой требуются предложения. Допускается пустое значение, но не значение NULL.
take		integer	Максимальное количество предложений, ожидаемое в результате. Значение по умолчанию — 10, если не задано.

Ответы

Имя	Тип	Описание
200 OK	InstancesSuggestResponse	Успешная операция. Headers x-ms-request-id: string
Other Status Codes	TsiError	Непредвиденная ошибка. Headers x-ms-request-id: string

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

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

Scopes

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

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

Определения

Имя	Описание
InstancesSearchStringSuggestion	Предлагаемая строка поиска, используемая для дальнейшего поиска экземпляров временных рядов.
InstancesSuggestRequest	Запрос на получение предложений строк поиска для поиска экземпляров временных рядов на основе текста префикса.
InstancesSuggestResponse	Ответ на получение предложений для поиска экземпляров временных рядов.
TsiError	Сведения об ошибке API.
TsiErrorBody	Определенная ошибка API с кодом ошибки и сообщением.
TsiErrorDetails	Дополнительные сведения об ошибке.

InstancesSearchStringSuggestion

Предлагаемая строка поиска, используемая для дальнейшего поиска экземпляров временных рядов.

Имя	Тип	Описание
highlightedSearchString	string	Выделена предлагаемая строка поиска для отображения пользователю. Выделение вставок и тегов в фрагментах текста, соответствующих строке поиска. Не используйте выделенную строку поиска для дальнейших вызовов поиска.
searchString	string	Предлагаемая строка поиска. Можно использовать для дальнейшего поиска экземпляров временных рядов.

InstancesSuggestRequest

Запрос на получение предложений строк поиска для поиска экземпляров временных рядов на основе текста префикса.

Имя	Тип	Описание
searchString	string	Строка поиска, для которой требуются предложения. Допускается пустое значение, но не значение NULL.
take	integer	Максимальное количество предложений, ожидаемое в результате. Значение по умолчанию — 10, если не задано.

InstancesSuggestResponse

Ответ на получение предложений для поиска экземпляров временных рядов.

Имя	Тип	Описание
suggestions	InstancesSearchStringSuggestion[]	Список вариантов экземпляров для поиска моделей временных рядов.

TsiError

Сведения об ошибке API.

Имя	Тип	Описание
error	TsiErrorBody	Определенная ошибка API с кодом ошибки и сообщением.

TsiErrorBody

Определенная ошибка API с кодом ошибки и сообщением.

Имя	Тип	Описание
code	string	Независимая от языка, читаемая человеком строка, определяющая код ошибки для конкретной службы. Этот код служит более конкретным индикатором для кода ошибки HTTP, указанного в ответе. Может использоваться для программной обработки конкретных случаев ошибок.
details	TsiErrorDetails[]	Содержит дополнительные сведения об ошибке. Может принимать значение NULL.
innerError	TsiErrorBody	Содержит более конкретную ошибку, которая сужает причину. Может принимать значение NULL.
message	string	Удобочитаемое, независимое от языка представление ошибки. Он предназначен для разработчиков и не подходит для воздействия на конечных пользователей.
target	string	Целевой объект конкретной ошибки (например, имя свойства в ошибке). Может принимать значение NULL.

TsiErrorDetails

Дополнительные сведения об ошибке.

Имя	Тип	Описание
code	string	Независимая от языка, читаемая человеком строка, определяющая код ошибки для конкретной службы. Этот код служит более конкретным индикатором для кода ошибки HTTP, указанного в ответе. Может использоваться для программной обработки конкретных случаев ошибок.
message	string	Удобочитаемое, независимое от языка представление ошибки. Он предназначен для разработчиков и не подходит для воздействия на конечных пользователей.