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 參數

名稱	位於	必要	類型	Description
environmentFqdn	path	True	string	每個環境 FQDN，例如 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com。 您可以從取得環境 API、Azure 入口網站 或 Azure Resource Manager 的回應中取得此功能變數名稱。
api-version	query	True	string	要與用戶端要求搭配使用的 API 版本。 目前支援的版本是 「2020-07-31」。

要求標頭

名稱	必要	類型	Description
x-ms-client-request-id		string	選擇性用戶端要求識別碼。 服務會記錄此值。 允許服務跨服務追蹤作業，並允許客戶連絡有關特定要求的支持人員。
x-ms-client-session-id		string	選擇性用戶端會話識別碼。 服務會記錄此值。 允許服務追蹤跨服務的相關作業群組，並允許客戶連絡支持人員，以取得特定要求群組的相關信息。

要求本文

名稱	必要	類型	Description
searchString	True	string	搜尋需要建議的字串。 允許空白，但不允許為 Null。
take		integer	結果中預期的建議數目上限。 未設定時，預設為10。

回應

名稱	類型	Description
200 OK	InstancesSuggestResponse	成功的作業。 Headers x-ms-request-id: string
Other Status Codes	TsiError	非預期的錯誤。 Headers x-ms-request-id: string

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

名稱	Description
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"
    }
  ]
}

定義

名稱	Description
InstancesSearchStringSuggestion	建議用於進一步搜尋時間序列實例的搜尋字串。
InstancesSuggestRequest	要求根據前置詞文字取得時間序列實例搜尋的搜尋字串建議。
InstancesSuggestResponse	取得搜尋時間序列實例建議的回應。
TsiError	API 錯誤的相關信息。
TsiErrorBody	具有錯誤碼和訊息的特定 API 錯誤。
TsiErrorDetails	其他錯誤資訊。

InstancesSearchStringSuggestion

建議用於進一步搜尋時間序列實例的搜尋字串。

名稱	類型	Description
highlightedSearchString	string	醒目提示要向用戶顯示的建議搜尋字串。 反白顯示符合搜尋字串之文字部分的插入和 標記。 請勿使用醒目提示的搜尋字串來執行進一步的搜尋呼叫。
searchString	string	建議的搜尋字串。 可用於進一步搜尋時間序列實例。

InstancesSuggestRequest

要求根據前置詞文字取得時間序列實例搜尋的搜尋字串建議。

名稱	類型	Description
searchString	string	搜尋需要建議的字串。 允許空白，但不允許為 Null。
take	integer	結果中預期的建議數目上限。 未設定時，預設為10。

InstancesSuggestResponse

取得搜尋時間序列實例建議的回應。

名稱	類型	Description
suggestions	InstancesSearchStringSuggestion[]	搜尋時間序列模型的實例建議清單。

TsiError

API 錯誤的相關信息。

名稱	類型	Description
error	TsiErrorBody	具有錯誤碼和訊息的特定 API 錯誤。

TsiErrorBody

具有錯誤碼和訊息的特定 API 錯誤。

名稱	類型	Description
code	string	與語言無關、人類可讀取的字串，可定義服務特定的錯誤碼。 此程式代碼可作為回應中指定的 HTTP 錯誤碼更明確的指標。 可用來以程式設計方式處理特定錯誤案例。
details	TsiErrorDetails[]	包含其他錯誤資訊。 可能是 Null。
innerError	TsiErrorBody	包含更明確的錯誤，可縮小原因範圍。 可能是 Null。
message	string	人類可讀、與語言無關的錯誤表示法。 它是開發人員的協助，不適合公開給終端使用者。
target	string	例如，特定錯誤的目標 (，錯誤) 的屬性名稱。 可能是 Null。

TsiErrorDetails

其他錯誤資訊。

名稱	類型	Description
code	string	與語言無關、人類可讀取的字串，可定義服務特定的錯誤碼。 此程式代碼可作為回應中指定的 HTTP 錯誤碼更明確的指標。 可用來以程式設計方式處理特定錯誤案例。
message	string	人類可讀、與語言無關的錯誤表示法。 它是開發人員的協助，不適合公開給終端使用者。