ジャンプ先

• リクエスト
• レスポンス

エンドポイントを使用したスコア・モデル

post

/omlmod/v1/deployment/{uri}/score

URIで識別されるエンドポイントを使用してモデルをスコアリングします。この方法を使用してスコアリングできるのは、共有モデルまたはコール元によって作成されたモデルのみです。

リクエスト

パス・パラメータ

• uri(required): string
  エンドポイントの一意のURI。

サポートされているメディア・タイプ

• application/json
• multipart/form-data

リクエスト本文 - application/json ()

ルート・スキーマ : schema

型: object

ソースの表示

• inputRecords(required): array inputRecords
  (属性名と属性値)ペアの(String, Object)マップ形式の入力レコードのリスト。ONNX_IMGモデルの場合、属性値には、イメージ・ピクセル値を格納する多次元配列またはbase64でエンコードされたファイルの内容を指定できます。
• topN: number (integer)
  最小値: 1
• topNdetails: number (integer)
  最小値: 1

  最大値: 50

{
    "required":[
        "inputRecords"
    ],
    "properties":{
        "inputRecords":{
            "type":"array",
            "items":{
                "type":"object"
            },
            "description":"a list of input records in form of a (String, Object) map with (attribute name, attribute value) pairs. For ONNX_IMG models, the attribute value can either be a multidimensional array storing the image pixel values or base64-encoded file contents."
        },
        "topN":{
            "type":"number",
            "format":"integer",
            "minimum":1
        },
        "topNdetails":{
            "type":"number",
            "format":"integer",
            "minimum":1,
            "maximum":50
        }
    }
}

ネストされたスキーマ : inputRecords

型: array

(属性名と属性値)ペアの(String, Object)マップ形式の入力レコードのリスト。ONNX_IMGモデルの場合、属性値には、イメージ・ピクセル値を格納する多次元配列またはbase64でエンコードされたファイルの内容を指定できます。

ソースの表示

• 配列: オブジェクト items

{
    "type":"array",
    "items":{
        "type":"object"
    },
    "description":"a list of input records in form of a (String, Object) map with (attribute name, attribute value) pairs. For ONNX_IMG models, the attribute value can either be a multidimensional array storing the image pixel values or base64-encoded file contents."
}

ネストされたスキーマ : items

型: object

リクエスト本文 - multipart/form-data ()

ルート・スキーマ : schema

型: object

ソースの表示

• imageData(required): string (binary)
  スコアリングするイメージ・ファイル。

{
    "type":"object",
    "required":[
        "imageData"
    ],
    "properties":{
        "imageData":{
            "description":"The image file to be scored.",
            "type":"string",
            "format":"binary"
        }
    }
}

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

正常にスコアリングされました。データ・マイニング機能のタイプごとに異なるレスポンス・スキーマ。

本文()

ルート・スキーマ : ScoringOutputResultSet

型: object

ソースの表示

• scoringResults(required): array scoringResults

{
    "required":[
        "scoringResults"
    ],
    "properties":{
        "scoringResults":{
            "type":"array",
            "items":{
                "oneOf":[
                    {
                        "$ref":"#/components/schemas/ClassificationOutput"
                    },
                    {
                        "$ref":"#/components/schemas/RegressionOutput"
                    },
                    {
                        "$ref":"#/components/schemas/ClusteringOutput"
                    },
                    {
                        "$ref":"#/components/schemas/FeatureExtractionOutput"
                    }
                ]
            }
        }
    }
}

ネストされたスキーマ : scoringResults

型: array

ソースの表示

• 配列: items

{
    "type":"array",
    "items":{
        "oneOf":[
            {
                "$ref":"#/components/schemas/ClassificationOutput"
            },
            {
                "$ref":"#/components/schemas/RegressionOutput"
            },
            {
                "$ref":"#/components/schemas/ClusteringOutput"
            },
            {
                "$ref":"#/components/schemas/FeatureExtractionOutput"
            }
        ]
    }
}

ネストされたスキーマ : items

1つのスキーマに一致

ソースの表示

• object ClassificationOutput
• object RegressionOutput
• object ClusteringOutput
• object FeatureExtractionOutput

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/ClassificationOutput"
        },
        {
            "$ref":"#/components/schemas/RegressionOutput"
        },
        {
            "$ref":"#/components/schemas/ClusteringOutput"
        },
        {
            "$ref":"#/components/schemas/FeatureExtractionOutput"
        }
    ]
}

ネストされたスキーマ : ClassificationOutput

型: object

ソースの表示

• classifications(required): array classifications
• details: array details

{
    "required":[
        "classifications"
    ],
    "properties":{
        "classifications":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Classification"
            }
        },
        "details":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Detail"
            }
        }
    }
}

ネストされたスキーマ : RegressionOutput

型: object

ソースの表示

• details: array details
• regression(required): number (double)

{
    "required":[
        "regression"
    ],
    "properties":{
        "regression":{
            "type":"number",
            "format":"double"
        },
        "details":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Detail"
            }
        }
    }
}

ネストされたスキーマ : ClusteringOutput

型: object

ソースの表示

• clusters(required): array clusters
• details: array details

{
    "required":[
        "clusters"
    ],
    "properties":{
        "clusters":{
            "type":"array",
            "items":{
                "oneOf":[
                    {
                        "$ref":"#/components/schemas/ClusterProb"
                    },
                    {
                        "$ref":"#/components/schemas/ClusterDistance"
                    }
                ]
            }
        },
        "details":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Detail"
            }
        }
    }
}

ネストされたスキーマ : FeatureExtractionOutput

型: object

ソースの表示

• weights: array weights

{
    "properties":{
        "weights":{
            "type":"array",
            "items":{
                "type":"number",
                "oneOf":[
                    {
                        "format":"float"
                    },
                    {
                        "format":"double"
                    }
                ]
            }
        }
    }
}

ネストされたスキーマ : classifications

型: array

ソースの表示

• 配列: object Classification

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Classification"
    }
}

ネストされたスキーマ : details

型: array

ソースの表示

• 配列: object Detail

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Detail"
    }
}

ネストされたスキーマ : Classification

型: object

ソースの表示

• label(required): string
• probability(required): number (double)

{
    "required":[
        "label",
        "probability"
    ],
    "properties":{
        "label":{
            "type":"string"
        },
        "probability":{
            "type":"number",
            "format":"double"
        }
    }
}

ネストされたスキーマ : Detail

型: object

ソースの表示

• columnName(required): string
• weight(required): number (double)

{
    "required":[
        "columnName",
        "weight"
    ],
    "properties":{
        "columnName":{
            "type":"string"
        },
        "weight":{
            "type":"number",
            "format":"double"
        }
    }
}

ネストされたスキーマ : details

型: array

ソースの表示

• 配列: object Detail

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Detail"
    }
}

ネストされたスキーマ : clusters

型: array

ソースの表示

• 配列: items

{
    "type":"array",
    "items":{
        "oneOf":[
            {
                "$ref":"#/components/schemas/ClusterProb"
            },
            {
                "$ref":"#/components/schemas/ClusterDistance"
            }
        ]
    }
}

ネストされたスキーマ : details

型: array

ソースの表示

• 配列: object Detail

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Detail"
    }
}

ネストされたスキーマ : items

1つのスキーマに一致

ソースの表示

• object ClusterProb
• object ClusterDistance

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/ClusterProb"
        },
        {
            "$ref":"#/components/schemas/ClusterDistance"
        }
    ]
}

ネストされたスキーマ : ClusterProb

型: object

ソースの表示

• clusterId(required): string
• probability(required): number (double)

{
    "required":[
        "clusterId",
        "probability"
    ],
    "properties":{
        "clusterId":{
            "type":"string"
        },
        "probability":{
            "type":"number",
            "format":"double"
        }
    }
}

ネストされたスキーマ : ClusterDistance

型: object

ソースの表示

• clusterId(required): string
• distance(required): number (double)

{
    "required":[
        "clusterId",
        "distance"
    ],
    "properties":{
        "clusterId":{
            "type":"string"
        },
        "distance":{
            "type":"number",
            "format":"double"
        }
    }
}

ネストされたスキーマ : weights

型: array

ソースの表示

• 配列: items

{
    "type":"array",
    "items":{
        "type":"number",
        "oneOf":[
            {
                "format":"float"
            },
            {
                "format":"double"
            }
        ]
    }
}

ネストされたスキーマ : items

1つのスキーマに一致

ソースの表示

• float
• double

{
    "type":"number",
    "oneOf":[
        {
            "format":"float"
        },
        {
            "format":"double"
        }
    ]
}

400レスポンス

不正なリクエストです。

本文()

ルート・スキーマ : Error

型: object

ソースの表示

• code(required): string
• message(required): string

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    }
}

401レスポンス

認可されていません。

本文()

ルート・スキーマ : Error

型: object

ソースの表示

• code(required): string
• message(required): string

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    }
}

404レスポンス

リソースが見つかりません。

本文()

ルート・スキーマ : Error

型: object

ソースの表示

• code(required): string
• message(required): string

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    }
}

500レスポンス

リポジトリへの接続中の問題、問合せ実行中の問題、またはその他の予期しないエラーの問題です。

本文()

ルート・スキーマ : Error

型: object

ソースの表示

• code(required): string
• message(required): string

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    }
}

先頭に戻る