学習リストの照会
- 印刷する
- PDF
学習リストの照会
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Classic/VPC環境で利用できます。
学習の実行をリクエストした全リストを照会します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
GET | /services/{serviceId}/trains |
リクエストヘッダ
AiTEMS APIで共通して使用されるヘッダの詳細は、AiTEMSの共通ヘッダをご参照ください。
リクエストクエリパラメータ
パラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
offset | Integer | Optional | 照会データのスタート位置
|
limit | Integer | Optional | 照会データの最大数
|
リクエストパスパラメータ
パラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
serviceId | String | Required | サービス ID
|
リクエストクエリパラメータ
パラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
isRecent | Boolean | Optional | タイプごとに最近リクエストした項目かどうか
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request GET 'https://aitems.apigw.ntruss.com/api/v1/services/6wxgu******/trains
?isRecent=true' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
trains | Array | - | 学習情報 |
offset | Integer | - | 照会データのスタート位置 |
limit | Integer | - | 照会データの最大数 |
trains
trains
の説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
serviceId | String | - | サービス ID |
type | String | - | 学習リクエストタイプ
|
hpConfig | Object | - | Hyperparameter Optimization(HPO)の設定情報 |
hpConfig.is_enabled | Boolean | - | HPOの設定有無
|
hpConfig.{option} | String, Long, Boolean | - | 設定された HPO
|
version | String | - | 学習バージョン |
description | String | - | 学習の説明 |
status | String | - | 学習の状態
|
createdDate | String | - | サービスの作成日時 |
nextUpdateDate | String | - | サービスの次回の更新予定日時 |
inference | Boolean | - | 推論結果の有無
|
レスポンスステータスコード
AiTEMS APIで共通して使用されるレスポンスステータスコードの詳細は、AiTEMS APIの共通レスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"trains": [
{
"serviceId": "6wxgu******",
"type": "pop",
"hpConfig": {
"is_enabled": false
},
"version": "maqll******",
"status": "stopping",
"createdDate": "2024-07-30T11:25:36.558",
"inference": false
}
],
"offset": 0,
"limit": 1000
}
この記事は役に立ちましたか?