Person Directories - Update Person

Servicio:

Azure AI Services

Versión de la API:

2025-05-01-preview

Actualizar las propiedades de la persona.

PATCH {endpoint}/contentunderstanding/personDirectories/{personDirectoryId}/persons/{personId}?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.
personDirectoryId	path	True	string pattern: ^[a-zA-Z0-9._-]{1,64}$	El identificador único del directorio de personas.
personId	path	True	string pattern: ^[a-zA-Z0-9._-]{1,64}$	El identificador único de la persona.
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
faceIds	string[]	Lista de rostros asociados a la persona.
tags	object	Etiquetas asociadas a la persona.

Respuestas

Nombre	Tipo	Description
200 OK	PersonDirectoryPerson	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 Person in Person Directory

Solicitud de ejemplo

HTTP

PATCH {endpoint}/contentunderstanding/personDirectories/myDirectory/persons/4f66b612-e57d-4d17-9ef7-b951aea2cf0f?api-version=2025-05-01-preview

{
  "tags": {
    "age": null
  },
  "faceIds": [
    "6995a5ae-83fa-4c64-a8b7-23aefc6cf0fc"
  ]
}

Respuesta de muestra

status code:

200

{
  "personId": "4f66b612-e57d-4d17-9ef7-b951aea2cf0f",
  "tags": {
    "name": "Paul"
  },
  "faceIds": [
    "7a87f162-8dd5-4aea-8810-373e36b96b38",
    "f28b3cda-4005-44b6-8518-6fcddef108cb",
    "6995a5ae-83fa-4c64-a8b7-23aefc6cf0fc"
  ]
}

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.
PersonDirectoryPerson	Persona en un directorio de personas.
PersonDirectoryPersonUpdate	Persona 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.

PersonDirectoryPerson

Object

Persona en un directorio de personas.

Nombre	Tipo	Description
faceIds	string[]	Lista de rostros asociados a la persona.
personId	string pattern: ^[a-zA-Z0-9._-]{1,64}$	El identificador único de la persona.
tags	object	Etiquetas asociadas a la persona.

PersonDirectoryPersonUpdate

Object

Persona en un directorio de personas.

Nombre	Tipo	Description
faceIds	string[]	Lista de rostros asociados a la persona.
tags	object	Etiquetas asociadas a la persona.