Face List Operations - Get Large Face Lists

서비스:

Azure AI Services

API 버전:

v1.2-preview.1

largeFaceListId, name, userData 및 recognitionModel에 대한 큰 얼굴 목록의 정보를 나열합니다.
largeFaceList 내에서 얼굴 정보를 얻으려면 "큰 얼굴 목록 얼굴 가져오기"를 사용합니다.

큰 얼굴 목록은 largeFaceListId의 사전순으로 저장됩니다.

• • "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}/largefacelists

선택적 매개 변수:

GET {endpoint}/face/{apiVersion}/largefacelists?start={start}&top={top}&returnRecognitionModel={returnRecognitionModel}

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
apiVersion	path	True	string	API 버전
endpoint	path	True	string uri	지원되는 Cognitive Services 엔드포인트(프로토콜 및 호스트 이름, 예: https://{resource-name}.cognitiveservices.azure.com).
returnRecognitionModel	query		boolean	'recognitionModel'을 반환합니다. 기본값은 false입니다.
start	query		string	"start"보다 큰 리소스를 나열합니다. 64자를 넘지 않습니다. 기본값은 비어 있습니다.
top	query		integer int32	나열할 항목 수([1, 1000])입니다. 기본값은 1000입니다.

응답

Name	형식	Description
200 OK	LargeFaceList[]	호출이 성공하면 큰 얼굴 목록의 배열과 해당 정보(largeFaceListId, name 및 userData)가 반환됩니다.
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 LargeFaceLists

샘플 요청

HTTP

GET {endpoint}/face/v1.2-preview.1/largefacelists?start=my_list_id&top=20&returnRecognitionModel=True

샘플 응답

상태 코드:

200

[
  {
    "name": "your_large_face_list_name",
    "userData": "your_user_data",
    "recognitionModel": "recognition_01",
    "largeFaceListId": "your_large_face_list_id"
  }
]

정의

Name	Description
FaceError	오류 개체입니다. Face Service에서 반환된 오류 코드 및 메시지에 대한 포괄적인 세부 정보는 다음 링크를 참조하세요. https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	오류 세부 정보가 포함된 응답입니다.
LargeFaceList	큰 얼굴 목록은 최대 1,000,000개의 얼굴 목록입니다.
RecognitionModel	얼굴의 인식 모델입니다.

FaceError

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

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

FaceErrorResponse

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

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

LargeFaceList

큰 얼굴 목록은 최대 1,000,000개의 얼굴 목록입니다.

Name	형식	Description
largeFaceListId	string	유효한 문자는 소문자 또는 숫자 또는 '-' 또는 '_'의 문자이며 최대 길이는 64입니다.
name	string	사용자 정의 이름, 최대 길이는 128입니다.
recognitionModel	RecognitionModel	인식 모델의 이름입니다. 인식 모델은 얼굴 기능을 추출하고 감지된 faceIds와 연결할 때 사용됩니다.
userData	string	선택적 사용자 정의 데이터입니다. 길이는 16K를 초과하지 않아야 합니다.

RecognitionModel

얼굴의 인식 모델입니다.

Name	형식	Description
recognition_01	string	"Detect"의 기본 인식 모델입니다. 2019년 3월 이전에 만든 모든 faceId는 이 인식 모델과 결합됩니다.
recognition_02	string	인식 모델은 2019년 3월에 출시되었습니다.
recognition_03	string	인식 모델은 2020년 5월에 출시됩니다.
recognition_04	string	인식 모델은 2021년 2월에 출시되었습니다. 더 나은 인식 정확도를 위해 이 인식 모델을 사용하는 것이 좋습니다.