グループ化データに対するPython関数の実行
post
/api/py-scripts/v1/group-apply/{scriptName}
列値でグループ化されたデータに対してユーザー所有のPython関数を実行します。
リクエスト
サポートされているメディア・タイプ
- application/json
パス・パラメータ
- scriptName: string
Pythonスクリプトの名前
リクエストの引数および追加引数を指定する(名前 - 値)ペアのJSON文字列
ルート・スキーマ: EmbedScriptComputeGrp
型:
ソースの表示
object- asyncFlag(optional): boolean
ジョブを非同期で実行するかどうか。
- envName(optional): string
conda環境の名前。
- graphicsFlag(optional): boolean
スクリプトでレンダリングされたイメージを結果に取得するかどうか。
- groupBy: string
グループ化する列。列のリストを設定するには、カンマ区切りリストを指定します。
- input: string
入力データを指定する問合せ文。
- orderBy(optional): string
順序付けする列。列のリストを設定するには、カンマ区切りリストを指定します。
- parallel(optional): integer(int32)
並列度。
- parallelFlag(optional): boolean
ジョブをパラレルに実行するかどうか。
- parameters(optional): string
スクリプトに渡されるキーワード引数を指定する(名前 - 値)ペアのJSON文字列。
- service(optional): string
指定可能な値:
[ "LOW", "MEDIUM", "HIGH" ]サービスのLEVEL。デフォルトはLOWです。 - timeout (オプション): integer(int32)
最小値:
1800最大値:43200非同期ジョブのタイムアウト制限(秒単位、デフォルトは1800秒)。`asyncFlag`=trueとともに使用する必要があります。
リクエストの例(application/json)
{"input":"select * from GRADE", "groupBy":"GENDER, YEAR", "orderBy":"GENDER", "parameters":"{\"oml_input_type\":\"default\"}", "parallelFlag":true}レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
デフォルトでは、ジョブの結果を返します。
201レスポンス
400レスポンス
無効なパラメータが指定され、出力がサイズ制限を超えているか、他のスクリプト実行エラーが発生しました。
500レスポンス
ブローカへの接続中、ジョブの実行中に問題が発生したか、または他の予期しないエラーが発生しました。
例
例1: 同期の例
次の例では、group_countというスクリプトを実行します。この例では、parallelFlagをtrueに設定して、データベースの並列性を利用します。
curl -i -X POST --header "Authorization: Bearer ${token}" \
--header 'Content-Type: application/json' --header 'Accept: application/json' \
-d '{"input":"select * from IRIS", "parameters":"{\"oml_input_type\":\"pandas.DataFrame\"}", "groupBy":"Species", "orderBy":"Sepal_Length", "parallelFlag":true}' \
"<oml-cloud-service-location-url>/oml/api/py-scripts/v1/group-apply/group_count"レスポンス・ヘッダー
レスポンス・ヘッダーは次のとおりです。
HTTP/1.1 200 OK
Date: Mon, 17 Aug 2020 21:06:54 GMT
Content-Type: application/json
Content-Length: 5045
Connection: keep-alive
Cache-Control: no-cache, no-store, private
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1;mode=block
Strict-Transport-Security: max-age=31536000; includeSubDomains
X-Content-Type-Options: nosniff
Set-Cookie: JSESSIONID=node0bucgs4gt7hci1gxvgtqc1hjdv647.node0; Path=/oml; Secure; HttpOnly
Expires: Thu, 01 Jan 1970 00:00:00 GMTレスポンス本文
JSON形式のレスポンス本文の一部を次に示します。
{"result":{"versicolor_8":{"SEPAL_LENGTH":{"0":5.7},"SPECIES":{"0":"versicolor"},"COUNT":{"0":5}},
"versicolor_7":{"SEPAL_LENGTH":{"0":5.6},"SPECIES":{"0":"versicolor"},"COUNT":{"0":2}},...}例2
次の例では、test_seaborn_inpというスクリプトを実行します。
curl -i -k -X POST --header "Authorization: Bearer ${token}" --header
'Content-Type: application/json' --header 'Accept: application/json' -d
'{"input": "select * from IRIS", "groupBy": "Species", "envName": "seaborn","graphicsFlag": true}'
"<oml-cloud-service-location-url>/oml/api/py-scripts/v1/group-apply/test_seaborn_inp"レスポンス本文
RESTエンドポイントの結果は、イメージおよびデータを含むPythonスクリプトから返される値のJSON表現です。イメージ・バイトはPNG形式で返されます。
{
"result": {
"0": {
"GROUP": "setosa",
"IMAGE": "iVBORw0KGgoAAAAN......AAAAASUVORK5CYII=",
"DATA": "\"hello world\"",
"TITLE": "Iris plot",
"ID": 1
},
"1": {
"GROUP": "versicolor",
"IMAGE": "iVBORw0KGgoAAAAN......AAAAASUVORK5CYII=",
"DATA": "\"hello world\"",
"TITLE": "Iris plot",
"ID": 1
},
"2": {
"GROUP": "virginica",
"IMAGE": "iVBORw0KGgoAAAAN......AAAAASUVORK5CYII=",
"DATA": "\"hello world\"",
"TITLE": "Iris plot",
"ID": 1
}
}
}