データ型

column_def

データセットのカラム情報を表します。以下の項目を持つ JSON Object として表現されます。

• column_name: string -- カラム名。
• data_type: string -- データ型。
• nullable: boolean -- ヌル許容フラグ。 true であればヌル値が許容されます。 false であればヌル値は許容されずエラーとなります。 リクエストデータでは本項目は省略可能です。 省略された場合は false になります。
• attnum: integer -- データベース上の列番号。 本項目は今後廃止される可能性があります。 利用しないでください。 リクエストデータでは本項目を指定することはできません。

dataset_info

データセットの情報を表します。以下の項目を持つ JSON Object として表現されます。

• id: integer -- 内部管理テーブル上の ID。 本項目は今後廃止される可能性があります。 利用しないでください。
• session_id: integer -- セッション ID。 本項目は今後廃止される可能性があります。 利用しないでください。
• usename: string -- データベースロール名。 本項目は今後廃止される可能性があります。 利用しないでください。
• ddc_type: string -- 種別。 本項目は今後廃止される可能性があります。 利用しないでください。
• short_form: string -- データセット名。
• long_form: string -- 長形式のデータセット名。 本項目は今後廃止される可能性があります。 利用しないでください。
• realname: string -- データベース上のテーブル名。 本項目は今後廃止される可能性があります。 利用しないでください。
• created_at: object -- データセットの作成日時。 本項目は今後廃止される可能性があります。 利用しないでください。
• committed_at: object -- データセットのコミット日時。 本項目は今後廃止される可能性があります。 利用しないでください。
• prepared_activity_id: integer -- データセットに対する操作情報。 本項目は今後廃止される可能性があります。 利用しないでください。

citation_info

サイテーションの情報を表します。以下の項目を持つ JSON Object として表現されます。

• id: integer -- 内部管理テーブル上の ID。 本項目は今後廃止される可能性があります。 利用しないでください。
• short_form: string -- サイテーション名。
• long_form: string -- 長形式のサイテーション名。
• dataset_name: string -- データセット名。
• dataset_realname: string -- データベース上でのデータセットのテーブル名。 本項目は今後廃止される可能性があります。 利用しないでください。
• transaction_time: object -- サイテーションの発行日時。
• created_at: object -- データベース上でのサイテーションの作成日時。 本項目は今後廃止される可能性があります。 利用しないでください。

upstream_info

モデルストアの上流情報を表します。以下の項目を持つ JSON Object として表現されます。

• id: integer -- 内部管理テーブル上の ID。
• model_store_ddc_id: string -- 内部管理テーブル上の旧形式モデルストア ID。 本項目は今後廃止される可能性があります。 利用しないでください。
• model_store_dataset_id: integer -- 内部管理テーブル上のモデルストア ID。 本項目は今後廃止される可能性があります。 利用しないでください。
• upstream_endpoint: string -- 上流ノードのエンドポイント。
• upstream_apikey: string -- 上流ノードに接続するための API キー。
• upstream_secret: string -- 上流ノードに接続するためのシークレット。
• upstream_model_store_ddc: string -- 上流ノードのモデルストア名。
• alias: string -- エイリアス名。
• description: string -- 説明。
• enabled: boolean -- 有効無効を表すフラグ。
• created_at: object -- データベース上での上流情報の作成日時。 本項目は今後廃止される可能性があります。 利用しないでください。
• updated_at: object -- データベース上での上流情報の最終更新日時。 本項目は今後廃止される可能性があります。 利用しないでください。

model_info

モデル情報を表します。以下の項目を持つ JSON Object として表現されます。

• start_datetime: object -- モデルが表す開始日時。 本項目は今後廃止される可能性があります。 利用しないでください。
• end_datetime: object -- モデルが表す終了日時。 本項目は今後廃止される可能性があります。 利用しないでください。
• location: string -- モデルが表す空間範囲。 本項目は今後廃止される可能性があります。 利用しないでください。
• tenant_id: string -- モデルが生成された xData Edge インスタンスのテナント ID。
• model_id: string -- モデルを一意に識別する ID。
• model_kind: string -- モデルの種類。
• model_description: string -- モデルの説明。
• model_meta: object -- モデルのメタ情報。
• model_state: integer -- モデルの状態を表す分類番号。 連合学習のサイクルにおける状態を区別するために利用されます。
  • 10: 学習されたモデル。
  • 20: 下流ノードからフィードバックされたモデル。
  • 30: 集約されたモデル。
  • 40: 上流ノードから転送されたモデル。
• model_hash: string -- モデルのハッシュ値。
• model_size: integer -- モデルのバイナリデータとしてのサイズ。
• round: integer -- 連合学習のラウンド数。 現在は利用されていません。
• hop_count: integer -- ノード間でのモデル転送におけるホップ数。 現在は利用されていません。
• model_store_ddc: string -- このモデルが格納されているモデルストア名。

condition

データセットのレコード等、各種情報を取得するときの取得条件を表します。 JSON Logic の記法で表現されます。 ただし、利用可能な演算子は JSON Logic とは異なります。

• https://jsonlogic.com/

記述例

{
    "and": [
        { ">=": [ "age", 20 ] },
        { "<" : [ "age", 30 ] }
    ]
}

この記述例は「age カラムの値が 20 以上かつ 30 未満」という条件を表します。

式 (expression)

一つの条件式は JSON object で以下のように記述します。

{
    "operator": [ "operand1", "operand2", ... ]
}

• JSON object はただ一つのキーを持ちます。 キーの名前によって演算の種類が決まります。
• キーに対応する値は JSON array です。 配列の各要素が演算のパラメータ (オペランド) になります。 パラメータの数や型は演算子によって異なります。

カラム名

データセットのカラム名は JSON の string で記述します。

値

数値や文字列、真偽値などの即値は JSON の値で記述します。 ただし、データセットのカラム名に一致する文字列はカラム名として解釈されます。

演算子

以下の演算子を利用できます。

演算子	説明	パラメータ数
=	A と B が等しい	2
<>	A と B が等しくない	2
>	A は B よりも大きい	2
>=	A は B よりも大きいか等しい	2
<	A は B よりも小さい	2
<=	A は B よりも小さいか等しい	2
!	パラメータの否定	1
and	すべてのパラメータが true	任意
or	いずれかのパラメータが true	任意
in	A は B の要素のいずれかに等しい	2 (B は JSON array)
+	すべてのパラメータの和	任意
*	すべてのパラメータの積	任意
-	A - B	2
/	A / B	2