Person Group Operations - Create Person Group Person

Service:

Azure AI Services

API Version:

v1.1-preview.1

Create uma nova pessoa num Grupo de Pessoas especificado. Para adicionar o rosto a esta pessoa, chame "Adicionar Cara de Pessoa do Grupo de Pessoas".

Nota

• • Quota de subscrição de escalão gratuito:
    • 1000 pessoas em todas as pessoas Grupos.
  • Quota de subscrição de escalão S0:
    • 10 000 pessoas por Grupo de Pessoas.
    • 1.000.000 pessoas Grupos.
    • 100.000.000 pessoas em todas as pessoas Grupos.

POST {endpoint}/face/{apiVersion}/persongroups/{personGroupId}/persons

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
apiVersion	path	True	string	Versão da API
endpoint	path	True	string uri	Pontos finais dos Serviços Cognitivos suportados (protocolo e nome do anfitrião, por exemplo: https://{resource-name}.cognitiveservices.azure.com).
personGroupId	path	True	string	ID do contentor. Regex pattern: ^[a-z0-9-_]+$

Corpo do Pedido

Name	Necessário	Tipo	Description
name	True	string	Nome definido pelo utilizador, o comprimento máximo é 128.
userData		string	Dados definidos pelo utilizador opcionais. O comprimento não deve exceder os 16 K.

Respostas

Name	Tipo	Description
200 OK	CreatePersonResult	Uma chamada bem-sucedida devolve um novo personId criado.
Other Status Codes	FaceErrorResponse	Uma resposta de erro inesperada. Headers x-ms-error-code: string

Segurança

Ocp-Apim-Subscription-Key

A chave secreta da sua subscrição do Azure AI Face.

Type: apiKey
In: header

AADToken

Fluxo OAuth2 do Azure Active Directory

Type: oauth2
Flow: accessCode
Authorization URL: https://api.example.com/oauth2/authorize
Token URL: https://api.example.com/oauth2/token

Scopes

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

Exemplos

Create Person in PersonGroup

Sample Request

HTTP

POST {endpoint}/face/v1.1-preview.1/persongroups/your_person_group_id/persons

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

Sample Response

Status code:

200

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

Definições

Name	Description
CreatePersonResult	Resposta da criação de pessoa.
FaceError	O objeto de erro. Para obter detalhes abrangentes sobre os códigos de erro e as mensagens devolvidas pelo Serviço Face, consulte a seguinte ligação: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Uma resposta que contém detalhes de erro.

CreatePersonResult

Resposta da criação de pessoa.

Name	Tipo	Description
personId	string	ID da pessoa.

FaceError

O objeto de erro. Para obter detalhes abrangentes sobre os códigos de erro e as mensagens devolvidas pelo Serviço Face, consulte a seguinte ligação: https://aka.ms/face-error-codes-and-messages.

Name	Tipo	Description
code	string	Um dos conjuntos de códigos de erro definidos pelo servidor.
message	string	Uma representação legível por humanos do erro.

FaceErrorResponse

Uma resposta que contém detalhes de erro.

Name	Tipo	Description
error	FaceError	O objeto de erro.