REST APIを使用して、Prediction Oneの予測を実行できます。

Inference API

予測データに対して作成済モデルによる予測を実行できます。 実行に必要なエンドポイント（URL）やAPIキー等は「API作成画面」から作成してください。 API作成後の画面で必要な情報を確認することができます。

URL

URLは「API作成画面」で確認できます。

HTTPメソッドは、POSTです。

Request

header

path parameter

ありません。

query parameter

ありません。

body

以下のフォーマットです。

{
	"inputs": [
		{
			"name": "pr",   # prediction data
			"type": "csv",
			"data": "6LfjeFlG/xxxxxx"
		},
		{
			"name": "ar",	# add analysis result
			"type": "boolean",
			"data": true
		},
		{
			"name": "ad",	# add prediction data
			"type": "boolean",
			"data": true
		},
		{
			"name": "nc",	# without classification results
			"type": "boolean",
			"data": true
		},
		{
			"name": "nr",	# without row numbers
			"type": "boolean",
			"data": true
		},
		{
			"name": "pc",
			"type": "string",
			"data": "column_name"
		}
	]
}

inputsのパラメータ

Response

body

以下のフォーマットです。

{
    "version": str,
	"outputs": [
		{
			"name": "prediction_analysis.csv",
			"data": "6LfjeFlG/xxxxxx"
		},
		{
			"name": "prediction_valid.csv",
			"data": "6LfjeFlG/xxxxxx"
		}
	]
}

outputsのパラメータ

error message

実行例 1

Inference APIのpythonによる実行例が以下となります。

サンプルデータの「1_プレミアムサービス購入.csv」で作成したモデルに対して、API作成を行った状態を前提としています。 予測対象として「2_プレミアムサービス購入（予測用）.csv」を利用して、Inference APIを使用して予測を算出しています。

import base64
import requests

prediction_data_file_path = '2_プレミアムサービス購入（予測用）.csv'
api_url = 'YOUR_API_URL'
api_key = 'YOUR_API_KEY'

headers = {
    'x-api-key': api_key, 'content-type': 'application/json; charset=utf-8'}

with open(prediction_data_file_path, 'rb') as f:
    lines = f.readlines()

header = lines[0]
for line in lines[1:]:
    prediction_data = base64.b64encode(header + line).decode("ascii")
    body = {
        "inputs": [
            {
                "name": "pr",  # prediction data
                "type": "csv",
                "data": prediction_data
            },
            {
                "name": "ar",  # add analysis result
                "type": "boolean",
                "data": True
            },
            {
                "name": "ad",  # add prediction data
                "type": "boolean",
                "data": True
            },
            {
                "name": "nc",  # without classification results
                "type": "boolean",
                "data": True
            }
        ]
    }

    response = requests.post(api_url, headers=headers, json=body)
    response_json = response.json()
    if 'outputs' in response_json:
        for output in response_json['outputs']:
            print(output['name'])
            print(base64.b64decode(output['data']).decode())
    else:
        print(response_json)

実行例 2

Inference 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/jsonn; charset=utf-8" -X POST -d @"{2.のファイルのフルパス}" -G {YOUR_API_URL}
ex) $ curl -o "response.json" -H "x-api-key:xxxx-xxx-xxx-xxxx" -H "Content-Type: application/jsonn; charset=utf-8" -X POST -d @body.txt https://user-api.predictionone.sony.biz/v1/groups/xxxxxxxxx/classifiers/xxxxxxxxx/inference