TF2 API (1.0.0)

Download OpenAPI specification:Download

TF2 QAI-Testbed API.

Login

ログイン情報入力

アカウントID、パスワードを入力し、ユーザ認証を行う。

Request Body schema: application/json

ログインユーザのアカウントIDとパスワードを設定

AccountId required	string ログインに使用するアカウントID
Password required	string ログインに使用するパスワード

Responses

Request samples

Payload

Content type

application/json

{"AccountId": "user",
"Password": "user_pass"
}

Response samples

200
403
404
500

Content type

application/json

{"Result": {"Code": "L01000",
"Message": "Login Success"
},
"UserInfo": {"UserId": 2,
"UserName": "開発者A",
"OrganizerId": 1,
"OrganizerName": "dep-A"
}
}

mlComponents

機械学習コンポーネント一覧表示.

ログインユーザの組織に紐付く機械学習コンポーネント一覧情報を取得し、機械学習コンポーネント一覧画面に遷移し表示

Authorizations:

cookieAuth

path Parameters

OrganizerId

required

string

組織ID(ログイン情報入力でのレスポンスから取得)

Responses

Response samples

200
401
404
500

Content type

application/json

{"Result": {"Code": "P12000",
"Message": "Success."
},
"mlComponents": [{"Id": 1,
"Name": "A社住宅価格予測-機械学習コンポーネント",
"Description": "A社の住宅価格を予測する機械学習コンポーネント",
"ProblemDomain": "重回帰分析",
"MLFrameworkName": "Tensorflow-2.3",
"GuidelineName": "AIQM Guideline"
},
{"Id": 2,
"Name": "B社文字認識-機械学習コンポーネント",
"Description": "B社の文字を認識する機械学習コンポーネント",
"ProblemDomain": "画像分類",
"MLFrameworkName": "Tensorflow-2.3",
"GuidelineName": "AIQM Guideline"
},
{"Id": 3,
"Name": "C社ゴルフスコア読取-機械学習コンポーネント",
"Description": "C社のスコア表枠組み、文字を認識する機械学習コンポーネント",
"ProblemDomain": "レイアウト認識、画像分類",
"MLFrameworkName": "Tensorflow-2.3",
"GuidelineName": "AIQM Guideline"
}
]
}

機械学習コンポーネント追加.

機械学習コンポーネントを追加する

Authorizations:

cookieAuth

path Parameters

OrganizerId

required

string

組織ID

Request Body schema: application/json

機械学習コンポーネント追加情報

Name required	string
Description required	string
ProblemDomain required	string 機械学習コンポーネントの対象とする問題領域を記載する。
MLFrameworkId required	integer 機械学習フレームワークのIDを記載する名称とIDはGET /mlFrameworksで取得する。
GuidelineId required	integer 関連するガイドラインIDを記載する。
ScopeId required	integer 関連するスコープIDを記載する。
GuidelineReason	string ガイドラインを選択した理由を記載する。
ScopeReason	string スコープを選択した理由を記載する。

Responses

Request samples

Payload

Content type

application/json

{"Name": "Fashion Classifier",
"Description": "Fashion image classification",
"ProblemDomain": "ImageClassification",
"MLFrameworkId": 1,
"GuidelineId": 1,
"ScopeId": 1,
"GuidelineReason": "This guideline fits the project.",
"ScopeReason": "This scope fits the project."
}

Response samples

Content type

application/json

{"Result": {"Code": "P22000",
"Message": "Success."
},
"MLComponentId": 4
}

機械学習コンポーネント追加（scrfトークンありで使用）.

機械学習コンポーネントを追加する（scrfトークンありで使用）

Authorizations:

cookieAuth

path Parameters

OrganizerId

required

string

組織ID

Request Body schema: application/json

機械学習コンポーネント追加情報

Name required	string
Description required	string
ProblemDomain required	string 機械学習コンポーネントの対象とする問題領域を記載する。
MLFrameworkId required	integer 機械学習フレームワークのIDを記載する名称とIDはGET /mlFrameworksで取得する。
GuidelineId required	integer 関連するガイドラインIDを記載する。
ScopeId required	integer 関連するスコープIDを記載する。
GuidelineReason	string ガイドラインを選択した理由を記載する。
ScopeReason	string スコープを選択した理由を記載する。

Responses

Request samples

Payload

Content type

application/json

{"Name": "Fashion Classifier",
"Description": "Fashion image classification",
"ProblemDomain": "ImageClassification",
"MLFrameworkId": 1,
"GuidelineId": 1,
"ScopeId": 1,
"GuidelineReason": "This guideline fits the project.",
"ScopeReason": "This scope fits the project."
}

Response samples

Content type

application/json

{"Result": {"Code": "P22000",
"Message": "Success."
},
"MLComponentId": 4
}

機械学習コンポーネント編集.

機械学習コンポーネントを編集する。
ガイドラインを使用中の場合（テストディスクリプション作成済み）、ガイドラインは変更できない。

Authorizations:

cookieAuth

path Parameters

OrganizerId required	string 組織ID
mlComponentsId required	integer 機械学習コンポーネントId

Request Body schema: application/json

Name	string
Description	string
ProblemDomain	string
MLFrameworkId	integer
GuidelineId	integer
ScopeId	integer 関連するスコープIDを記載する。
GuidelineReason	string ガイドラインを選択した理由を記載する。
ScopeReason	string スコープを選択した理由を記載する。

Responses

Request samples

Payload

Content type

application/json

{"Name": "Fashion Classifier",
"Description": "Fashion image classification",
"ProblemDomain": "ImageClassification",
"MLFrameworkId": 1,
"GuidelineId": 1,
"ScopeId": 1,
"GuidelineReason": "This guideline fits the project.",
"ScopeReason": "This scope fits the project."
}

Response samples

200
400
401
403
500

Content type

application/json

{"Result": {"Code": "P00000",
"Message": "Success."
},
"MLComponentId": 4
}

機械学習コンポーネント削除.

機械学習コンポーネント一覧表示から、選択した機械学習コンポーネントを削除する。削除する機械学習コンポーネントに関連するインベントリ情報とテストディスクリプション情報を削除する。

Authorizations:

cookieAuth

path Parameters

OrganizerId required	string 組織ID
mlComponentsId required	string 機械学習コンポーネントId

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"Result": {"Code": "P32000",
"Message": "success."
}
}

機械学習コンポーネントにレポート見解を登録.

機械学習コンポーネントにレポート見解を登録する。

Authorizations:

cookieAuth

path Parameters

OrganizerId required	string 組織ID
mlComponentsId required	integer 機械学習コンポーネントId

Request Body schema: application/json

ReportOpinion

string

Responses

Request samples

Payload

Content type

application/json

{"ReportOpinion": "All TDs meet the requirements"
}

Response samples

200
400
500

Content type

application/json

{"Result": {"Code": "P40000",
"Message": "Success."
},
"MLComponentId": 4
}

MLFrameworks

機械学習フレームワーク一覧取得.

機械学習フレームワークの一覧を取得する

Responses

Response samples

200
500

Content type

application/json

{"Result": {"Code": "M11000",
"Message": "Success."
},
"MLFrameworks": [{"Id": 1,
"Name": "Tensorflow-2.3"
}
]
}

Inventories

インベントリ一覧取得.

選択した機械学習コンポーネントとログインユーザの組織に紐付くインベントリの一覧を取得

Authorizations:

cookieAuth

path Parameters

OrganizerId required	string 組織ID
mlComponentsId required	integer 機械学習コンポーネントId

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"Result": {"Code": "I12000",
"Message": "Success."
},
"Inventories": [{"Id": 1,
"Name": "TestDataset_0818",
"DataType": {"Id": 1,
"Name": "dataset"
},
"Description": "1枚の手書き文字データ(28x28, png)のpng",
"Formats": [{"Id": 1,
"Name": "CSV"
},
{"Id": 2,
"Name": "PNG"
}
],
"FilePath": "/mnt/xxx/1",
"CreationDatetime": "2020-09-28T01:22:03.920542",
"UpdateDatetime": "2020-09-28T01:22:03.920542"
},
{"Id": 2,
"Name": "TestDataset_0918",
"DataType": {"Id": 1,
"Name": "dataset"
},
"Description": "0918用のデータセット",
"Formats": [{"Id": 1,
"Name": "CSV"
}
],
"FilePath": "/mnt/xxx/2",
"CreationDatetime": "2020-09-28T01:22:03.920542",
"UpdateDatetime": "2020-09-28T01:22:03.920542"
},
{"Id": 3,
"Name": "TrainedModel_0907",
"DataType": {"Id": 2,
"Name": "model"
},
"Description": "0907用のモデル",
"Formats": [{"Id": 3,
"Name": "H5"
}
],
"FilePath": "/mnt/xxx/3",
"CreationDatetime": "2020-09-28T01:22:03.920542",
"UpdateDatetime": "2020-09-28T01:22:03.920542"
},
{"Id": 4,
"Name": "TestDataset_1018",
"DataType": {"Id": 1,
"Name": "dataset"
},
"Description": "1018用のデータセット",
"Formats": [{"Id": 1,
"Name": "CSV"
}
],
"FilePath": "/mnt/xxx/4",
"CreationDatetime": "2020-09-28T01:22:03.920542",
"UpdateDatetime": "2020-09-28T01:22:03.920542"
},
{"Id": 5,
"Name": "TrainedModel_1007",
"DataType": {"Id": 2,
"Name": "model"
},
"Destination": "1007用のモデル",
"Formats": [{"Id": 3,
"Name": "H5"
}
],
"FilePath": "/mnt/xxx/5",
"CreationDatetime": "2020-09-28T01:22:03.920542",
"UpdateDatetime": "2020-09-28T01:22:03.920542"
}
]
}

インベントリ追加.

選択した機械学習コンポーネントとログインユーザの組織に紐付くインベントリを追加する

Authorizations:

cookieAuth

path Parameters

OrganizerId required	string 組織ID
mlComponentsId required	integer 機械学習コンポーネントId

Request Body schema: application/json

インベントリ追加情報

Name required	string
TypeId required	integer dataTypeのIdを指定する。
FilePath required	string インベントリのアドレスを指定する。 TypeがWINDOWS_FILEの場合、以下の条件に当てはまるFilePathのみを許容する。・アルファベッドから始まる・長さが259バイト以下である TypeがUNIX_FILE_SYSTEMの場合、以下の条件に当てはまるFilePathのみを許容する。・/から始まる・長さが1023バイト以下である・一つの要素(ディレクトリ名・ファイル名)が255バイト以下であるこの条件に当てはまらないFilePathが指定された場合、422を返却する。
Destination	string
Formats required	Array of strings インベントリのフォーマットをN個設定するフォーマット一覧取得APIで取得された名前以外を指定した場合、本API内部でフォーマット追加処理をする

Responses

Request samples

Payload

Content type

application/json

{"Name": "TestDataset_0818",
"TypeId": 1,
"FilePath": "/mnt/xxx/1",
"Destination": "0818用のデータセット",
"Formats": ["csv"
]
}

Response samples

Content type

application/json

{"Result": {"Code": "I22000",
"Message": "Success."
}
}

インベントリ追加（scrfトークンありで使用）.

選択した機械学習コンポーネントとログインユーザの組織に紐付くインベントリを追加する（scrfトークンありで使用）.

Authorizations:

cookieAuth

path Parameters

OrganizerId required	string 組織ID
mlComponentsId required	integer 機械学習コンポーネントId

Request Body schema: application/json

インベントリ追加情報

Name required	string
TypeId required	integer dataTypeのIdを指定する。
FilePath required	string インベントリのアドレスを指定する。 TypeがWINDOWS_FILEの場合、以下の条件に当てはまるFilePathのみを許容する。・アルファベッドから始まる・長さが259バイト以下である TypeがUNIX_FILE_SYSTEMの場合、以下の条件に当てはまるFilePathのみを許容する。・/から始まる・長さが1023バイト以下である・一つの要素(ディレクトリ名・ファイル名)が255バイト以下であるこの条件に当てはまらないFilePathが指定された場合、422を返却する。
Destination	string
Formats required	Array of strings インベントリのフォーマットをN個設定するフォーマット一覧取得APIで取得された名前以外を指定した場合、本API内部でフォーマット追加処理をする

Responses

Request samples

Payload

Content type

application/json

{"Name": "TestDataset_0818",
"TypeId": 1,
"FilePath": "/mnt/xxx/1",
"Destination": "0818用のデータセット",
"Formats": ["csv"
]
}

Response samples

Content type

application/json

{"Result": {"Code": "I22000",
"Message": "Success."
}
}

インベントリ編集.

選択した機械学習コンポーネントとログインユーザの組織に紐付く対象のインベントリIDを指定し、そのインベントリ情報を編集する。

Authorizations:

cookieAuth

path Parameters

OrganizerId required	string 組織ID
mlComponentsId required	integer 機械学習コンポーネントId
inventoryId required	integer インベントリId

Request Body schema: application/json

インベントリ追加情報

Name required	string
TypeId required	integer dataTypeのIdを指定する。
FilePath required	string インベントリのアドレスを指定する。 TypeがWINDOWS_FILEの場合、以下の条件に当てはまるFilePathのみを許容する。・アルファベッドから始まる・長さが259バイト以下である TypeがUNIX_FILE_SYSTEMの場合、以下の条件に当てはまるFilePathのみを許容する。・/から始まる・長さが1023バイト以下である・一つの要素(ディレクトリ名・ファイル名)が255バイト以下であるこの条件に当てはまらないFilePathが指定された場合、422を返却する。
Destination	string
Formats required	Array of strings インベントリのフォーマットをN個設定するフォーマット一覧取得APIで取得された名前以外を指定した場合、本API内部でフォーマット追加処理をする

Responses

Request samples

Payload

Content type

application/json

{"Name": "TestDataset_0818",
"TypeId": 1,
"FilePath": "/mnt/xxx/1",
"Destination": "0818用のデータセット",
"Formats": ["csv"
]
}

Response samples

Content type

application/json

{"Result": {"Code": "I32000",
"Message": "Success."
}
}

インベントリ削除.

選択した機械学習コンポーネントとログインユーザの組織に紐付く対象のインベントリIDを指定し、そのインベントリ情報を削除する

Authorizations:

cookieAuth

path Parameters

OrganizerId required	string 組織ID
mlComponentsId required	integer 機械学習コンポーネントId
inventoryId required	integer インベントリId

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"Result": {"Code": "I42000",
"Message": "success."
}
}

Format

フォーマット一覧取得.

フォーマットの一覧を取得する

Responses

Response samples

200
404
500

Content type

application/json

{"Result": {"Code": "I72000",
"Message": "Success."
},
"Tags": [{"Id": 1,
"Name": "png"
},
{"Id": 2,
"Name": "jpg"
}
]
}

Data Type

データタイプ一覧取得.

データタイプの一覧を取得する

Responses

Response samples

200
500

Content type

application/json

{"Result": {"Code": "I82000",
"Message": "Success."
},
"DataTypes": [{"Id": 1,
"Name": "dataset"
},
{"Id": 2,
"Name": "model"
},
{"Id": 3,
"Name": "attribute set"
}
]
}

Tag

(使用機能なし)タグ一覧取得.

タグの一覧を取得する

Responses

Response samples

200
404
422
500

Content type

application/json

{"Result": {"Code": "I62000",
"Message": "Success."
},
"Tags": [{"Id": 1,
"Type": "INVENTORY",
"Name": "CSV"
},
{"Id": 2,
"Type": "INVENTORY",
"Name": "TF_MODEL"
}
]
}

Quality_Measurement

測定基準一覧取得.

測定基準の一覧を取得する

Responses

Response samples

200
404
422
500

Content type

application/json

{"Result": {"Code": "Q22000",
"Message": "Success."
},
"QualityMeasurements": [{"Id": 1,
"Name": "学習モデルの精度計測",
"Description": "学習モデルの正確性評価指標",
"QualityDimensionId": 5,
"Type": "float",
"Min": 0,
"Max": null,
"Structure": "single"
},
{"Id": 2,
"Name": "学習モデルの敵対的サンプル安定性計測",
"Description": "学習モデルの安定性評価指標",
"QualityDimensionId": 6,
"Type": "float",
"Min": null,
"Max": 1,
"Structure": "single"
}
]
}

(使用禁止→AIT追加APIで実施)測定基準追加.

測定基準を追加する。
測定基準はプリミティブな一つのメトリクス（指標値）をもつ。
この測定基準設計者が、どういった基準で算出するかをDescription項目で明確化しなければならない。
名称とバージョンの組み合わせが既に存在する場合、400を返却する。
存在しない内部品質特性IDを指定した場合、400を返却する。

Request Body schema: application/json

測定基準追加情報

Name required	string
Version required	string
Description required	string
QualityDimensionId required	integer
required	object

Responses

Request samples

Payload

Content type

application/json

[{"Name": "分類問題における学習モデルACC計測",
"Version": 0.1,
"Description": "* 評価物：学習済モデル  \n* 対象領域：分類問題  \n* メトリクス：  \n  * ACC = (TP+TF) / (TP+FP+TN+FN)  \n",
"QualityDimensionId": 5,
"OperandTemplates": [{"Name": "ACC",
"Unit": "%"
}
]
}
]

Response samples

200
400
500

Content type

application/json

{"Result": {"Code": "Q23000",
"Message": "Success."
},
"QualityMeasurementId": 100
}

関係演算子取得.

関係演算子の一覧を取得する

Responses

Response samples

200
404
422
500

Content type

application/json

{"Result": {"Code": "Q32000",
"Message": "Success."
},
"RelationalOperators": [{"Id": 1,
"Expression": "==",
"Description": "値が等しければTrue"
},
{"Id": 2,
"Expression": "!=",
"Description": "値が等しくなければtrue"
},
{"Id": 3,
"Expression": ">",
"Description": "値が大きければtrue"
},
{"Id": 4,
"Expression": "<",
"Description": "値が小さければtrue"
},
{"Id": 5,
"Expression": ">=",
"Description": "値が同じか大きければtrue"
},
{"Id": 6,
"Expression": "<=",
"Description": "値が同じが小さければtrue"
}
]
}

AIT

インストールしたtestRunner(AIT)AITの一覧取得.

インストールしたtestRunner(AIT)の一覧を取得する.
MlComponentとは関連しない.
0件もありえる.

Responses

Response samples

200
500

Content type

application/json

{"Result": {"Code": "A00000"
},
"AITDetail": {"$ref": "#/components/schemas/AITDetailList"
}
}

指定されたTestRunner(AIT)をアンインストールする.

指定されたTestRunner(AIT)をアンインストールする.
全てのMlComponentのTestDescriotionで使用中のTestRunner(AIT)はアンインストールしない.
アンインストールの処理は、delete_flagをtrueにする.

Authorizations:

cookieAuth

path Parameters

testRunnerId

required

integer

TestRunner(AIT)のId

Responses

Response samples

200
400
401
404
500

Content type

application/json

{"Result": {"Code": "A02000",
"Message": "success."
}
}

指定されたtestRunner(AIT)を使用しているTestDescriptionIDとMlComponentIDを取得する.

指定されたtestRunner(AIT)を使用しているTestDescriptionIDとMlComponentIDを取得する.
全てのMlComponentのTestDescriptionが対象.
0件もありえる.

path Parameters

id

required

integer

TestRunner(AIT)のId

Responses

Response samples

200
500

Content type

application/json

{"Result": {"Code": "A03000",
"Message": "success."
},
"UsingTD": [{"TestDescriptionID": 1,
"TestRunnerId": 5,
"MlComponentID": 1
},
{"TestDescriptionID": 2,
"TestRunnerId": 5,
"MlComponentID": 1
},
{"TestDescriptionID": 10,
"TestRunnerId": 5,
"MlComponentID": 2
}
]
}

AIT_Local

ローカルレジストリにインストールしたAITの一覧取得.

ローカルレジストリにインストールしたAITの一覧を取得する.
MlComponentとは関連しない.
0件もありえる.

Responses

Response samples

200
500

Content type

application/json

{"Result": {"Code": "AL0000"
},
"AITLocalList": [{"ait_id": 1,
"name": "eval_mnist_acc_tf2.3",
"version": 0.1,
"description": "Only Sequential API Model Accuracy = TP+TNTP+FP+FN+TN\n",
"create_user_account": "airc_developerA",
"create_user_name": "開発者A",
"status": "registration in progress"
},
{"ait_id": 2,
"name": "dummy_AIT_2",
"version": 0.1,
"description": "dummy_AIT_description_2\n",
"create_user_account": "airc_developerB",
"create_user_name": "開発者B",
"status": "OK"
},
{"ait_id": 3,
"name": "dummy_AIT_3",
"version": 0.1,
"description": "dummy_AIT_description_3\n",
"create_user_account": "airc_developerC",
"create_user_name": "開発者C",
"status": "OK"
}
]
}

Test descriotions

テスト実行.

選択した機械学習コンポーネントとログインユーザの組織に紐付くテスト機能を実行する。※非同期処理

Authorizations:

cookieAuth

path Parameters

OrganizerId required	string 組織ID
mlComponentsId required	integer 機械学習コンポーネントId

Request Body schema: application/json

非同期処理コマンド

Command required	string
TestDescriptionIds required	Array of integers コマンドの反映先となるtestDescriptionIDを指定する。複数のtestDescriptionIDを指定可能とする。すべてのtestDescriptionに対して実施したい場合は、空を指定する。

Responses

Request samples

Payload

Content type

application/json

{"Command": "AsyncStart",
"TestDescriptionIds": [1,
2
]
}

Response samples

Content type

application/json

{"Result": {"Code": "R12000",
"Message": "Success."
},
"Job": {"Id": 1,
"StartDateTime": "2019-10-25 15:00:00T+0900"
}
}

テスト実行（scrfトークンありで使用）.

選択した機械学習コンポーネントとログインユーザの組織に紐付くテスト機能を実行する。※非同期処理（scrfトークンありで使用）

Authorizations:

cookieAuth

path Parameters

OrganizerId required	string 組織ID
mlComponentsId required	integer 機械学習コンポーネントId

Request Body schema: application/json

非同期処理コマンド

Command required	string
TestDescriptionIds required	Array of integers コマンドの反映先となるtestDescriptionIDを指定する。複数のtestDescriptionIDを指定可能とする。すべてのtestDescriptionに対して実施したい場合は、空を指定する。

Responses

Request samples

Payload

Content type

application/json

{"Command": "AsyncStart",
"TestDescriptionIds": [1,
2
]
}

Response samples

Content type

application/json

{"Result": {"Code": "R12000",
"Message": "Success."
},
"Job": {"Id": 1,
"StartDateTime": "2019-10-25 15:00:00T+0900"
}
}

テスト実行ジョブのステータスと結果取得.

実行指示した各job(test description)のステータス・結果を取得する

Authorizations:

cookieAuth

path Parameters

OrganizerId required	string 組織ID
mlComponentsId required	integer 機械学習コンポーネントId

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"Result": {"Code": "R22000",
"Message": "Success."
},
"Job": {"Id": 1,
"Status": "RUNNING",
"Result": "NA",
"ResultDetail": "OK:1 NG:0 ERR:0 NA:1"
},
"Runs": [{"Id": 1,
"TestDescriptionID": 1,
"Status": "DONE",
"Result": "OK",
"ResultDetail": "OK"
},
{"Id": 2,
"TestDescriptionID": 2,
"Status": "RUNNING",
"Result": "NA",
"ResultDetail": "NA"
}
]
}

テストディスクリプション一覧表示.

選択した機械学習コンポーネントとログインユーザの組織に紐付くテストディスクリプション一覧を取得し、テストディスクリプション一覧を表示

Authorizations:

cookieAuth

path Parameters

OrganizerId required	string 組織ID
mlComponentsId required	integer 機械学習コンポーネントId

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"Result": {"Code": "T12000",
"Message": "Success."
},
"Test": {"Id": 1,
"Status": "DONE",
"Result": "NG",
"ResultDetail": "OK 2 / NG 1 / NA 1",
"TestDescriptions": [{"Id": 1,
"Name": "NeuronCoverage",
"Result": "OK",
"CreationDatetime": "2020-09-28T01:22:03.920542",
"UpdateDatetime": "2020-09-28T01:22:03.920542",
"TargetInventories": [{"Id": 1,
"Name": "TestDataset_1001",
"TemplateInventoryId": 1
}
],
"Opinion": "ニューロンカバレージが規定のXX%以上であり、品質に問題なしと判断した。",
"Star": true,
"TestRunnerId": 11
},
{"Id": 2,
"Name": "MetamorphicTesting",
"Result": "OK",
"ResultDetail": "OK",
"CreationDatetime": "2020-09-28T01:22:03.920542",
"UpdateDatetime": "2020-09-28T01:22:03.920542",
"TargetInventories": [{"Id": 2,
"Name": "TestDataset_1005",
"TemplateInventoryId": 2
},
{"Id": 3,
"Name": "TrainedModel_1005",
"TemplateInventoryId": 3
}
],
"Opinion": "",
"Star": false,
"TestRunnerId": 12
},
{"Id": 3,
"Name": "AttributeCoverage",
"Result": "NG",
"ResultDetail": "AttributeCoverage is not enough",
"CreationDatetime": "2020-09-28T01:22:03.920542",
"UpdateDatetime": "2020-09-28T01:22:03.920542",
"TargetInventories": [{"Id": 2,
"Name": "TestDataset_1005",
"TemplateInventoryId": 4
}
],
"Opinion": "",
"Star": false,
"TestRunnerId": 13
},
{"Id": 4,
"ParentID": 3,
"Name": "AttributeCoverage",
"Result": "NA",
"ResultDetail": "NA",
"CreationDatetime": "2020-09-28T01:22:03.920542",
"UpdateDatetime": "2020-09-28T01:22:03.920542",
"TargetInventories": [{"Id": 4,
"Name": "TestDataset_1018",
"TemplateInventoryId": 5
},
{"Id": 5,
"Name": "TrainedModel_1007",
"TemplateInventoryId": 6
}
],
"Opinion": "",
"Star": false,
"TestRunnerId": 14
}
]
}
}

テストディスクリプション追加

選択した機械学習コンポーネントとログインユーザの組織に紐付くテストディスクリプション詳細情報を追加する

Authorizations:

cookieAuth

path Parameters

OrganizerId required	string 組織ID
mlComponentsId required	integer 機械学習コンポーネントId

Request Body schema: application/json

テストディスクリプション詳細追加情報

Name required	string
QualityDimensionID required	integer 内部品質プロパティIDを指定する。存在しない内部品質プロパティIDを指定した場合、422を返却する。
ParentID	integer 親(コピー元)のTestDescriptionIDを指定する。コピーではなく、新規作成の場合は指定しない。存在しないTestDescriptionIDを指定した場合、422を返却する。
required	object
required	Array of objects
required	object

Responses

Request samples

Payload

Content type

application/json

{"Name": "Neuron Coverage",
"ParentID": 10,
"QualityDimensionID": 1,
"QualityMeasurements": {"Id": 1,
"Value": "60",
"RelationalOperatorId": 1,
"Enable": true
},
"TargetInventories": [{"Id": 1,
"InventoryId": 5,
"TemplateInventoryId": 1
},
{"Id": 2,
"InventoryId": 4,
"TemplateInventoryId": 2
}
],
"TestRunner": {"Id": 1,
"Params": [{"TestRunnerParamTemplateId": 1,
"Value": "0.5"
},
{"TestRunnerParamTemplateId": 2,
"Value": "0.3"
},
{"TestRunnerParamTemplateId": 3,
"Value": "1.0"
}
]
}
}

Response samples

Content type

application/json

{"Result": {"Code": "T22000",
"Message": "Success."
}
}

テストディスクリプション追加（scrfトークンありで使用）

選択した機械学習コンポーネントとログインユーザの組織に紐付くテストディスクリプション詳細情報を追加する.
（scrfトークンありで使用）

Authorizations:

cookieAuth

path Parameters

OrganizerId required	string 組織ID
mlComponentsId required	integer 機械学習コンポーネントId

Request Body schema: application/json

テストディスクリプション詳細追加情報

Name required	string
QualityDimensionID required	integer 内部品質プロパティIDを指定する。存在しない内部品質プロパティIDを指定した場合、422を返却する。
ParentID	integer 親(コピー元)のTestDescriptionIDを指定する。コピーではなく、新規作成の場合は指定しない。存在しないTestDescriptionIDを指定した場合、422を返却する。
required	object
required	Array of objects
required	object

Responses

Request samples

Payload

Content type

application/json

{"Name": "Neuron Coverage",
"ParentID": 10,
"QualityDimensionID": 1,
"QualityMeasurements": {"Id": 1,
"Value": "60",
"RelationalOperatorId": 1,
"Enable": true
},
"TargetInventories": [{"Id": 1,
"InventoryId": 5,
"TemplateInventoryId": 1
},
{"Id": 2,
"InventoryId": 4,
"TemplateInventoryId": 2
}
],
"TestRunner": {"Id": 1,
"Params": [{"TestRunnerParamTemplateId": 1,
"Value": "0.5"
},
{"TestRunnerParamTemplateId": 2,
"Value": "0.3"
},
{"TestRunnerParamTemplateId": 3,
"Value": "1.0"
}
]
}
}

Response samples

Content type

application/json

{"Result": {"Code": "T22000",
"Message": "Success."
}
}

テストディスクリプション詳細表示.

選択した機械学習コンポーネントとログインユーザの組織に紐付く対象のテストディスクリプションIDを指定し、そのテストディスクリプションの詳細情報を取得

Authorizations:

cookieAuth

path Parameters

OrganizerId required	string 組織ID
mlComponentsId required	integer 機械学習コンポーネントId
testTestDescriptionsId required	integer テストディスクリプションId

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"Result": {"Code": "T32000",
"Message": "Success."
},
"TestDescriptionDetail": {"Id": 1,
"Name": "NeuronCoverage",
"ParentID": 3,
"QualityDimension": {"id": 5,
"Name": "学習の安定性"
},
"Opinion": "見解",
"QualityMeasurements": [{"id": 1,
"Name": "学習モデルの敵対的サンプル安定性計測",
"Value": 0.8,
"Description": "学習モデルの安定性評価指標",
"Structure": "single",
"RelationalOperatorId": 1,
"Enable": true,
"MeasureValue": 0.56
}
],
"TargetInventories": [{"Id": 4,
"Name": "TestDataset_1018",
"TemplateInventoryId": 1,
"TemplateInventoryName": "TestDataset",
"Type": "dataset",
"Description": "1枚の手書き文字データ(28x28, png)のpng",
"FilePath": "C:\\test\\train-images-idx3-ubyte.gz"
},
{"Id": 5,
"Name": "TrainedModel_1007",
"TemplateInventoryId": 2,
"TemplateInventoryName": "TrainedModel",
"Type": "model",
"Description": "学習モデル",
"FilePath": "C:\\test\\model_mnist_2d.h5"
}
],
"TestRunner": {"id": 1,
"Name": "neuron_coverage_v3.py",
"Description": "* データ入力形式: XXX\n* MLエンジン: tensorflow-vX.X\n* 出力: XXX\n",
"CreateUserAccount": "airc_developer",
"CreateUserName": "airc開発者",
"Version": "1",
"Quality": "https://airc.aist.go.jp/aiqm/quality/internal/要求分析の十分性",
"LandingPage": "https://github.com/AITName/AITVersion",
"Params": [{"Id": 1,
"Name": "Threshold",
"Description": "Threshold",
"Value": "0.5"
},
{"Id": 2,
"Name": "Lower Limit",
"Description": "Lower Limit",
"Value": "0.3"
},
{"Id": 3,
"Name": "Upper Limit",
"Description": "Upper Limit",
"Value": "1,0"
}
]
},
"TestDescriptionResult": {"Summary": "OK",
"Detail": "Current Coverage 85%",
"LogFile": "http://XXX",
"Graphs": [{"Id": 1,
"GraphType": "picture",
"Name": "distribution_graph",
"FileName": "distribution_graph_a.png",
"Description": "分布",
"ReportRequired": false,
"ReportIndex": 1,
"ReportName": "distribution_graph",
"Graph": "http://XXX"
},
{"Id": 2,
"GraphType": "picture",
"Name": "distribution_graph",
"FileName": "distribution_graph_b.png",
"Description": "分布",
"ReportRequired": false,
"ReportIndex": 2,
"ReportName": "distribution_graph",
"Graph": "http://XXX"
},
{"Id": 3,
"GraphType": "picture",
"Name": "distribution_graph",
"FileName": "distribution_graph_c.png",
"Description": "分布",
"ReportRequired": false,
"ReportIndex": 3,
"ReportName": "distribution_graph",
"Graph": "http://XXX"
}
],
"Downloads": [{"Id": 1,
"Name": "log",
"FileName": "log.txt",
"Description": "one image",
"DownloadURL": "http://XXX"
}
],
"CreationDatetime": "2020-09-28T01:22:03.920542",
"UpdateDatetime": "2020-09-28T01:22:03.920542",
"Star": true
}
}
}

テストディスクリプション詳細削除.

選択した機械学習コンポーネントとログインユーザの組織に紐付く対象のテストディスクリプションIDを指定し、そのテストディスクリプションの詳細情報を削除する指定したテストディスクリプションに子供がいる場合、子供も再帰的に削除する

Authorizations:

cookieAuth

path Parameters

OrganizerId required	string 組織ID
mlComponentsId required	integer 機械学習コンポーネントId
testTestDescriptionsId required	integer テストディスクリプションId

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"Result": {"Code": "T52000",
"Message": "success."
}
}

テストディスクリプション詳細編集.

選択した機械学習コンポーネントとログインユーザの組織に紐付く対象のテストディスクリプションIDを指定し、そのテストディスクリプションの詳細情報を編集する。ただし、更新対象がテスト実行済み、かつ結果が成功の場合は編集不可とする。

Authorizations:

cookieAuth

path Parameters

OrganizerId required	string 組織ID
mlComponentsId required	integer 機械学習コンポーネントId
testTestDescriptionsId required	integer テストディスクリプションId

Request Body schema: application/json

テストディスクリプション詳細追加情報

Name required	string
QualityDimensionID required	integer 内部品質プロパティIDを指定する。存在しない内部品質プロパティIDを指定した場合、422を返却する。
required	object
required	Array of objects
required	object

Responses

Request samples

Payload

Content type

application/json

{"Name": "Neuron Coverage",
"QualityDimensionID": 1,
"QualityMeasurements": {"Id": 1,
"Value": "60",
"RelationalOperatorId": 1,
"Enable": true
},
"TargetInventories": [{"Id": 1,
"InventoryId": 5,
"TemplateInventoryId": 1
},
{"Id": 2,
"InventoryId": 4,
"TemplateInventoryId": 1
}
],
"TestRunner": {"Id": 1,
"Params": [{"TestRunnerParamTemplateId": 1,
"Value": "0.5"
},
{"TestRunnerParamTemplateId": 2,
"Value": "0.3"
},
{"TestRunnerParamTemplateId": 3,
"Value": "1.0"
}
]
}
}

Response samples

Content type

application/json

{"Result": {"Code": "T42000",
"Message": "Success."
}
}

お気に入り設定

指定したテストディスクリプションをお気に入りに設定する

Authorizations:

cookieAuth

path Parameters

OrganizerId required	string 組織ID
mlComponentsId required	integer 機械学習コンポーネントId
testTestDescriptionsId required	integer テストディスクリプションId

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"Result": {"Code": "T62000",
"Message": "Success."
}
}

お気に入り設定解除

指定したテストディスクリプションをお気に入りから外す

Authorizations:

cookieAuth

path Parameters

OrganizerId required	string 組織ID
mlComponentsId required	integer 機械学習コンポーネントId
testTestDescriptionsId required	integer テストディスクリプションId

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"Result": {"Code": "T72000",
"Message": "Success."
}
}

祖先テストディスクリプション一覧表示.

該当するテストディスクリプションの祖先リストを昇順（親→子）の順序で返却する。返却するリストの最後尾には該当テストディスクリプションが付加される。そのため、親のいないテストディスクリプションを指定した場合、該当テストディスクリプション1つだけが返却される。

Authorizations:

cookieAuth

path Parameters

OrganizerId required	string 組織ID
mlComponentsId required	integer 機械学習コンポーネントId
testTestDescriptionsId required	integer テストディスクリプションId

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"Result": {"Code": "T82000",
"Message": "Success."
},
"TestDescriptions": [{"Id": 1,
"Name": "NeuronCoverage",
"Result": "OK",
"CreationDatetime": "2020-09-28T01:22:03.920542",
"UpdateDatetime": "2020-09-28T01:22:03.920542",
"TargetInventories": [{"Id": 1,
"Name": "TestDataset_1001",
"TemplateInventoryId": 1
}
],
"Opinion": "ニューロンカバレージが規定のXX%以上であり、品質に問題なしと判断した。",
"Star": true,
"TestRunnerId": 10
},
{"Id": 2,
"ParentID": 1,
"Name": "MetamorphicTesting",
"Result": "OK",
"ResultDetail": "OK",
"CreationDatetime": "2020-09-28T01:22:03.920542",
"UpdateDatetime": "2020-09-28T01:22:03.920542",
"TargetInventories": [{"Id": 2,
"Name": "TestDataset_1005",
"TemplateInventoryId": 2
},
{"Id": 3,
"Name": "TrainedModel_1005",
"TemplateInventoryId": 3
}
],
"Opinion": "",
"Star": false,
"TestRunnerId": 10
},
{"Id": 3,
"ParentID": 2,
"Name": "AttributeCoverage",
"Result": "NG",
"ResultDetail": "AttributeCoverage is not enough",
"CreationDatetime": "2020-09-28T01:22:03.920542",
"UpdateDatetime": "2020-09-28T01:22:03.920542",
"TargetInventories": [{"Id": 2,
"Name": "TestDataset_1005",
"TemplateInventoryId": 4
}
],
"Opinion": "",
"Star": false,
"TestRunnerId": 10
},
{"Id": 4,
"ParentID": 3,
"Name": "AttributeCoverage",
"Result": "NA",
"ResultDetail": "NA",
"CreationDatetime": "2020-09-28T01:22:03.920542",
"UpdateDatetime": "2020-09-28T01:22:03.920542",
"TargetInventories": [{"Id": 4,
"Name": "TestDataset_1018",
"TemplateInventoryId": 5
},
{"Id": 5,
"Name": "TrainedModel_1007",
"TemplateInventoryId": 6
}
],
"Opinion": "",
"Star": false,
"TestRunnerId": 10
}
]
}

レポート生成器に対してコマンドを発行する.

発行コマンドは以下の通り。

パラメータ設定
レポート生成

Authorizations:

cookieAuth

path Parameters

OrganizerId required	string 組織ID
mlComponentsId required	integer 機械学習コンポーネントId

Request Body schema: application/json

コマンド

Command required	string `SetParam` : パラメータ設定 `Generate` : レポート生成
Destination required	Array of strings コマンドの反映先となるtestDescriptionIDを指定する。複数のtestDescriptionIDを指定可能とする。すべてのtestDescriptionに対して実施したい場合は、空を指定する。
	object `SetParam` `Opinion` : 見解設定 `Graphs` : グラフごとのレポート表示設定 `Generate` : レポート生成 `TargetReportTemplateId` : レポート出力時のテンプレートID (TargetReportTemplateIdが指定されなかった場合、品質特性の値からダミーのテンプレートを作成し出力する)

Responses

Request samples

Payload

Content type

application/json

Example

SetParam

{"Command": "SetParam",
"Destination": ["1"
],
"Params": {"Opinion": "XXX",
"Graphs": [{"GraphId": 1,
"ReportRequired": true,
"ReportIndex": 1,
"ReportName": "Graph-A"
},
{"GraphId": 2,
"ReportRequired": true,
"ReportIndex": 2,
"ReportName": "Graph-B"
},
{"GraphId": 2,
"ReportRequired": false
}
]
}
}

Response samples

Content type

application/json

{"Result": {"Code": "D12000",
"Message": "Success."
},
"OutParams": [{"ReportUrl": "http://xxx"
}
]
}

レポート生成器に対してコマンドを発行する.（scrfトークンありで使用）

発行コマンドは以下の通り。

パラメータ設定
レポート生成（scrfトークンありで使用）

Authorizations:

cookieAuth

path Parameters

OrganizerId required	string 組織ID
mlComponentsId required	integer 機械学習コンポーネントId

Request Body schema: application/json

コマンド

Command required	string `SetParam` : パラメータ設定 `Generate` : レポート生成
Destination required	Array of strings コマンドの反映先となるtestDescriptionIDを指定する。複数のtestDescriptionIDを指定可能とする。すべてのtestDescriptionに対して実施したい場合は、空を指定する。
	object `SetParam` `Opinion` : 見解設定 `Graphs` : グラフごとのレポート表示設定 `Generate` : レポート生成 `TargetReportTemplateId` : レポート出力時のテンプレートID (TargetReportTemplateIdが指定されなかった場合、品質特性の値からダミーのテンプレートを作成し出力する)

Responses

Request samples

Payload

Content type

application/json

Example

SetParam

{"Command": "SetParam",
"Destination": ["1"
],
"Params": {"Opinion": "XXX",
"Graphs": [{"GraphId": 1,
"ReportRequired": true,
"ReportIndex": 1,
"ReportName": "Graph-A"
},
{"GraphId": 2,
"ReportRequired": true,
"ReportIndex": 2,
"ReportName": "Graph-B"
},
{"GraphId": 2,
"ReportRequired": false
}
]
}
}

Response samples

Content type

application/json

{"Result": {"Code": "D12000",
"Message": "Success."
},
"OutParams": [{"ReportUrl": "http://xxx"
}
]
}

Download

指定されたIDに紐づくファイルをダウンロードする.

指定したIDに紐づくファイルをダウンロードする

Authorizations:

cookieAuth

path Parameters

DownloadId

required

integer

ダウンロードID

Responses

Response samples

401
404
500

Content type

application/json

{"Result": {"Code": "D16001",
"Message": "Unauthorized request."
}
}

Role

ユーザロール一覧取得.

ユーザロールの一覧を取得する.
TODO ロール関連の実装は保留とするため、実装は見合わせる.

Responses

Response samples

200
500

Content type

application/json

{"Result": {"Code": "U12000",
"Message": "Success."
},
"roles": [{"Id": 1,
"Name": "admin"
},
{"Id": 2,
"Name": "mlmanager"
},
{"Id": 3,
"Name": "user"
}
]
}

UserControl

ユーザー一覧を取得する.

ユーザ一覧を取得する.
TODO ユーザ関連の実装は保留とするため、実装は見合わせる.

Authorizations:

cookieAuth

Responses

Response samples

200
401
500

Content type

application/json

{"Result": {"Code": "U01000",
"Message": "Success."
},
"Users": [{"Id": 1,
"OrganizerId": "team-A",
"Name": "JohnDoe",
"AccountId": "TestUser",
"Roles": [{"Role": "mlmanager",
"TargetMLComponentId": 1
},
{"Role": "User",
"TargetMLComponentId": 2
}
],
"CreationDatetime": "2021-09-07T11:22:03.920542",
"UpdateDatetime": "2021-09-07T11:22:03.920542"
}
]
}

ユーザーを追加する.

ユーザーを追加する.
TODO ユーザ関連の実装は保留とするため、実装は見合わせる.

Request Body schema: application/json

Name	string ログインユーザ名
OrganizerId	string 所属する組織ID
AccountId	string ログインに使用するアカウントID
Password	string ログインに使用するパスワード

Responses

Request samples

Payload

Content type

application/json

{"Name": "string",
"OrganizerId": "string",
"AccountId": "string",
"Password": "string"
}

Response samples

200
400
500

Content type

application/json

{"Result": {"Code": "U02000",
"Message": "Success."
},
"UserId": 1
}

ユーザーパスワードを変更する.

ユーザーパスワードを変更する.
ログインなしで実施可能とする.
現状のパスワードが正しくない場合、400エラーを返却する.
TODO ユーザ関連の実装は保留とするため、実装は見合わせる.

path Parameters

AccountId

required

string

アカウントID

Request Body schema: application/json

CurrentPassword	string 現在のログインパスワード
NewPassword	string 新ログインパスワード

Responses

Request samples

Payload

Content type

application/json

{"CurrentPassword": "string",
"NewPassword": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"Result": {"Code": "U03000",
"Message": "Success."
}
}

ユーザー情報を編集する.

ユーザー情報を編集する.
本機能はadmin/mlmanager/userが実行可能とする.
TODO ユーザ関連の実装は保留とするため、実装は見合わせる.

Authorizations:

cookieAuth

path Parameters

id

required

integer

ユーザID

Request Body schema: application/json

NewName	string 新ユーザ名
NewOrganizerId	string 新組織ID

Responses

Request samples

Payload

Content type

application/json

{"NewName": "string",
"NewOrganizerId": "string"
}

Response samples

Content type

application/json

{"Result": {"Code": "U08000",
"Message": "Success."
}
}

ユーザーを削除する.

ユーザーを削除する.
本機能はadmin/mlmanagerが実行可能とする.
TODO ユーザ関連の実装は保留とするため、実装は見合わせる.

Authorizations:

cookieAuth

path Parameters

id

required

integer

ユーザID

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"Result": {"Code": "U04000",
"Message": "Success."
}
}

ユーザーパスワードを変更する.

ユーザーパスワードを変更する.
本機能はadmin/mlmanagerが実行可能とする.
現状のパスワードを設定する必要がないパスワードリセット機能となる.
TODO ユーザ関連の実装は保留とするため、実装は見合わせる.

Authorizations:

cookieAuth

path Parameters

id

required

integer

ユーザID

Request Body schema: application/json

NewPassword

string

ログインに使用するパスワード

Responses

Request samples

Payload

Content type

application/json

{"NewPassword": "string"
}

Response samples

Content type

application/json

{"Result": {"Code": "U05000",
"Message": "Success."
}
}

ユーザーロールを追加する.

ユーザーロールを追加する.
本機能はadmin/mlmanagerが実行可能とする.
ロールとは、admin|mlmanager|userのいずれかで、mlmanagerとuserはmlcomponent単位に設定する.
重複ロールを追加しようとした場合、200を返却する.
TODO ロール関連の実装は保留とするため、実装は見合わせる.

Authorizations:

cookieAuth

path Parameters

id

required

integer

ユーザID

Request Body schema: application/json

object (UserRole)

ユーザ権限情報

Responses

Request samples

Payload

Content type

application/json

{"UserRole": {"Role": "mlmanager",
"TargetMLComponentId": 1
}
}

Response samples

Content type

application/json

{"Result": {"Code": "U06000",
"Message": "Success."
}
}

ユーザーロールを削除する.

ユーザーロールを削除する.
本機能はadmin/mlmanagerが実行可能とする.
与えられていないロールに対して削除をした場合、200を返却する.
TODO ロール関連の実装は保留とするため、実装は見合わせる.

Authorizations:

cookieAuth

path Parameters

id

required

integer

ユーザID

Request Body schema: application/json

object (UserRole)

ユーザ権限情報

Responses

Request samples

Payload

Content type

application/json

{"UserRole": {"Role": "mlmanager",
"TargetMLComponentId": 1
}
}

Response samples

Content type

application/json

{"Result": {"Code": "U07000",
"Message": "Success."
}
}

Organizer

組織一覧を取得する.

組織一覧を取得する.
TODO 組織関連の実装は保留とするため、実装は見合わせる.

Authorizations:

cookieAuth

Responses

Response samples

200
401
500

Content type

application/json

{"Result": {"Code": "O01000",
"Message": "Success."
},
"Organizers": [{"Id": 1,
"OrganizerId": "team-A",
"Name": "Aチーム",
"CreationDatetime": "2021-09-07T11:22:03.920542",
"UpdateDatetime": "2021-09-07T11:22:03.920542"
}
]
}

組織を追加する.

組織を追加する.
ログインユーザであれば誰でも実施可能である.
後述の組織変更、組織削除APIでは操作可能な権限を、adminまたは当該組織の作成ユーザと限定するため、
作成ユーザIDを永続化してサーバ内部に保持する.
TODO 組織関連の実装は保留とするため、実装は見合わせる.

Authorizations:

cookieAuth

Request Body schema: application/json

Name	string 組織名
OrganizerId	string 組織ID

Responses

Request samples

Payload

Content type

application/json

{"Name": "Aチーム",
"OrganizerId": "team-A"
}

Response samples

200
400
401
500

Content type

application/json

{"Result": {"Code": "O02000",
"Message": "Success."
},
"Id": 1
}

組織を変更する.

組織を変更する.
変更操作はAdminか、組織作成ユーザのみ受け付ける.
TODO 組織関連の実装は保留とするため、実装は見合わせる.

Authorizations:

cookieAuth

path Parameters

Id

required

integer

ID（DB管理上のIDであり、ユーザが入力する組織IDとは別）

Request Body schema: application/json

Name	string 組織名
OrganizerId	string 組織ID

Responses

Request samples

Payload

Content type

application/json

{"Name": "Bチーム",
"OrganizerId": "team-B"
}

Response samples

Content type

application/json

{"Result": {"Code": "O03000",
"Message": "Success."
}
}

組織を削除する.

組織を削除する.
変更操作はAdminか、組織作成ユーザのみ受け付ける.
削除する組織に関連する機械学習コンポーネントと、
それに結び付くインベントリ情報とテストディスクリプション情報を削除する.
ユーザに割り当て済みの組織を削除しようとした場合、400エラーを返却する.
TODO 組織関連の実装は保留とするため、実装は見合わせる.

Authorizations:

cookieAuth

path Parameters

Id

required

integer

ID（DB管理上のIDであり、ユーザが入力する組織IDとは別）

Responses

Response samples

Content type

application/json

{"Result": {"Code": "O04000",
"Message": "Success."
}
}

ReportTemplate

レポートテンプレート一覧を取得する.

Responses

Response samples

200
500

Content type

application/json

{"Result": {"Code": "R01000",
"Message": "Success."
},
"ReportTemplates": [[{"Id": 1,
"Name": "AIQMガイドライン準拠レポートテンプレート",
"GidelineId": 1,
"CreationDatetime": "2020-09-28T01:22:03.920542",
"UpdateDatetime": "2020-09-28T01:22:03.920542"
},
{"Id": 2,
"Name": "QA4AIガイドライン準拠レポートテンプレート",
"GidelineId": 2,
"CreationDatetime": "2020-09-28T01:22:03.920542",
"UpdateDatetime": "2020-09-28T01:22:03.920542"
}
]
]
}

レポートテンプレートをインストールする.

レポートテンプレート(zip)をインストールする.
指定したレポートテンプレート名とガイドラインIDのテンプレートレポートが既に存在する場合、新規追加ではなく上書きをする.
zip内のファイル構成例は以下とする.
ファイルチェックは以下2点のチェックを実施する.
　①ZIPを正常に解凍できること
　②解凍後、「base_report_format.html」「css/base_report.css」が存在すること
そのほかのファイル構成は任意とする.

  root  
    │  base_report_format.html  
    │  frame.html  
    │  frame_image.html  
    │  frame_summary.html  
    │  frame_table.html  
    │  frame_textarea.html  
    │  
    ├─css  
    │      base_report.css  
    │  
    └─resource  
            title_bg.png  
            title_green.png

Authorizations:

cookieAuth

Request Body schema: multipart/form-data

Name	string
GidelineId	integer
File	object レポートテンプレートをZIP圧縮したファイルのバイナリデータ

Responses

Response samples

200
400
401
500

Content type

application/json

{"Result": {"Code": "R02000",
"Message": "Success."
},
"ReportTemplateId": 0
}

レポートテンプレートのひな形を生成する.

レポートテンプレートのひな形「base_report_format.html」を生成する.
作成した一式をzipファイルとして返却する.

  root  
    │  base_report_format.html  
    │  frame.html  
    │  frame_image.html  
    │  frame_summary.html  
    │  frame_table.html  
    │  frame_textarea.html  
    │  
    ├─css  
    │      base_report.css  
    │  
    └─resource  
            title_bg.png  
            title_green.png

Authorizations:

cookieAuth

Request Body schema: application/json

GuidelineId

integer

ガイドラインID

Responses

Request samples

Payload

Content type

application/json

{"GuidelineId": 0
}

Response samples

400
401
500

Content type

application/json

{"Result": {"Code": "R03400",
"Message": "Invalid request parameter."
}
}

レポートテンプレート一式をZIP形式でダウンロードする.

Authorizations:

cookieAuth

path Parameters

id

required

integer

レポートテンプレートID

Responses

Response samples

401
404
500

Content type

application/json

{"Result": {"Code": "R04401",
"Message": "Unauthorized request."
}
}

Guideline

ガイドライン削除.

ガイドラインを削除する。削除するガイドラインに関連するscope、quality_dimension、scope_quality_dimensionを削除する。

Authorizations:

cookieAuth

path Parameters

GuidelineId

required

string

ガイドラインID

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"Result": {"Code": "G23000",
"Message": "success."
}
}

ガイドラインスキーマファイル取得

指定したidを持つガイドラインスキーマファイルを取得する。

＜処理詳細＞
１．ユーザが指定したガイドラインのidを受信する。
２．idに紐づくガイドラインスキーマファイルを取得する。
３．取得した情報をユーザに返す。

path Parameters

guideline_id

required

integer

ガイドラインID

Responses

Response samples

200
404
500

Content type

application/json

{"Result": {"Code": "G26000",
"Message": "Success."
},
"GuidelineSchemaFile": { }
}

ガイドラインスキーマファイル更新

指定したidを持つガイドラインスキーマファイルを更新する。

＜処理詳細＞
１．ユーザが指定したガイドラインのidとガイドラインスキーマファイルを受信する。
２．ガイドラインスキーマファイルを更新する。
３．登録合否とIDをユーザに返す。

path Parameters

guideline_id

required

integer

ガイドラインID

Request Body schema: multipart/form-data

ガイドラインスキーマファイル情報

File	object ガイドラインスキーマファイルのバイナリデータ

Responses

Response samples

200
400
500

Content type

application/json

{"Result": {"Code": "G27000",
"Message": "Success."
},
"GuidelineSchemaFileId": 1
}

ガイドライン削除.

ガイドラインを削除する。削除するガイドラインに関連するscope、quality_dimension、scope_quality_dimension、guideline_schema_fileを削除する。

Authorizations:

cookieAuth

path Parameters

GuidelineId

required

string

ガイドラインID

Responses

Response samples

200
404
500

Content type

application/json

{"Result": {"Code": "G28000",
"Message": "success."
}
}

ガイドラインスキーマファイル編集チェック

指定したガイドラインidに対してガイドラインスキーマファイルで編集できるか否かを判定する。

＜処理詳細＞
１．ユーザが指定したガイドラインidとガイドラインスキーマファイルを受信する。
２．ガイドラインidでDBのガイドライン情報を検索し、MlComponentやTestDescriptionで使用中のscopeとQDを取得する。
３．ガイドラインスキーマファイルの編集によって上記２が削除されなければ、編集可能としてTrueを返す（編集不可ならFalse）。

path Parameters

guideline_id

required

integer

ガイドラインID

Request Body schema: multipart/form-data

ガイドラインスキーマファイル情報

File	object ガイドラインスキーマファイルのバイナリデータ

Responses

Response samples

200
404
500

Content type

application/json

{"Result": {"Code": "G29000",
"Message": "Success."
},
"CheckResult": true,
"WarningMessage": ["string"
]
}

ガイドラインスキーマファイル削除チェック

指定したガイドラインidに対して削除できるか否かを判定する。

＜処理詳細＞
１．ユーザが指定したガイドラインidを受信する。
２．ガイドラインidでDBのガイドライン情報を検索し、MlComponentやTestDescriptionで使用中のscopeとQDを取得する。
３．上記２が取得されなければ、編集可能としてTrueを返す（編集不可ならFalse）。

path Parameters

guideline_id

required

integer

ガイドラインID

Responses

Response samples

200
404
500

Content type

application/json

{"Result": {"Code": "G30000",
"Message": "Success."
},
"CheckResult": true,
"WarningMessage": ["string"
]
}

Scopes

スコープ一覧取得.

スコープ一覧取得をする。

Responses

Response samples

200
404
500

Content type

application/json

{"Result": {"Code": "S00000",
"Message": "Success"
},
"Scopes": [{"Id": 1,
"GuidelineId": 1,
"Name": "AIQM Scope",
"CreationDatetime": "2021/04/01 09:01:24",
"UpdateDatetime": "2021/06/15 11:31:56"
},
{"Id": 2,
"GuidelineId": 1,
"Name": "ML Scope",
"CreationDatetime": "2021/05/04 14:08:07",
"UpdateDatetime": "2021/05/16 17:54:41"
}
]
}

ガイドライン所属のスコープ一覧取得

ガイドライン所属のスコープ一覧を取得する。

＜処理詳細＞
１．ガイドライン所属のスコープ一覧を取得する。
２．ガイドライン所属のスコープ一覧をユーザに返す。

path Parameters

GuidelineId

required

string

ガイドラインID

Responses

Response samples

200
500

Content type

application/json

{"Result": {"Code": "S01000",
"Message": "Success"
},
"Scopes": [{"Id": 1,
"GuidelineId": 2,
"Name": "プロセススコープ",
"UserId": 2,
"CreationDatetime": "2022-01-01 09:01:24",
"UpdateDatetime": "2022-03-22 11:31:56"
},
{"Id": 2,
"GuidelineId": 2,
"Name": "製品・システムスコープ",
"UserId": 2,
"CreationDatetime": "2022-01-05 09:01:24",
"UpdateDatetime": "2022-02-01 15:11:33"
}
]
}

ガイドライン所属のスコープとQualityDimensionの関連一覧取得

ガイドライン所属のスコープとQualityDimensionの関連一覧を取得する。

＜処理詳細＞
１．ガイドライン所属のスコープとQualityDimensionの関連一覧を取得する。
２．ガイドライン所属のスコープとQualityDimensionの関連一覧をユーザに返す。

path Parameters

GuidelineId

required

string

ガイドラインID

Responses

Response samples

200
500

Content type

application/json

{"Result": {"Code": "S02000",
"Message": "Success"
},
"ScopeQualityDimensions": [{"Id": 1,
"GuidelineId": 2,
"ScopeId": 1,
"QualityDimensionId": 2,
"CreationDatetime": "2022-01-01 09:01:24"
},
{"Id": 2,
"GuidelineId": 2,
"ScopeId": 1,
"QualityDimensionId": 3,
"CreationDatetime": "2022-01-05 09:01:24"
},
{"Id": 3,
"GuidelineId": 2,
"ScopeId": 2,
"QualityDimensionId": 4,
"CreationDatetime": "2022-02-01 11:23:24"
}
]
}

Quality Dimension

ガイドライン毎の品質特性一覧の取得

＜処理詳細＞
１．ガイドライン毎の品質特性一覧を取得する。
２．ガイドライン毎の品質特性一覧をユーザに返す。

path Parameters

GuidelineId

required

string

ガイドラインID

Responses

Response samples

200
500

Content type

application/json

{"Result": {"Code": "G01000",
"Message": "Success"
},
"QualityDimensions": [{"Id": 1,
"Name": "Diversity_of_test_data",
"Description": "Diversity of test data",
"GuidelineId": 2,
"SubDimensions": "Accuracy_of_traained_model,Robustness_of_trained_model",
"QualityDimensionLevels": [{"QualityDimensionLevelId": "A",
"Name": "name A",
"Description": "description A",
"Level": 0
},
{"QualityDimensionLevelId": "B",
"Name": "name B",
"Description": "description B",
"Level": 1
}
],
"Url": "https://hostnmae/quality-dimension/api/0.0.1/AIQM_Guideline/Diversity_of_test_data",
"CreationDatetime": "2021-04-01 09:01:24",
"UpdateDatetime": "2021-06-15 11:31:56"
},
{"Id": 2,
"Name": "Accuracy_of_traained_model",
"Description": "Accuracy of traained model",
"GuidelineId": 2,
"SubDimensions": null,
"QualityDimensionLevels": [{"QualityDimensionLevelId": "A",
"Name": "name A",
"Description": "description A",
"Level": 0
},
{"QualityDimensionLevelId": "B",
"Name": "name B",
"Description": "description B",
"Level": 1
}
],
"Url": "https://hostnmae/quality-dimension/api/0.0.1/AIQM_Guideline/Accuracy_of_traained_model",
"CreationDatetime": "2021-05-04 14:08:07",
"UpdateDatetime": "2021-05-16 17:54:41"
},
{"Id": 3,
"Name": "Robustness_of_trained_model",
"Description": "description Robustness of trained model",
"GuidelineId": 2,
"SubDimensions": null,
"QualityDimensionLevels": [{"QualityDimensionLevelId": "A",
"Name": "name A",
"Description": "description A",
"Level": 0
},
{"QualityDimensionLevelId": "B",
"Name": "name B",
"Description": "description B",
"Level": 1
}
],
"Url": "https://hostnmae/quality-dimension/api/0.0.1/AIQM_Guideline/Robustness_of_trained_model",
"CreationDatetime": "2022-02-04 11:08:07",
"UpdateDatetime": "2022-02-16 13:12:55"
}
]
}

品質特性一覧取得.

スコープに関連する品質特性の一覧を取得する。

path Parameters

ScopeId

required

integer

スコープId

Responses

Response samples

200
500

Content type

application/json

{"Result": {"Result": {"Code": "Q00000",
"Message": "Success"
}
},
"QualityDimensions": [{"Id": 1,
"GuidelineId": 1,
"Name": "Diversity_of_test_data",
"Description": "Diversity of test data",
"SubDimensions": "Accuracy_of_traained_model,Robustness_of_trained_model",
"QualityDimensionLevels": [{"QualityDimensionLevelId": "A",
"Name": "name A",
"Description": "description A",
"Level": 0
},
{"QualityDimensionLevelId": "B",
"Name": "name B",
"Description": "description B",
"Level": 1
}
],
"Url": "https://hostnmae/quality-dimension/api/0.0.1/AIQM_Guideline/Diversity_of_test_data",
"CreationDatetime": "2021/04/01 09:01:24",
"UpdateDatetime": "2021/06/15 11:31:56"
}
]
}

画面表示用の品質特性を取得

画面表示用の品質特性を取得する.

＜処理詳細＞
１．画面表示用の品質特性を取得する。
２．画面表示用の品質特性情報をユーザに返す。

path Parameters

GuidelineName required	string ガイドライン名
QualityDimensionName required	string 品質特性名

Responses

Response samples

200
404
500

Content type

application/json

{"Result": {"Code": "Q02000",
"Message": "Success"
},
"QualityDimension": {"Id": 2,
"Name": "Diversity_of_test_data",
"Description": "Diversity of test data",
"SubDimensions": "Accuracy_of_traained_model,Robustness_of_trained_model",
"Url": "https://hostnmae/quality-dimension/api/0.0.1/AIQM_Guideline/Diversity_of_test_data",
"AnnotationTags": [{"Id": 1,
"Name": "Dataset"
}
],
"CreationDatetime": "2021-04-01 09:01:24",
"UpdateDatetime": "2021-06-15 11:31:56"
}
}

setting

setting取得.

DBのM_Settingからkeyに一致した値を取得する。

path Parameters

key

required

string

キー値

Responses

Response samples

200
404
500

Content type

application/json

{"Result": {"Result": {"Code": "V00000",
"Message": "Success"
}
},
"Value": "string"
}

setting値変更

DBのsettingの値を変更する。

＜処理詳細＞
１．ユーザが指定したsettingテーブルのkeyとvalueを受信する。
２．DBのM_Settingのkeyに対応したvalueを変更する。
３．変更結果を返す。

path Parameters

key

required

string

キー値

Request Body schema: application/json

Value

string

変更対象のvalue

Responses

Request samples

Payload

Content type

application/json

{"Value": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"Result": {"Code": "V10000",
"Message": "Success."
},
"Value": "string"
}