Image Operations - Analyze Image

Referencia

Servicio:: Azure AI Services

Versión de la API:: 2023-10-01

Analizar imagen
UNA API sincrónica para el análisis de contenido de imagen potencialmente perjudicial. Actualmente, admite cuatro categorías: Odio, SelfHarm, Sexual y Violencia.

POST {endpoint}/contentsafety/image:analyze?api-version=2023-10-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string	Puntos de conexión de Cognitive Services admitidos (protocolo y nombre de host, por ejemplo: https://.cognitiveservices.azure.com).
api-version	query	True	string	Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
image	True	ImageData	Imagen que se va a analizar.
categories		ImageCategory[]	Se analizarán las categorías. Si no están asignados, se devolverá un conjunto predeterminado de resultados de análisis para las categorías.
outputType		AnalyzeImageOutputType	Esto hace referencia al tipo de salida de análisis de imágenes. Si no se asigna ningún valor, el valor predeterminado será "FourSeverityLevels".

Respuestas

Nombre	Tipo	Description
200 OK	AnalyzeImageResult	La solicitud se ha realizado correctamente.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Una respuesta de error inesperada. Encabezados x-ms-error-code: string

Nombre

Tipo

Description

200 OK

AnalyzeImageResult

La solicitud se ha realizado correctamente.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Una respuesta de error inesperada.

Encabezados

x-ms-error-code: string

Seguridad

Ocp-Apim-Subscription-Key

Tipo: apiKey
En: header

OAuth2Auth

Tipo: oauth2
Flujo: application
Dirección URL del token: https://login.microsoftonline.com/common/oauth2/v2.0/token

Ámbitos

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

Ejemplos

Analyze Image

Solicitud de ejemplo

HTTP

POST {endpoint}/contentsafety/image:analyze?api-version=2023-10-01

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

Respuesta de muestra

status code:: 200

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

Definiciones

Nombre	Description
AnalyzeImageOptions	Solicitud de análisis de imágenes.
AnalyzeImageOutputType	Esto hace referencia al tipo de salida de análisis de imágenes. Si no se asigna ningún valor, el valor predeterminado será "FourSeverityLevels".
AnalyzeImageResult	Respuesta de análisis de imágenes.
Azure.Core.Foundations.Error	Objeto de error.
Azure.Core.Foundations.ErrorResponse	Respuesta que contiene los detalles del error.
Azure.Core.Foundations.InnerError	Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ImageCategoriesAnalysis	Resultado del análisis de imágenes.
ImageCategory	Categoría de daño admitida en el análisis de contenido de imágenes.
ImageData	La imagen puede ser bytes codificados en base64 o una dirección URL de blob. Solo puede elegir una de estas opciones. Si se proporcionan ambos, se rechazará la solicitud. El tamaño máximo de la imagen es de 2048 x 2048 píxeles y no debe superar los 4 MB, mientras que el tamaño mínimo de la imagen es de 50 x 50 píxeles.

AnalyzeImageOptions

Solicitud de análisis de imágenes.

Nombre	Tipo	Valor predeterminado	Description
categories	ImageCategory[]		Se analizarán las categorías. Si no están asignados, se devolverá un conjunto predeterminado de resultados de análisis para las categorías.
image	ImageData		Imagen que se va a analizar.
outputType	AnalyzeImageOutputType	FourSeverityLevels	Esto hace referencia al tipo de salida de análisis de imágenes. Si no se asigna ningún valor, el valor predeterminado será "FourSeverityLevels".

AnalyzeImageOutputType

Esto hace referencia al tipo de salida de análisis de imágenes. Si no se asigna ningún valor, el valor predeterminado será "FourSeverityLevels".

Nombre	Tipo	Description
FourSeverityLevels	string	Las gravedades de salida en cuatro niveles, el valor podría ser 0,2,4,6.

AnalyzeImageResult

Respuesta de análisis de imágenes.

Nombre	Tipo	Description
categoriesAnalysis	ImageCategoriesAnalysis[]	Resultado del análisis de categorías.

Azure.Core.Foundations.Error

Objeto de error.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
details	Azure.Core.Foundations.Error[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror	Azure.Core.Foundations.InnerError	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Representación legible del error.
target	string	Destino del error.

Azure.Core.Foundations.ErrorResponse

Respuesta que contiene los detalles del error.

Nombre	Tipo	Description
error	Azure.Core.Foundations.Error	Objeto de error.

Azure.Core.Foundations.InnerError

Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
innererror	Azure.Core.Foundations.InnerError	Error interno.

ImageCategoriesAnalysis

Resultado del análisis de imágenes.

Nombre	Tipo	Description
category	ImageCategory	Categoría de análisis de imágenes.
severity	integer	El valor aumenta con la gravedad del contenido de entrada. El valor de este campo viene determinado por el tipo de salida especificado en la solicitud. El tipo de salida podría ser "FourSeverityLevels" y el valor de salida puede ser 0, 2, 4, 6.

ImageCategory

Categoría de daño admitida en el análisis de contenido de imágenes.

Nombre	Tipo	Description
Hate	string	La categoría de daño de Image - Hate.
SelfHarm	string	Categoría de daño de Image - SelfHarm.
Sexual	string	Categoría de daño para Imagen - Sexual.
Violence	string	Categoría de daño de Imagen - Violencia.

ImageData

La imagen puede ser bytes codificados en base64 o una dirección URL de blob. Solo puede elegir una de estas opciones. Si se proporcionan ambos, se rechazará la solicitud. El tamaño máximo de la imagen es de 2048 x 2048 píxeles y no debe superar los 4 MB, mientras que el tamaño mínimo de la imagen es de 50 x 50 píxeles.

Nombre	Tipo	Description
blobUrl	string	Dirección URL del blob de la imagen.
content	string	Codificación Base64 de la imagen.

Compartir a través de

Image Operations - Analyze Image

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

Ocp-Apim-Subscription-Key

OAuth2Auth

Ámbitos

Ejemplos

Analyze Image

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AnalyzeImageOptions

AnalyzeImageOutputType

AnalyzeImageResult

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

ImageCategoriesAnalysis

ImageCategory

ImageData

Recursos adicionales