Person Directory Operations - Get Dynamic Person Group Persons

서비스:

Azure AI Services

API 버전:

v1.2-preview.1

지정된 동적 사람 그룹의 모든 사람을 나열합니다.
Person은 Person Directory "Create Person"에서 만든 personId의 사전순으로 저장됩니다.

• • "start" 매개 변수(문자열, 선택 사항)는 반환된 항목이 문자열 비교에 따라 더 큰 ID를 가질 ID 값을 지정합니다. "start"를 빈 값으로 설정하면 첫 번째 항목부터 항목을 반환해야 합니다.
  • "top" 매개 변수(int, 선택 사항)는 반환할 최대 항목 수를 결정하며 호출당 최대 1,000개의 항목으로 제한됩니다. 이 제한을 초과하는 추가 항목을 검색하려면 현재 호출에서 반환된 마지막 항목의 personId로 "시작"을 지정합니다.

팁

• 예를 들어 ID가 있는 총 5개의 항목이 있습니다. "itemId1", ..., "itemId5".
  • "start=&top="은 5개 항목을 모두 반환합니다.
  • "start=&top=2"는 "itemId1", "itemId2"를 반환합니다.
  • "start=itemId2&top=3"은 "itemId3", "itemId4", "itemId5"를 반환합니다.

GET {endpoint}/face/{apiVersion}/dynamicpersongroups/{dynamicPersonGroupId}/persons

선택적 매개 변수:

GET {endpoint}/face/{apiVersion}/dynamicpersongroups/{dynamicPersonGroupId}/persons?start={start}&top={top}

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
apiVersion	path	True	string	API 버전
dynamicPersonGroupId	path	True	string	동적 사용자 그룹의 ID입니다. regex 패턴: ^[a-z0-9-_]+$
endpoint	path	True	string uri	지원되는 Cognitive Services 엔드포인트(프로토콜 및 호스트 이름, 예: https://{resource-name}.cognitiveservices.azure.com).
start	query		string	"start"보다 큰 리소스를 나열합니다. 64자를 넘지 않습니다. 기본값은 비어 있습니다.
top	query		integer int32	나열할 항목 수([1, 1000])입니다. 기본값은 1000입니다.

응답

Name	형식	Description
200 OK	ListPersonResult	성공한 호출은 개인 디렉터리에 있는 사람 정보 배열을 반환합니다.
Other Status Codes	FaceErrorResponse	예기치 않은 오류 응답입니다. 헤더 x-ms-error-code: string

보안

Ocp-Apim-Subscription-Key

Azure AI Face 구독의 비밀 키입니다.

형식: apiKey
In(다음 안에): header

AADToken

Azure Active Directory OAuth2 흐름

형식: oauth2
Flow: accessCode
권한 부여 URL: https://api.example.com/oauth2/authorize
토큰 URL: https://api.example.com/oauth2/token

범위

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

예제

Get DynamicPersonGroup Persons

샘플 요청

HTTP

GET {endpoint}/face/v1.2-preview.1/dynamicpersongroups/your_dynamic_person_group_id/persons?start=00000000-0000-0000-0000-000000000000&top=20

샘플 응답

상태 코드:

200

{
  "personIds": [
    "1d44651f-fadb-41f5-8918-c30609964489",
    "c1d3b745-2548-4abf-b057-a386c9bd52f1"
  ]
}

정의

Name	Description
FaceError	오류 개체입니다. Face Service에서 반환된 오류 코드 및 메시지에 대한 포괄적인 세부 정보는 다음 링크를 참조하세요. https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	오류 세부 정보가 포함된 응답입니다.
ListPersonResult	목록 동적 사람 그룹 사용자의 응답입니다.

FaceError

오류 개체입니다. Face Service에서 반환된 오류 코드 및 메시지에 대한 포괄적인 세부 정보는 다음 링크를 참조하세요. https://aka.ms/face-error-codes-and-messages.

Name	형식	Description
code	string	서버에서 정의한 오류 코드 집합 중 하나입니다.
message	string	사람이 읽을 수 있는 오류 표현입니다.

FaceErrorResponse

오류 세부 정보가 포함된 응답입니다.

Name	형식	Description
error	FaceError	오류 개체입니다.

ListPersonResult

목록 동적 사람 그룹 사용자의 응답입니다.

Name	형식	Description
personIds	string[]	PersonDirectory Person ID의 배열입니다.