Image Analysis - Analyze Image

Ссылка

Служба:: Azure AI Services

Версия API:: 2023-04-01-preview

Проанализируйте входное изображение. Запрос содержит поток изображения с любым типом контента ['image/*', 'application/octet-stream'] или полезные данные JSON, которые включают свойство URL, которое будет использоваться для извлечения потока изображения.

POST /imageanalysis:analyze?api-version=2023-04-01-preview

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

POST /imageanalysis:analyze?features={features}&model-name={model-name}&language={language}&smartcrops-aspect-ratios={smartcrops-aspect-ratios}&gender-neutral-caption={gender-neutral-caption}&api-version=2023-04-01-preview

Параметры URI

Имя	В	Обязательно	Тип	Описание
api-version	query	True	string	Запрошенная версия API.
features	query		VisualFeature[]	Запрошенные визуальные функции: теги, объекты, субтитры, denseCaptions, read, smartCrops, people. Этот параметр необходимо указать, если параметр model-name не указан.
gender-neutral-caption	query		boolean	Логический флаг для включения гендерно-нейтрального субтитров для функций caption и denseCaptions. Если этот параметр не указан, по умолчанию используется значение false.
language	query		string	Требуемый язык для создания выходных данных. Если этот параметр не задан, используется значение по умолчанию "en". Список поддерживаемых языков см. в этой статье https://aka.ms/cv-languages .
model-name	query		string	Имя настраиваемой обученной модели. Этот параметр необходимо указать, если параметр "features" не указан.
smartcrops-aspect-ratios	query		string	Список пропорций, используемых для функции smartCrops. Пропорции вычисляются путем деления целевой ширины обрезки на высоту. Поддерживаемые значения находятся в диапазоне от 0,75 до 1,8 (включительно). Несколько значений должны быть разделены запятыми. Если этот параметр не указан, служба вернет одно предложение обрезки с пропорциями, которые она считает подходящими в диапазоне от 0,5 до 2,0 (включительно).

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

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

Ответы

Имя	Тип	Описание
200 OK	ImageAnalysisResult	Успех
Other Status Codes	ErrorResponse	Ошибка Заголовки x-ms-error-code: string

Имя

Тип

Описание

200 OK

ImageAnalysisResult

Успех

Other Status Codes

ErrorResponse

Ошибка

Заголовки

x-ms-error-code: string

Примеры

AnalyzeImage_CustomModel

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

HTTP

POST /imageanalysis:analyze?model-name=my_model_name&api-version=2023-04-01-preview

{
  "url": "https://example.com/image.jpg"
}

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

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

{
  "customModelResult": {
    "objectsResult": {
      "values": [
        {
          "id": "1",
          "boundingBox": {
            "x": 197,
            "y": 68,
            "w": 356,
            "h": 394
          },
          "tags": [
            {
              "name": "class1",
              "confidence": 0.92431640625
            }
          ]
        },
        {
          "id": "2",
          "boundingBox": {
            "x": 0,
            "y": 77,
            "w": 241,
            "h": 359
          },
          "tags": [
            {
              "name": "class1",
              "confidence": 0.87890625
            }
          ]
        }
      ]
    }
  },
  "modelVersion": "2023-04-01-preview",
  "metadata": {
    "width": 660,
    "height": 495
  }
}

Определения

Имя	Описание
AdultMatch	Объект , описывающий совпадение содержимого для взрослых.
AdultResult	Объект, описывающий, содержит ли изображение содержимое, ориентированное на взрослых, и (или) является ли непристойным.
BoundingBox	Ограничивающий прямоугольник для области внутри изображения.
CaptionResult	Краткое описание того, что изображено на изображении.
CropRegion	Регион, определенный для интеллектуальной обрезки. Для каждого запрошенного пропорции будет возвращена одна область.
DenseCaption	Краткое описание того, что изображено на изображении.
DenseCaptionsResult	Список субтитров.
DetectedObject	Описывает обнаруженный объект на изображении.
DetectedPerson	Человек, обнаруженный на изображении.
DocumentLine	Объект строки содержимого, состоящий из соседней последовательности элементов содержимого, таких как слова и метки выделения.
DocumentPage	Содержимое и элементы макета, извлеченные из страницы из входных данных.
DocumentSpan	Смежная область объединенного свойства содержимого, указанная как смещение и длина.
DocumentStyle	Объект , представляющий наблюдаемые стили текста.
DocumentWord	Объект слова, состоящий из непрерывной последовательности символов. Для языков, не разделенных пробелами, таких как китайский, японский и корейский, каждый символ представлен как собственное слово.
ErrorResponse	Ответ возвращается при возникновении ошибки.
ErrorResponseDetails	Сведения об ошибке.
ErrorResponseInnerError	Подробная ошибка.
ImageAnalysisResult	Описывать объединенные результаты различных типов анализа изображений.
ImageMetadataApiModel	Сведения о метаданных изображения, такие как высота и ширина.
ImagePredictionResult	Описывает результат прогнозирования изображения.
ImageUrl	Документ JSON с URL-адресом, указывающим на анализируемое изображение.
ObjectsResult	Описывает обнаруженные объекты на изображении.
PeopleResult	Объект , описывающий, содержит ли изображение людей.
ReadResult	Результаты операции чтения.
SmartCropsResult	Результат интеллектуальной обрезки.
Tag	Наблюдение за сущностью на изображении, а также оценка достоверности.
TagsResult	Список тегов с уровнем достоверности.
VisualFeature	Запрошенные визуальные функции: теги, объекты, субтитры, denseCaptions, read, smartCrops, people. Этот параметр необходимо указать, если параметр model-name не указан.

AdultMatch

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

Имя	Тип	Описание
confidence	number	Значение , указывающее уровень достоверности совпадающего содержимого для взрослых.
isMatch	boolean	Значение , указывающее, соответствует ли изображение содержимому для взрослых.

AdultResult

Объект, описывающий, содержит ли изображение содержимое, ориентированное на взрослых, и (или) является ли непристойным.

Имя	Тип	Описание
adult	AdultMatch	Объект , описывающий совпадение содержимого для взрослых.
gore	AdultMatch	Объект , описывающий совпадение содержимого для взрослых.
racy	AdultMatch	Объект , описывающий совпадение содержимого для взрослых.

BoundingBox

Ограничивающий прямоугольник для области внутри изображения.

Имя	Тип	Описание
h	integer	Высота, измеряемая от верхней левой точки области, в пикселях.
w	integer	Ширина, измеряемая от верхней левой точки области, в пикселях.
x	integer	Левая координата верхней левой точки области в пикселях.
y	integer	Верхняя координата верхней левой точки области в пикселях.

CaptionResult

Краткое описание того, что изображено на изображении.

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

CropRegion

Регион, определенный для интеллектуальной обрезки. Для каждого запрошенного пропорции будет возвращена одна область.

Имя	Тип	Описание
aspectRatio	number	Пропорции области обрезки.
boundingBox	BoundingBox	Ограничивающий прямоугольник для области внутри изображения.

DenseCaption

Краткое описание того, что изображено на изображении.

Имя	Тип	Описание
boundingBox	BoundingBox	Ограничивающий прямоугольник для области внутри изображения.
confidence	number	Уровень достоверности, который служба имеет в заголовке.
text	string	Текст заголовка.

DenseCaptionsResult

Список субтитров.

Имя	Тип	Описание
values	DenseCaption[]	Список субтитров.

DetectedObject

Описывает обнаруженный объект на изображении.

Имя	Тип	Описание
boundingBox	BoundingBox	Ограничивающий прямоугольник для области внутри изображения.
id	string	Идентификатор обнаруженного объекта.
tags	Tag[]	Достоверность классификации обнаруженного объекта.

DetectedPerson

Человек, обнаруженный на изображении.

Имя	Тип	Описание
boundingBox	BoundingBox	Ограничивающий прямоугольник для области внутри изображения.
confidence	number	Оценка достоверности наблюдения за человеком на изображении как значение в диапазоне от 0 до 1.

DocumentLine

Объект строки содержимого, состоящий из соседней последовательности элементов содержимого, таких как слова и метки выделения.

Имя	Тип	Описание
boundingBox	number[]	Ограничивающий прямоугольник линии.
content	string	Сцепленное содержимое содержащихся элементов в порядке чтения.
spans	DocumentSpan[]	Расположение строки в сцепленном содержимом в порядке чтения.

DocumentPage

Содержимое и элементы макета, извлеченные из страницы из входных данных.

Имя	Тип	Описание
angle	number	Общая ориентация содержимого по часовой стрелке, измеряемая в градусах между (-180, 180].
height	number	Высота изображения/PDF в пикселях/дюймах соответственно.
lines	DocumentLine[]	Извлеченные строки со страницы, потенциально содержащие как текстовые, так и визуальные элементы.
pageNumber	integer	1-й номер страницы во входном документе.
spans	DocumentSpan[]	Расположение страницы в сцепленном содержимом в порядке чтения.
width	number	Ширина изображения/PDF в пикселях/дюймах соответственно.
words	DocumentWord[]	Извлеченные слова со страницы.

DocumentSpan

Смежная область объединенного свойства содержимого, указанная как смещение и длина.

Имя	Тип	Описание
length	integer	Число символов в содержимом, представленном диапазоном.
offset	integer	Отсчитываемый от нуля индекс содержимого, представленного диапазоном.

DocumentStyle

Объект , представляющий наблюдаемые стили текста.

Имя	Тип	Описание
confidence	number	Уверенность в правильном определении стиля.
isHandwritten	boolean	Является ли содержимое рукописным или нет.
spans	DocumentSpan[]	Расположение текстовых элементов в сцепленном содержимом, к которому применяется стиль.

DocumentWord

Объект слова, состоящий из непрерывной последовательности символов. Для языков, не разделенных пробелами, таких как китайский, японский и корейский, каждый символ представлен как собственное слово.

Имя	Тип	Описание
boundingBox	number[]	Ограничивающий прямоугольник слова.
confidence	number	Уверенность в правильном извлечении слова.
content	string	Текстовое содержимое слова.
span	DocumentSpan	Смежная область объединенного свойства содержимого, указанная как смещение и длина.

ErrorResponse

Ответ возвращается при возникновении ошибки.

Имя	Тип	Описание
error	ErrorResponseDetails	Сведения об ошибке.

ErrorResponseDetails

Сведения об ошибке.

Имя	Тип	Описание
code	string	Код ошибки.
details	ErrorResponseDetails[]	Список подробных ошибок.
innererror	ErrorResponseInnerError	Подробная ошибка.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponseInnerError

Подробная ошибка.

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

ImageAnalysisResult

Описывать объединенные результаты различных типов анализа изображений.

Имя	Тип	Описание
adultResult	AdultResult	Объект, описывающий, содержит ли изображение содержимое, ориентированное на взрослых, и (или) является ли непристойным.
captionResult	CaptionResult	Краткое описание того, что изображено на изображении.
customModelResult	ImagePredictionResult	Описывает результат прогнозирования изображения.
denseCaptionsResult	DenseCaptionsResult	Список субтитров.
metadata	ImageMetadataApiModel	Сведения о метаданных изображения, такие как высота и ширина.
modelVersion	string	Версия модели.
objectsResult	ObjectsResult	Описывает обнаруженные объекты на изображении.
peopleResult	PeopleResult	Объект , описывающий, содержит ли изображение людей.
readResult	ReadResult	Результаты операции чтения.
smartCropsResult	SmartCropsResult	Результат интеллектуальной обрезки.
tagsResult	TagsResult	Список тегов с уровнем достоверности.

ImageMetadataApiModel

Сведения о метаданных изображения, такие как высота и ширина.

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

ImagePredictionResult

Описывает результат прогнозирования изображения.

Имя	Тип	Описание
objectsResult	ObjectsResult	Описывает обнаруженные объекты на изображении.
tagsResult	TagsResult	Список тегов с уровнем достоверности.

ImageUrl

Документ JSON с URL-адресом, указывающим на анализируемое изображение.

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

ObjectsResult

Описывает обнаруженные объекты на изображении.

Имя	Тип	Описание
values	DetectedObject[]	Массив обнаруженных объектов.

PeopleResult

Объект , описывающий, содержит ли изображение людей.

Имя	Тип	Описание
values	DetectedPerson[]	Массив обнаруженных людей.

ReadResult

Результаты операции чтения.

Имя	Тип	Описание
content	string	Сцепить строковое представление всех текстовых и визуальных элементов в порядке чтения.
pages	DocumentPage[]	Список проанализированных страниц.
stringIndexType	string	Метод, используемый для вычисления смещения и длины строки, возможные значения: "textElements", "unicodeCodePoint", "utf16CodeUnit" и т. д.
styles	DocumentStyle[]	Извлеченные стили шрифтов.

SmartCropsResult

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

Имя	Тип	Описание
values	CropRegion[]	Рекомендуемые регионы для обрезки изображения.

Tag

Наблюдение за сущностью на изображении, а также оценка достоверности.

Имя	Тип	Описание
confidence	number	Уровень достоверности наблюдаемой сущности.
name	string	Имя сущности.

TagsResult

Список тегов с уровнем достоверности.

Имя	Тип	Описание
values	Tag[]	Список тегов с уровнем достоверности.

VisualFeature

Запрошенные визуальные функции: теги, объекты, субтитры, denseCaptions, read, smartCrops, people. Этот параметр необходимо указать, если параметр model-name не указан.

Имя	Тип	Описание
caption	string
denseCaptions	string
objects	string
people	string
read	string
smartCrops	string
tags	string

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

Image Analysis - Analyze Image

Параметры URI

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

Ответы

Примеры

AnalyzeImage_CustomModel

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

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

Определения

AdultMatch

AdultResult

BoundingBox

CaptionResult

CropRegion

DenseCaption

DenseCaptionsResult

DetectedObject

DetectedPerson

DocumentLine

DocumentPage

DocumentSpan

DocumentStyle

DocumentWord

ErrorResponse

ErrorResponseDetails

ErrorResponseInnerError

ImageAnalysisResult

ImageMetadataApiModel

ImagePredictionResult

ImageUrl

ObjectsResult

PeopleResult

ReadResult

SmartCropsResult

Tag

TagsResult

VisualFeature

Дополнительные ресурсы