Compartir a través de


Person Group Person - Get

Recupere la información de una persona, incluidas las caras persistentes registradas, el nombre y userData.

GET {Endpoint}/face/v1.0/persongroups/{personGroupId}/persons/{personId}

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://westus.api.cognitive.microsoft.com).

personGroupId
path True

string

maxLength: 64
pattern: ^[a-z0-9-_]+$

Identificador que hace referencia a un grupo de personas determinado.

personId
path True

string (uuid)

Identificador que hace referencia a una persona determinada.

Encabezado de la solicitud

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

string

Respuestas

Nombre Tipo Description
200 OK

Person

Una llamada correcta devuelve la información de la persona.

Other Status Codes

APIError

Respuesta de error.

Seguridad

Ocp-Apim-Subscription-Key

Tipo: apiKey
En: header

Ejemplos

Get person example

Solicitud de ejemplo

GET {Endpoint}/face/v1.0/persongroups/abc/persons/25985303-c537-4467-b41d-bdb45cd95ca1

Respuesta de muestra

{
  "personId": "25985303-c537-4467-b41d-bdb45cd95ca1",
  "persistedFaceIds": [
    "015839fb-fbd9-4f79-ace9-7675fc2f1dd9",
    "fce92aed-d578-4d2e-8114-068f8af4492e",
    "b64d5e15-8257-4af2-b20a-5a750f8940e7"
  ],
  "name": "Ryan",
  "userData": "User-provided data attached to the person."
}

Definiciones

Nombre Description
APIError

Información de error devuelta por la API

Error

Cuerpo del error.

Person

Objeto Person.

APIError

Información de error devuelta por la API

Nombre Tipo Description
error

Error

Cuerpo del error.

Error

Cuerpo del error.

Nombre Tipo Description
code

string

message

string

Person

Objeto Person.

Nombre Tipo Description
name

string

maxLength: 128

Nombre definido por el usuario, la longitud máxima es 128.

persistedFaceIds

string[] (uuid)

PersistedFaceIds de caras registradas en la persona. Estos persistedFaceIds se devuelven de Persona: agregar una cara de persona y no expirarán.

personId

string (uuid)

PersonId de la lista de caras de destino.

userData

string

maxLength: 16384

Datos especificados por el usuario. La longitud no debe superar los 16 KB.