🌐 日本語 · English

Documentation Powered by ReDoc

AITRIOS | Console (2.0.0)

Download OpenAPI specification:Download

Provisioning

GetQrCodeForProvisioning

エッジデバイスをプロビジョニングするためのQRを、Base64エンコード形式で生成します。

query Parameters
ntp
required
string

NTPサーバーのIPアドレスまたはホスト名。指定できる文字数は64文字までです。

auto
boolean
Default: false
  • 設定値
    値がtrueの場合は、自動登録用のEnrollment QRを生成します。値がfalseの場合、手動登録用のService QRを生成します。
wifi_ssid
string

Wi-Fiネットワークに接続するためのSSID情報。

wifi_pass
string

Wi-Fiネットワークに接続するためのパスワード。

proxy_url
string

デバイスが接続するプロキシサーバーのURL。

proxy_port
string

デバイスが接続するプロキシサーバーのポート番号。

proxy_user_name
string

デバイスが接続するプロキシサーバーのユーザー名。

proxy_pass
string

デバイスが接続するプロキシサーバーのパスワード。

ip_address
string

デバイスに割り当てられたIPアドレス。指定できる文字数は39文字までです。

subnet_mask
string

デバイスに適用されるサブネットマスク。指定できる文字数は39文字までです。

gateway
string

ゲートウェイのIPアドレス。指定できる文字数は39文字までです。

dns
string

DNSサーバーのIPアドレス。指定できる文字数は39文字までです。

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS",
  • "contents": "string"
}

Certificate

EnrollDevice

デバイス証明書を使ってエッジデバイスを登録します。 前提条件や注意事項：
・.pem、.cer、または.crtの形式のプライマリ X.509 証明書に対応しています。

Request Body schema: application/json
device_name
required
string

デバイス名。 ※指定できる文字数は255文字までです。

primary_certificate
required
string

X.509プライマリ証明書（.pemファイル、.cerファイル、または.crtファイル）。 ※先頭と末尾の署名を除いた次の証明書を指定してください。

-----BEGIN CERTIFICATE-----

-----END CERTIFICATE-----

また、改行を含めないでください。

Responses

Request samples

Content type
application/json
{
  • "device_name": "string",
  • "primary_certificate": "string"
}

Response samples

Content type
application/json
{
  • "result": "string",
  • "id": "string"
}

DeleteDevice

パスパラメーターで指定したエッジデバイスを削除します。

path Parameters
device_id
required
string

デバイスID。

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetDeviceCertificates

エッジデバイスの証明書の情報をリスト化して取得します。

Responses

Response samples

Content type
application/json
{
  • "certificates":
    [
    ]
}

GetDeviceCertificate

特定のエッジデバイスのデバイス証明書情報を取得します。

path Parameters
device_id
required
string

デバイスID。

Responses

Response samples

Content type
application/json
{
  • "device_id": "string",
  • "internal_device_id": "string",
  • "device_name": "string",
  • "credentials_id_object": "string",
  • "credentials_type": "string",
  • "expiration_date": "string",
  • "created_time": "string"
}

UpdateDeviceCertificate

特定のエッジデバイスのデバイス証明書情報を更新します。

path Parameters
device_id
required
string

デバイスID。

Request Body schema: application/json
primary_certificate
required
string

X.509プライマリーデバイス証明書
（.pemファイルまたは .cerファイル）

※先頭と末尾の署名を除いた次の証明書を指定してください。

-----BEGIN CERTIFICATE-----

-----END CERTIFICATE-----

また、改行を含めないでください。

Responses

Request samples

Content type
application/json
{
  • "primary_certificate": "string"
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

Manage Devices

GetDevices

クエリパラメーターで指定したエッジデバイスの情報をリスト化します。

query Parameters
connectionState
string
Default: ""

接続状態。

  • 設定値
    Connected
    Disconnected
device_name
string
Default: ""

デバイス名。※あいまい検索が可能です。

device_id
string
Default: ""

デバイスID。※あいまい検索が可能です。

device_group_id
string
Default: ""

デバイスグループID。

device_ids
string
Default: ""

デバイスIDのリスト。デバイスIDを複数指定するには、カンマで区切ります。

scope
string
Default: "full"

返却されるレスポンスパラメーターの範囲。

  • 設定値
    full：全パラメーターを返します。
    minimal：最小限のパラメーターを返します。 ※時間の短縮に有効です。

Responses

Response samples

Content type
application/json
{
  • "devices":
    [
    ]
}

GetDevice

クエリパラメーターで指定したエッジデバイスの情報を返します。

path Parameters
device_id
required
string

デバイスID。

Responses

Response samples

Content type
application/json
{
  • "device_id": "string",
  • "place": "string",
  • "comment": "string",
  • "property":
    {
    },
  • "device_type": "string",
  • "display_device_type": "string",
  • "ins_id": "string",
  • "ins_date": "string",
  • "upd_id": "string",
  • "upd_date": "string",
  • "connectionState": "string",
  • "lastActivityTime": "string",
  • "models":
    [
    ],
  • "device_groups":
    [
    ],
  • "configuration": { },
  • "state": { },
  • "command_results":
    [
    ],
  • "apps":
    [
    ]
}

SetPermission

指定したエッジデバイスでファクトリーリセットの実行を許可するか否かを指定します。

path Parameters
device_id
required
string

デバイスID。

query Parameters
factory_reset
required
string

指定したエッジデバイスに対し、ファクトリーリセットの実行を許可または禁止します。

  • 設定値
    値がtrueの場合は、ファクトリーリセットの実行を許可します。値がfalseの場合は、ファクトリーリセットの実行を禁止します。

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetDeviceGroups

指定したグループに含まれる登録済みエッジデバイスの情報をリスト化します。クエリパラメーターにデバイスIDを指定すると、デバイスが属するグループを確認できます。

query Parameters
device_group_id
string
Default: ""

デバイスグループのID。※あいまい検索が可能です。

comment
string
Default: ""

対象の説明。※あいまい検索が可能です。

device_id
string
Default: ""

該当グループに属するデバイスID。 指定されたデバイスIDを含むデバイスグループをリスト化します。

Responses

Response samples

Content type
application/json
{
  • "device_groups":
    [
    ]
}

CreateDeviceGroup

デバイスグループを作成します。

query Parameters
device_group_id
required
string

デバイスグループの名称。 グループ名は半角文字で100文字まで指定できます。半角カンマは使用できません。

comment
string
Default: ""

対象の説明。指定できる文字数は100文字までです。

device_id
string
Default: ""

含まれるデバイスID。
対象が複数存在する場合は、以下のように記載します。
※カンマで区切る
※同じ値を使用しない

del_from_dgroup
string
Default: "0"

複数のグループに属するデバイスを削除するには、以下のように設定します。

  • 設定値 0：削除しない
    1：削除

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetDeviceGroup

特定のデバイスグループ（デバイスグループID）の情報をリスト化します。

path Parameters
device_group_id
required
string

デバイスグループID。

Responses

Response samples

Content type
application/json
{
  • "device_group_id": "string",
  • "device_type": "string",
  • "comment": "string",
  • "ins_id": "string",
  • "ins_date": "string",
  • "upd_id": "string",
  • "upd_date": "string",
  • "devices":
    [
    ]
}

DeleteDeviceGroup

device_idで指定したデバイスの登録を削除します。

path Parameters
device_group_id
required
string

削除したいデバイスグループのID。

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

UpdateDeviceGroup

指定したデバイスグループに対し、デバイスの登録、削除、更新を行います。

path Parameters
device_group_id
required
string

更新するデバイスグループのID。

query Parameters
comment
string
Default: ""

対象の説明。指定できる文字数は100文字までです。 説明を削除するには、"@@nullupdate "を指定します。

※commentとdevice_idが設定されていない場合は、エラーになります。

device_id
string
Default: ""

置き換え対象のデバイスID。 デバイスIDの登録を解除するには、"@@nullupdate "を指定します。 対象が複数存在する場合は、以下のように記載します。 ※カンマで区切る
※同じ値を使用しない

※commentとdevice_idが設定されていない場合は、エラーになります。

del_from_dgroup
string
Default: "0"

デフォルトグループからデバイスを削除するかどうかを指定します。

  • 設定値
    0：削除しない
    1：削除

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

Device Command

StartUploadInferenceResult

推論結果のメタデータ（Output Tensor）および入力画像の取得開始をエッジデバイスに指示します。

path Parameters
device_id
required
string

デバイスID。

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS",
  • "outputSubDirectory": "string",
  • "outputSubDirectoryIR": "string"
}

StopUploadInferenceResult

指定したデバイスで、推論結果のメタデータ（Output Tensor）および画像（Input Image）の取得を停止します。

path Parameters
device_id
required
string

デバイスID。

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

Reboot

指定したデバイスを再起動します。

path Parameters
device_id
required
string

デバイスID。

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

ResetDevice

指定したエッジデバイスを、初期状態に戻す次の操作を行います。 ※ファクトリーリセット
※推論結果のメタデータと画像データを除く機器情報をConsoleから削除。

path Parameters
device_id
required
string

デバイスID。

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

SetDeviceLog

このAPIはお使いになれません。指定したデバイスのログ設定を変更します。

path Parameters
device_id
required
string

デバイスID。

query Parameters
level
string
Default: "Error"

ログのレベル。

  • 値の定義 ※大文字と小文字は識別されません。
    Error
    Warn
    Info
    Debug
    Verbose
destination
string
Default: "UART"

出力先のタイプ別

  • 値の定義 ※大文字と小文字は識別されません。
    UART
    Cloud
    Both
SensorRegister
string
Default: false

センサーレジスター。

  • 設定値
    true
    false

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

SetDeviceAppLog

特定のエッジデバイスに対し、ロギングを有効または無効に設定します。

path Parameters
device_id
required
string

デバイスID。

Request Body schema: application/json
enable
boolean
Default: true

機能を有効または無効にします。

  • 設定値
    true：有効
    false：無効

Responses

Request samples

Content type
application/json
{
  • "enable": true
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

SetImageConfiguration

画像のフレームレートまたはカメラのドライブモードを設定します。フレームレートまたはドライブモードのいずれかの設定が必要です。

path Parameters
device_id
required
string

デバイスID。

Request Body schema: application/json
frame_rate
integer
Default: 2997

フレームレート。※センサーから出力されるフレームレートを100倍した整数値を設定します。フレームレートの最大値はドライブモードの値に依存します（詳細はドライブモードのパラメーター、drive_modeを参照してください）。

  • 設定値
    99
    499
    999
    1248
    1498
    1998
    2497
    2997
drive_mode
integer
Default: 1

ドライブモード。

  • 設定値
    1 2
    3 4
  • ドライブモードの仕様
    モード ビニング スケール クロップ 生データサイズ 最大フレームレート
    1 On - - 2028x1520 30(29.97)fps
    2 Off On - 2028x1520 20(19.98)fps
    3 Off Off On 2028x1520 20(19.98)fps
    4 Off Off Off 4056x3040 10(9.99)fps

Responses

Request samples

Content type
application/json
{
  • "frame_rate": 2997,
  • "drive_mode": 1
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetDirectImage

指定したエッジデバイスから出力される画像をリアルタイムで返します。 本APIを使用すれば、擬似ストリーミングによる再生が可能です。

path Parameters
device_id
required
string

デバイスID。

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS",
  • "contents": "string"
}

ChangePassword

指定したデバイスに対し、以下のパスワードを更新します。 ※ プロキシ

path Parameters
device_id
required
string

デバイスID。

Request Body schema: application/json
password
required
string

最大32文字までの平文を設定できます。

Responses

Request samples

Content type
application/json
{
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

SetDeviceConfiguration

指定したデバイスに、デバイスConfigを適用します。Configはデバイスに非同期で適用されます。変更が適用されたか確認するには、GetDevicesまたはGetDevice APIを使用してください。

path Parameters
device_id
required
string

デバイスID。

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "payload":
    {
    }
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

Command Parameter File

GetCommandParameterFile

Command Parameter Fileの情報をリスト化します。

Responses

Response samples

Content type
application/json
{
  • "parameter_list":
    [
    ]
}

RegistCommandParameterFile

さまざまな種類のCommand Parameter fileを登録します。

本APIでは、以下のパラメーターを事前に登録できます。

  • StartUploadInferenceData API

次のＡＰＩでは、ファイルの管理やデバイスへの適用を行います。

＜パラメーターファイルの管理＞

  • RegistCommandParameterFile API
  • GetCommandParameterFile API
  • UpdateCommandParameterFile API
  • DeleteCommandParameterFile API

＜デバイスとのバインド/アンバインド＞

  • BindCommandParameterFileToDevice API
  • UnbindCommandParameterFile API

Command Parameter fileがデバイスに適用されていない場合は、デフォルト値が使用されます。 必須のパラメーターが不足しているAPIを実行した場合は、エラーが発生します。 デフォルトのファイルは次のAPIを使って指定してください。

  • SetDefaultCommandParameterFile API
Request Body schema: application/json
file_name
required
string

ファイル名。指定できる文字数は100文字までです。

parameter
required
string

Base64形式でエンコードされたCommand Parameter fileの内容。フォーマットの詳細は、Console ユーザーマニュアルを参照してください。

comment
string

対象の説明。

Responses

Request samples

Content type
application/json
{
  • "file_name": "string",
  • "parameter": "string",
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

UpdateCommandParameterFile

Command Parameter fileを更新します。

path Parameters
file_name
required
string

ファイル名。

Request Body schema: application/json
parameter
required
string

Base64形式でエンコードされたCommand Parameter fileの内容。フォーマットの詳細は、Console ユーザーマニュアルを参照してください。

comment
string

対象の説明。

Responses

Request samples

Content type
application/json
{
  • "parameter": "string",
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

DeleteCommandParameterFile

Command Parameter fileを削除します。

path Parameters
file_name
required
string

ファイル名。

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

ExportCommandParameterFile

指定したCommand Parameter fileの情報をエクスポートします。

path Parameters
file_name
required
string

ファイル名。

Responses

Response samples

Content type
application/json
{
  • "contents": "string",
  • "file_name": "string"
}

SetDefaultCommandParameterFile

デフォルトのCommand Parameter fileを登録します。

path Parameters
file_name
required
string

ファイル名。

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

BindCommandParameterFileToDevice

指定したエッジデバイスにCommand Parameter fileをバインドします。

path Parameters
file_name
required
string

ファイル名。

Request Body schema: application/json
device_ids
required
string

デバイスIDを複数指定するには、カンマで区切ります。

Responses

Request samples

Content type
application/json
{
  • "device_ids": "string"
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

UnbindCommandParameterFile

指定したエッジデバイスからCommand Parameter fileのバインドを解除します。

path Parameters
file_name
required
string

ファイル名。

Request Body schema: application/json
device_ids
required
string

デバイスIDを複数指定するには、カンマで区切ります。

Responses

Request samples

Content type
application/json
{
  • "device_ids": "string"
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

Custom Setup File

GetDeviceCustomSetupFiles

カスタム設定ファイルの情報をリスト化します。

query Parameters
type
string

カスタム設定ファイルの種類。

  • 設定値 'Gamma'

Responses

Response samples

Content type
application/json
{
  • "device_setup_files":
    [
    ]
}

CreateDeviceCustomSetupFile

カスタム設定ファイルを作成します。

Request Body schema: application/json
type
required
string

カスタム設定ファイルの種類。

  • 設定値
    'Gamma'
file_name
required
string

ファイル名。

file_id
required
string

デバイスカスタム設定ファイルのファイルID。

comment
string

対象の説明。

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "file_name": "string",
  • "file_id": "string",
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetDeviceCustomSetupFile

カスタム設定ファイルの情報をリスト化します。

path Parameters
file_name
required
string

ファイル名。

Responses

Response samples

Content type
application/json
{
  • "file_name": "string",
  • "type": "string",
  • "comment": "string",
  • "ins_id": "string",
  • "ins_date": "string",
  • "upd_id": "string",
  • "upd_date": "string"
}

DeleteDeviceCustomSetupFile

カスタム設定ファイルを削除します。

path Parameters
file_name
required
string

ファイル名。

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

Deploy

GetDeployConfigurations

デプロイConfigの設定を抽出してリスト化します。

Responses

Response samples

Content type
application/json
{
  • "deploy_configurations":
    [
    ]
}

CreateDeployConfiguration

デプロイConfigを作成します。以下も併せて登録されます。

  • エッジシステムソフトウェア
  • AIモデル
  • エッジアプリケーション
query Parameters
config_id
required
string

指定できる文字数は半角20文字までです。

comment
string
Default: ""

指定できる文字数は100文字までです。

sensor_loader_version_number
string
Default: ""

Sensor Chip Firmware (loader) のバージョン番号。

sensor_version_number
string
Default: ""

センサーのバージョン番号。

model_id
string
Default: ""

AIモデルのID。

model_version_number
string
Default: "Latest"

AIモデルのバージョン番号。

ap_fw_version_number
string
Default: ""

Main Chip Firmwareのバージョン番号。

gamma_mode
string
Default: "custom"

Gammaモード。

  • 設定値
    custom
    auto
gamma_file_name
string
Default: ""

Gammaファイル名。

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetDeployConfiguration

指定したデプロイConfigの情報をリスト化します。

path Parameters
config_id
required
string

デプロイConfigのID。

Responses

Response samples

Content type
application/json
{
  • "config_id": "string",
  • "device_type": "string",
  • "config_comment": "string",
  • "running_cnt": 0,
  • "success_cnt": 0,
  • "fail_cnt": 0,
  • "firmware":
    {
    },
  • "model":
    {
    },
  • "custom_setup":
    {
    },
  • "ins_id": "string",
  • "ins_date": "string",
  • "upd_id": "string",
  • "upd_date": "string"
}

DeployByConfiguration

デプロイConfigで指定した次の機能をエッジデバイスにデプロイします。

  • エッジシステムソフトウェア
  • AIモデル
  • カスタム設定ファイル
path Parameters
config_id
required
string

設定ID。

query Parameters
device_ids
required
string

デバイスIDを複数指定するには、カンマで区切ります。

replace_model_id
string
Default: ""

モデルIDまたはnetwork_idを指定します。
※指定したモデルIDがデータベースに存在しない場合は、入力した値をnetwork_idとして使用します。

comment
string
Default: ""

指定できる文字数は100文字までです。

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS",
  • "deploy_id": 12345
}

DeleteDeployConfiguration

指定したデプロイConfigを削除します。

path Parameters
config_id
required
string

デプロイConfigのID

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

CancelDeployment

エッジデバイス上で実行されるエッジシステムソフトウェア、AIモデル、エッジアプリケーションなどのコア機能のデプロイを中止します。デプロイがまだ行われていないエッジデバイスに対して操作を中止します。デプロイがすでに行われている場合は、本操作による変更はありません。

path Parameters
device_id
required
string

デバイスID。

deploy_id
required
integer

デプロイID

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetDeployHistory

エッジデバイス上で実行されるエッジシステムソフトウェア、AIモデル、エッジアプリケーションなどのコア機能のデプロイ履歴を返します。

path Parameters
device_id
required
string

デバイスID。

Responses

Response samples

Content type
application/json
{
  • "deploys":
    [
    ]
}

GetDeployStatusHistory

デプロイメントレイヤーに対するデプロイ履歴をリスト化します。

query Parameters
deploy_id
integer

デプロイID。

app_deploy_id
integer

アプリケーションのデプロイID。

from_datetime
string

デプロイ開始日時（形式: 'yyyyMMddhhmm'）に、未来の時刻を指定できません。

to_datetime
string

デプロイ終了日時（形式: 'yyyyMMddhhmm'）に、未来の時刻やfrom_datetimeよりも早い時刻を指定できません。

top
required
number
Default: 20

返すレコード数。100を指定した場合は、100件取得します。

skip
required
number
Default: 0

取得をスキップするレコード数。100を指定した場合は、101件目からデータを取得します。

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

GetDeployStatus

指定したデプロイIDのステータスを返します。

path Parameters
deploy_id
required
integer

デプロイID。

deploy_type
required
string

デプロイの種類

  • 設定値
    config
    app

Responses

Response samples

Content type
application/json
{
  • "deploy_id": 10,
  • "from_datetime": "2023-09-06T13:50:07.930666+00:00",
  • "deploy_type": "1",
  • "running_cnt": 3,
  • "success_cnt": 5,
  • "fail_cnt": 3,
  • "config_id": "config_230812",
  • "dnn_model": "zonedection_20230824_v1.0",
  • "dnn_model_version": "1.00",
  • "device_firmware": "D70004",
  • "device_sensor": "910701",
  • "device_sensor_loader": "920301",
  • "gamma_mode": "custom",
  • "gamma_file_name": "gamma_file_v1.00",
  • "devices":
    [
    ]
}

DeployDeviceModel

指定したエッジデバイスにデバイスモデルをデプロイします。

path Parameters
model_id
required
string

AIモデルのID。

device_id
required
string

デバイスID。

query Parameters
version_number
string
Default: ""

バージョン番号

replace_model_id
string
Default: ""

モデルIDを置き換えます。

comment
string
Default: ""

対象の説明。※指定できる文字数は100文字までです。

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

UndeployModel

指定されたデバイスの特定のモデルをアンデプロイします。

path Parameters
device_id
required
string

デバイスID。

model_id
required
string

AIモデルのID。

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

Train Model

GetTrainingKits

トレーニングキットの情報をリスト化します。

query Parameters
order_by
string
Default: "asc"

ソート順：トレーニングキットの作成日順に並び替えます。 値の範囲: desc、asc

Responses

Response samples

Content type
application/json
{
  • "training_kits":
    [
    ]
}

GetProjects

パラメーターで指定した条件に一致するプロジェクトを検索して返します。パラメーターを指定していない場合は、作成したすべてのプロジェクトが返されます。

query Parameters
project_name
string

プロジェクト名。※あいまい検索が可能です。

model_platform
string

AIモデルのプラットフォームを指定します。

  • 設定値
    0：Custom Vision
    1：Non-Custom Vision
project_type
string

プロジェクトの種類

  • 設定値
    0：Base Model
    1：Device Model
device_id
string

デバイスID。

include_training_flg
string
Default: "0"

プロジェクトのproperty情報を取得するには、"1 "を指定してください。

Responses

Response samples

Content type
application/json
{
  • "model_projects":
    [
    ]
}

CreateBaseProject

ベースモデルで使用するプロジェクトを作成します。

query Parameters
project_name
required
string

プロジェクト名。指定できる文字数は50文字までです。

training_kit
required
string

トレーニングキットのID。

comment
string

対象の説明。指定できる文字数は100文字までです。

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

CreateDeviceProject

指定したモデルのベースモデルに基づいて、デバイスモデル用のプロジェクトを作成します。

query Parameters
project_name
required
string

プロジェクト名。指定できる文字数は50文字までです。

model_id
required
string

AIモデルのID。

device_id
required
string

デバイスID。

version_number
string

バージョン番号デフォルトでは最新バージョンが使用されます。

comment
string

対象の説明。指定できる文字数は100文字までです。

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetProject

指定したプロジェクトの情報をリスト化します。

path Parameters
project_name
required
string

プロジェクト名。

query Parameters
include_training_flg
string
Default: "0"

プロジェクトのproperty情報を取得するには、"1 "を指定してください。

Responses

Response samples

Content type
application/json
{
  • "model_project_name": "string",
  • "model_project_id": "string",
  • "model_platform": "string",
  • "model_type": "string",
  • "project_type": "string",
  • "device_id": "string",
  • "project_model_file_name": "string",
  • "project_model_accuracy": "string",
  • "project_comment": "string",
  • "project":
    {
    },
  • "model":
    {
    }
}

DeleteProject

指定したプロジェクトを削除します。 ※プロジェクトにモデルが既に保存されている場合は、DeleteModel APIを使用して削除してください。

path Parameters
project_name
required
string

プロジェクト名。

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

SaveModel

Base ProjectまたはDevice Projectから、変換前のモデルをエクスポートして保存します。

path Parameters
project_name
required
string

プロジェクト名。

query Parameters
model_id
string

AIモデルのID。指定できる文字数は半角20文字までです。 ※新しいBase Modelを登録する場合にのみ指定します。

initial_version_number
integer
Default: "1"

初期バージョン番号。 ※新しいBase Modelを登録する場合にのみ指定します。

  • 値の範囲：1〜99
functionality
string

機能の説明。指定できる文字数は100文字までです。 ※新しいBase Modelを登録する場合にのみ指定します。

vendor_name
string

ベンダー名。指定できる文字数は100文字までです。 ※新しいBase Modelを登録する場合にのみ指定します。

comment
string

対象の説明。指定できる文字数は100文字までです。 ※新規保存時に、モデルおよびバージョンの説明として設定されます。 ※バージョンアップ時は、バージョンの説明として設定されます。

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetRelearnStatus

特定のAIモデルの再学習ステータスを返します。

path Parameters
project_name
required
string

プロジェクト名。

Responses

Response samples

Content type
application/json
{
  • "result": "string",
  • "status": "string"
}

Relearn

指定したプロジェクトで再学習を行います。

path Parameters
project_name
required
string

プロジェクト名。

query Parameters
training_type
string
Default: "Regular"

学習の手法。※Custom Visionのプロジェクトでのみ指定できます。

  • 設定値
    Regular：簡易学習。
    Advanced：詳細学習。
    ※予算の割り当て（時間単位）をreserved_budget_in_hoursパラメーターで指定します。
reserved_budget_in_hours
string
Default: "1"

時間単位による予算。※Custom Visionプロジェクトでtraining_typeがAdvancedに設定されている場合に指定します。

Responses

Response samples

Content type
application/json
{
  • "result": "string",
  • "iteration_id": "string",
  • "iteration_name": "string"
}

ImportImagesFromFiles

再学習に使用する画像ファイルをプロジェクトにインポートします。

path Parameters
project_name
required
string

プロジェクト名。

Request Body schema: application/json
required
Array of objects
tags_name
Array of any
Default: []

ラベル。 ※分類したいときに使用します。1つのタグに対して適用できます。

Responses

Request samples

Content type
application/json
{
  • "images":
    [
    ],
  • "tags_name": [ ]
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

ImportImagesFromScblob

再学習に使用する画像ファイルをAzure Blob Storage経由でプロジェクトにインポートします。

path Parameters
project_name
required
string
Request Body schema: application/json
container_url
required
string

Blob Storage ContainerのSAS URL。※読み取りおよび一覧表示の権限が必要です。

tags_name
Array of any
Default: []

ラベル。 ※分類したいときに使用します。1つのタグに対して適用できます。

Responses

Request samples

Content type
application/json
{
  • "container_url": "string",
  • "tags_name": [ ]
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetProjectIterations

指定したプロジェクトのイテレーション情報をリスト化します。

path Parameters
project_id
required
string

プロジェクトID。

query Parameters
overlap_threshold
string
Default: "0.3"

オーバーラップの閾値。バウンディングボックスのオーバーラップ閾値。正確な予測ができているか判定します。

threshold
string
Default: "0.5"

正確な予測ができているか判定する閾値。

Responses

Response samples

Content type
application/json
{
  • "iterations":
    [
    ]
}

GetProjectImages

指定されたプロジェクトに登録されている画像およびその情報を取得します。

path Parameters
project_id
required
string

プロジェクトID。

query Parameters
iteration_id
string

イテレーションID。

order_by
string
Default: "newest"

ソート順：画像の作成日順に並べ替えます。
値の範囲：newest、oldest

number_of_images
string
Default: 50

情報を取得する画像数。
値の範囲：0～256

skip
string
Default: 0

情報の取得をスキップする画像数。

image_size_type
string
Default: "リサイズ"

画像サイズの種類。※Custom Visionのプロジェクトでのみ指定できます。

  • 設定値
    resized
    thumbnail
    original

Responses

Response samples

Content type
application/json
{
  • "total_image_count": 0,
  • "images":
    [
    ]
}

DeleteProjectImages

画像IDを指定してプロジェクトから画像を削除します。

path Parameters
project_id
required
string

プロジェクトID。

query Parameters
image_ids
required
string

画像のID。※複数指定するには、カンマで区切ります。指定できるIDは、1から256までです。

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetProjectImagesById

プロジェクトに含まれる画像のうち、指定した画像IDの情報をリスト化します。

path Parameters
project_id
required
string

プロジェクトID。

query Parameters
image_ids
required
string

画像のID。※複数指定するには、カンマで区切ります。指定できるIDは、1から256までです。

iteration_id
string

イテレーションID。

image_size_type
string
Default: "resized"

画像サイズの種類。※Custom Visionのプロジェクトでのみ指定できます。

  • 設定値
    resized
    thumbnail
    original

Responses

Response samples

Content type
application/json
{
  • "images":
    [
    ]
}

GetImageRegionProposals

指定した画像IDに対して、画像検出の領域提案（推論結果）を取得します。

path Parameters
project_id
required
string

プロジェクトID。

image_id
required
string

画像ID。

Responses

Response samples

Content type
application/json
{
  • "project_id": "string",
  • "image_id": "string",
  • "proposals":
    [
    ]
}

CreateProjectImageRegions

プロジェクトに保存されている画像にタグ付けします。

path Parameters
project_id
required
string

プロジェクトID。

Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "regions":
    [
    ]
}

Response samples

Content type
application/json
{
  • "created":
    [
    ],
  • "duplicated":
    [
    ],
  • "exceeded":
    [
    ]
}

UpdateProjectImageRegions

プロジェクト内で画像に適用されたタグを更新します。

path Parameters
project_id
required
string

対象の説明。

Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "regions":
    [
    ]
}

Response samples

Content type
application/json
{
  • "updated":
    [
    ]
}

DeleteProjectImageRegions

プロジェクト内の画像からタグを削除します。

path Parameters
project_id
required
string

プロジェクトID。

region_id
required
string

リージョンID。

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetProjectTags

プロジェクトに適用されているタグをリスト化します。

path Parameters
project_id
required
string

プロジェクトID。

query Parameters
iteration_id
string

イテレーションID。

order_by
string
Default: "asc"

ソート順：タグの作成日順に並べ替えます。
値の範囲: asc, desc

Responses

Response samples

Content type
application/json
{
  • "tags":
    [
    ]
}

CreateProjectTag

指定したプロジェクトに新しいタグを作成します。

path Parameters
project_id
required
string

プロジェクトID。

query Parameters
tag_name
required
string

タグの名称。

description
string

対象の説明。

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "type": "string",
  • "image_count": "string"
}

DeleteProjectTag

指定したプロジェクトからタグを削除します。

path Parameters
project_id
required
string

プロジェクトID。

tag_id
required
string

タグ ID。

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

UpdateProjectTag

プロジェクトに適用されているタグを更新します。

path Parameters
project_id
required
string

プロジェクトID。

tag_id
required
string

タグ ID。

Request Body schema: application/json
name
required
string

名前。

description
string

対象の説明。

type
required
string

タイプ。※Regularのみ指定できます。

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "type": "string",
  • "image_count": "string"
}

GetProjectTaggedImages

プロジェクト内のタグ付き画像の情報を返します。

path Parameters
project_id
required
string

プロジェクトID。

query Parameters
tag_ids
string

タグのID。※複数指定するには、カンマで区切ります。

iteration_id
string

イテレーションID。

number_of_images
integer
Default: 50

取得する画像の数。 値の範囲：0～256

skip
integer
Default: 0

情報の取得をスキップする画像数。

order_by
string
Default: "newest"

ソート順：画像の作成日順に並べ替えます。 値の範囲：newest、oldest

image_size_type
string
Default: "resized"

画像サイズの種類。※Custom Visionのプロジェクトでのみ指定できます。

  • 設定値
    resized
    thumbnail
    original

Responses

Response samples

Content type
application/json
{
  • "total_image_count": 0,
  • "tagged_images":
    [
    ],
  • "blank_tags":
    [
    ]
}

GetProjectUntaggedImages

プロジェクト内で、タグを適用していない画像の情報を返します。

path Parameters
project_id
required
string

プロジェクトID。

query Parameters
iteration_id
string

イテレーションID。

number_of_images
integer
Default: 50

取得する画像の数。 値の範囲：0～256

skip
integer
Default: 0

情報の取得をスキップする画像数。

order_by
string
Default: "newest"

ソート順：画像の作成日順に並べ替えます。 値の範囲：newest、oldest

image_size_type
string
Default: "resized"

画像サイズの種類。※Custom Visionのプロジェクトでのみ指定できます。

  • 設定値
    resized
    thumbnail
    original

Responses

Response samples

Content type
application/json
{
  • "total_image_count": 0,
  • "untagged_images":
    [
    ]
}

GetModels

モデルの情報をリスト化します。

query Parameters
model_id
string

AIモデルのIDです。※あいまい検索が可能です。

comment
string

モデルの説明。※あいまい検索が可能です。

project_name
string

プロジェクト名。※あいまい検索が可能です。

model_platform
string

AIモデルのプラットフォームを指定します。

  • 設定値
    0：Custom Vision
    1：Non-Custom Vision
project_type
string

プロジェクトの種類を指定します。

  • 設定値
    0：Base Model
    1：Device Model
device_id
string

デバイスのIDを並び替えます。

latest_type
string
Default: "1"

最新バージョンの種別。

  • 設定値
    0：最新の公開バージョン。
    1：変換処理または公開が完了した最新バージョン。

Responses

Response samples

Content type
application/json
{
  • "models":
    [
    ]
}

ImportBaseModel

Base Modelをプロジェクトにインポートします。新しいモデルIDは、新規登録されます。登録済みのIDを指定した場合は、上書きされます。

Request Body schema: application/json
One of
model
required
string

モデルファイルのSAS URLまたはPresigned URL。

input_format_param
string

入力フォーマットパラメーターファイルのSAS URLまたはPresigned URL。
※用途：パッケージャー変換情報（画像フォーマット情報）。
※json形式はオブジェクトの配列です。各オブジェクトには以下の値が含まれます。
 ・ordinal：コンバーターへのDNN入力の順序（値の範囲: 0～2)
 ・format：フォーマット（"RGB"または"BGR"）
※例：  [{      "ordinal":0,      "format":"RGB"
 },  {
     "ordinal":1,      "format":"RGB"
 }]

network_config
string

ネットワークコンフィグファイルのSAS URLまたはPresigned URL。
※用途：モデルコンバーターの変換パラメーター情報です。そのため、変換前のモデルを指定する場合には指定する必要はありません。
※例：  {
   "Postprocessor": {
     "params": {
       "background": false,        "scale_factors": [
         10.0,          10.0,          5.0,          5.0
       ],        "score_thresh":0.01,        "max_size_per_class":64,        "max_total_size":64,        "clip_window": [
         0,          0,          1,          1
       ],        "iou_threshold":0.45
     }
   }
 }

model_id
required
string

新規登録またはバージョンアップで使用するモデルID。指定できる文字数は100文字までです。

converted
boolean
Default: false

指定したモデルファイルを変換するかどうかを指定します。

vendor_name
string

ベンダー名。指定できる文字数は100文字までです。 ※新しいBase Modelを登録する場合にのみ指定します。

comment
string

対象の説明。指定できる文字数は100文字までです。 ※新規保存時に、モデルおよびバージョンの説明として設定されます。 ※バージョンアップ時は、バージョンの説明として設定されます。

network_type
string
Default: "1"

モデルにアプリケーションが必要かどうかを指定。

  • 設定値
    0：必要
    1：不要
metadata_format_id
string

メタデータフォーマットID。指定できる文字数は100文字までです。

Responses

Request samples

Content type
application/json
Example
input_model_url
input_model_url
file_id
{
  • "model": "string",
  • "input_format_param": "string",
  • "network_config": "string",
  • "model_id": "string",
  • "converted": false,
  • "vendor_name": "string",
  • "comment": "string",
  • "network_type": "1",
  • "metadata_format_id": "string"
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

PublishModel

AIモデルをConvertします。 この処理には時間がかかるため、非同期で行われます。 ※処理状況を確認するには、GetBaseModelStatus APIの結果、またはGetDeviceModelStatus APIのレスポンスを確認してください。処理が完了すると「Import completed」が返されます。

path Parameters
model_id
required
string

AIモデルのID。

query Parameters
device_id
string

デバイスID。 ※Device Modelが対象の場合に指定します。 Base Modelが対象の場合は指定の必要はありません。

Responses

Response samples

Content type
application/json
Example
SUCCESS
SUCCESS
WARNING
{
  • "result": "SUCCESS",
  • "import_id": "550e8400-e29b-41d4-a716-446655440000"
}

DeleteModel

指定したモデル ID に紐づくBase Model、Device Model、プロジェクトを削除します。

path Parameters
model_id
required
string

AIモデルのID。

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

UpdateModel

指定したAIモデルの属性情報を更新します。

path Parameters
model_id
required
string

AIモデルのID。指定できる文字数は100文字までです。

query Parameters
comment
string

対象の説明。指定できる文字数は100文字までです。

version_number
string

ベンダー名。指定できる文字数は100文字までです。

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetBaseModelStatus

指定したBase Modelの情報を取得します。

path Parameters
model_id
required
string

AIモデルのID。

query Parameters
latest_type
string
Default: "1"

最新バージョンの種別。

  • 設定値
    0：最新の公開バージョン。
    1：変換処理または公開が完了した最新バージョン。

Responses

Response samples

Content type
application/json
{
  • "model_id": "string",
  • "model_type": "string",
  • "functionality": "string",
  • "vendor_name": "string",
  • "model_comment": "string",
  • "network_type": "string",
  • "create_by": "string",
  • "package_id": "string",
  • "product_id": "string",
  • "metadata_format_id": "string",
  • "projects":
    [
    ]
}

GetBaseModelVersions

ベースモデルのバージョンを表示します。

path Parameters
model_id
required
string

AIモデルのID。

query Parameters
version_number
string

バージョン番号

scope
string
Default: "full"

返却されるレスポンスパラメーターの範囲。

  • 設定値
    full :すべてのパラメーターを返します。
    minimal：最小限のパラメーターを返します。 ※時間の短縮に有効です。

Responses

Response samples

Content type
application/json
{
  • "model_id": "string",
  • "model_type": "string",
  • "functionality": "string",
  • "vendor_name": "string",
  • "model_comment": "string",
  • "network_type": "string",
  • "create_by": "string",
  • "package_id": "string",
  • "product_id": "string",
  • "metadata_format_id": "string",
  • "projects":
    [
    ]
}

UpdateBaseModelVersion

指定したBase Modelバージョンの属性情報を更新します。

path Parameters
model_id
required
string

AIモデルのID。

version_number
required
string

バージョン番号

Request Body schema: application/json
comment
string

バージョンの説明。指定できる文字数は100文字までです。

input_format_param
string

入力フォーマットパラメーターファイルのSAS URLまたはPresigned URL。
※用途：パッケージャー変換情報（画像フォーマット情報）。
※json形式はオブジェクトの配列です。各オブジェクトには以下の値が含まれます。
 ・ordinal：コンバーターへのDNN入力の順序（値の範囲: 0～2)
 ・format：フォーマット（"RGB"または"BGR"）
※例：  [{      "ordinal":0,      "format":"RGB"
 },  {
     "ordinal":1,      "format":"RGB"
 }]

network_config
string

ネットワークコンフィグファイルのSAS URLまたはPresigned URL。 ※用途：モデルコンバーターの変換パラメーター情報です。そのため、変換前のモデルを指定する場合には指定する必要はありません。 ※例：  {
   "Postprocessor": {
     "params": {
       "background": false,        "scale_factors": [
         10.0,          10.0,          5.0,          5.0
       ],        "score_thresh":0.01,        "max_size_per_class":64,        "max_total_size":64,        "clip_window": [
         0,          0,          1,          1
       ],        "iou_threshold":0.45
     }
   }
 }

Responses

Request samples

Content type
application/json
{
  • "comment": "string",
  • "input_format_param": "string",
  • "network_config": "string"
}

Response samples

Content type
application/json
{
  • "model_id": "string",
  • "model_type": "string",
  • "functionality": "string",
  • "vendor_name": "string",
  • "model_comment": "string",
  • "network_type": "string",
  • "create_by": "string",
  • "package_id": "string",
  • "product_id": "string",
  • "metadata_format_id": "string",
  • "projects":
    [
    ]
}

GetDeviceModelStatus　

指定したデバイスモデルの情報を取得します。

path Parameters
model_id
required
string

AIモデルのID。

device_id
required
string

デバイスID。

query Parameters
latest_type
string
Default: "1"

最新バージョンの種別。

  • 設定値
    0：公開した最新バージョン。
    1：変換処理または公開が完了した最新バージョン。

Responses

Response samples

Content type
application/json
{
  • "model_id": "string",
  • "model_type": "string",
  • "functionality": "string",
  • "vendor_name": "string",
  • "model_comment": "string",
  • "network_type": "string",
  • "create_by": "string",
  • "package_id": "string",
  • "product_id": "string",
  • "metadata_format_id": "string",
  • "projects":
    [
    ]
}

GetDeviceModelVersions

Device Modelのバージョン情報をリスト化します。

path Parameters
model_id
required
string

AIモデルのID。

device_id
required
string

デバイスID。

query Parameters
scope
string
Default: "full"

返却されるレスポンスパラメーターの範囲。

  • 設定値
    full :すべてのパラメーターを返します。
    minimal：最小限のパラメーターを返します。 ※時間の短縮に有効です。
version_number
string

バージョン番号

Responses

Response samples

Content type
application/json
{
  • "model_id": "string",
  • "model_type": "string",
  • "functionality": "string",
  • "vendor_name": "string",
  • "model_comment": "string",
  • "network_type": "string",
  • "create_by": "string",
  • "package_id": "string",
  • "product_id": "string",
  • "metadata_format_id": "string",
  • "projects":
    [
    ]
}

UpdateDeviceModelVersion

指定したエッジデバイスに対して、AIモデルバージョンの属性情報を更新します。

path Parameters
model_id
required
string

AIモデルのID。

device_id
required
string

デバイスID。

version_number
required
string

バージョン番号

Request Body schema: application/json
comment
string

バージョンの説明。

Responses

Request samples

Content type
application/json
{
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetDnnParams

指定したAIモデルのdnn_paramsを取得します。

path Parameters
model_id
required
string

AIモデルのID。

query Parameters
version_number
string
Default: "latest"

バージョン番号

device_id
string

デバイスID。 ※Device Modelが対象の場合に指定します。 Base Modelが対象の場合は指定の必要はありません。

Responses

Response samples

Content type
application/json
{
  • "contents": "string"
}

Firmware

GetFirmwares

エッジシステムソフトウェアの情報をリスト化します。

query Parameters
firmware_type
string

エッジシステムソフトウェアの種類とID。

  • 設定値
    00：Main Chip Firmware
    01：Sensor Chip Firmware (main)
    02：Sensor Chip Firmware (loader)

Responses

Response samples

Content type
application/json
{
  • "firmwares":
    [
    ]
}

CreateFirmware

選択したエッジシステムソフトウェアをConsoleに登録します。

Request Body schema: application/json
firmware_type
required
string

エッジシステムソフトウェアの種類とID。

  • 設定値
    00：Main Chip Firmware
    01：Sensor Chip Firmware (main)
    02：Sensor Chip Firmware (loader)
version_number
required
string

バージョン番号。

comment
string
Default: ""

説明文。※指定できる文字数は100文字までです。

file_name
required
string

エッジシステムソフトウェアのファイル名。

file_content
required
string

Base64エンコード済みのファームウェアファイル。

Responses

Request samples

Content type
application/json
{
  • "firmware_type": "string",
  • "version_number": "string",
  • "comment": "",
  • "file_name": "string",
  • "file_content": "string"
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetFirmware

選択したエッジシステムソフトウェアの情報を取得します。

path Parameters
firmware_type
required
string

エッジシステムソフトウェアの種類とID。

  • 設定値
    00：Main Chip Firmware
    01：Sensor Chip Firmware (main)
    02：Sensor Chip Firmware (loader)
version_number
required
string

バージョン番号

Responses

Response samples

Content type
application/json
{
  • "firmware_id": "string",
  • "firmware_type": "string",
  • "comment": "string",
  • "ins_id": "string",
  • "ins_date": "string",
  • "upd_id": "string",
  • "upd_date": "string",
  • "versions":
    [
    ]
}

DeleteFirmware

選択したエッジシステムソフトウェアをConsoleから削除します。

path Parameters
firmware_type
required
string

エッジシステムソフトウェアの種類とID。

  • 設定値
    00：Main Chip Firmware
    01：Sensor Chip Firmware (main)
    02：Sensor Chip Firmware (loader)
version_number
required
string

バージョン番号

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

Device App

GetDeviceApps

エッジデバイス上で実行される、エッジアプリケーションの情報をリスト化します。

Responses

Response samples

Content type
application/json
{
  • "apps":
    [
    ]
}

ImportDeviceApp

エッジデバイスにデプロイする、エッジデバイスアプリケーションをConsoleにインポートします。

Request Body schema: application/json
compiled_flg
required
string

対象アプリケーションのコンパイル状況（フラグ）。

  • 設定値
    0：コンパイル未実施
    1：コンパイル済み
entry_point
string
Default: "ppl"

アプリケーションのエントリーポイント。

app_name
required
string

アプリケーションの名称。 ※以下の文字が利用できます。 英数字
アンダーバー
ドット
※設定できる文字数は app_name + version_number <=31 までです。

version_number
required
string

アプリケーションのバージョン番号。 ※以下の文字が利用できます。 英数字
アンダーバー
ドット
※設定できる文字数は app_name + version_number <=31 までです。

comment
string

対象の説明。※指定できる文字数は100文字までです。

file_name
required
string

対象ファイルの名称。

file_content
required
string

Base64エンコード済みのアプリケーションファイル。

object

スキーマ情報。

Responses

Request samples

Content type
application/json
{
  • "compiled_flg": "string",
  • "entry_point": "ppl",
  • "app_name": "string",
  • "version_number": "string",
  • "comment": "string",
  • "file_name": "string",
  • "file_content": "string",
  • "schema_info":
    {
    }
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetDeviceApp

エッジアプリケーションの情報を取得します。

path Parameters
app_name
required
string

アプリケーション名。

version_number
required
string

アプリケーションのバージョン。

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "create_by": "string",
  • "package_id": "string",
  • "product_id": "string",
  • "schema_info":
    {
    },
  • "version": "string",
  • "compiled_flg": "string",
  • "status": "string",
  • "comment": "string",
  • "deploy_count": { },
  • "ins_id": "string",
  • "ins_date": "string",
  • "upd_id": "string",
  • "upd_date": "string"
}

DeleteDeviceApp

指定したエッジアプリケーションをConsoleから削除します。

path Parameters
app_name
required
string

アプリケーション名。

version_number
required
string

アプリケーションのバージョン。

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

ExportDeviceApp

指定したエッジアプリケーションをエクスポートします。

path Parameters
app_name
required
string

アプリケーション名。

version_number
required
string

アプリケーションのバージョン。

Responses

Response samples

Content type
application/json
{
  • "contents": "string",
  • "file_name": "string"
}

GetDeviceAppDeploys

指定したエッジアプリケーションのデプロイ状況を取得します。

path Parameters
app_name
required
string

アプリケーション名。

version_number
required
string

アプリケーションのバージョン。

Responses

Response samples

Content type
application/json
{
  • "deploys":
    [
    ]
}

GetAppDevices

エッジアプリケーションのデプロイ情報をリスト化します。

path Parameters
app_name
required
string

アプリケーション名。

version_number
required
string

アプリケーションのバージョン。

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

DeployDeviceApp

エッジアプリケーションをデバイスにデプロイします。

Request Body schema: application/json
app_name
required
string

アプリケーション名。

version_number
required
string

アプリケーションのバージョン。

device_ids
required
string

デバイスIDを複数指定するには、カンマで区切ります。

comment
string

対象の説明。※指定できる文字数は100文字までです。

Responses

Request samples

Content type
application/json
{
  • "app_name": "string",
  • "version_number": "string",
  • "device_ids": "string",
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "result": "string",
  • "app_deploy_id": 0
}

UndeployDeviceApp

エッジアプリケーションをデバイスからアンデプロイします。

query Parameters
device_ids
required
string

対象のデバイスID。

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

Insight

ExportImages

指定された条件に基づいて、画像をZIPファイル形式でエクスポートするURLを返します。 ※リンクは暗号化されているため、他の環境での画像学習にも利用できます。

[前提条件]

  • 返されるURLにアクセスと、対象の画像をZIPファイル形式でダウンロードできます。 画像は次の方法で暗号化されます。
  • 画像は、APIによってランダムに生成された共有鍵を使って暗号化されます。この共有鍵は画像の復号に必要です。
  • 暗号化はAES128のCBCモードで行われます。
  • ZIPファイルには、iv（※1）と暗号化された（※2）の情報が含まれます。 ※1.最初の16バイトは初期化ベクトル（iv）を表します。復号する際は、この iv を使用します。 ※2.暗号化された画像データは17バイト目以降に格納されます。画像は、AESブロックサイズ16バイトのPKCS7アルゴリズムでパディングされます。復号する際は、最初の16バイト（iv）を除いた、残りのデータを復号してパディングを解除してください。
  • 共有鍵は、APIが提供するキー（※3）を秘密鍵で復号することで取得できます。 ※3.APIが提供する鍵は、OAEPパディングを使用してRSA暗号化を行い、Base64形式でエンコードされています。復号する際は、Base64をデコードしてから結果を復号します。

[鍵の生成］

  • 公開鍵と秘密鍵はSierによって生成されます。

  • 鍵の長さは1024ビットまたは2048ビットのいずれかで発行されます。

  • APIにパラメーターとして提供される公開鍵は、Base64形式にエンコードした、PEMファイルである必要があります。

    例：文字列全体を以下のようにBase64形式にエンコードします。

    -----BEGIN PUBLIC KEY-----
    MIGfMA0GCSqGSIb3DQEBAQUAA4GNADC
    ..
    -----END PUBLIC KEY-----

query Parameters
key
required
string

公開鍵。 ※Base64形式にエンコードされた公開鍵（PEMファイル）。

from_datetime
string
Default: ""

日時（開始）。

  • フォーマット：yyyyMMddhhmm
to_datetime
string
Default: ""

日時（終了）。

  • フォーマット：yyyyMMddhhmm
device_id
string
Default: ""

デバイスID。

file_format
string
Default: ""

画像のファイル形式。指定がない場合は、フィルタリングされません。

  • 設定値
    JPG
    BMP

Responses

Response samples

Content type
application/json
{
  • "key": "string",
  • "url": "string"
}

GetImageDirectories

画像が保存されているディレクトリー情報（デバイスグループおよびデバイス情報）を取得します。

query Parameters
device_id
string

デバイスID。 指定したデバイスIDの画像ディレクトリーをリスト化します。

include_deleted_device
boolean
Default: false

Consoleから削除したデバイスに保存されている画像を含めるかどうかを指定します。

Responses

Response samples

Content type
application/json
[
  • {
    }
]

GetImages

特定のエッジデバイスから出力された画像を取得します。 ※用途：UIでの画像表示。 ※Developer Edition V1.7.0以降をお使いの場合は、GetImages Stable API を使用してください。

path Parameters
device_id
required
string

デバイスID。

sub_directory_name
required
string

ディレクトリー名。

query Parameters
order_by
string
Default: "ASC"

ソート順：画像の作成日順に並べ替えます。 値の範囲：DESC、ASC

number_of_images
integer
Default: 50

情報を取得する画像数。 値の範囲：0～256

skip
integer
Default: 0

情報の取得をスキップする画像数。

from_datetime
string
Default: ""

日時（開始）。

  • フォーマット：yyyyMMddhhmm
to_datetime
string
Default: ""

日時（終了）。

  • フォーマット：yyyyMMddhhmm
include_deleted_device
boolean
Default: false

Consoleから削除したデバイスに保存されている画像を含めるかどうかを指定します。

Responses

Response samples

Content type
application/json
{
  • "total_image_count": 0,
  • "images":
    [
    ]
}

DeleteImages

特定のエッジデバイスから出力された画像を削除します。 ※Developer Edition V1.7.0 以降をお使いの場合は、DeleteImages Stable API を使用してください。

path Parameters
device_id
required
string

デバイスID。

sub_directory_name
required
string

ディレクトリー名。

Request Body schema: application/json
directory_deletion
string
Default: "0"

画像の削除方法を指定するフラグ。

  • 設定値
    0：ファイルを指定して削除
    1：ディレクトリーを指定して削除
filenames
Array of strings

directory_deletionが0のときに削除するファイル。

Responses

Request samples

Content type
application/json
{
  • "directory_deletion": "0",
  • "filenames":
    [
    ]
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetImages Stable

特定のエッジデバイスから出力された画像をダウンロードするためのSAS URLを返します。データをダウンロードするにはURLをコピーして使用します。 取得したURLは1時間有効です。 ※このAPIは、Developer Edition V1.7.0以降に対応しています。

path Parameters
device_id
required
string

デバイスID。

sub_directory_name
required
string

ディレクトリー名。

query Parameters
limit
integer
Default: 50

情報を取得する画像数。 値の範囲：1～256

starting_after
string

クエリパラメーター（limit）で指定した画像数に追加でデータを取得します。画像を引き続き取得するには、レスポンスで得られる値（continuation_token）を指定してください。

name_starts_with
string
Default: ""

入力文字列と前方一致するオブジェクトのみを返します。

Responses

Response samples

Content type
application/json
{
  • "continuation_token": "string",
  • "data":
    [
    ]
}

DeleteImages Stable

特定のエッジデバイスから出力された画像を削除します。 ※このAPIは、Developer Edition V1.7.0以降に対応しています。

path Parameters
device_id
required
string

デバイスID。

sub_directory_name
required
string

ディレクトリー名。

Request Body schema: application/json
directory_deletion
string
Default: "0"

画像の削除方法を指定するフラグ。

  • 設定値
    0：ファイルを指定して削除
    1：ディレクトリーを指定してファイルを削除
filenames
Array of strings

directory_deletionが0のときに削除するファイル。

limit
integer
Default: 10000

削除する画像の数。古い画像から順に削除されます。 値の範囲：1～10000

Responses

Request samples

Content type
application/json
{
  • "directory_deletion": "0",
  • "filenames":
    [
    ],
  • "limit": 10000
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetInferenceResult

特定のエッジデバイスから出力された推論結果を取得します。

path Parameters
device_id
required
string

デバイスID。

id
required
string

推論結果のID。

Responses

Response samples

Content type
application/json
{
  • "DeviceID": "string",
  • "ModelID": "string",
  • "Image": true,
  • "Inferences":
    [
    ],
  • "id": "string",
  • "project_id": "string",
  • "_ts": 0
}

GetInferenceResults

特定のエッジデバイスから出力された推論結果を複数取得します。

path Parameters
device_id
required
string

デバイスID。

query Parameters
NumberOfInferenceresults
integer
Default: 20

情報を取得するアイテムの数。 指定した件数までの最新レコードを返します。※最大値：10,000

filter
string
Default: ""

検索フィルター。 ※仕様は以下の点を除いて変更ありません (AzureポータルのCosmosDB UIを除く)。

  • "where"句を先頭に追加する必要はありません。
  • deviceIDを含める必要もありません。

例：

  • モデルIDでフィルタリングする場合
    c.ModelID = "0201020001790103"
  • Cosmosのタイムスタンプでフィルタリングする場合
    c._ts > 1606897951
raw
integer
Default: 0

1を指定した場合は、レコードがCosmosDBに追加され、返されます。

  • 設定値
    0：追加しない
    1：追加
time
string
Default: ""

推論結果を以下の範囲で抽出します。

  • 抽出範囲
    (time - threshold) <= T ※推論結果メタデータ内の時刻 < (time + threshold)
    ※threshold = 5ミリ秒

  • 設定値
    yyyy：4桁の年を表す文字列
    MM：2桁の月を表す文字列
    dd：2桁の日を表す文字列
    HH：2桁の時間を表す文字列
    mm：2桁の分を表す文字列
    ss：2桁の秒を表す文字列
    ffff：3桁のミリ秒を表す文字列

include_deleted_device
boolean
Default: false

Consoleから削除したデバイスに保存されている推論結果を含めるかどうかを指定します。

Responses

Response samples

Content type
application/json
[
  • {
    }
]

DeleteInferenceResults

GetInferenceResults で取得した推論データを削除します。 ※このAPIは、Developer Edition V1.7.0以降に対応しています。

path Parameters
device_id
required
string

デバイスID。

query Parameters
item_ids
required
string
Example: item_ids=1,2,3,5

GetInferenceResultsから取得した削除対象の推論結果のID。

include_deleted_device
boolean
Default: false

Consoleから削除したデバイスに保存されている、複数の推論結果も削除するかどうか指定します。

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

Connector

UpdateIRHubConnector

エッジデバイスから取得した推論結果をAzure Event Hubsに転送するための外部転送設定を更新します。

Request Body schema: application/json
url
string

Azure Event Hubsに推論結果を転送するための接続文字です。※初期値に戻す場合は指定しないでください。初期値の場合は、サービス内でストリーム処理が行われます。

name
string

Azure Event Hubs のインスタンス名。※初期値に戻す場合は指定しないでください。初期値の場合は、サービス内でストリーム処理が行われます。

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

UpdateStorageConnector

ストレージハブコネクタを更新します。ストレージサービスに転送する項目（推論結果、画像、または両方）を指定してください。推論結果の送信先を変更するには、コマンドパラメーター内のUploadMethodIRの値を変更します。推論結果をクラウドストレージに保存する場合は、UploadMethodIRの値を「BlobStorage」に設定します。同様に、送信先をAITRIOS内部ストレージに戻す場合は、UploadMethodIRの値を「Mqtt」に設定してください。

Request Body schema: application/json
One of
type
string
Default: "AZURE"

ストレージサービスの種類。「AZURE」を指定します。

  • 設定値
    AZURE
mode
integer
Default: 0

画像、推論結果、またはその両方を含めるかどうかを指定します。

  • 設定値
    0：画像のみ
    1：画像と推論結果の両方
    2：推論結果のみ
endpoint
string

送信先となるAzure Blob Storageのエンドポイント。
※デフォルト値にリセットする場合は、“endpoint”、“connection_string”、“container_name”を指定しないでください。“mode”で「画像」を指定している場合は、ストリーム処理が行われます。“mode”で「推論結果」を指定している場合は、推論設定が削除されます。

connection_string
string

Azure Blob Storageの接続文字列。
※初期化する場合は、“endpoint”の説明を参照してください。

container_name
string

Azure Blob Storageのコンテナ名。
※初期化する場合は、“endpoint”の説明を参照してください。

Responses

Request samples

Content type
application/json
Example
Azure
Azure
AWS
{
  • "type": "AZURE",
  • "mode": 0,
  • "endpoint": "string",
  • "connection_string": "string",
  • "container_name": "string"
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

Utility

UploadFile

以下のAPIで使用するパラメーター（file ID）を返します。返された 'file_info.id' をパラメーターとして指定してください。

  • ImportBaseModel
Request Body schema: multipart/form-data
type_code
string
Enum: "NonConverted" "Converted" "InputFormatParam" "NetworkConfig" "CustomSetup"

ファイルタイプコード。

file
string <バイナリ>

ファイルの内容。

Responses

Response samples

Content type
application/json
{
  • "result": "string",
  • "file_info":
    {
    }
}