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


Analyze - Image

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

POST /imageanalysis:analyze?api-version=2024-02-01
POST /imageanalysis:analyze?features={features}&language={language}&model-version={model-version}&smartcrops-aspect-ratios={smartcrops-aspect-ratios}&gender-neutral-caption={gender-neutral-caption}&api-version=2024-02-01

Параметры URI

Имя В Обязательно Тип Описание
api-version
query True

string

Запрошенная версия API.

features
query

VisualFeature[]

Запрошенные визуальные функции. Необходимо указать хотя бы один визуальный компонент.

gender-neutral-caption
query

boolean

Логический флаг для включения гендерно-нейтрального субтитров для функций caption и denseCaptions. Если этот параметр не указан, по умолчанию используется значение false.

language
query

string

Требуемый язык для создания выходных данных. Если этот параметр не задан, используется значение по умолчанию "en". Список поддерживаемых языков см. в этой статье https://aka.ms/cv-languages .

model-version
query

string

Версия модели.

smartcrops-aspect-ratios
query

array[]

Список пропорций, используемых для функции 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

Примеры

ImageAnalysis_Analyze_MaximumSet_Gen
ImageAnalysis_Analyze_MinimumSet_Gen

ImageAnalysis_Analyze_MaximumSet_Gen

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

POST /imageanalysis:analyze?features=tags&language=hduryxtlvjjvwnmpjiojibvjy&model-version=kkblitshktun&smartcrops-aspect-ratios=&gender-neutral-caption=True&api-version=2024-02-01

{
  "url": "https://microsoft.com/a"
}

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

{
  "captionResult": {
    "text": "azcggjzjuvbytsq",
    "confidence": 0
  },
  "objectsResult": {
    "values": [
      {
        "id": "iaofvdltgfjrsffgltupmo",
        "boundingBox": {
          "x": 0,
          "y": 0,
          "w": 27,
          "h": 13
        },
        "tags": [
          {
            "name": "expoctetvqe",
            "confidence": 0
          }
        ]
      }
    ]
  },
  "readResult": {
    "blocks": [
      {
        "lines": [
          {
            "text": "npk",
            "boundingPolygon": [
              {
                "x": 0,
                "y": 0
              },
              {
                "x": 0,
                "y": 0
              },
              {
                "x": 0,
                "y": 0
              },
              {
                "x": 0,
                "y": 0
              }
            ],
            "words": [
              {
                "text": "wljuxeeadklupdpxgcinka",
                "boundingPolygon": [
                  {
                    "x": 0,
                    "y": 0
                  },
                  {
                    "x": 0,
                    "y": 0
                  },
                  {
                    "x": 0,
                    "y": 0
                  },
                  {
                    "x": 0,
                    "y": 0
                  }
                ],
                "confidence": 0
              }
            ]
          }
        ]
      }
    ]
  },
  "denseCaptionsResult": {
    "values": [
      {
        "text": "pqrcyrtz",
        "confidence": 0,
        "boundingBox": {
          "x": 0,
          "y": 0,
          "w": 27,
          "h": 13
        }
      }
    ]
  },
  "modelVersion": "hslbdtpcuyabri",
  "metadata": {
    "width": 10,
    "height": 27
  },
  "tagsResult": {
    "values": [
      {
        "name": "expoctetvqe",
        "confidence": 0
      }
    ]
  },
  "smartCropsResult": {
    "values": [
      {
        "aspectRatio": 23,
        "boundingBox": {
          "x": 0,
          "y": 0,
          "w": 27,
          "h": 13
        }
      }
    ]
  },
  "peopleResult": {
    "values": [
      {
        "boundingBox": {
          "x": 0,
          "y": 0,
          "w": 27,
          "h": 13
        },
        "confidence": 0
      }
    ]
  }
}

ImageAnalysis_Analyze_MinimumSet_Gen

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

POST /imageanalysis:analyze?api-version=2024-02-01

{
  "url": "https://www.abc.com"
}

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

{
  "modelVersion": "cvhbhwpfswz",
  "metadata": {
    "width": 10,
    "height": 23
  }
}

Определения

Имя Описание
BoundingBox

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

CaptionResult

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

ContentTag

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

CropRegion

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

DenseCaption

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

DenseCaptionsResult

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

DetectedObject

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

DetectedPerson

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

DetectedTextBlock

Обнаруженный блок текста.

DetectedTextLine

Обнаруженная текстовая строка.

DetectedTextWord

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

ErrorResponse

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

ErrorResponseDetails

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

ErrorResponseInnerError

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

ImageAnalysisResult

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

ImageMetadata

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

ImagePoint

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

ImageUrl

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

ObjectsResult

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

PeopleResult

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

ReadResult

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

SmartCropsResult

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

TagsResult

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

VisualFeature

Запрошенные визуальные функции. Необходимо указать хотя бы одну визуальную функцию.

BoundingBox

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

Имя Тип Описание
h

integer

Высота, измеряемая от верхней левой точки области, в пикселях.

w

integer

Ширина, измеряемая от верхней левой точки области, в пикселях.

x

integer

Левая координата верхней левой точки области в пикселях.

y

integer

Верхняя координата левой верхней точки области в пикселях.

CaptionResult

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

Имя Тип Описание
confidence

number

Уровень доверия службы в заголовке. Оценки достоверности охватывают диапазон от 0,0 до 1,0 (включительно), при этом более высокие значения указывают на более высокую достоверность совпадения.

text

string

Текст заголовка.

ContentTag

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

Имя Тип Описание
confidence

number

Уровень достоверности наблюдаемой сущности. Оценки достоверности охватывают диапазон от 0,0 до 1,0 (включительно), при этом более высокие значения указывают на более высокую достоверность совпадения.

name

string

Имя сущности.

CropRegion

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

Имя Тип Описание
aspectRatio

number

Пропорции области обрезки.

boundingBox

BoundingBox

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

DenseCaption

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

Имя Тип Описание
boundingBox

BoundingBox

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

confidence

number

Уровень доверия службы в заголовке. Оценки достоверности охватывают диапазон от 0,0 до 1,0 (включительно), при этом более высокие значения указывают на более высокую достоверность совпадения.

text

string

Текст заголовка.

DenseCaptionsResult

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

Имя Тип Описание
values

DenseCaption[]

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

DetectedObject

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

Имя Тип Описание
boundingBox

BoundingBox

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

id

string

Идентификатор обнаруженного объекта.

tags

ContentTag[]

Достоверность классификации обнаруженного объекта.

DetectedPerson

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

Имя Тип Описание
boundingBox

BoundingBox

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

confidence

number

Оценка достоверности наблюдения за человеком на изображении. Оценки достоверности охватывают диапазон от 0,0 до 1,0 (включительно), при этом более высокие значения указывают на более высокую достоверность совпадения.

DetectedTextBlock

Обнаруженный блок текста.

Имя Тип Описание
lines

DetectedTextLine[]

Список текстовых строк в текстовом блоке.

DetectedTextLine

Обнаруженная текстовая строка.

Имя Тип Описание
boundingPolygon

ImagePoint[]

Ограничивающий многоугольник текстовой строки.

text

string

Текстовое содержимое обнаруженной текстовой строки.

words

DetectedTextWord[]

Список слов в текстовой строке.

DetectedTextWord

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

Имя Тип Описание
boundingPolygon

ImagePoint[]

Ограничивающий многоугольник слова.

confidence

number

Уровень достоверности обнаружения слова. Оценки достоверности охватывают диапазон от 0,0 до 1,0 (включительно), при этом более высокие значения указывают на более высокую достоверность совпадения.

text

string

Текстовое содержимое слова.

ErrorResponse

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

Имя Тип Описание
error

ErrorResponseDetails

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

ErrorResponseDetails

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

Имя Тип Описание
code

string

Код ошибки.

details

ErrorResponseDetails[]

Список подробных ошибок.

innererror

ErrorResponseInnerError

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

message

string

Сообщение об ошибке.

target

string

Целевой объект ошибки.

ErrorResponseInnerError

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

Имя Тип Описание
code

string

Код ошибки.

innererror

ErrorResponseInnerError

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

message

string

Сообщение об ошибке.

ImageAnalysisResult

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

Имя Тип Описание
captionResult

CaptionResult

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

denseCaptionsResult

DenseCaptionsResult

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

metadata

ImageMetadata

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

modelVersion

string

Версия модели.

objectsResult

ObjectsResult

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

peopleResult

PeopleResult

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

readResult

ReadResult

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

smartCropsResult

SmartCropsResult

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

tagsResult

TagsResult

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

ImageMetadata

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

Имя Тип Описание
height

integer

Высота изображения в пикселях.

width

integer

Ширина изображения в пикселях.

ImagePoint

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

Имя Тип Описание
x

integer

Координата X этой точки.

y

integer

Координата Y этой точки.

ImageUrl

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

Имя Тип Описание
url

string

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

ObjectsResult

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

Имя Тип Описание
values

DetectedObject[]

Массив обнаруженных объектов.

PeopleResult

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

Имя Тип Описание
values

DetectedPerson[]

Массив обнаруженных людей.

ReadResult

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

Имя Тип Описание
blocks

DetectedTextBlock[]

Список текстовых блоков.

SmartCropsResult

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

Имя Тип Описание
values

CropRegion[]

Рекомендуемые регионы для обрезки изображения.

TagsResult

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

Имя Тип Описание
values

ContentTag[]

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

VisualFeature

Запрошенные визуальные функции. Необходимо указать хотя бы одну визуальную функцию.

Имя Тип Описание
caption

string

Описание или заголовок, суммируя содержимое изображения.

denseCaptions

string

Подробные субтитры, предоставляющие подробное описание содержимого изображения.

objects

string

Определенные объекты, распознанные и помеченные на изображении.

people

string

Обнаружение и анализ людей на изображении.

read

string

Текстовое содержимое, извлеченное из изображения, например знаки или метки.

smartCrops

string

Автоматически создаваемые обрезанные версии изображения, ориентированные на важное содержимое.

tags

string

Визуальные теги, представляющие объекты, обнаруженные на изображении.