Person Directory Operations - Create Person

Servizio:

Azure AI Services

Versione API:

v1.2-preview.1

Crea una nuova persona in una directory person. Per aggiungere il viso a questa persona, chiama Person Directory "Add Person Face".

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
apiVersion	path	True	string	Versione API
endpoint	path	True	string uri	Endpoint di Servizi cognitivi supportati (protocollo e nome host, ad esempio: https://{nome-risorsa}.cognitiveservices.azure.com).

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
name	True	string	Il nome definito dall'utente, la lunghezza massima è 128.
userData		string	Dati facoltativi definiti dall'utente. La lunghezza non deve superare 16.000.

Risposte

Nome	Tipo	Descrizione
202 Accepted	CreatePersonResult	Una chiamata con esito positivo restituisce un corpo di risposta vuoto. Il servizio ha accettato la richiesta e inizierà presto l'elaborazione. Il client può eseguire una query sullo stato dell'operazione e ottenere il risultato usando l'URL specificato nell'intestazione della risposta 'Operation-Location'. L'URL scade entro 48 ore. Intestazioni Location: string operation-Location: string
Other Status Codes	FaceErrorResponse	Risposta di errore imprevista. Intestazioni x-ms-error-code: string

Sicurezza

Ocp-Apim-Subscription-Key

Chiave privata per la sottoscrizione di Viso di Intelligenza artificiale di Azure.

Tipo: apiKey
In: header

AADToken

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: accessCode
URL di autorizzazione: https://api.example.com/oauth2/authorize
URL token: https://api.example.com/oauth2/token

Ambiti

Nome	Descrizione
https://cognitiveservices.azure.com/.default

Esempio

Create Person in PersonDirectory

Esempio di richiesta

HTTP

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

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

Risposta di esempio

Codice di stato:

202

location: https://contoso.com/operationstatus
operation-Location: https://contoso.com/operationstatus

{
  "personId": "85c0c630-c9c9-40f8-8a4e-f9ae4f926ea5"
}

Definizioni

Nome	Descrizione
CreatePersonResult	Risposta della persona di creazione.
FaceError	Oggetto error. Per informazioni dettagliate sui codici di errore e i messaggi restituiti dal servizio Viso, vedere il collegamento seguente: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Risposta contenente i dettagli dell'errore.

CreatePersonResult

Risposta della persona di creazione.

Nome	Tipo	Descrizione
personId	string	ID persona della persona.

FaceError

Oggetto error. Per informazioni dettagliate sui codici di errore e i messaggi restituiti dal servizio Viso, vedere il collegamento seguente: https://aka.ms/face-error-codes-and-messages.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
message	string	Rappresentazione leggibile dell'errore.

FaceErrorResponse

Risposta contenente i dettagli dell'errore.

Nome	Tipo	Descrizione
error	FaceError	Oggetto error.