ジャンプ先

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

イメージの分類

post

/omlmod/v1/cognitive-image/classification

事前構築済のONNXイメージ・モデルによるイメージ分類結果スコアリングを取得します。topNのパラメータを入力の一部として渡すことができ、確率が最も高い上位Nクラスが返されます(確率でソート)。デフォルトでは、上位5つのクラスが返されます。topNが0に設定されている場合、エンドポイントはソートされていない完全なリストを返します。

リクエスト

この操作にはリクエスト・パラメータはありません。

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

• application/json
• multipart/form-data

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

ルート・スキーマ : schema

型: object

ソースの表示

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

  デフォルト値: 5

  topNの値。デフォルトは5です。topNが0に設定されている場合、ソートされていない完全なリストが返されます。

{
    "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 COGNITIVE_IMAGE models, the attribute value can either be a multidimensional array storing the image pixel values or base64-encoded file contents."
        },
        "topN":{
            "type":"integer",
            "description":"A value for topN. Default is 5. When topN is set to 0, the full, unsorted list will be returned.",
            "minimum":0,
            "default":5
        }
    }
}

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

型: array

(属性名と属性値)ペアの(String, Object)マップ形式の入力レコードのリスト。COGNITIVE_IMAGEモデルの場合、属性値には、イメージ・ピクセル値を格納する多次元配列または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 COGNITIVE_IMAGE 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)
  スコアリングするイメージ・ファイル。
• topN: integer
  最小値: 0

  デフォルト値: 5

  topNの値。デフォルトは5です。topNが0に設定されている場合、ソートされていない完全なリストが返されます。

{
    "required":[
        "imageData"
    ],
    "properties":{
        "imageData":{
            "description":"The image file to be scored.",
            "type":"string",
            "format":"binary"
        },
        "topN":{
            "type":"integer",
            "description":"A value for topN. Default is 5.  When topN is set to 0, the full, unsorted list will be returned.",
            "minimum":0,
            "default":5
        }
    }
}

先頭に戻る

レスポンス

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

• application/json

200レスポンス

クラスのリストとそれに対応する確率。

本文()

ルート・スキーマ : schema

型: array

ソースの表示

• 配列: object ClassificationOutputResultSet

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

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

型: object

ソースの表示

• classificationResults(required): array classificationResults

{
    "required":[
        "classificationResults"
    ],
    "properties":{
        "classificationResults":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ClassificationOutput"
            }
        }
    }
}

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

型: array

ソースの表示

• 配列: object ClassificationOutput

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

ネストされたスキーマ : 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"
            }
        }
    }
}

ネストされたスキーマ : 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"
        }
    }
}

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"
        }
    }
}

先頭に戻る