画像の有害性診断

Classic/VPC環境で利用できます。

公開 URLまはた Base64でエンコードされたデータを使用して画像の有害性を検知します。

リクエストヘッダ

CLOVA GreenEye APIで共通して使用されるヘッダの詳細は、CLOVA GreenEyeの共通ヘッダをご参照ください。

リクエストパスパラメータ

パラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`domainId`	String	Required	ドメイン ID コンソールの Domain > API連携設定で Invoke URLから確認可能
`signature`	String	Required	署名コンソールの Domain > API連携設定で Invoke URLから確認可能

参考

リクエストパスパラメータは、ユーザーごとに異なる文字列で構成されています。NAVERクラウドプラットフォームコンソールでサービスの申し込みとドメインの作成を完了すると Domainの API連携設定で提供される APIGW Invoke URLで確認できます。詳細は、CLOVA GreenEyeご利用ガイドをご参照ください。

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`version`	String	Required	CLOVA GreenEyeサービスのバージョン `V1`
`requestId`	String	Optional	API呼び出し UUID 必要に応じて任意の値を入力
`timestamp`	Number	Required	リクエスト時間の Timestamp
`images`	Array	Required	画像情報呼び出し1件につき1つの画像のみ入力可能

`images`

imagesの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`name`	String	Required	画像名画像の識別とレスポンス結果の確認に使用
`url`	String	Conditional	画像を取得できる公開 URL `url`と`data`のうちどちらかは必ず入力 `url`と`data`を両方入力すると`url`は無視して`data`を適用
`data`	String	Conditional	Base64でエンコードした画像バイト `url`と`data`のうちどちらかは必ず入力 `url`と`data`を両方入力すると`url`は無視して`data`を適用

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://clovagreeneye.apigw.ntruss.com/custom/v1/{domainId}/{signature}/predict' \
--header 'X-GREEN-EYE-SECRET: {Client Secret}' \
--header 'Content-Type: application/json' \
--data '{
    "version": "V1",
    "requestId": {RequestId},
    "timestamp": 1724750100000,
    "images": [
        {
            "name": "20191025_155202",
            "url": "https://kr.object.ncloudstorage.com/bk1/20191025_155202.jpg"
        }
    ]
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`version`	String	-	CLOVA GreenEyeサービスのバージョン
`requestId`	String	-	リクエスト UUID
`timestamp`	Number	-	リクエスト時間の Timestamp
`images`	Array	-	画像情報

`images`

imagesの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`result`	Object	-	レスポンス結果
`result.adult`	Object	-	成人向けレーティング情報
`result.adult.confidence`	Float	-	成人向けスコア(点) 0~1 1に近いほどその確率は高い
`result.normal`	Object	-	正常レーティング情報
`result.normal.confidence`	Float	-	正常スコア(点) 0~1 1に近いほどその確率は高い
`result.porn`	Object	-	ワイセツなものレーティング情報
`result.porn.confidence`	Float	-	ワイセツなものスコア(点) 0~1 1に近いほどその確率は高い
`result.sexy`	Object	-	軽度の成人向けレーティング情報
`result.sexy.confidence`	Float	-	軽度の成人向けスコア(点) 0~1 1に近いほどその確率は高い
`latency`	Integer	-	レスポンスタイム(ミリ秒)
`confidence`	Float	-	最も高いスコア(点)
`message`	String	-	レスポンスメッセージ
`name`	String	-	画像名画像の識別とレスポンス結果の確認に使用

レスポンスステータスコード

NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "version": "V1",
    "requestId": "RequestId",
    "timestamp": 1724978377692,
    "images": [
        {
            "result": {
                "adult": {
                    "confidence": 0.020802784711122513
                },
                "normal": {
                    "confidence": 0.9232523441314697
                },
                "porn": {
                    "confidence": 0.027517495676875114
                },
                "sexy": {
                    "confidence": 0.028427353128790855
                }
            },
            "latency": 81.0,
            "confidence": 0.9232523441314697,
            "message": "SUCCESS",
            "name": "20191025_155202"
        }
    ]
}