Person Directory Operations - Get Dynamic Person Group References

Tjänst:

Azure AI Services

API-version:

v1.2-preview.1

Visa en lista över alla dynamiska persongrupper som en person har refererats till av i Person Directory.
Dynamiska persongrupper lagras i alfabetisk ordning efter dynamiskt persongrupp-ID som skapats i personkatalogen "Skapa dynamisk persongrupp".

• • Parametern "start" (sträng, valfritt) anger ett ID-värde från vilket returnerade poster har större ID:er baserat på strängjämförelse. Om du anger "start" till ett tomt värde anges att poster ska returneras från och med det första objektet.
  • Parametern "top" (int, optional) anger det maximala antalet poster som ska returneras, med en gräns på upp till 1 000 poster per anrop. Om du vill hämta ytterligare poster utanför den här gränsen anger du "start" med personId för den senaste posten som returnerades i det aktuella anropet.

Tips/Råd

• Det finns till exempel totalt 5 objekt med deras ID: "itemId1", ..., "itemId5".
  • "start=&top=" returnerar alla 5 objekt.
  • "start=&top=2" returnerar "itemId1", "itemId2".
  • "start=itemId2&top=3" returnerar "itemId3", "itemId4", "itemId5".

GET {endpoint}/face/{apiVersion}/persons/{personId}/dynamicPersonGroupReferences

Med valfria parametrar:

GET {endpoint}/face/{apiVersion}/persons/{personId}/dynamicPersonGroupReferences?start={start}&top={top}

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).
personId	path	True	string (uuid)	Person-ID för personen.
start	query		string	Visa en lista över resurser som är större än "start". Den innehåller högst 64 tecken. Standardvärdet är tomt.
top	query		integer (int32) minimum: 1 maximum: 1000	Antalet objekt som ska listas, i [1, 1 000]. Standardvärdet är 1 000.

Svar

Name	Typ	Description
200 OK	ListGroupReferenceResult	Ett lyckat anrop returnerar en matris med dynamicPersonGroups-information som refererar till angivet personId.
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

Get DynamicPersonGroup References

Exempelbegäran

HTTP

GET {endpoint}/face/v1.2-preview.1/persons/85c0c630-c9c9-40f8-8a4e-f9ae4f926ea5/dynamicPersonGroupReferences?start=00000000-0000-0000-0000-000000000000&top=20

Exempelsvar

Statuskod:

200

{
  "dynamicPersonGroupIds": [
    "your_dynamic_person_group_id"
  ]
}

Definitioner

Name	Description
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.
ListGroupReferenceResult	Svar på en lista med en dynamisk persongrupp.

FaceError

Objekt

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

Objekt

Ett svar som innehåller felinformation.

Name	Typ	Description
error	FaceError	Felobjektet.

ListGroupReferenceResult

Objekt

Svar på en lista med en dynamisk persongrupp.

Name	Typ	Description
dynamicPersonGroupIds	string[] minLength: 1 maxLength: 64 pattern: ^[a-z0-9-_]+$	Matris med PersonDirectory DynamicPersonGroup-ID:er.