REST APIを使用して、予測APIを更新できます。
予測APIを更新します。
https://developer-api.predictionone.sony.biz/v1/external/classifiers
HTTPメソッドは、PATCHです。
| name | 説明 |
|---|---|
| x-api-key | API Key。 |
| content-type | application/json |
| name | 説明 |
|---|---|
| classifier_id | 予測API ID |
ありません。
以下のフォーマットです。
{
"rules": [{
"source": str,
"order": str,
"priority": int
}],
"active": bool,
"is_editable": bool
}
| name | 説明 |
|---|---|
| rules | 下記rules参照 |
| active | 予測APIが動作中かどうか |
| is_editable | 予測APIが編集制限中かどうか |
| name | 説明 |
|---|---|
| source | IP すべてを許可する場合は0.0.0.0/0を指定 |
| order | allow: 許可, deny: 拒否 |
| priority | 優先度 |
以下のフォーマットです。
{
"classifier": {
"classifier_id": str,
"model_id": int,
"status": str,
"api_key": str,
"version": str,
"url": Or(str, None),
"active": bool,
"is_editable": bool,
"create_datetime": str,
"update_datetime": str,
"rules": [{
"source": str,
"order": str,
"priority": int
}]
}
}
| name | 説明 |
|---|---|
| classifier_id | 予測API ID |
| model_id | モデルID |
| status | 下記status参照 |
| api_key | 予測APIのAPI KEY |
| version | 予測APIのバージョン |
| url | 予測APIのURL |
| active | 予測APIが動作中かどうか |
| is_editable | 予測APIが編集制限中かどうか |
| create_datetime | 予測APIの作成日 |
| update_datetime | 予測APIの更新日 |
| rules | 下記rules参照 |
| name | 説明 |
|---|---|
| building | 作成中 |
| running | 実行中 |
| updating | 更新中 |
| failed | 失敗 |
| terminating | 停止中 |
| terminated | 停止済 |
| name | 説明 |
|---|---|
| source | IP すべてを許可する場合は0.0.0.0/0を指定 |
| order | allow: 許可, deny: 拒否 |
| priority | 優先度 |
| code | error | message | reason |
|---|---|---|---|
| 4001000204 | PREDA_EXTERNAL_BAD_REQUEST | invalid_api_key. | APIキーが存在しない |
| 4001000204 | PREDA_EXTERNAL_BAD_REQUEST | Inactive_credential. | APIキーが間違っている |
| 4001000204 | PREDA_EXTERNAL_BAD_REQUEST | Not_found_credential. | APIキーが間違っている |
| 4001000204 | PREDA_EXTERNAL_BAD_REQUEST | This user may be deleted. | ユーザー情報が削除されている可能性がある |
Update Classifier APIのpythonによる実行例が以下となります。
import requests
classifier_id = 'YOUR_CLASSIFIER_ID'
api_url = f'https://developer-api.predictionone.sony.biz/v1/external/classifiers/{classifier_id}'
api_key = 'YOUR_API_KEY'
headers = {'x-api-key': api_key, 'content-type': 'application/json'}
# request
body = {
'rules': [{
'source': '0.0.0.0/0',
'order': 'allow',
'priority': 0
}],
'active': True,
'is_editable': True
}
response = requests.patch(api_url, json=body, headers=headers)
response_json = response.json()
Update Classifier APIのコマンドプロンプトからcurlコマンドによる実行例が以下となります。
1. コマンドプロンプトを立ち上げる
2. body情報を記載したファイルを保存(body.txtとする)
3. リクエストする
$ curl -o "response.json" -H "x-api-key:{Get API Key APIから取得したAPI KEY}" -H "Content-Type: application/json" -X PATCH -d @"{2.のファイルのフルパス}" -G https://developer-api.predictionone.sony.biz/v1/external/classifiers/{YOUR_CLASSIFIER_ID}
ex) $ curl -o "response.json" -H "x-api-key:xxxx-xxx-xxx-xxxx" -H "Content-Type: application/jsonn" -X PATCH -d @body.txt https://developer-api.predictionone.sony.biz/v1/external/classifiers/xxxxxx