다음을 통해 공유

Large Person Group - List

서비스:
Azure AI Services
API 버전:
1.0

모든 기존 큰 사람 그룹의 largePersonGroupId, 이름, userData 및 recognitionModel을 나열합니다.

  • 큰 사람 그룹은 largePersonGroupId의 사전순으로 저장됩니다.
  • "start" 매개 변수(문자열, 선택 사항)는 반환된 항목이 문자열 비교에 의해 더 큰 ID를 갖는 사용자 제공 largePersonGroupId 값입니다. "start"는 첫 번째 항목의 반환을 나타내기 위해 비어 있음으로 설정됩니다.
  • "top" 매개 변수(int, 선택 사항)는 반환할 항목 수를 지정합니다. 한 번의 호출로 최대 1,000개의 항목을 반환할 수 있습니다. 더 많은 항목을 가져오려면 현재 호출의 마지막으로 반환된 항목의 ID로 "시작"을 지정할 수 있습니다.
    예를 들어 총 5개의 큰 사람 그룹("group1", ..., "group5")이 있습니다.
    "start=&top="은 5개의 그룹을 모두 반환합니다.
    "start=&top=2"는 "group1", "group2"를 반환합니다.
    "start=group2&top=3"은 "group3", "group4", "group5"를 반환합니다.
GET {Endpoint}/face/v1.0/largepersongroups
선택적 매개 변수: 
GET {Endpoint}/face/v1.0/largepersongroups?start={start}&top={top}&returnRecognitionModel={returnRecognitionModel}

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
Endpoint
 path True

string

지원되는 Cognitive Services 엔드포인트(프로토콜 및 호스트 이름( 예: https://westus.api.cognitive.microsoft.com).
returnRecognitionModel
 query

boolean

작업이 응답에서 'recognitionModel'을 반환해야 하는지 여부를 나타내는 값입니다.
start
 query

string

maxLength: 64

"start"보다 큰 최소 largePersonGroupId의 큰 사람 그룹을 나열합니다.
top
 query

integer

minimum: 1
maximum: 1000

나열할 큰 사용자 그룹의 수입니다.

요청 헤더

Name 필수 형식 Description
Ocp-Apim-Subscription-Key True

string

응답

Name 형식 Description
200 OK

LargePersonGroup[]

성공적인 호출은 대규모 사용자 그룹 및 해당 정보의 배열을 반환합니다.
Other Status Codes

APIError

오류 응답입니다.

보안

Ocp-Apim-Subscription-Key

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

예제

List large person groups example

샘플 요청

GET {Endpoint}/face/v1.0/largepersongroups?start=sample_group&top=2&returnRecognitionModel=True

샘플 응답

상태 코드:
200 
[
  {
    "largePersonGroupId": "f92f6f1b-3258-4444-8fa2-c2df505cc7ac",
    "name": "large-person-group-name1",
    "userData": "User-provided data attached to the large person group.",
    "recognitionModel": "recognition_01"
  },
  {
    "largePersonGroupId": "c76f7f13-0ed3-4d00-8a3e-2ad3d78f6c37",
    "name": "large-person-group-name2",
    "userData": "User-provided data attached to the large person group.",
    "recognitionModel": "recognition_01"
  }
]

정의

Name Description
APIError

API에서 반환된 오류 정보
Error

오류 본문입니다.
LargePersonGroup

큰 사람 그룹 개체입니다.
RecognitionModel

인식 모델의 이름입니다. 인식 모델은 얼굴 기능이 추출되어 감지된 faceId, (Large)FaceList 또는 (Large)PersonGroup과 연결될 때 사용됩니다. Face - Detect 또는 (Large)FaceList - Create or (Large)PersonGroup - Create를 수행할 때 인식 모델 이름을 제공할 수 있습니다. 기본값은 'recognition_01'입니다. 최신 모델이 필요한 경우 필요한 모델을 명시적으로 지정하세요.

APIError

Object

API에서 반환된 오류 정보

Name 형식 Description
error

Error

오류 본문입니다.

Error

Object

오류 본문입니다.

Name 형식 Description
code

string

message

string

LargePersonGroup

Object

큰 사람 그룹 개체입니다.

Name 형식 Default value Description
largePersonGroupId

string

maxLength: 64
pattern: ^[a-z0-9-_]+$

대상 큰 사람 그룹의 LargePersonGroupId
name

string

minLength: 1
maxLength: 128

사용자 정의 이름, 최대 길이는 128입니다.
recognitionModel

RecognitionModel

recognition_01

인식 모델의 이름입니다. 인식 모델은 얼굴 기능이 추출되어 감지된 faceId, (Large)FaceList 또는 (Large)PersonGroup과 연결될 때 사용됩니다. Face - Detect 또는 (Large)FaceList - Create or (Large)PersonGroup - Create를 수행할 때 인식 모델 이름을 제공할 수 있습니다. 기본값은 'recognition_01'입니다. 최신 모델이 필요한 경우 필요한 모델을 명시적으로 지정하세요.
userData

string

maxLength: 16384

사용자가 지정한 데이터입니다. 길이는 16KB를 초과하면 안 됩니다.

RecognitionModel

열거형

인식 모델의 이름입니다. 인식 모델은 얼굴 기능이 추출되어 감지된 faceId, (Large)FaceList 또는 (Large)PersonGroup과 연결될 때 사용됩니다. Face - Detect 또는 (Large)FaceList - Create or (Large)PersonGroup - Create를 수행할 때 인식 모델 이름을 제공할 수 있습니다. 기본값은 'recognition_01'입니다. 최신 모델이 필요한 경우 필요한 모델을 명시적으로 지정하세요.

값 Description
recognition_01
recognition_02
recognition_03
recognition_04