Image Operations - Analyze Image

Referência

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, suporta quatro categorias: Ódio, Automutilação, Sexual e Violência.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string	Pontos de extremidade de Serviços Cognitivos suportados (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 do Pedido

Name	Necessá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	Isto refere-se ao tipo de saída de análise de imagem. Se nenhum valor for atribuído, o valor padrão será "FourSeverityLevels".

Respostas

Name	Tipo	Description
200 OK	AnalyzeImageResult	O pedido foi bem-sucedido.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Name

Tipo

Description

200 OK

AnalyzeImageResult

O pedido foi bem-sucedido.

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
Fluxo: application
Token URL: https://login.microsoftonline.com/common/oauth2/v2.0/token

Âmbitos

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

Exemplos

Analyze Image

Pedido de amostra

HTTP

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

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

Resposta da amostra

Código de estado:: 200

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

Definições

Name	Description
AnalyzeImageOptions	O pedido de análise de imagem.
AnalyzeImageOutputType	Isto refere-se 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 contendo 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 dano suportada na análise de conteúdo de imagem.
ImageData	A imagem pode ser de bytes codificados base64 ou um URL de blob. Você pode escolher apenas uma dessas opções. Se ambos forem fornecidos, o pedido será recusado. 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

O pedido de análise de imagem.

Name	Tipo	Default value	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	Isto refere-se ao tipo de saída de análise de imagem. Se nenhum valor for atribuído, o valor padrão será "FourSeverityLevels".

AnalyzeImageOutputType

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

Name	Tipo	Description
FourSeverityLevels	string	Severidades de produção em quatro níveis, o valor poderia ser 0,2,4,6.

AnalyzeImageResult

A resposta da análise de imagem.

Name	Tipo	Description
categoriesAnalysis	ImageCategoriesAnalysis[]	Resultado da análise por categorias.

Azure.Core.Foundations.Error

O objeto de erro.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
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 por humanos do erro.
target	string	O alvo do erro.

Azure.Core.Foundations.ErrorResponse

Uma resposta contendo detalhes do erro.

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

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

ImageCategoriesAnalysis

Resultado da análise de imagem.

Name	Tipo	Description
category	ImageCategory	A categoria de análise de imagem.
severity	integer	O valor aumenta com a severidade do conteúdo de entrada. O valor deste 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 dano suportada na análise de conteúdo de imagem.

Name	Tipo	Description
Hate	string	A categoria de dano para Imagem - Ódio.
SelfHarm	string	A categoria de dano para Imagem - Automutilação.
Sexual	string	A categoria de dano para Imagem - Sexual.
Violence	string	A categoria dano para Imagem - Violência.

ImageData

A imagem pode ser de bytes codificados base64 ou um URL de blob. Você pode escolher apenas uma dessas opções. Se ambos forem fornecidos, o pedido será recusado. 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.

Name	Tipo	Description
blobUrl	string	O url de blob da imagem.
content	string	A codificação Base64 da imagem.

Partilhar via

Image Operations - Analyze Image

Parâmetros do URI

Corpo do Pedido

Respostas

Segurança

Ocp-Apim-Subscription-Key

OAuth2Auth

Âmbitos

Exemplos

Analyze Image

Pedido de amostra

Resposta da amostra

Definições

AnalyzeImageOptions

AnalyzeImageOutputType

AnalyzeImageResult

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

ImageCategoriesAnalysis

ImageCategory

ImageData

Recursos adicionais