Image Operations - Analyze Image

Служба:: Azure AI Services

Версия API:: 2024-09-01

Анализ изображения
Синхронный API для анализа потенциально вредного содержимого изображения. В настоящее время она поддерживает четыре категории: "Ненависть", "Самохарм", "Сексуальное" и "Насилие".

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string (uri)	Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например: https://< имя-ресурса.cognitiveservices.azure.com>).
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.

Текст запроса

Имя	Обязательно	Тип	Описание
image	True	ImageData	Изображение для анализа.
categories		ImageCategory[]	Категории будут проанализированы. Если они не назначены, возвращается набор результатов анализа по умолчанию для категорий.
outputType		AnalyzeImageOutputType	Это относится к типу выходных данных анализа изображений. Если значение не назначено, значение по умолчанию будет иметь значение FourSeverityLevels.

Ответы

Имя	Тип	Описание
200 OK	AnalyzeImageResult	Запрос выполнен успешно.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Непредвиденное сообщение об ошибке. Заголовки x-ms-error-code: string

Имя

Тип

Описание

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

Области

Имя	Описание
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
    }
  ]
}

Определения

Имя	Описание
AnalyzeImageOptions	Запрос на анализ изображений.
AnalyzeImageOutputType	Это относится к типу выходных данных анализа изображений. Если значение не назначено, значение по умолчанию будет иметь значение FourSeverityLevels.
AnalyzeImageResult	Ответ на анализ изображений.
Azure.Core.Foundations.Error	Объект ошибки.
Azure.Core.Foundations.ErrorResponse	Ответ, содержащий сведения об ошибке.
Azure.Core.Foundations.InnerError	Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по Azure REST API — https://aka.ms/AzureRestApiGuidelines#handling-errors.
ImageCategoriesAnalysis	Результат анализа изображений.
ImageCategory	Категория вреда, поддерживаемая в анализе содержимого изображения.
ImageData	Изображение может быть закодировано в кодировке Base64 или URL-адрес большого двоичного объекта. Вы можете выбрать только один из этих вариантов. Если оба указаны, запрос будет отклонен. Максимальный размер изображения составляет 2048 x 2048 пикселей и не должен превышать 4 МБ, а минимальный размер изображения составляет 50 x 50 пикселей.

AnalyzeImageOptions

Объект

Запрос на анализ изображений.

Имя	Тип	Default value	Описание
categories	ImageCategory[]		Категории будут проанализированы. Если они не назначены, возвращается набор результатов анализа по умолчанию для категорий.
image	ImageData		Изображение для анализа.
outputType	AnalyzeImageOutputType	FourSeverityLevels	Это относится к типу выходных данных анализа изображений. Если значение не назначено, значение по умолчанию будет иметь значение FourSeverityLevels.

AnalyzeImageOutputType

Перечисление

Это относится к типу выходных данных анализа изображений. Если значение не назначено, значение по умолчанию будет иметь значение FourSeverityLevels.

Значение	Описание
FourSeverityLevels	Уровень серьезности выходных данных в четырех уровнях может иметь значение 0,2 4,6.

AnalyzeImageResult

Объект

Ответ на анализ изображений.

Имя	Тип	Описание
categoriesAnalysis	ImageCategoriesAnalysis[]	Результат анализа для категорий.

Azure.Core.Foundations.Error

Объект

Объект ошибки.

Имя	Тип	Описание
code	string	Один из определяемых сервером кодов ошибок.
details	Azure.Core.Foundations.Error[]	Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.
innererror	Azure.Core.Foundations.InnerError	Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.
message	string	Читаемое пользователем представление ошибки.
target	string	Целевой объект ошибки.

Azure.Core.Foundations.ErrorResponse

Объект

Ответ, содержащий сведения об ошибке.

Имя	Тип	Описание
error	Azure.Core.Foundations.Error	Объект ошибки.

Azure.Core.Foundations.InnerError

Объект

Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по Azure REST API — https://aka.ms/AzureRestApiGuidelines#handling-errors.

Имя	Тип	Описание
code	string	Один из определяемых сервером кодов ошибок.
innererror	Azure.Core.Foundations.InnerError	Внутренняя ошибка.

ImageCategoriesAnalysis

Объект

Результат анализа изображений.

Имя	Тип	Описание
category	ImageCategory	Категория анализа изображений.
severity	integer (int32)	Значение увеличивается с серьезностью входного содержимого. Значение этого поля определяется типом выходных данных, указанным в запросе. Тип выходных данных может быть "FourSeverityLevels", а выходное значение может иметь значение 0, 2, 4, 6.

ImageCategory

Перечисление

Категория вреда, поддерживаемая в анализе содержимого изображения.

Значение	Описание
Hate	Категория вреда для изображения - Ненависть.
SelfHarm	Категория вреда для Image — SelfHarm.
Sexual	Категория вреда для изображения - сексуальный.
Violence	Категория вреда для изображения - насилие.

ImageData

Объект

Изображение может быть закодировано в кодировке Base64 или URL-адрес большого двоичного объекта. Вы можете выбрать только один из этих вариантов. Если оба указаны, запрос будет отклонен. Максимальный размер изображения составляет 2048 x 2048 пикселей и не должен превышать 4 МБ, а минимальный размер изображения составляет 50 x 50 пикселей.

Имя	Тип	Описание
blobUrl	string (uri)	URL-адрес большого двоичного объекта изображения.
content	string (byte)	Кодировка Base64 изображения.

Поделиться через

Image Operations - Analyze Image

Параметры URI

Текст запроса

Ответы

Безопасность

Ocp-Apim-Subscription-Key

OAuth2Auth

Области

Примеры

Analyze Image

Образец запроса

Пример ответа

Определения

AnalyzeImageOptions

AnalyzeImageOutputType

AnalyzeImageResult

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

ImageCategoriesAnalysis

ImageCategory

ImageData