Person Directory Operations - Update Dynamic Person Group With Person Changes

서비스:

Azure AI Services

API 버전:

v1.2-preview.1

기존 동적 인물 그룹의 이름 또는 userData를 업데이트하고 사용자를 추가하거나 제거하여 구성원을 관리합니다.
요청 본문에 없는 경우 속성은 변경되지 않은 상태로 유지됩니다.

PATCH {endpoint}/face/{apiVersion}/dynamicpersongroups/{dynamicPersonGroupId}

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).

요청 본문

Name	형식	Description
addPersonIds	string[]	추가할 Person Directory "Create Person"에서 만든 personId의 배열입니다.
name	string	사용자 정의 이름, 최대 길이는 128입니다.
removePersonIds	string[]	제거할 Person Directory "Create Person"에서 만든 personId의 배열입니다.
userData	string	선택적 사용자 정의 데이터입니다. 길이는 16K를 초과하지 않아야 합니다.

응답

Name	형식	Description
202 Accepted		호출이 성공하면 빈 응답 본문이 반환됩니다. 서비스가 요청을 수락했으며 곧 처리를 시작할 예정입니다. 클라이언트는 'Operation-Location' 응답 헤더에 지정된 URL을 사용하여 작업 상태 및 결과를 쿼리할 수 있습니다. URL은 48시간 후에 만료됩니다. URL은 Person Directory "동적 사람 그룹 참조 가져오기"가 이 요청에서 변경한 내용을 반환하는 시점의 상태를 제공합니다. 헤더 operation-Location: string
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

예제

Update DynamicPersonGroup

샘플 요청

HTTP

PATCH {endpoint}/face/v1.2-preview.1/dynamicpersongroups/your_dynamic_person_group_id

{
  "name": "your_dynamic_person_group_name",
  "userData": "your_user_data",
  "addPersonIds": [
    "85c0c630-c9c9-40f8-8a4e-f9ae4f926ea5"
  ],
  "removePersonIds": [
    "67f7e96d-823a-4318-9bf6-e9a2a2608899"
  ]
}

샘플 응답

상태 코드:

202

operation-Location: https://contoso.com/operationstatus

정의

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

FaceError

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

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

FaceErrorResponse

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

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