Get Area Of Interest - Get Area Of Interest

Referencia

Servicio:: Azure AI Services

Versión de la API:: 3.2

Esta operación devuelve un rectángulo delimitador alrededor del área más importante de la imagen. Se devolverá una respuesta correcta en JSON. Si se produce un error en la solicitud, la respuesta contiene un código de error y un mensaje para ayudar a determinar lo que salió mal. Tras un error, se devuelve el código de error y un mensaje de error. El código de error podría ser uno de InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, FailedToProcess, Timeout o InternalServerError.

POST {Endpoint}/vision/v3.2/areaOfInterest

Con parámetros opcionales:

POST {Endpoint}/vision/v3.2/areaOfInterest?model-version={model-version}

Parámetros de identificador URI

Nombre En Requerido Tipo Description

Nombre	En	Requerido	Tipo	Description
Endpoint	path	True	string	Puntos de conexión de Cognitive Services admitidos.
model-version	query		string	Parámetro opcional para especificar la versión del modelo de IA. Los valores aceptados son: "latest", "2021-04-01", "2021-05-01". El valor predeterminado es "latest". Patrón de Regex: `^(latest\|\d{4}-\d{2}-\d{2})(-preview)?$`

Endpoint

path

True

string

Puntos de conexión de Cognitive Services admitidos.

model-version

query

string

Parámetro opcional para especificar la versión del modelo de IA. Los valores aceptados son: "latest", "2021-04-01", "2021-05-01". El valor predeterminado es "latest".

Patrón de Regex: ^(latest|\d{4}-\d{2}-\d{2})(-preview)?$

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
url	True	string	Dirección URL accesible públicamente de una imagen.

Respuestas

Nombre	Tipo	Description
200 OK	AreaOfInterestResult	La respuesta incluye el área extraída de interés en formato JSON.
Other Status Codes	ComputerVisionErrorResponse	Respuesta de error.

Seguridad

Ocp-Apim-Subscription-Key

Tipo: apiKey
En: header

Ejemplos

Successful GetAreaOfInterest request

Solicitud de ejemplo

HTTP

POST https://westus.api.cognitive.microsoft.com/vision/v3.2/areaOfInterest


{
  "url": "{url}"
}

Respuesta de muestra

status code:: 200

{
  "areaOfInterest": {
    "h": 951,
    "w": 950,
    "x": 160,
    "y": 0
  },
  "requestId": "ed2de1c6-fb55-4686-b0da-4da6e05d283f",
  "metadata": {
    "format": "Jpeg",
    "height": 951,
    "width": 1378
  },
  "modelVersion": "2021-04-01"
}

Definiciones

Nombre	Description
AreaOfInterestResult	Resultado de la operación AreaOfInterest.
BoundingRect	Un rectángulo delimitador para un área dentro de una imagen.
ComputerVisionError	Error de solicitud de API.
ComputerVisionErrorCodes	Código de error.
ComputerVisionErrorResponse	Respuesta de error de API.
ComputerVisionInnerError	Detalles sobre el error de solicitud de API.
ComputerVisionInnerErrorCodeValue	Código de error.
ImageMetadata	Metadatos de imagen.
ImageUrl

AreaOfInterestResult

Resultado de la operación AreaOfInterest.

Nombre	Tipo	Description
areaOfInterest	BoundingRect	Cuadro de límite para un área de interés dentro de una imagen.
metadata	ImageMetadata	Metadatos de imagen.
modelVersion	string	Versión del modelo de IA.
requestId	string	Id. de la solicitud de api rest.

BoundingRect

Un rectángulo delimitador para un área dentro de una imagen.

Nombre	Tipo	Description
h	integer	Alto medido desde el punto superior izquierdo del área, en píxeles.
w	integer	Ancho medido desde el punto superior izquierdo del área, en píxeles.
x	integer	Coordenada X del punto superior izquierdo del área, en píxeles.
y	integer	Coordenada Y del punto superior izquierdo del área, en píxeles.

ComputerVisionError

Error de solicitud de API.

Nombre	Tipo	Description
code	ComputerVisionErrorCodes	Código de error.
innererror	ComputerVisionInnerError	El error interno contiene información más específica.
message	string	Mensaje que explica el error notificado por el servicio.

ComputerVisionErrorCodes

Código de error.

Nombre	Tipo	Description
InternalServerError	string
InvalidArgument	string
InvalidRequest	string
ServiceUnavailable	string

ComputerVisionErrorResponse

Respuesta de error de API.

Nombre	Tipo	Description
error	ComputerVisionError	Contenido del error.

ComputerVisionInnerError

Detalles sobre el error de solicitud de API.

Nombre	Tipo	Description
code	ComputerVisionInnerErrorCodeValue	Código de error.
message	string	Mensaje de error.

ComputerVisionInnerErrorCodeValue