인물 태그 제거

VPC 환경에서 이용 가능합니다.

인물에 설정된 인물 태그 중 지정된 항목을 제거합니다. 요청 바디를 사용하는 POST 방식의 API로, 요청 바디를 지원하지 않는 HTTP 클라이언트 환경에서 사용할 수 있습니다.

참고

동일한 기능을 DELETE 방식으로 제공하는 인물 수정 태그 제거 API도 계속 제공됩니다. 두 API는 요청 메서드와 URI만 다르며 요청 바디와 응답 형식은 동일하므로, 이용 환경에 맞는 방식을 선택해 주십시오.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
POST	/api/v1/workspaces/{workspace_name}/persons/{person_id}/person-tags/remove

요청 헤더

Media Intelligence API에서 공통으로 사용하는 헤더에 대한 정보는 Media Intelligence 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`workspace_name`	String	Required	워크스페이스 이름
`person_id`	String	Required	인물 ID 인물 목록 조회 참조

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`tagIds`	Array[Integer]	Required	제거할 인물 태그 ID 목록 존재하지 않거나 이미 제거된 태그 ID는 무시됨

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request POST 'https://mi.apigw.ntruss.com/api/v1/workspaces/my-workspace/persons/1001/person-tags/remove' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
  "tagIds": [200]
}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`code`	String	-	API 처리 결과 코드
`message`	String	-	API 처리 결과 메시지
`result`	Object	-	인물 태그 목록 객체
`result.personId`	Integer	-	인물 ID
`result.tagList`	Array	-	인물에 최종 설정된 태그 목록: tagList 요청으로 제거된 태그를 제외한 전체 목록

`tagList`

tagList에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`id`	Integer	-	인물 태그 ID
`name`	String	-	인물 태그 이름

응답 상태 코드

Media Intelligence API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Media Intelligence 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
  "code": "0",
  "message": "success",
  "result": {
    "personId": 1001,
    "tagList": [
      {
        "id": 100,
        "name": "아나운서"
      }
    ]
  }
}