Image Operations - Analyze Image
画像の分析
有害な可能性がある画像コンテンツを分析するための同期 API。 現在は、ヘイト、セルフハーム、性的、暴力の 4 つのカテゴリがサポートされています。
POST {endpoint}/contentsafety/image:analyze?api-version=2024-09-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
endpoint
|
path | True |
string |
サポートされている Cognitive Services エンドポイント (プロトコルとホスト名など: https://.cognitiveservices.azure.com). |
api-version
|
query | True |
string |
この操作に使用する API バージョン。 |
要求本文
名前 | 必須 | 型 | 説明 |
---|---|---|---|
image | True |
分析する画像。 |
|
categories |
カテゴリが分析されます。 割り当てられない場合は、カテゴリの既定の分析結果セットが返されます。 |
||
outputType |
これは、画像分析出力の種類を指します。 値が割り当てられていない場合、既定値は "FourSeverityLevels" になります。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
要求は成功しました。 |
|
Other Status Codes |
予期しないエラー応答。 ヘッダー x-ms-error-code: string |
セキュリティ
Ocp-Apim-Subscription-Key
型:
apiKey
/:
header
OAuth2Auth
型:
oauth2
フロー:
application
Token URL (トークン URL):
https://login.microsoftonline.com/common/oauth2/v2.0/token
スコープ
名前 | 説明 |
---|---|
https://cognitiveservices.azure.com/.default |
例
Analyze Image
要求のサンプル
POST {endpoint}/contentsafety/image:analyze?api-version=2024-09-01
{
"image": {
"content": "Y29udGVudDE="
}
}
応答のサンプル
{
"categoriesAnalysis": [
{
"category": "Hate",
"severity": 0
},
{
"category": "SelfHarm",
"severity": 0
},
{
"category": "Sexual",
"severity": 0
},
{
"category": "Violence",
"severity": 2
}
]
}
定義
名前 | 説明 |
---|---|
Analyze |
画像分析要求。 |
Analyze |
これは、画像分析出力の種類を指します。 値が割り当てられていない場合、既定値は "FourSeverityLevels" になります。 |
Analyze |
画像分析応答。 |
Azure. |
エラー オブジェクト。 |
Azure. |
エラーの詳細を含む応答。 |
Azure. |
エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
Image |
画像分析結果。 |
Image |
画像コンテンツ分析でサポートされる損害カテゴリ。 |
Image |
イメージには、base64 でエンコードされたバイトまたは BLOB URL のいずれかを指定できます。 これらのオプションは 1 つだけ選択できます。 両方が指定されている場合、要求は拒否されます。 最大イメージ サイズは 2048 x 2048 ピクセルであり、4 MB を超えないようにします。最小イメージ サイズは 50 x 50 ピクセルです。 |
AnalyzeImageOptions
画像分析要求。
名前 | 型 | 規定値 | 説明 |
---|---|---|---|
categories |
カテゴリが分析されます。 割り当てられない場合は、カテゴリの既定の分析結果セットが返されます。 |
||
image |
分析する画像。 |
||
outputType | FourSeverityLevels |
これは、画像分析出力の種類を指します。 値が割り当てられていない場合、既定値は "FourSeverityLevels" になります。 |
AnalyzeImageOutputType
これは、画像分析出力の種類を指します。 値が割り当てられていない場合、既定値は "FourSeverityLevels" になります。
名前 | 型 | 説明 |
---|---|---|
FourSeverityLevels |
string |
出力の重大度は 4 レベルで、値は 0,2,4,6 にすることができます。 |
AnalyzeImageResult
画像分析応答。
名前 | 型 | 説明 |
---|---|---|
categoriesAnalysis |
カテゴリの分析結果。 |
Azure.Core.Foundations.Error
エラー オブジェクト。
名前 | 型 | 説明 |
---|---|---|
code |
string |
サーバー定義の一連のエラー コードの 1 つ。 |
details |
この報告されたエラーの原因となった特定のエラーに関する詳細の配列。 |
|
innererror |
エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。 |
|
message |
string |
エラーの人間が判読できる表現。 |
target |
string |
エラーのターゲット。 |
Azure.Core.Foundations.ErrorResponse
エラーの詳細を含む応答。
名前 | 型 | 説明 |
---|---|---|
error |
エラー オブジェクト。 |
Azure.Core.Foundations.InnerError
エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
名前 | 型 | 説明 |
---|---|---|
code |
string |
サーバー定義の一連のエラー コードの 1 つ。 |
innererror |
内部エラー。 |
ImageCategoriesAnalysis
画像分析結果。
名前 | 型 | 説明 |
---|---|---|
category |
画像分析カテゴリ。 |
|
severity |
integer |
値は、入力コンテンツの重大度に応じて増加します。 このフィールドの値は、要求で指定された出力の種類によって決まります。 出力の種類は 'FourSeverityLevels' で、出力値は 0、2、4、6 にすることができます。 |
ImageCategory
画像コンテンツ分析でサポートされる損害カテゴリ。
名前 | 型 | 説明 |
---|---|---|
Hate |
string |
画像 - ヘイトの損害カテゴリ。 |
SelfHarm |
string |
Image - SelfHarm の損害カテゴリ。 |
Sexual |
string |
画像の損害カテゴリ - 性的。 |
Violence |
string |
画像の損害カテゴリ - 暴力。 |
ImageData
イメージには、base64 でエンコードされたバイトまたは BLOB URL のいずれかを指定できます。 これらのオプションは 1 つだけ選択できます。 両方が指定されている場合、要求は拒否されます。 最大イメージ サイズは 2048 x 2048 ピクセルであり、4 MB を超えないようにします。最小イメージ サイズは 50 x 50 ピクセルです。
名前 | 型 | 説明 |
---|---|---|
blobUrl |
string |
イメージの BLOB URL。 |
content |
string |
イメージの Base64 エンコード。 |