Person Directory Operations - Create Person

Tjänst:

Azure AI Services

API-version:

v1.2-preview.1

Skapar en ny person i en personkatalog. Om du vill lägga till ansikte till den här personen anropar du personkatalogen "Lägg till personligt ansikte".

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
apiVersion	path	True	string	API-version
endpoint	path	True	string uri	Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://{resource-name}.cognitiveservices.azure.com).

Begärandetext

Name	Obligatorisk	Typ	Description
name	True	string	Användardefinierat namn, maximal längd är 128.
userData		string	Valfria användardefinierade data. Längden får inte överstiga 16 K.

Svar

Name	Typ	Description
202 Accepted	CreatePersonResult	Ett lyckat anrop returnerar en tom svarstext. Tjänsten har godkänt begäran och kommer snart att börja bearbetas. Klienten kan köra frågor mot åtgärdsstatusen och resultatet med hjälp av den URL som anges i svarshuvudet "Åtgärdsplats". URL:en upphör att gälla om 48 timmar. Sidhuvuden Location: string operation-Location: string
Other Status Codes	FaceErrorResponse	Ett oväntat felsvar. Sidhuvuden x-ms-error-code: string

Säkerhet

Ocp-Apim-Subscription-Key

Den hemliga nyckeln för din Azure AI Face-prenumeration.

Typ: apiKey
I: header

AADToken

The Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: accessCode
Auktoriseringswebbadress: https://api.example.com/oauth2/authorize
Token-webbadress: https://api.example.com/oauth2/token

Omfattningar

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

Exempel

Create Person in PersonDirectory

Exempelbegäran

HTTP

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

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

Exempelsvar

Statuskod:

202

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

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

Definitioner

Name	Description
CreatePersonResult	Svar från skapa person.
FaceError	Felobjektet. Mer information om felkoder och meddelanden som returneras av ansiktstjänsten finns i följande länk: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Ett svar som innehåller felinformation.

CreatePersonResult

Svar från skapa person.

Name	Typ	Description
personId	string	Person-ID för personen.

FaceError

Felobjektet. Mer information om felkoder och meddelanden som returneras av ansiktstjänsten finns i följande länk: https://aka.ms/face-error-codes-and-messages.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
message	string	En mänsklig läsbar representation av felet.

FaceErrorResponse

Ett svar som innehåller felinformation.

Name	Typ	Description
error	FaceError	Felobjektet.