Person Directory Operations - Get Dynamic Person Group References
Lista alla dynamiska personer Grupper en person har refererats av i Person Directory.
Dynamisk person Grupper lagras i alfabetisk ordning efter dynamiskt persongrupps-ID som skapats i personkatalogen "Skapa dynamisk persongrupp".
-
- Parametern "start" (sträng, valfritt) anger ett ID-värde från vilket returnerade poster kommer att ha 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
- 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
GET {endpoint}/face/{apiVersion}/persons/{personId}/dynamicPersonGroupReferences?start={start}&top={top}
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
api
|
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). |
person
|
path | True |
string uuid |
Personens person-ID. |
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 |
Antalet objekt att lista, i [1, 1000]. Standardvärdet är 1 000. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
Ett lyckat anrop returnerar en matris med dynamicPersonGroups-information som refererar till angivet personId. |
|
Other Status Codes |
Ett oväntat felsvar. Sidhuvuden x-ms-error-code: string |
Säkerhet
Ocp-Apim-Subscription-Key
Den hemliga nyckeln för din Ansiktsprenumeration på Azure AI.
Typ:
apiKey
I:
header
AADToken
Azure Active Directory OAuth2-flödet
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
GET {endpoint}/face/v1.1-preview.1/persons/85c0c630-c9c9-40f8-8a4e-f9ae4f926ea5/dynamicPersonGroupReferences?start=00000000-0000-0000-0000-000000000000&top=20
Exempelsvar
{
"dynamicPersonGroupIds": [
"your_dynamic_person_group_id"
]
}
Definitioner
Name | Description |
---|---|
Face |
Felobjektet. Omfattande information om felkoder och meddelanden som returneras av ansiktstjänsten finns på följande länk: https://aka.ms/face-error-codes-and-messages. |
Face |
Ett svar som innehåller felinformation. |
List |
Svar på listans dynamiska persongrupp. |
FaceError
Felobjektet. Omfattande information om felkoder och meddelanden som returneras av ansiktstjänsten finns på 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 |
Felobjektet. |
ListGroupReferenceResult
Svar på listans dynamiska persongrupp.
Name | Typ | Description |
---|---|---|
dynamicPersonGroupIds |
string[] |
Matris med ID:t PersonDirectory DynamicPersonGroup. |