Image Operations - Analyze Image

服務:

Azure AI Services

API 版本:

2024-09-01

分析影像
用於分析潛在有害影像內容的同步 API。 目前，它支援四種類別：仇恨、自我哈姆、性與暴力。

POST {endpoint}/contentsafety/image:analyze?api-version=2024-09-01

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string	支援的認知服務端點（通訊協定和主機名，例如：https://.cognitiveservices.azure.com).
api-version	query	True	string	要用於這項作業的 API 版本。

要求本文

名稱	必要	類型	Description
image	True	ImageData	要分析的影像。
categories		ImageCategory[]	系統會分析類別。 如果未指派它們，則會傳回類別的預設分析結果集。
outputType		AnalyzeImageOutputType	這是指影像分析輸出的類型。 如果未指派任何值，預設值會是 “FourSeverityLevels”。

回應

名稱	類型	Description
200 OK	AnalyzeImageResult	要求已成功。
Other Status Codes	Azure.Core.Foundations.ErrorResponse	未預期的錯誤回應。 標題 x-ms-error-code: string

安全性

Ocp-Apim-Subscription-Key

類型: apiKey
位於: header

OAuth2Auth

類型: oauth2
Flow: application
權杖 URL: https://login.microsoftonline.com/common/oauth2/v2.0/token

範圍

名稱	Description
https://cognitiveservices.azure.com/.default

範例

Analyze Image

範例要求

HTTP

POST {endpoint}/contentsafety/image:analyze?api-version=2024-09-01

{
  "image": {
    "content": "Y29udGVudDE="
  }
}

範例回覆

狀態碼:

200

{
  "categoriesAnalysis": [
    {
      "category": "Hate",
      "severity": 0
    },
    {
      "category": "SelfHarm",
      "severity": 0
    },
    {
      "category": "Sexual",
      "severity": 0
    },
    {
      "category": "Violence",
      "severity": 2
    }
  ]
}

定義

名稱	Description
AnalyzeImageOptions	影像分析要求。
AnalyzeImageOutputType	這是指影像分析輸出的類型。 如果未指派任何值，預設值會是 “FourSeverityLevels”。
AnalyzeImageResult	影像分析回應。
Azure.Core.Foundations.Error	error 物件。
Azure.Core.Foundations.ErrorResponse	包含錯誤詳細數據的回應。
Azure.Core.Foundations.InnerError	物件，包含有關錯誤的更特定資訊。 根據Microsoft一個 API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
ImageCategoriesAnalysis	影像分析結果。
ImageCategory	影像內容分析中支持的傷害類別。
ImageData	影像可以是base64編碼的位元組或 Blob URL。 您只能選擇其中一個選項。 如果兩者都提供，則會拒絕要求。 影像大小上限為 2048 x 2048 像素，不應超過 4 MB，而最小影像大小為 50 x 50 像素。

AnalyzeImageOptions

影像分析要求。

名稱	類型	預設值	Description
categories	ImageCategory[]		系統會分析類別。 如果未指派它們，則會傳回類別的預設分析結果集。
image	ImageData		要分析的影像。
outputType	AnalyzeImageOutputType	FourSeverityLevels	這是指影像分析輸出的類型。 如果未指派任何值，預設值會是 “FourSeverityLevels”。

AnalyzeImageOutputType

這是指影像分析輸出的類型。 如果未指派任何值，預設值會是 “FourSeverityLevels”。

名稱	類型	Description
FourSeverityLevels	string	四個層級的輸出嚴重性，此值可以是 0,2,4,6。

AnalyzeImageResult

影像分析回應。

名稱	類型	Description
categoriesAnalysis	ImageCategoriesAnalysis[]	類別的分析結果。

Azure.Core.Foundations.Error

error 物件。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
details	Azure.Core.Foundations.Error[]	導致此錯誤之特定錯誤的詳細數據陣列。
innererror	Azure.Core.Foundations.InnerError	物件，包含與目前對象有關錯誤更具體的資訊。
message	string	錯誤的人類可讀取表示法。
target	string	錯誤的目標。

Azure.Core.Foundations.ErrorResponse

包含錯誤詳細數據的回應。

名稱	類型	Description
error	Azure.Core.Foundations.Error	error 物件。

Azure.Core.Foundations.InnerError

物件，包含有關錯誤的更特定資訊。 根據Microsoft一個 API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
innererror	Azure.Core.Foundations.InnerError	內部錯誤。

ImageCategoriesAnalysis

影像分析結果。

名稱	類型	Description
category	ImageCategory	影像分析類別。
severity	integer	值會隨著輸入內容的嚴重性而增加。 此欄位的值是由要求中指定的輸出類型所決定。 輸出類型可以是 'FourSeverityLevels'，輸出值可以是 0、2、4、6。

ImageCategory

影像內容分析中支持的傷害類別。

名稱	類型	Description
Hate	string	影像 - 仇恨的危害類別。
SelfHarm	string	Image - SelfHarm 的危害類別。
Sexual	string	影像 - 性傷害類別。
Violence	string	影像 - 暴力的傷害類別。

ImageData

影像可以是base64編碼的位元組或 Blob URL。 您只能選擇其中一個選項。 如果兩者都提供，則會拒絕要求。 影像大小上限為 2048 x 2048 像素，不應超過 4 MB，而最小影像大小為 50 x 50 像素。

名稱	類型	Description
blobUrl	string	影像的 Blob URL。
content	string	影像的Base64編碼。