Describe Image - Describe Image

Служба:

Azure AI Services

Версия API:

3.2

Эта операция создает описание изображения на удобочитаемом языке с полными предложениями. Описание основано на коллекции тегов контента, которые также возвращаются операцией. Для каждого изображения можно создать несколько описаний. Описания упорядочены по их оценке достоверности. Описания могут включать результаты из моделей знаменитостей и ориентиров предметной области, если это применимо. Поддерживаются два метода ввода: (1) Отправка изображения или (2) с указанием URL-адреса изображения. Успешный ответ будет возвращен в формате JSON. Если запрос завершился сбоем, ответ будет содержать код ошибки и сообщение, чтобы понять, что произошло неправильно.

POST {Endpoint}/vision/v3.2/describe

С использованием необязательных параметров:

POST {Endpoint}/vision/v3.2/describe?maxCandidates={maxCandidates}&language={language}&descriptionExclude={descriptionExclude}&model-version={model-version}

Параметры URI

Имя	В	Обязательно	Тип	Описание
Endpoint	path	True	string	Поддерживаемые конечные точки Cognitive Services.
descriptionExclude	query		DescriptionExclude[]	Отключите указанные модели домена при создании описания.
language	query		string	Нужный язык для создания выходных данных. Если этот параметр не указан, значение по умолчанию — en. Список поддерживаемых языков см. в https://aka.ms/cv-languages.
maxCandidates	query		integer (int32)	Максимальное количество возвращаемых описаний кандидатов. Значение по умолчанию — 1.
model-version	query		string pattern: ^(latest|\d{4}-\d{2}-\d{2})(-preview)?$	Необязательный параметр, указывающий версию модели ИИ. Допустимые значения: "latest", "2021-04-01", "2021-05-01". По умолчанию используется значение "последняя".

Заголовок запроса

Имя	Обязательно	Тип	Описание
Ocp-Apim-Subscription-Key	True	string

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

Имя	Обязательно	Тип	Описание
url	True	string	Общедоступный URL-адрес изображения.

Ответы

Имя	Тип	Описание
200 OK	ImageDescription	Объект описания изображения.
Other Status Codes	ComputerVisionErrorResponse	Ответ на ошибку.

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

Ocp-Apim-Subscription-Key

Тип: apiKey
В: header

Примеры

Successful DescribeImage request

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

HTTP

POST https://westus.api.cognitive.microsoft.com/vision/v3.2/describe?maxCandidates=1


{
  "url": "{url}"
}

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

Код состояния:

200

{
  "description": {
    "tags": [
      "person",
      "man",
      "outdoor",
      "window",
      "glasses"
    ],
    "captions": [
      {
        "text": "Satya Nadella sitting on a bench",
        "confidence": 0.48293603002174407
      }
    ]
  },
  "requestId": "ed2de1c6-fb55-4686-b0da-4da6e05d283f",
  "metadata": {
    "width": 1500,
    "height": 1000,
    "format": "Jpeg"
  },
  "modelVersion": "2021-04-01"
}

Определения

Имя	Описание
ComputerVisionError	Ошибка запроса API.
ComputerVisionErrorCodes	Код ошибки.
ComputerVisionErrorResponse	Ответ об ошибке API.
ComputerVisionInnerError	Сведения об ошибке запроса API.
ComputerVisionInnerErrorCodeValue	Код ошибки.
DescriptionExclude	Отключите указанные модели домена при создании описания.
ImageCaption	Заголовок изображения, т. е. краткое описание изображения.
ImageDescription	Коллекция тегов контента, а также список подписей, отсортированных по уровню достоверности и метаданным изображения.
ImageMetadata	Метаданные изображения.
ImageUrl

ComputerVisionError

Object

Ошибка запроса API.

Имя	Тип	Описание
code	ComputerVisionErrorCodes	Код ошибки.
innererror	ComputerVisionInnerError	Внутренняя ошибка содержит более конкретные сведения.
message	string	Сообщение, объясняющее ошибку, сообщаемую службой.

ComputerVisionErrorCodes

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

Код ошибки.

Значение	Описание
InternalServerError
InvalidArgument
InvalidRequest
ServiceUnavailable

ComputerVisionErrorResponse

Object

Ответ об ошибке API.

Имя	Тип	Описание
error	ComputerVisionError	Содержимое ошибки.

ComputerVisionInnerError

Object

Сведения об ошибке запроса API.

Имя	Тип	Описание
code	ComputerVisionInnerErrorCodeValue	Код ошибки.
message	string	Сообщение об ошибке.

ComputerVisionInnerErrorCodeValue

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

Код ошибки.

Значение	Описание
BadArgument
CancelledRequest
DetectFaceError
FailedToProcess
InternalServerError
InvalidDetails
InvalidImageFormat
InvalidImageSize
InvalidImageUrl
InvalidModel
InvalidThumbnailSize
NotSupportedFeature
NotSupportedImage
NotSupportedLanguage
NotSupportedVisualFeature
StorageException
Timeout
Unspecified
UnsupportedMediaType

DescriptionExclude

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

Отключите указанные модели домена при создании описания.

Значение	Описание
Celebrities
Landmarks

ImageCaption

Object

Заголовок изображения, т. е. краткое описание изображения.

Имя	Тип	Описание
confidence	number (double)	Уровень достоверности службы имеется в заголовке.
text	string	Текст заголовка.

ImageDescription

Object

Коллекция тегов контента, а также список подписей, отсортированных по уровню достоверности и метаданным изображения.

Имя	Тип	Описание
description.captions	ImageCaption[]	Список подписей, отсортированных по уровню достоверности.
description.tags	string[]	Коллекция тегов изображений.
metadata	ImageMetadata	Метаданные изображения.
modelVersion	string pattern: ^(latest|\d{4}-\d{2}-\d{2})(-preview)?$	Версия модели ИИ.
requestId	string	Идентификатор запроса REST API.

ImageMetadata

Object

Метаданные изображения.

Имя	Тип	Описание
format	string	Формат изображения.
height	integer (int32)	Высота изображения в пикселях.
width	integer (int32)	Ширина изображения в пикселях.

ImageUrl

Object

Имя	Тип	Описание
url	string	Общедоступный URL-адрес изображения.