Compartir a través de

Person Group Operations - Get Large Person Group Person

  • Referencia
Servicio:
Azure AI Services
Versión de la API:
v1.2-preview.1

Recupere el nombre de una persona y userData, y los faceId persistentes que representan las características faciales de la persona registrada.

GET {endpoint}/face/{apiVersion}/largepersongroups/{largePersonGroupId}/persons/{personId}

Parámetros de identificador URI

Nombre En Requerido Tipo Description
apiVersion
 path True

string

Versión de API
endpoint
 path True

string

uri

Puntos de conexión de Cognitive Services admitidos (protocolo y nombre de host, por ejemplo: https://{resource-name}.cognitiveservices.azure.com).
largePersonGroupId
 path True

string

Identificador del contenedor.

Patrón de Regex: ^[a-z0-9-_]+$
personId
 path True

string

uuid

Id. de la persona.

Respuestas

Nombre Tipo Description
200 OK

LargePersonGroupPerson

Una llamada correcta devuelve la información de la persona.
Other Status Codes

FaceErrorResponse

Una respuesta de error inesperada.

Encabezados

x-ms-error-code: string

Seguridad

Ocp-Apim-Subscription-Key

Clave secreta de la suscripción de Azure AI Face.

Tipo: apiKey
En: header

AADToken

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: accessCode
Dirección URL de autorización: https://api.example.com/oauth2/authorize
Dirección URL del token: https://api.example.com/oauth2/token

Ámbitos

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

Ejemplos

Get Person from LargePersonGroup

Solicitud de ejemplo

GET {endpoint}/face/v1.2-preview.1/largepersongroups/your_large_person_group_id/persons/25985303-c537-4467-b41d-bdb45cd95ca1

Respuesta de muestra

status code:
200 
{
  "personId": "25985303-c537-4467-b41d-bdb45cd95ca1",
  "name": "your_large_person_group_person_name",
  "userData": "your_user_data",
  "persistedFaceIds": [
    "43897a75-8d6f-42cf-885e-74832febb055"
  ]
}

Definiciones

Nombre Description
FaceError

Objeto de error. Para obtener detalles completos sobre los códigos de error y los mensajes devueltos por face Service, consulte el vínculo siguiente: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse

Respuesta que contiene los detalles del error.
LargePersonGroupPerson

Persona de un grupo de personas grande especificado. Para agregar cara a esta persona, llame a "Add Large Person Group Person Face".

FaceError

Objeto de error. Para obtener detalles completos sobre los códigos de error y los mensajes devueltos por face Service, consulte el vínculo siguiente: https://aka.ms/face-error-codes-and-messages.

Nombre Tipo Description
code

string

Uno de un conjunto definido por el servidor de códigos de error.
message

string

Representación legible del error.

FaceErrorResponse

Respuesta que contiene los detalles del error.

Nombre Tipo Description
error

FaceError

Objeto de error.

LargePersonGroupPerson

Persona de un grupo de personas grande especificado. Para agregar cara a esta persona, llame a "Add Large Person Group Person Face".

Nombre Tipo Description
name

string

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

string[]

Identificadores de caras registradas en la persona.
personId

string

Id. de la persona.
userData

string

Datos opcionales definidos por el usuario. La longitud no debe superar los 16 000.