Person Group Operations - Create Large Person Group Person

Servicio:

Azure AI Services

Versión de la API:

v1.2-preview.1

Cree una nueva persona en un grupo de personas grandes especificado. Para agregar cara a esta persona, llame a "Add Large Person Group Person Face".

Nota

• • Cuota de suscripción de nivel gratis:
    • 1.000 personas en todos los grupos de personas grandes.
  • Cuota de suscripción de nivel S0:
    • 1.000.000 personas por grupo de personas grandes.
    • 1.000.000 grupos de personas grandes.
    • 1.000.000.000 personas en todos los grupos de personas grandes.

POST {endpoint}/face/{apiVersion}/largepersongroups/{largePersonGroupId}/persons

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-_]+$

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
name	True	string	Nombre definido por el usuario, la longitud máxima es 128.
userData		string	Datos opcionales definidos por el usuario. La longitud no debe superar los 16 000.

Respuestas

Nombre	Tipo	Description
200 OK	CreatePersonResult	Una llamada correcta devuelve un nuevo personId creado.
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

Create Person in LargePersonGroup

Solicitud de ejemplo

HTTP

POST {endpoint}/face/v1.2-preview.1/largepersongroups/your_large_person_group_id/persons

{
  "name": "your_large_person_group_person_name",
  "userData": "your_user_data"
}

Respuesta de muestra

status code:

200

{
  "personId": "25985303-c537-4467-b41d-bdb45cd95ca1"
}

Definiciones

Nombre	Description
CreatePersonResult	Respuesta de la persona de creación.
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.

CreatePersonResult

Respuesta de la persona de creación.

Nombre	Tipo	Description
personId	string	Id. de persona de la persona.

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.