Time Series Instances - Suggest

  • リファレンス
サービス:
Time Series Insights
API バージョン:
2020-07-31

後で検索インスタンスで使用する時系列インスタンス属性に基づいてキーワードを提案します。

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

URI パラメーター

名前 / 必須 型 説明
environmentFqdn
 path True

string

環境ごとの FQDN (たとえば、10000000-0000-0000-0000-100000000109.env.timeseries.azure.com)。 このドメイン名は、Get Environments API、Azure portal、または Azure Resource Managerの応答から取得できます。
api-version
 query True

string

クライアント要求で使用される API のバージョン。 現在サポートされているバージョンは "2020-07-31" です。

要求ヘッダー

名前 必須 型 説明
x-ms-client-request-id

string

オプションのクライアント要求 ID。 サービスでは、この値が記録されます。 サービスがサービス間で操作をトレースできるようにし、特定の要求に関して顧客がサポートに問い合わせることができます。
x-ms-client-session-id

string

オプションのクライアント セッション ID。 サービスでは、この値が記録されます。 サービスがサービス間で関連する操作のグループをトレースできるようにし、顧客が特定の要求グループに関してサポートに連絡できるようにします。

要求本文

名前 必須 型 説明
searchString True

string

候補が必要な検索文字列。 空は許可されますが、null は使用できません。
take

integer

結果で予想される候補の最大数。 既定値は、設定されていない場合は 10 です。

応答

名前 型 説明
200 OK

InstancesSuggestResponse

操作は成功しました。

ヘッダー

x-ms-request-id: string
Other Status Codes

TsiError

予期しないエラー。

ヘッダー

x-ms-request-id: string

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
user_impersonation ユーザー アカウントの借用

例

InstancesSuggest

要求のサンプル

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

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

応答のサンプル

状態コード:
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

エラーの人間が判読できる言語に依存しない表現。 これは開発者の支援を目的としており、エンド ユーザーへの公開には適していません。