Azure Time Series Insights Gen2 モデル API
概要
時系列モデル (インスタンス、階層、および型) を作成する 3 つの各コンポーネントには、CREATE、READ、UPDATE、DELETE、ページ分割、バッチ操作をサポートする対応する REST API があります。
- Instance API では、ページ分割された GET 操作、バッチ CREATE、READ、UPDATE、DELETE 操作、検索、検索操作に関するキーワード (keyword)提案がサポートされています。
- Hierarchy API では、ページ分割された GET 操作と、バッチ CREATE、READ、UPDATE、DELETE 操作がサポートされています。
- Type API では、ページ分割された GET 操作とバッチ CREATE、READ、UPDATE、DELETE 操作がサポートされています。
4 番目の API では、タイム シリーズ モデル設定の REST サポートが提供されます。
- モデル設定 API では、Time Series Model 構成設定の HTTP GET および UPDATE 操作がサポートされています。 時系列モデルとインスタンス、階層、および型の定義の詳細については、「Time Series Model」を参照してください。
Instances API
Instances API を使用すると、TIME Series インスタンスに対して CREATE、READ、UPDATE、DELETE の各操作を実行できます。
Get Instances API は、要求に一致するすべての Time Series インスタンスを返します。
インスタンスの管理 API を使用すると、インスタンスに対するバッチ操作が可能になります。 この API に対するすべての操作は HTTP POST 操作です。 各操作はペイロードを受け入れます。 ペイロードは JSON オブジェクトです。 このオブジェクトは、1 つのプロパティを定義します。 プロパティ キーは、API によって許可される操作の名前です。 サポートされている操作は、 PUT、 UPDATE、 DELETE です。
これらの API を使用すると、Time Series Instances の検出が可能になります。
ヒント
以下の 検索クエリ機能 に関するページを参照してください。
階層 API
階層 API を使用すると、時系列階層で CREATE、READ、UPDATE、DELETE が有効になります。
| API | 説明 |
|---|---|
| 階層の取得 API | 要求に一致するすべての時系列階層を返します。 |
| 階層 API の管理 | 階層に対するバッチ操作を有効にします。 この API に対するすべての操作は HTTP POST 操作です。 各操作はペイロードを受け入れます。 ペイロードは JSON オブジェクトです。 このオブジェクトは、1 つのプロパティを定義します。 プロパティ キーは、API で許可される操作の名前です。 サポートされている操作は、 PUT、 UPDATE、 DELETE です。 |
Types API
Types API を使用すると、時系列型とその関連変数に対して CREATE、READ、UPDATE、DELETE が有効になります。
| API | 説明 |
|---|---|
| 型の取得 API | すべての時系列型とそれに関連付けられている変数を返します。 |
| Post Types API | 型に対するバッチ操作を有効にします。 この API に対するすべての操作は HTTP POST 操作です。 各操作はペイロードを受け入れます。 ペイロードは JSON オブジェクトです。 このオブジェクトは、1 つのプロパティを定義します。 プロパティ キーは、API で許可される操作の名前です。 サポートされている操作は、 PUT、 UPDATE、 DELETE です。 |
モデル設定 API
モデル設定 API を使用すると、TimeSeriesIds によって環境内で自動的に作成されたモデルに対して CREATE、READ、UPDATE、DELETE が有効になります。
| API | 説明 |
|---|---|
| モデル設定 API の取得 | TimeSeriesIds の環境で自動的に作成されたモデルを返します。 |
| モデル設定の更新 API | TimeSeriesIds の環境で、要求で指定された新しい値を使用してモデルを更新します。 |
検索機能
ワイルドカード検索
(フレーズ検索内ではなく) 1 つの用語内で 1 つの文字と複数の文字のワイルドカード検索をサポートしています。
1 文字
1 文字のワイルドカード検索を実行するには、 記号を使用します ? 。 1 文字のワイルドカード検索では、文字列に一致する用語が検索され、1 文字が置き換えられます。
または testをtext検索するには、 を検索しますte?t。
複数の文字
複数文字のワイルドカード検索を実行するには、 記号を使用します * 。 複数の文字ワイルドカード検索では、0 個以上の文字が検索されます。
、tests、または testerをtest検索するには、検索を使用します。 test*
また、用語の途中でワイルドカード検索を使用することもできます。 をdryer検索するには、 検索を使用できます。 dr*r
ブール演算子
ブール演算子を使用すると、論理演算子を使用して用語を結合できます。 AND、OR、、、+-および NOT はブール演算子としてサポートされています。
重要
- ブール演算子は ALL CAPS に含まれる必要があります。
- ブール演算子は、空白を使用して検索句から分離する必要があります。
dryer AND washerは有効ですが、 は有効ではありませんdryer ANDwasher。
AND 演算子
AND 演算子は、1 つのドキュメントのテキスト内の任意の場所に両方の用語が存在するドキュメントと一致します。
を含む dryer washer ドキュメントを検索し、 foo bar 検索を使用するには: dryer washer AND foo bar。
注意
記号 && は、演算子 AND の代わりに使用できます。
OR 演算子
OR 演算子は、2 つの用語をリンクし、いずれかの用語がドキュメントに存在する場合に一致するドキュメントを検索します。 OR 演算子は、既定の結合演算子です。 つまり、2 つの項の間にブール演算子がない場合は、 OR 演算子が使用されます。
次のいずれかの検索を含む dryer washer 、または単に dryer 使用するドキュメントを検索するには:
'dryer washer' dryer'dryer washer' OR dryer
注意
記号 || は、演算子 OR の代わりに使用できます。
+ 演算子
または 必須演算子では + 、記号の後の用語が + 1 つのドキュメントのフィールド内のどこかに存在する必要があります。
を含むdryer必要があり、含まれている可能性があるwasherドキュメントを検索するには、 検索を使用します。 +dryer washer
- 演算子
or prohibit 演算子は - 、記号の後に用語を含むドキュメントを - 除外します。
検索を含む dryer washer が使用しない foo bar ドキュメントを検索するには: dryer washer -foo bar。
NOT
NOT 演算子は、 の後NOTの用語を含むドキュメントを除外します。
を含む dryer washer が使用していない foo bar ドキュメントを検索するには: dryer washer NOT foo bar。
NOT 演算子は、1 つの用語だけで使用することはできません。
次の検索では、結果は返されません: NOT dryer washer。
注意
記号 ! は NOT 演算子の代わりに使用できます。
- 除外された検索用語の直前に置く必要があります。
dryer !washerは有効ですが、 は有効ではありませんdryer ! washer。
関連項目
アプリケーションの登録と Azure Active Directory プログラミング モデルの詳細については、「 開発者向け Azure Active Directory」を参照してください。
要求パラメーターと認証パラメーターの詳細については、「 認証と承認」を参照してください。
HTTP 要求と応答のテストに役立つツールは次のとおりです。
Fiddler。 この無料の Web デバッグ プロキシでは、REST 要求をインターセプトできるため、HTTP 要求と応答メッセージを診断できます。
JWT.io。 このツールを使用すると、ベアラー トークンに要求をすばやくダンプし、その内容を検証できます。
Postman。 これは、REST API をデバッグするための無料の HTTP 要求および応答テスト ツールです。
Gen2 Azure Time Series Insightsの詳細については、Gen2 のドキュメントを参照してください。