REST APIを使用して、Prediction Oneも予測モデルの作成ができます。以下の一連のAPIによって実行します。
API KEYを取得します。
https://developer-api.predictionone.sony.biz/v1/external/api-key
HTTPメソッドは、GETです。
| name | 説明 |
|---|---|
| x-api-key | Secret Key。 |
ありません。
| name | 説明 |
|---|---|
| credential_type | 下記credential_type参照 |
| model_id | credential_typeでretrainを指定した場合必須。再学習する予測APIのモデルIDを指定 |
| name | 説明 |
|---|---|
| train | 学習API用 |
| deploy | 予測API用 |
| retrain | 再学習API用 |
ありません。
以下のフォーマットです。
{
"api_key": str,
"end_date": str
}
| 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. | ユーザー情報が削除されている可能性がある |
| 4001000204 | PREDA_EXTERNAL_BAD_REQUEST | This model may be deleted. | モデルが削除されている可能性がある |
| 4001000204 | PREDA_EXTERNAL_BAD_REQUEST | Model id is required. | モデルIDが指定されていない可能性がある |
Get API Key APIのpythonによる実行例が以下となります。
import requests
api_url = 'https://developer-api.predictionone.sony.biz/v1/external/api-key'
secret_key = 'YOUR_SECRET_KEY'
headers = {'x-api-key': secret_key}
# 再学習の場合
params = {'credential_type': 'retrain', 'model_id': YOUR_MODEL_ID}
# 学習の場合
params = {'credential_type': 'train'}
# 予測APIデプロイの場合
params = {'credential_type': 'deploy'}
# request
response = requests.get(api_url, params=params, headers=headers)
response_json = response.json()
api_key = response_json['api_key']
Get API Key APIのコマンドプロンプトからcurlコマンドによる実行例が以下となります。
1. コマンドプロンプトを立ち上げる
2. credential_typeを記載したファイルを保存(param.txtとする)
3. リクエストする
$ curl -o "response.json" -H "x-api-key:{画面から取得したシークレットキー}" -X GET -G https://developer-api.predictionone.sony.biz/v1/external/api-key --data-urlencode filename@"{3.のファイルのフルパス}"
ex) $ curl -o "response.json" -H "x-api-key:xxxx-xxx-xxx-xxxx" -X GET -G https://developer-api.predictionone.sony.biz/v1/external/api-key --data-urlencode filename@param.txt
4. response.jsonを確認しapi_keyを取得