Person Directories - Update Face

Servicio:

Azure AI Services

Versión de la API:

2025-05-01-preview

Actualizar las propiedades de la cara, como modificar la asociación con una persona.

PATCH {endpoint}/contentunderstanding/personDirectories/{personDirectoryId}/faces/{faceId}?api-version=2025-05-01-preview

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string (uri)	Punto de conexión de servicio de Content Understanding.
faceId	path	True	string pattern: ^[a-zA-Z0-9._-]{1,64}$	El identificador único de la cara.
personDirectoryId	path	True	string pattern: ^[a-zA-Z0-9._-]{1,64}$	El identificador único del directorio de personas.
api-version	query	True	string minLength: 1	Versión de API que se usará para la operación.

Encabezado de la solicitud

Media Types: "application/merge-patch+json"

Nombre	Requerido	Tipo	Description
x-ms-client-request-id		string (uuid)	Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Cuerpo de la solicitud

Media Types: "application/merge-patch+json"

Nombre	Tipo	Description
personId	string	Persona asociada con la cara, si la hubiera.

Respuestas

Nombre	Tipo	Description
200 OK	PersonDirectoryFace	La solicitud se ha realizado correctamente. Encabezados x-ms-client-request-id: string
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: accessCode
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize
Dirección URL del token: https://login.microsoftonline.com/common/oauth2/token

Ámbitos

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

Ejemplos

Update Face in Person Directory

Solicitud de ejemplo

HTTP

PATCH {endpoint}/contentunderstanding/personDirectories/myDirectory/faces/7a87f162-8dd5-4aea-8810-373e36b96b38?api-version=2025-05-01-preview

{
  "personId": "19323b77-2012-487b-b131-09c318dc23df"
}

Respuesta de muestra

status code:

200

{
  "faceId": "7a87f162-8dd5-4aea-8810-373e36b96b38",
  "personId": "19323b77-2012-487b-b131-09c318dc23df",
  "boundingBox": {
    "left": 33,
    "top": 73,
    "width": 262,
    "height": 324
  },
  "imageReferenceId": "face1.jpg"
}

Definiciones

Nombre	Description
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/azure/Guidelines.md#handling-errors.
BoundingBox	Cuadro delimitador en una imagen.
PersonDirectoryFace	Cara en un directorio de personas.
PersonDirectoryFaceUpdate	Cara en un directorio de personas.

Azure.Core.Foundations.Error

Object

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	Una representación en lenguaje natural del error.
target	string	Destino del error.

Azure.Core.Foundations.ErrorResponse

Object

Respuesta que contiene los detalles del error.

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

Azure.Core.Foundations.InnerError

Object

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/azure/Guidelines.md#handling-errors.

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.

BoundingBox

Object

Cuadro delimitador en una imagen.

Nombre	Tipo	Description
height	integer (int32)	Altura del cuadro delimitador.
left	integer (int32)	Coordenada izquierda del cuadro delimitador.
top	integer (int32)	Coordenada superior del cuadro delimitador.
width	integer (int32)	Anchura del cuadro delimitador.

PersonDirectoryFace

Object

Cara en un directorio de personas.

Nombre	Tipo	Description
boundingBox	BoundingBox	Cuadro delimitador de la cara en la imagen de origen.
faceId	string pattern: ^[a-zA-Z0-9._-]{1,64}$	El identificador único de la cara.
imageReferenceId	string	Identificador proporcionado por el usuario para la imagen de origen.
personId	string	Persona asociada con la cara, si la hubiera.

PersonDirectoryFaceUpdate

Object

Cara en un directorio de personas.

Nombre	Tipo	Description
personId	string	Persona asociada con la cara, si la hubiera.