Describe Image - Describe Image

Serviço:

Azure AI Services

Versão da API:

3.2

Esta operação gera uma descrição de uma imagem no idioma legível por humanos com frases completas. A descrição se baseia em uma coleção de marcas de conteúdo, que também são retornadas pela operação. Mais de uma descrição pode ser gerada para cada imagem. As descrições são ordenadas por pontuação de confiança. As descrições podem incluir resultados de modelos de domínio de celebridades e de referência, se aplicável. Há suporte para dois métodos de entrada : (1) Carregar uma imagem ou (2) especificar uma URL de imagem. Uma resposta bem-sucedida será retornada no 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.2/describe

Com parâmetros opcionais:

POST {Endpoint}/vision/v3.2/describe?maxCandidates={maxCandidates}&language={language}&descriptionExclude={descriptionExclude}&model-version={model-version}

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.
language	query		string	O idioma desejado para a geração de saída. Se esse parâmetro não for especificado, o valor padrão será "en". Consulte https://aka.ms/cv-languages para obter uma lista de idiomas com suporte.
maxCandidates	query		integer (int32)	Número máximo de descrições de candidatos a serem retornadas. A predefinição é 1.
model-version	query		string pattern: ^(latest|\d{4}-\d{2}-\d{2})(-preview)?$	Parâmetro opcional para especificar a versão do modelo de IA. Os valores aceitos são: "latest", "2021-04-01", "2021-05-01". O padrão é "mais recente".

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	ImageDescription	Objeto de descrição da imagem.
Other Status Codes	ComputerVisionErrorResponse	Resposta de erro.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

Exemplos

Successful DescribeImage request

Solicitação de exemplo

HTTP

POST https://westus.api.cognitive.microsoft.com/vision/v3.2/describe?maxCandidates=1


{
  "url": "{url}"
}

Resposta de exemplo

Código de status:

200

{
  "description": {
    "tags": [
      "person",
      "man",
      "outdoor",
      "window",
      "glasses"
    ],
    "captions": [
      {
        "text": "Satya Nadella sitting on a bench",
        "confidence": 0.48293603002174407
      }
    ]
  },
  "requestId": "ed2de1c6-fb55-4686-b0da-4da6e05d283f",
  "metadata": {
    "width": 1500,
    "height": 1000,
    "format": "Jpeg"
  },
  "modelVersion": "2021-04-01"
}

Definições

Nome	Description
ComputerVisionError	O erro de solicitação de API.
ComputerVisionErrorCodes	O código de erro.
ComputerVisionErrorResponse	A resposta de erro da API.
ComputerVisionInnerError	Detalhes sobre o erro de solicitação de API.
ComputerVisionInnerErrorCodeValue	O código de erro.
DescriptionExclude	Desative os modelos de domínio especificados ao gerar a descrição.
ImageCaption	Uma legenda de imagem, ou seja, uma breve descrição do que a imagem ilustra.
ImageDescription	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.
ImageUrl

ComputerVisionError

Objeto

O erro de solicitação de API.

Nome	Tipo	Description
code	ComputerVisionErrorCodes	O código de erro.
innererror	ComputerVisionInnerError	O erro interno contém informações mais específicas.
message	string	Uma mensagem explicando o erro relatado pelo serviço.

ComputerVisionErrorCodes

Enumeração

O código de erro.

Valor	Description
InternalServerError
InvalidArgument
InvalidRequest
ServiceUnavailable

ComputerVisionErrorResponse

Objeto

A resposta de erro da API.

Nome	Tipo	Description
error	ComputerVisionError	Conteúdo de erro.

ComputerVisionInnerError

Objeto

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

Nome	Tipo	Description
code	ComputerVisionInnerErrorCodeValue	O código de erro.
message	string	Mensagem de erro.

ComputerVisionInnerErrorCodeValue

Enumeração

O código de erro.

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

DescriptionExclude

Enumeração

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

Valor	Description
Celebrities
Landmarks

ImageCaption

Objeto

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

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

ImageDescription

Objeto

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
description.captions	ImageCaption[]	Uma lista de legendas, classificada por nível de confiança.
description.tags	string[]	Uma coleção de marcas de imagem.
metadata	ImageMetadata	Metadados de imagem.
modelVersion	string pattern: ^(latest|\d{4}-\d{2}-\d{2})(-preview)?$	Versão do modelo de IA.
requestId	string	ID da solicitação da API REST.

ImageMetadata

Objeto

Metadados de imagem.

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

ImageUrl

Objeto

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