Analyze Image - Analyze Image

Referência

Serviço:: Azure AI Services

Versão da API:: 3.1

Essa operação extrai um conjunto avançado de recursos visuais com base no conteúdo da imagem. Há suporte para dois métodos de entrada : (1) Carregar uma imagem ou (2) especificar uma URL de imagem. Em sua solicitação, há um parâmetro opcional para permitir que você escolha quais recursos retornar. Por padrão, as categorias de imagem são retornadas na resposta. Uma resposta bem-sucedida será retornada em JSON. Se a solicitação falhar, a resposta conterá um código de erro e uma mensagem para ajudar a entender o que deu errado.

POST {Endpoint}/vision/v3.1/analyze

Com parâmetros opcionais:

POST {Endpoint}/vision/v3.1/analyze?visualFeatures={visualFeatures}&details={details}&language={language}&descriptionExclude={descriptionExclude}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
Endpoint	path	True	string	Pontos de extremidade dos Serviços Cognitivos com suporte.
descriptionExclude	query		DescriptionExclude[]	Desative os modelos de domínio especificados ao gerar a descrição.
details	query		Details[]	Uma cadeia de caracteres que indica quais detalhes específicos do domínio devem ser retornados. Vários valores devem ser separados por vírgulas. Os tipos de recursos visuais válidos incluem: Celebridades - identifica celebridades se detectadas na imagem, Landmarks - identifica pontos de referência notáveis na imagem.
language	query		string	A linguagem desejada para geração de saída. Se esse parâmetro não for especificado, o valor padrão será "en". Idiomas com suporte:en - inglês, Padrão. es - espanhol, ja - japonês, pt - português, zh - chinês simplificado.
visualFeatures	query		VisualFeatureTypes[]	Uma cadeia de caracteres que indica quais tipos de recursos visuais devem ser retornados. Vários valores devem ser separados por vírgulas. Os tipos de recursos visuais válidos incluem: Categorias – categoriza o conteúdo da imagem de acordo com uma taxonomia definida na documentação. Marcas – marca a imagem com uma lista detalhada de palavras relacionadas ao conteúdo da imagem. Descrição - descreve o conteúdo da imagem com uma frase em inglês completa. Faces – detecta se os rostos estão presentes. Se encontrar, gera coordenadas, sexo e idade. ImageType - detecta se a imagem é clip-art ou um desenho de linha. Cor – determina a cor de destaque, a cor dominante e se uma imagem é preta&branca. Adulto - detecta se a imagem é pornográfica por natureza (retrata nudez ou um ato sexual) ou é sangrenta (retrata violência extrema ou sangue). Conteúdo sexual (também conhecido como conteúdo picante) também será detectado. Objetos – detecta vários objetos dentro de uma imagem, incluindo o local aproximado. O argumento Objects só está disponível em inglês. Marcas – detecta várias marcas dentro de uma imagem, incluindo a localização aproximada. O argumento Brands só está disponível em inglês.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
url	True	string	URL acessível publicamente de uma imagem.

Respostas

Nome	Tipo	Description
200 OK	ImageAnalysis	A resposta inclui os recursos extraídos no formato JSON. Estas são as definições para tipos de enumeração: ClipartType Non - clipart = 0, ambíguo = 1, normal - clipart = 2, bom - clipart = 3. LineDrawingTypeNon - LineDrawing = 0, LineDrawing = 1.
Other Status Codes	ComputerVisionError	Resposta de erro.

Nome

Tipo

Description

200 OK

ImageAnalysis

A resposta inclui os recursos extraídos no formato JSON. Estas são as definições para tipos de enumeração:

ClipartType

Non - clipart = 0, ambíguo = 1, normal - clipart = 2, bom - clipart = 3. LineDrawingTypeNon - LineDrawing = 0, LineDrawing = 1.

Other Status Codes

ComputerVisionError

Resposta de erro.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

Exemplos

Successful AnalyzeImage request

Solicitação de exemplo

HTTP

POST https://westus.api.cognitive.microsoft.com/vision/v3.1/analyze?visualFeatures=Categories,Adult,Tags,Description,Faces,Color,ImageType,Objects,Brands&details=Celebrities,Landmarks&language=en


{
  "url": "{url}"
}

Resposta de exemplo

Código de status:: 200

{
  "categories": [
    {
      "name": "abstract_",
      "score": 0.00390625
    },
    {
      "name": "people_",
      "score": 0.83984375,
      "detail": {
        "celebrities": [
          {
            "name": "Satya Nadella",
            "faceRectangle": {
              "left": 597,
              "top": 162,
              "width": 248,
              "height": 248
            },
            "confidence": 0.999028444
          }
        ]
      }
    },
    {
      "name": "building_",
      "score": 0.984375,
      "detail": {
        "landmarks": [
          {
            "name": "Forbidden City",
            "confidence": 0.9829016923904419
          }
        ]
      }
    }
  ],
  "adult": {
    "isAdultContent": false,
    "isRacyContent": false,
    "isGoryContent": false,
    "adultScore": 0.0934349000453949,
    "racyScore": 0.06861349195241928,
    "goreScore": 0.012872257380997575
  },
  "tags": [
    {
      "name": "person",
      "confidence": 0.9897908568382263
    },
    {
      "name": "man",
      "confidence": 0.9449388980865479
    },
    {
      "name": "outdoor",
      "confidence": 0.938492476940155
    },
    {
      "name": "window",
      "confidence": 0.8951393961906433
    },
    {
      "name": "pangolin",
      "confidence": 0.7250059783791661,
      "hint": "mammal"
    }
  ],
  "description": {
    "tags": [
      "person",
      "man",
      "outdoor",
      "window",
      "glasses"
    ],
    "captions": [
      {
        "text": "Satya Nadella sitting on a bench",
        "confidence": 0.48293603002174407
      }
    ]
  },
  "requestId": "0dbec5ad-a3d3-4f7e-96b4-dfd57efe967d",
  "metadata": {
    "width": 1500,
    "height": 1000,
    "format": "Jpeg"
  },
  "faces": [
    {
      "age": 44,
      "gender": "Male",
      "faceRectangle": {
        "left": 593,
        "top": 160,
        "width": 250,
        "height": 250
      }
    }
  ],
  "color": {
    "dominantColorForeground": "Brown",
    "dominantColorBackground": "Brown",
    "dominantColors": [
      "Brown",
      "Black"
    ],
    "accentColor": "873B59",
    "isBWImg": false
  },
  "imageType": {
    "clipArtType": 0,
    "lineDrawingType": 0
  },
  "objects": [
    {
      "rectangle": {
        "x": 0,
        "y": 0,
        "w": 50,
        "h": 50
      },
      "object": "tree",
      "confidence": 0.9,
      "parent": {
        "object": "plant",
        "confidence": 0.95
      }
    }
  ],
  "brands": [
    {
      "name": "Pepsi",
      "confidence": 0.857,
      "rectangle": {
        "x": 489,
        "y": 79,
        "w": 161,
        "h": 177
      }
    },
    {
      "name": "Coca-Cola",
      "confidence": 0.893,
      "rectangle": {
        "x": 216,
        "y": 55,
        "w": 171,
        "h": 372
      }
    }
  ]
}

Definições

Nome	Description
AdultInfo	Um objeto que descreve se a imagem contém conteúdo orientado para adultos e/ou é picante.
BoundingRect	Uma caixa delimitadora para uma área dentro de uma imagem.
Category	Um objeto que descreve a categoria identificada.
CategoryDetail	Um objeto que descreve detalhes adicionais da categoria.
CelebritiesModel	Um objeto que descreve uma possível identificação de celebridades.
ColorInfo	Um objeto que fornece metadados adicionais que descrevem atributos de cor.
ComputerVisionError	Detalhes sobre o erro de solicitação de API.
ComputerVisionErrorCodes	O código de erro.
DescriptionExclude	Desative os modelos de domínio especificados ao gerar a descrição.
Details	Uma cadeia de caracteres que indica quais detalhes específicos do domínio devem ser retornados. Vários valores devem ser separados por vírgulas. Os tipos de recursos visuais válidos incluem: Celebridades - identifica celebridades se detectadas na imagem, Landmarks - identifica pontos de referência notáveis na imagem.
DetectedBrand	Uma marca detectada em uma imagem.
DetectedObject	Um objeto detectado em uma imagem.
FaceDescription	Um objeto que descreve um rosto identificado na imagem.
FaceRectangle	Um objeto que descreve o retângulo facial.
Gender	Possível sexo do rosto.
ImageAnalysis	Resultado da operação AnalyzeImage.
ImageCaption	Uma imagem legenda, ou seja, uma breve descrição do que a imagem descreve.
ImageDescriptionDetails	Uma coleção de marcas de conteúdo, juntamente com uma lista de legendas classificadas por nível de confiança e metadados de imagem.
ImageMetadata	Metadados de imagem.
ImageTag	Uma observação de entidade na imagem, juntamente com a pontuação de confiança.
ImageType	Um objeto que fornece possíveis tipos de imagem e níveis de confiança correspondentes.
ImageUrl
LandmarksModel	Um ponto de referência reconhecido na imagem.
ObjectHierarchy	Um objeto detectado dentro de uma imagem.
VisualFeatureTypes	Uma cadeia de caracteres que indica quais tipos de recursos visuais devem ser retornados. Vários valores devem ser separados por vírgulas. Os tipos de recursos visuais válidos incluem: Categorias – categoriza o conteúdo da imagem de acordo com uma taxonomia definida na documentação. Marcas – marca a imagem com uma lista detalhada de palavras relacionadas ao conteúdo da imagem. Descrição - descreve o conteúdo da imagem com uma frase em inglês completa. Faces – detecta se os rostos estão presentes. Se encontrar, gera coordenadas, sexo e idade. ImageType - detecta se a imagem é clip-art ou um desenho de linha. Cor – determina a cor de destaque, a cor dominante e se uma imagem é preta&branca. Adulto - detecta se a imagem é pornográfica por natureza (retrata nudez ou um ato sexual) ou é sangrenta (retrata violência extrema ou sangue). Conteúdo sexual (também conhecido como conteúdo picante) também será detectado. Objetos – detecta vários objetos dentro de uma imagem, incluindo o local aproximado. O argumento Objects só está disponível em inglês. Marcas – detecta várias marcas dentro de uma imagem, incluindo a localização aproximada. O argumento Brands só está disponível em inglês.

AdultInfo

Um objeto que descreve se a imagem contém conteúdo orientado para adultos e/ou é picante.

Nome	Tipo	Description
adultScore	number	Pontuação de 0 a 1 que indica quanto o conteúdo é considerado orientado para adultos na imagem.
goreScore	number	Pontuação de 0 a 1 que indica como a imagem é gory.
isAdultContent	boolean	Um valor que indica se a imagem contém conteúdo orientado para adultos.
isGoryContent	boolean	Um valor que indica se a imagem é gory.
isRacyContent	boolean	Um valor que indica se a imagem é picante.
racyScore	number	Pontuação de 0 a 1 que indica o quão sugestiva é a imagem.

BoundingRect

Uma caixa delimitadora para uma área dentro de uma imagem.

Nome	Tipo	Description
h	integer	Altura medida do ponto superior esquerdo da área, em pixels.
w	integer	Largura medida do ponto superior esquerdo da área, em pixels.
x	integer	Coordenada X do ponto superior esquerdo da área, em pixels.
y	integer	Coordenada Y do ponto superior esquerdo da área, em pixels.

Nome	Tipo	Description
detail	CategoryDetail	Detalhes da categoria identificada.
name	string	Nome da categoria.
score	number	Pontuação da categoria.

CategoryDetail

Um objeto que descreve detalhes adicionais da categoria.

Nome	Tipo	Description
celebrities	CelebritiesModel[]	Uma matriz de celebridades, se houver identificado.
landmarks	LandmarksModel[]	Uma matriz de pontos de referência, se houver identificado.

CelebritiesModel

Um objeto que descreve uma possível identificação de celebridades.

Nome	Tipo	Description
confidence	number	Nível de confiança para o reconhecimento de celebridades como um valor que varia de 0 a 1.
faceRectangle	FaceRectangle	Local do rosto identificado na imagem.
name	string	O nome da celebridade.

ColorInfo

Um objeto que fornece metadados adicionais que descrevem atributos de cor.

Nome	Tipo	Description
accentColor	string	Cor de ênfase possível.
dominantColorBackground	string	Possível cor de plano de fundo dominante.
dominantColorForeground	string	Possível cor de primeiro plano dominante.
dominantColors	string[]	Uma matriz de cores dominantes possíveis.
isBWImg	boolean	Um valor que indica se a imagem é preta e branca.

ComputerVisionError

Detalhes sobre o erro de solicitação de API.

Nome	Tipo	Description
code	ComputerVisionErrorCodes	O código de erro.
message	string	Uma mensagem explicando o erro relatado pelo serviço.
requestId	string	Um identificador de solicitação exclusivo.

ComputerVisionErrorCodes

O código de erro.

Nome	Tipo	Description
BadArgument	string
CancelledRequest	string
DetectFaceError	string
FailedToProcess	string
InternalServerError	string
InvalidDetails	string
InvalidImageFormat	string
InvalidImageSize	string
InvalidImageUrl	string
InvalidModel	string
InvalidThumbnailSize	string
NotSupportedFeature	string
NotSupportedImage	string
NotSupportedLanguage	string
NotSupportedVisualFeature	string
StorageException	string
Timeout	string
Unspecified	string
UnsupportedMediaType	string

DescriptionExclude

Desative os modelos de domínio especificados ao gerar a descrição.

Nome	Tipo	Description
Celebrities	string
Landmarks	string

Details

Uma cadeia de caracteres que indica quais detalhes específicos do domínio devem ser retornados. Vários valores devem ser separados por vírgulas. Os tipos de recursos visuais válidos incluem: Celebridades - identifica celebridades se detectadas na imagem, Landmarks - identifica pontos de referência notáveis na imagem.

Nome	Tipo	Description
Celebrities	string
Landmarks	string

DetectedBrand

Uma marca detectada em uma imagem.

Nome	Tipo	Description
confidence	number	Pontuação de confiança de ter observado a marca na imagem, como um valor que varia de 0 a 1.
name	string	Rótulo para a marca.
rectangle	BoundingRect	Localização aproximada da marca detectada.

DetectedObject

Um objeto detectado em uma imagem.

Nome	Tipo	Description
confidence	number	Pontuação de confiança de ter observado o objeto na imagem, como um valor que varia de 0 a 1.
object	string	Rótulo para o objeto .
parent	ObjectHierarchy	O objeto pai, de uma perspectiva de taxonomia. O objeto pai é uma forma mais genérica desse objeto. Por exemplo, um "buldogue" teria um pai de "cão".
rectangle	BoundingRect	Localização aproximada do objeto detectado.

FaceDescription

Um objeto que descreve um rosto identificado na imagem.

Nome	Tipo	Description
age	integer	Possível idade do rosto.
faceRectangle	FaceRectangle	Retângulo na imagem que contém o rosto identificado.
gender	Gender	Possível sexo do rosto.

FaceRectangle

Um objeto que descreve o retângulo facial.

Nome	Tipo	Description
height	integer	Altura medida do ponto superior esquerdo da face, em pixels.
left	integer	Coordenada X do ponto superior esquerdo da face, em pixels.
top	integer	Coordenada Y do ponto superior esquerdo da face, em pixels.
width	integer	Largura medida do ponto superior esquerdo da face, em pixels.

Gender

Possível sexo do rosto.

Nome	Tipo	Description
Female	string
Male	string

ImageAnalysis

Resultado da operação AnalyzeImage.

Nome	Tipo	Description
adult	AdultInfo	Um objeto que descreve se a imagem contém conteúdo orientado para adultos e/ou é picante.
brands	DetectedBrand[]	Matriz de marcas detectadas na imagem.
categories	Category[]	Uma matriz que indica categorias identificadas.
color	ColorInfo	Um objeto que fornece metadados adicionais que descrevem atributos de cor.
description	ImageDescriptionDetails	Uma coleção de marcas de conteúdo, juntamente com uma lista de legendas classificadas por nível de confiança e metadados de imagem.
faces	FaceDescription[]	Uma matriz de rostos possíveis dentro da imagem.
imageType	ImageType	Um objeto que fornece possíveis tipos de imagem e níveis de confiança correspondentes.
metadata	ImageMetadata	Metadados de imagem.
objects	DetectedObject[]	Matriz de objetos que descrevem o que foi detectado na imagem.
requestId	string	Id da solicitação da API REST.
tags	ImageTag[]	Uma lista de marcas com nível de confiança.

ImageCaption

Uma imagem legenda, ou seja, uma breve descrição do que a imagem descreve.

Nome	Tipo	Description
confidence	number	O nível de confiança que o serviço tem no legenda.
text	string	O texto do legenda.

ImageDescriptionDetails

Uma coleção de marcas de conteúdo, juntamente com uma lista de legendas classificadas por nível de confiança e metadados de imagem.

Nome	Tipo	Description
captions	ImageCaption[]	Uma lista de legendas, classificada por nível de confiança.
tags	string[]	Uma coleção de marcas de imagem.

ImageMetadata

Metadados de imagem.

Nome	Tipo	Description
format	string	Formato de imagem.
height	integer	Altura da imagem, em pixels.
width	integer	Largura da imagem, em pixels.

ImageTag

Uma observação de entidade na imagem, juntamente com a pontuação de confiança.

Nome	Tipo	Description
confidence	number	O nível de confiança que a entidade foi observada.
hint	string	Dica/detalhes opcionais para essa marca.
name	string	Nome da entidade.

ImageType

Um objeto que fornece possíveis tipos de imagem e níveis de confiança correspondentes.

Nome	Tipo	Description
clipArtType	integer	Nível de confiança de que a imagem é um clip-art.
lineDrawingType	integer	Nível de confiança de que a imagem é um desenho de linha.

ImageUrl

Nome	Tipo	Description
url	string	URL acessível publicamente de uma imagem.

LandmarksModel

Um ponto de referência reconhecido na imagem.

Nome	Tipo	Description
confidence	number	Nível de confiança para o reconhecimento de ponto de referência como um valor que varia de 0 a 1.
name	string	Nome do ponto de referência.

ObjectHierarchy

Um objeto detectado dentro de uma imagem.

Nome	Tipo	Description
confidence	number	Pontuação de confiança de ter observado o objeto na imagem, como um valor que varia de 0 a 1.
object	string	Rótulo para o objeto .
parent	ObjectHierarchy	O objeto pai, de uma perspectiva de taxonomia. O objeto pai é uma forma mais genérica desse objeto. Por exemplo, um "buldogue" teria um pai de "cão".

VisualFeatureTypes

Uma cadeia de caracteres que indica quais tipos de recursos visuais devem ser retornados. Vários valores devem ser separados por vírgulas. Os tipos de recursos visuais válidos incluem: Categorias – categoriza o conteúdo da imagem de acordo com uma taxonomia definida na documentação. Marcas – marca a imagem com uma lista detalhada de palavras relacionadas ao conteúdo da imagem. Descrição - descreve o conteúdo da imagem com uma frase em inglês completa. Faces – detecta se os rostos estão presentes. Se encontrar, gera coordenadas, sexo e idade. ImageType - detecta se a imagem é clip-art ou um desenho de linha. Cor – determina a cor de destaque, a cor dominante e se uma imagem é preta&branca. Adulto - detecta se a imagem é pornográfica por natureza (retrata nudez ou um ato sexual) ou é sangrenta (retrata violência extrema ou sangue). Conteúdo sexual (também conhecido como conteúdo picante) também será detectado. Objetos – detecta vários objetos dentro de uma imagem, incluindo o local aproximado. O argumento Objects só está disponível em inglês. Marcas – detecta várias marcas dentro de uma imagem, incluindo a localização aproximada. O argumento Brands só está disponível em inglês.

Nome	Tipo	Description
Adult	string
Brands	string
Categories	string
Color	string
Description	string
Faces	string
ImageType	string
Objects	string
Tags	string

Compartilhar via

Analyze Image - Analyze Image

Parâmetros de URI

Cabeçalho da solicitação

Corpo da solicitação

Respostas

Segurança

Ocp-Apim-Subscription-Key

Exemplos

Successful AnalyzeImage request

Solicitação de exemplo

Resposta de exemplo

Definições

AdultInfo

BoundingRect

Category

CategoryDetail

CelebritiesModel

ColorInfo

ComputerVisionError

ComputerVisionErrorCodes

DescriptionExclude

Details

DetectedBrand

DetectedObject

FaceDescription

FaceRectangle

Gender

ImageAnalysis

ImageCaption

ImageDescriptionDetails

ImageMetadata

ImageTag

ImageType

ImageUrl

LandmarksModel

ObjectHierarchy

VisualFeatureTypes

Recursos adicionais