Analyze - Image

Referência

Serviço:: Azure AI Services

Versão da API:: 2024-02-01

Analise a imagem de entrada. A solicitação contém fluxo de imagem com qualquer tipo de conteúdo ['image/*', 'application/octet-stream'], ou um conteúdo JSON que inclui uma propriedade de URL a ser usada para recuperar o fluxo de imagem.

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

Com parâmetros opcionais:

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
api-version	query	True	string	Versão da API solicitada.
features	query		VisualFeature[]	Os recursos visuais solicitados. Pelo menos um recurso visual deve ser especificado.
gender-neutral-caption	query		boolean	Sinalizador booliano para habilitar legendas neutras de gênero para recursos de legenda e denseCaptions. Se esse parâmetro não for especificado, o valor padrão será "false".
language	query		string	A linguagem desejada para geração de saída. Se este parâmetro não for especificado, o valor padrão é “en”. Consulte https://aka.ms/cv-languages para obter uma lista de idiomas com suporte.
model-version	query		string	Versão do modelo.
smartcrops-aspect-ratios	query		array[]	Uma lista de proporções a serem usadas para o recurso smartCrops. As taxas de proporção são calculadas dividindo a largura da cultura de destino pela altura. Os valores com suporte estão entre 0,75 e 1,8 (inclusive). Vários valores devem ser separados por vírgulas. Se esse parâmetro não for especificado, o serviço retornará uma sugestão de corte com uma taxa de proporção que achar adequada entre 0,5 e 2,0 (inclusive).

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	ImageAnalysisResult	Êxito
Other Status Codes	ErrorResponse	Erro Cabeçalhos x-ms-error-code: string

Nome

Tipo

Description

200 OK

ImageAnalysisResult

Êxito

Other Status Codes

ErrorResponse

Erro

Cabeçalhos

x-ms-error-code: string

Exemplos

ImageAnalysis_Analyze_MaximumSet_Gen

ImageAnalysis_Analyze_MinimumSet_Gen

ImageAnalysis_Analyze_MaximumSet_Gen

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 200

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

Solicitação de exemplo

HTTP

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

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

Resposta de exemplo

Código de status:: 200

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

Definições

Nome	Description
BoundingBox	Uma caixa delimitadora para uma área dentro de uma imagem.
CaptionResult	Uma breve descrição do que a imagem descreve.
ContentTag	Uma observação de entidade na imagem, juntamente com a pontuação de confiança.
CropRegion	Uma região identificada para corte inteligente. Haverá uma região retornada para cada taxa de proporção solicitada.
DenseCaption	Uma breve descrição do que a imagem descreve.
DenseCaptionsResult	Uma lista de legendas.
DetectedObject	Descreve um objeto detectado em uma imagem.
DetectedPerson	Uma pessoa detectada em uma imagem.
DetectedTextBlock	Um bloco de texto detectado.
DetectedTextLine	Uma linha de texto detectada.
DetectedTextWord	Uma palavra detectada que consiste em uma sequência contígua de caracteres. Para idiomas delimitados por espaço, como chinês, japonês e coreano, cada caractere é representado como sua própria palavra.
ErrorResponse	Resposta retornada quando ocorre um erro.
ErrorResponseDetails	Informações de erro.
ErrorResponseInnerError	Erro detalhado.
ImageAnalysisResult	Descrever os resultados combinados de diferentes tipos de análise de imagem.
ImageMetadata	As informações de metadados da imagem, como altura e largura.
ImagePoint	Um objeto que representa um ponto na imagem.
ImageUrl	Um documento JSON com uma URL apontando para a imagem publicamente acessível a ser analisada.
ObjectsResult	Descreve objetos detectados em uma imagem.
PeopleResult	Um objeto que descreve se a imagem contém pessoas.
ReadResult	Os resultados de uma operação de Leitura.
SmartCropsResult	Resultado do corte inteligente.
TagsResult	Uma lista de marcas com nível de confiança.
VisualFeature	Os recursos visuais solicitados. Pelo menos um recurso visual deve ser especificado.

BoundingBox

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 esquerda do ponto superior esquerdo da área, em pixels.
y	integer	Coordenada superior do ponto superior esquerdo da área, em pixels.

CaptionResult

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 na legenda. As pontuações de confiança abrangem o intervalo de 0,0 a 1,0 (inclusive), com valores mais altos indicando uma maior confiança de uma correspondência.
text	string	O texto da legenda.

ContentTag

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. As pontuações de confiança abrangem o intervalo de 0,0 a 1,0 (inclusive), com valores mais altos indicando uma maior confiança de uma correspondência.
name	string	Nome da entidade.

CropRegion

Uma região identificada para corte inteligente. Haverá uma região retornada para cada taxa de proporção solicitada.

Nome	Tipo	Description
aspectRatio	number	A taxa de proporção da região de corte.
boundingBox	BoundingBox	Uma caixa delimitadora para uma área dentro de uma imagem.

DenseCaption

Uma breve descrição do que a imagem descreve.

Nome	Tipo	Description
boundingBox	BoundingBox	Uma caixa delimitadora para uma área dentro de uma imagem.
confidence	number	O nível de confiança que o serviço tem na legenda. As pontuações de confiança abrangem o intervalo de 0,0 a 1,0 (inclusive), com valores mais altos indicando uma maior confiança de uma correspondência.
text	string	O texto da legenda.

DenseCaptionsResult

Uma lista de legendas.

Nome	Tipo	Description
values	DenseCaption[]	Uma lista de legendas.

DetectedObject

Descreve um objeto detectado em uma imagem.

Nome	Tipo	Description
boundingBox	BoundingBox	Uma caixa delimitadora para uma área dentro de uma imagem.
id	string	ID do objeto detectado.
tags	ContentTag[]	Confianças de classificação do objeto detectado.

DetectedPerson

Uma pessoa detectada em uma imagem.

Nome	Tipo	Description
boundingBox	BoundingBox	Uma caixa delimitadora para uma área dentro de uma imagem.
confidence	number	Pontuação de confiança de ter observado a pessoa na imagem. As pontuações de confiança abrangem o intervalo de 0,0 a 1,0 (inclusive), com valores mais altos indicando uma maior confiança de uma correspondência.

DetectedTextBlock

Um bloco de texto detectado.

Nome	Tipo	Description
lines	DetectedTextLine[]	Lista de linhas de texto no bloco de texto.

DetectedTextLine

Uma linha de texto detectada.

Nome	Tipo	Description
boundingPolygon	ImagePoint[]	Polígono delimitando a linha de texto.
text	string	Conteúdo de texto da linha de texto detectada.
words	DetectedTextWord[]	Lista de palavras na linha de texto.

DetectedTextWord

Uma palavra detectada que consiste em uma sequência contígua de caracteres. Para idiomas delimitados por espaço, como chinês, japonês e coreano, cada caractere é representado como sua própria palavra.

Nome	Tipo	Description
boundingPolygon	ImagePoint[]	Polígono delimitando a palavra.
confidence	number	O nível de confiança de que a palavra foi detectada. As pontuações de confiança abrangem o intervalo de 0,0 a 1,0 (inclusive), com valores mais altos indicando uma maior confiança de uma correspondência.
text	string	Conteúdo de texto da palavra.

ErrorResponse

Resposta retornada quando ocorre um erro.

Nome	Tipo	Description
error	ErrorResponseDetails	Informações de erro.

ErrorResponseDetails

Informações de erro.

Nome	Tipo	Description
code	string	Código do erro.
details	ErrorResponseDetails[]	Lista de erros detalhados.
innererror	ErrorResponseInnerError	Erro detalhado.
message	string	Mensagem de erro.
target	string	Destino do erro.

ErrorResponseInnerError

Erro detalhado.

Nome	Tipo	Description
code	string	Código do erro.
innererror	ErrorResponseInnerError	Erro detalhado.
message	string	Mensagem de erro.

ImageAnalysisResult

Descrever os resultados combinados de diferentes tipos de análise de imagem.

Nome	Tipo	Description
captionResult	CaptionResult	Uma breve descrição do que a imagem descreve.
denseCaptionsResult	DenseCaptionsResult	Uma lista de legendas.
metadata	ImageMetadata	As informações de metadados da imagem, como altura e largura.
modelVersion	string	Versão do modelo.
objectsResult	ObjectsResult	Descreve objetos detectados em uma imagem.
peopleResult	PeopleResult	Um objeto que descreve se a imagem contém pessoas.
readResult	ReadResult	Os resultados de uma operação de Leitura.
smartCropsResult	SmartCropsResult	Resultado do corte inteligente.
tagsResult	TagsResult	Uma lista de marcas com nível de confiança.

ImageMetadata

As informações de metadados da imagem, como altura e largura.

Nome	Tipo	Description
height	integer	A altura da imagem em pixels.
width	integer	A largura da imagem em pixels.

ImagePoint

Um objeto que representa um ponto na imagem.

Nome	Tipo	Description
x	integer	A coordenada x deste ponto.
y	integer	A coordenada y deste ponto.

ImageUrl

Um documento JSON com uma URL apontando para a imagem publicamente acessível a ser analisada.

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

ObjectsResult

Descreve objetos detectados em uma imagem.

Nome	Tipo	Description
values	DetectedObject[]	Uma matriz de objetos detectados.

PeopleResult

Um objeto que descreve se a imagem contém pessoas.

Nome	Tipo	Description
values	DetectedPerson[]	Uma matriz de pessoas detectadas.

ReadResult

Os resultados de uma operação de Leitura.

Nome	Tipo	Description
blocks	DetectedTextBlock[]	Uma lista de blocos de texto.

SmartCropsResult

Resultado do corte inteligente.

Nome	Tipo	Description
values	CropRegion[]	Regiões recomendadas para cortar a imagem.

TagsResult

Uma lista de marcas com nível de confiança.

Nome	Tipo	Description
values	ContentTag[]	Uma lista de marcas com nível de confiança.

VisualFeature

Os recursos visuais solicitados. Pelo menos um recurso visual deve ser especificado.

Nome	Tipo	Description
caption	string	Uma descrição ou uma legenda resumindo o conteúdo da imagem.
denseCaptions	string	Legendas detalhadas que fornecem descrições detalhadas do conteúdo da imagem.
objects	string	Objetos específicos reconhecidos e rotulados na imagem.
people	string	Detecção e análise de pessoas na imagem.
read	string	Conteúdo textual extraído da imagem, como sinais ou rótulos.
smartCrops	string	As versões cortadas geradas automaticamente da imagem se concentram em conteúdo importante.
tags	string	Marcas visuais que representam objetos detectados na imagem.

Compartilhar via

Analyze - Image

Parâmetros de URI

Corpo da solicitação

Respostas

Exemplos

ImageAnalysis_Analyze_MaximumSet_Gen

Solicitação de exemplo

Resposta de exemplo

ImageAnalysis_Analyze_MinimumSet_Gen

Solicitação de exemplo

Resposta de exemplo

Definições

BoundingBox

CaptionResult

ContentTag

CropRegion

DenseCaption

DenseCaptionsResult

DetectedObject

DetectedPerson

DetectedTextBlock

DetectedTextLine

DetectedTextWord

ErrorResponse

ErrorResponseDetails

ErrorResponseInnerError

ImageAnalysisResult

ImageMetadata

ImagePoint

ImageUrl

ObjectsResult

PeopleResult

ReadResult

SmartCropsResult

TagsResult

VisualFeature

Recursos adicionais