Analyze Image - Analyze Image

Referência

Service:: Cognitive Services - Computer Vision

API Version:: 3.1

Esta operação extrai um conjunto avançado de funcionalidades visuais com base no conteúdo da imagem. São suportados dois métodos de entrada : (1) Carregar uma imagem ou (2) especificar um URL de imagem. No seu pedido, existe um parâmetro opcional que lhe permite escolher as funcionalidades a devolver. Por predefinição, as categorias de imagens são devolvidas na resposta. Será devolvida uma resposta com êxito em JSON. Se o pedido falhar, a resposta conterá um código de erro e uma mensagem para ajudar a compreender o que correu mal.

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

With optional parameters:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
Endpoint	path	True	string	Pontos finais dos Serviços Cognitivos suportados.
descriptionExclude	query		DescriptionExclude[]	Desative os modelos de domínio especificados ao gerar a descrição.
details	query		Details[]	Uma cadeia que indica os detalhes específicos do domínio a devolver. Vários valores devem ser separados por vírgulas. Os tipos de funcionalidades visuais válidos incluem: Celebridades - identifica celebridades se forem detetadas na imagem, Marcos - identifica marcos notáveis na imagem.
language	query		string	A linguagem pretendida para a geração de saída. Se este parâmetro não for especificado, o valor predefinido é "en". Idiomas suportados:en - Inglês, Predefinição. es - espanhol, ja - japonês, pt - português, zh - chinês simplificado.
visualFeatures	query		VisualFeatureTypes[]	Uma cadeia que indica os tipos de funcionalidades visuais a devolver. Vários valores devem ser separados por vírgulas. Os tipos de funcionalidades visuais válidos incluem: Categorias – categoriza o conteúdo da imagem de acordo com uma taxonomia definida na documentação. Etiquetas – identifica a imagem com uma lista detalhada de palavras relacionadas com o conteúdo da imagem. Descrição – descreve o conteúdo da imagem com uma frase completa em inglês. Rostos – deteta se os rostos estão presentes. Se estiver presente, gere coordenadas, género e idade. ImageType – deteta se a imagem é clipart ou um desenho de linha. Cor – determina a cor do ambiente, a cor dominante e se uma imagem é preta&branco. Adulto - deteta se a imagem é pornográfica por natureza (representa nudez ou um ato sexual), ou é sangrento (retrata a violência extrema ou o sangue). Também é detetado conteúdo sexualmente sugestivo (também conhecido como conteúdo picante). Objetos – deteta vários objetos numa imagem, incluindo a localização aproximada. O argumento Objetos só está disponível em inglês. Marcas – deteta várias marcas numa imagem, incluindo a localização aproximada. O argumento Marcas só está disponível em inglês.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Corpo do Pedido

Name	Necessário	Tipo	Description
url	True	string	URL acessível publicamente de uma imagem.

Respostas

Name	Tipo	Description
200 OK	ImageAnalysis	A resposta inclui as funcionalidades extraídas no formato JSON. Eis as definições para tipos de enumeração: ClipartType Non - clipart = 0, ambíguo = 1, normal - clipart = 2, good - clipart = 3. LineDrawingTypeNon - LineDrawing = 0, LineDrawing = 1.
Other Status Codes	ComputerVisionError	Resposta de erro.

Name

Tipo

Description

200 OK

ImageAnalysis

A resposta inclui as funcionalidades extraídas no formato JSON. Eis as definições para tipos de enumeração:

ClipartType

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

Other Status Codes

ComputerVisionError

Resposta de erro.

Segurança

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Exemplos

Successful AnalyzeImage request

Sample Request

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}"
}

Sample Response

Status code:: 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

Name	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 de categoria adicionais.
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 do pedido da API.
ComputerVisionErrorCodes	O código de erro.
DescriptionExclude	Desative os modelos de domínio especificados ao gerar a descrição.
Details	Uma cadeia que indica os detalhes específicos do domínio a devolver. Vários valores devem ser separados por vírgulas. Os tipos de funcionalidades visuais válidos incluem: Celebridades - identifica celebridades se forem detetadas na imagem, Marcos - identifica marcos notáveis na imagem.
DetectedBrand	Uma marca detetada numa imagem.
DetectedObject	Um objeto detetado numa 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 ilustra.
ImageDescriptionDetails	Uma coleção de etiquetas de conteúdo, juntamente com uma lista de legendas ordenadas 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 classificação de confiança.
ImageType	Um objeto que fornece possíveis tipos de imagem e níveis de confiança correspondentes.
ImageUrl
LandmarksModel	Um marco reconhecido na imagem.
ObjectHierarchy	Um objeto detetado dentro de uma imagem.
VisualFeatureTypes	Uma cadeia que indica os tipos de funcionalidades visuais a devolver. Vários valores devem ser separados por vírgulas. Os tipos de funcionalidades visuais válidos incluem: Categorias – categoriza o conteúdo da imagem de acordo com uma taxonomia definida na documentação. Etiquetas – identifica a imagem com uma lista detalhada de palavras relacionadas com o conteúdo da imagem. Descrição – descreve o conteúdo da imagem com uma frase completa em inglês. Rostos – deteta se os rostos estão presentes. Se estiver presente, gere coordenadas, género e idade. ImageType – deteta se a imagem é clipart ou um desenho de linha. Cor – determina a cor do ambiente, a cor dominante e se uma imagem é preta&branco. Adulto - deteta se a imagem é pornográfica por natureza (representa nudez ou um ato sexual), ou é sangrento (retrata a violência extrema ou o sangue). Também é detetado conteúdo sexualmente sugestivo (também conhecido como conteúdo picante). Objetos – deteta vários objetos numa imagem, incluindo a localização aproximada. O argumento Objetos só está disponível em inglês. Marcas – deteta várias marcas numa imagem, incluindo a localização aproximada. O argumento Marcas 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.

Name	Tipo	Description
adultScore	number	Classificação de 0 a 1 que indica o quanto o conteúdo é considerado orientado para adultos dentro da imagem.
goreScore	number	Classificação de 0 a 1 que indica o quão gory é a imagem.
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	Classificação de 0 a 1 que indica o quão sugestiva é a imagem.

BoundingRect

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

Name	Tipo	Description
h	integer	Altura medida a partir do ponto superior esquerdo da área, em píxeis.
w	integer	Largura medida a partir do ponto superior esquerdo da área, em píxeis.
x	integer	Coordenada X do ponto superior esquerdo da área, em píxeis.
y	integer	Coordenada Y do ponto superior esquerdo da área, em píxeis.

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

CategoryDetail

Um objeto que descreve detalhes de categoria adicionais.

Name	Tipo	Description
celebrities	CelebritiesModel[]	Uma série de celebridades, se alguma for identificada.
landmarks	LandmarksModel[]	Uma matriz de marcos, se for identificada.

CelebritiesModel

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

Name	Tipo	Description
confidence	number	Nível de confiança para o reconhecimento de celebridades como um valor entre 0 e 1.
faceRectangle	FaceRectangle	Localização do rosto identificado na imagem.
name	string	Nome da celebridade.

ColorInfo

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

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

ComputerVisionError

Detalhes sobre o erro do pedido da API.

Name	Tipo	Description
code	ComputerVisionErrorCodes	O código de erro.
message	string	Uma mensagem a explicar o erro comunicado pelo serviço.
requestId	string	Um identificador de pedido exclusivo.

ComputerVisionErrorCodes

O código de erro.

Name	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.

Name	Tipo	Description
Celebrities	string
Landmarks	string

Details

Uma cadeia que indica os detalhes específicos do domínio a devolver. Vários valores devem ser separados por vírgulas. Os tipos de funcionalidades visuais válidos incluem: Celebridades - identifica celebridades se forem detetadas na imagem, Marcos - identifica marcos notáveis na imagem.

Name	Tipo	Description
Celebrities	string
Landmarks	string

DetectedBrand

Uma marca detetada numa imagem.

Name	Tipo	Description
confidence	number	Classificação de confiança de ter observado a marca na imagem, como um valor entre 0 e 1.
name	string	Etiqueta para a marca.
rectangle	BoundingRect	Localização aproximada da marca detetada.

DetectedObject

Um objeto detetado numa imagem.

Name	Tipo	Description
confidence	number	Classificação de confiança de ter observado o objeto na imagem, como um valor entre 0 e 1.
object	string	Etiqueta para o objeto.
parent	ObjectHierarchy	O objeto principal, de uma perspetiva de taxonomia. O objeto principal é uma forma mais genérica deste objeto. Por exemplo, um "bulldog" teria um pai de "cão".
rectangle	BoundingRect	Localização aproximada do objeto detetado.

FaceDescription

Um objeto que descreve um rosto identificado na imagem.

Name	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.

Name	Tipo	Description
height	integer	Altura medida a partir do ponto superior esquerdo do rosto, em píxeis.
left	integer	Coordenada X do ponto superior esquerdo do rosto, em píxeis.
top	integer	Coordenada Y do ponto superior esquerdo do rosto, em píxeis.
width	integer	Largura medida a partir do ponto superior esquerdo do rosto, em píxeis.

Gender

Possível sexo do rosto.

Name	Tipo	Description
Female	string
Male	string

ImageAnalysis

Resultado da operação AnalyzeImage.

Name	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 detetadas 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 etiquetas de conteúdo, juntamente com uma lista de legendas ordenadas 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 detetado na imagem.
requestId	string	ID do pedido da API REST.
tags	ImageTag[]	Uma lista de etiquetas com nível de confiança.

ImageCaption

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

Name	Tipo	Description
confidence	number	O nível de confiança que o serviço tem na legenda.
text	string	O texto da legenda.

ImageDescriptionDetails

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

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

ImageMetadata

Metadados de imagem.

Name	Tipo	Description
format	string	Formato de imagem.
height	integer	Altura da imagem, em píxeis.
width	integer	Largura da imagem, em píxeis.

ImageTag

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

Name	Tipo	Description
confidence	number	O nível de confiança que a entidade foi observada.
hint	string	Sugestão/detalhes opcionais para esta etiqueta.
name	string	Nome da entidade.

ImageType

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

Name	Tipo	Description
clipArtType	integer	Nível de confiança de que a imagem é um ClipArt.
lineDrawingType	integer	Nível de confiança de que a imagem é um desenho de linha.

ImageUrl

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

LandmarksModel

Um marco reconhecido na imagem.

Name	Tipo	Description
confidence	number	Nível de confiança para o reconhecimento de marco como um valor entre 0 e 1.
name	string	Nome do marco.

ObjectHierarchy

Um objeto detetado dentro de uma imagem.

Name	Tipo	Description
confidence	number	Classificação de confiança de ter observado o objeto na imagem, como um valor entre 0 e 1.
object	string	Etiqueta para o objeto.
parent	ObjectHierarchy	O objeto principal, de uma perspetiva de taxonomia. O objeto principal é uma forma mais genérica deste objeto. Por exemplo, um "bulldog" teria um pai de "cão".

VisualFeatureTypes

Uma cadeia que indica os tipos de funcionalidades visuais a devolver. Vários valores devem ser separados por vírgulas. Os tipos de funcionalidades visuais válidos incluem: Categorias – categoriza o conteúdo da imagem de acordo com uma taxonomia definida na documentação. Etiquetas – identifica a imagem com uma lista detalhada de palavras relacionadas com o conteúdo da imagem. Descrição – descreve o conteúdo da imagem com uma frase completa em inglês. Rostos – deteta se os rostos estão presentes. Se estiver presente, gere coordenadas, género e idade. ImageType – deteta se a imagem é clipart ou um desenho de linha. Cor – determina a cor do ambiente, a cor dominante e se uma imagem é preta&branco. Adulto - deteta se a imagem é pornográfica por natureza (representa nudez ou um ato sexual), ou é sangrento (retrata a violência extrema ou o sangue). Também é detetado conteúdo sexualmente sugestivo (também conhecido como conteúdo picante). Objetos – deteta vários objetos numa imagem, incluindo a localização aproximada. O argumento Objetos só está disponível em inglês. Marcas – deteta várias marcas numa imagem, incluindo a localização aproximada. O argumento Marcas só está disponível em inglês.

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

Partilhar via

Analyze Image - Analyze Image

Parâmetros do URI

Cabeçalho do Pedido

Corpo do Pedido

Respostas

Segurança

Ocp-Apim-Subscription-Key

Exemplos

Successful AnalyzeImage request

Sample Request

Sample Response

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