Image Operations - Analyze Image

Serviço:

Azure AI Services

Versão da API:

2024-09-01

Analisar Imagem
Uma API síncrona para a análise de conteúdo de imagem potencialmente prejudicial. Atualmente, ele dá suporte a quatro categorias: Ódio, SelfHarm, Sexual e Violência.

POST {endpoint}/contentsafety/image:analyze?api-version=2024-09-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string	Pontos de extremidade dos Serviços Cognitivos com suporte (protocolo e nome do host, por exemplo: https://.cognitiveservices.azure.com).
api-version	query	True	string	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
image	True	ImageData	A imagem a ser analisada.
categories		ImageCategory[]	As categorias serão analisadas. Se eles não forem atribuídos, um conjunto padrão de resultados de análise para as categorias será retornado.
outputType		AnalyzeImageOutputType	Isso se refere ao tipo de saída de análise de imagem. Se nenhum valor for atribuído, o valor padrão será "FourSeverityLevels".

Respostas

Nome	Tipo	Description
200 OK	AnalyzeImageResult	A solicitação foi bem-sucedida.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

OAuth2Auth

Tipo: oauth2
Flow: application
URL do Token: https://login.microsoftonline.com/common/oauth2/v2.0/token

Escopos

Nome	Description
https://cognitiveservices.azure.com/.default

Exemplos

Analyze Image

Solicitação de exemplo

HTTP

POST {endpoint}/contentsafety/image:analyze?api-version=2024-09-01

{
  "image": {
    "content": "Y29udGVudDE="
  }
}

Resposta de exemplo

Código de status:

200

{
  "categoriesAnalysis": [
    {
      "category": "Hate",
      "severity": 0
    },
    {
      "category": "SelfHarm",
      "severity": 0
    },
    {
      "category": "Sexual",
      "severity": 0
    },
    {
      "category": "Violence",
      "severity": 2
    }
  ]
}

Definições

Nome	Description
AnalyzeImageOptions	A solicitação de análise de imagem.
AnalyzeImageOutputType	Isso se refere ao tipo de saída de análise de imagem. Se nenhum valor for atribuído, o valor padrão será "FourSeverityLevels".
AnalyzeImageResult	A resposta da análise de imagem.
Azure.Core.Foundations.Error	O objeto de erro.
Azure.Core.Foundations.ErrorResponse	Uma resposta que contém detalhes do erro.
Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ImageCategoriesAnalysis	Resultado da análise de imagem.
ImageCategory	A categoria de danos com suporte na análise de conteúdo de imagem.
ImageData	A imagem pode ser bytes codificados em base64 ou uma URL de blob. Você pode escolher apenas uma dessas opções. Se ambos forem fornecidos, a solicitação será recusada. O tamanho máximo da imagem é de 2048 x 2048 pixels e não deve exceder 4 MB, enquanto o tamanho mínimo da imagem é de 50 x 50 pixels.

AnalyzeImageOptions

A solicitação de análise de imagem.

Nome	Tipo	Valor padrão	Description
categories	ImageCategory[]		As categorias serão analisadas. Se eles não forem atribuídos, um conjunto padrão de resultados de análise para as categorias será retornado.
image	ImageData		A imagem a ser analisada.
outputType	AnalyzeImageOutputType	FourSeverityLevels	Isso se refere ao tipo de saída de análise de imagem. Se nenhum valor for atribuído, o valor padrão será "FourSeverityLevels".

AnalyzeImageOutputType

Isso se refere ao tipo de saída de análise de imagem. Se nenhum valor for atribuído, o valor padrão será "FourSeverityLevels".

Nome	Tipo	Description
FourSeverityLevels	string	As severidades de saída em quatro níveis, o valor pode ser 0,2,4,6.

AnalyzeImageResult

A resposta da análise de imagem.

Nome	Tipo	Description
categoriesAnalysis	ImageCategoriesAnalysis[]	Resultado da análise para categorias.

Azure.Core.Foundations.Error

O objeto de erro.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
details	Azure.Core.Foundations.Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível pelo ser humano do erro.
target	string	O destino do erro.

Azure.Core.Foundations.ErrorResponse

Uma resposta que contém detalhes do erro.

Nome	Tipo	Description
error	Azure.Core.Foundations.Error	O objeto de erro.

Azure.Core.Foundations.InnerError

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
innererror	Azure.Core.Foundations.InnerError	Erro interno.

ImageCategoriesAnalysis

Resultado da análise de imagem.

Nome	Tipo	Description
category	ImageCategory	A categoria de análise de imagem.
severity	integer	O valor aumenta com a gravidade do conteúdo de entrada. O valor desse campo é determinado pelo tipo de saída especificado na solicitação. O tipo de saída pode ser 'FourSeverityLevels', e o valor de saída pode ser 0, 2, 4, 6.

ImageCategory

A categoria de danos com suporte na análise de conteúdo de imagem.

Nome	Tipo	Description
Hate	string	A categoria de dano para Imagem - Ódio.
SelfHarm	string	A categoria de dano para Image – SelfHarm.
Sexual	string	A categoria de dano para Imagem - Sexual.
Violence	string	A categoria de dano para Imagem - Violência.

ImageData

A imagem pode ser bytes codificados em base64 ou uma URL de blob. Você pode escolher apenas uma dessas opções. Se ambos forem fornecidos, a solicitação será recusada. O tamanho máximo da imagem é de 2048 x 2048 pixels e não deve exceder 4 MB, enquanto o tamanho mínimo da imagem é de 50 x 50 pixels.

Nome	Tipo	Description
blobUrl	string	A URL do blob da imagem.
content	string	A codificação Base64 da imagem.