Custom Attributes 생성

Prev Next

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

Custom Attributes의 Profile을 생성합니다.

Profile 생성을 요청하면 다음 순서에 따라 생성 작업이 진행됩니다.

순서 생성 상태 설명
Step 1 registered: 등록됨 생성 작업이 NCLUE 시스템에 등록된 상태
Step 2 pending: 대기 중 생성 작업이 시스템 대기열에 올라간 상태
Step 3 in_progress: 생성 중 생성 작업이 서버에서 실행 중인 상태
Step 4
  • complete: 사용 가능
  • failed: 실패
 생성 작업이 완료된 상태
  • 생성 성공 시 complete 상태가 되며, 정상적으로 사용 가능
  • 작업 중 발생한 오류로 인해 생성 실패 시 failed 상태가 되며, 사용 불가
참고

Profile 생성 시 각 작업 시간은 데이터 양과 서비스 가용 자원 상황에 따라 달라집니다. 생성 진행 상태는 Custom Attributes 조회 API를 호출하여 응답 바디의 status 필드에서 확인해 주십시오.

요청

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

메서드 URI
POST /profile/custom-attributes

요청 헤더

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

요청 바디

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

필드 타입 필수 여부 설명
name String Required Profile 이름
  • 1~100 자
feature_id String Required 프로파일링에 적용할 Feature ID
keyword_set String Required 대상 사용자와 유사도를 확인할 속성 키워드 목록
  • 전체 키워드 총합 1,000 글자 이내
  • 각 키워드는 '\n'으로 구분
  • <예시> 러닝\n달리기\n마라톤
result_bucket String Required 프로파일링 결과를 저장할 Object Storage 버킷 이름
result_file_path String Required 프로파일링 결과를 저장할 result_bucket 내 파일 경로
  • 다음 특수 문자가 포함된 파일 경로는 입력 불가
    • &$@;:+,?*\{}^%`[]<>~#|"'
    • ASCII 코드가 0~31, 128~255인 문자
  • 파일명 생성 규칙
    • 입력 문자열이 '/'로 끝나면 디렉토리로 간주하여, 디렉토리 내부에 'nclue_{난수}_{연월시}.tsv' 파일명으로 생성
    • 그 외는 입력 문자열을 파일명으로 간주하여 '{입력문자열}_{난수}_{연월시}.tsv' 파일명으로 생성

요청 예시

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

curl --location --request POST 'https://nclue.apigw.ntruss.com/api/v1/profile/custom-attributes' \
--header 'X-NCP-APIGW-TIMESTAMP: {Timestamp}' \
--header 'X-NCP-IAM-ACCESS-KEY: {Access Key}' \
--header 'X-NCP-APIGW-SIGNATURE-V2: {API Gateway Signature}' \
--data '{
    "name": "YOUR_PROFILE_NAME",
    "feature_id": "1be871f6-****-****-****-827671fa8fdb",
    "keyword_set": "러닝\n달리기\n마라톤\n조깅\n러닝화\n러닝양말\n러닝앱\n런닝",
    "result_bucket": "YOUR_BUCKET_NAME",
    "result_file_path": "path/filename"
}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
profile_id String - Profile ID
profile_name String - Profile 이름
feature_id String - 프로파일링할 Feature ID
feature_name String - 프로파일링할 Feature 이름
keyword_set String - 속성 키워드 목록
  • 각 키워드는 ','로 구분
created_at String - Profile 생성 요청 일시(ISO 8601 형식)
result_bucket String - 프로파일링 결과를 저장할 Object Storage 버킷 이름
result_file_path String - 프로파일링 결과를 저장할 result_bucket 내 파일 경로

응답 상태 코드

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

응답 예시

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

{
    "profile_id": "a7f4f996-****-****-****-b0531230e17e",
    "profile_name": "YOUR_PROFILE_NAME",
    "feature_id": "1be871f6-****-****-****-827671fa8fdb",
    "feature_name": "YOUR_FEATURE_NAME",
    "keyword_set": "러닝,달리기,마라톤,조깅,러닝화,러닝양말,러닝앱,런닝",
    "created_at": "2024-11-26T17:25:42+09:00",
    "result_bucket": "YOUR_BUCKET_NAME",
    "result_file_path": "path/filename"
}