데이터셋 생성

Prev Next

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

서비스의 학습을 위해 새로운 데이터셋을 생성합니다.

참고

데이터셋을 생성하려면 스키마가 생성되어 있어야 합니다. 스키마 생성 API를 통해 스키마를 먼저 생성해 주십시오.

요청

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

메서드 URI
POST /datasets

요청 헤더

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

요청 바디

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

필드 타입 필수 여부 설명
type String Required 데이터셋 타입
  • user | item | interaction
    • user: 사용자 정보(연령, 성별 등)를 담은 데이터
    • item: 상품 관련 정보(가격, 출시일, 카테고리 등)를 담은 데이터
    • interaction: 사용자와 상품 간 상호작용으로 얻은 기록을 담은 데이터
name String Required 데이터셋 이름
  • 3~20자로 영문자, 숫자, 특수 문자 '_', '-'를 허용하며 영문자로 시작해야 함
description String Required 데이터셋에 대한 설명
  • 0~100자
schemaName String Required 데이터셋의 스키마 이름
osInfo Object Required 데이터 파일이 저장된 Object Storage 정보
osInfo.region String Required 데이터 파일이 저장된 Object Storage의 리전
  • KR
osInfo.bucket String Required 데이터 파일이 저장된 Object Storage의 버킷 이름
osInfo.key String Required 데이터 파일이 저장된 Object Storage의 경로(Prefix)

요청 예시

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

curl --location --request POST 'https://aitems.apigw.ntruss.com/api/v1/datasets' \
--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 '{
    "type": "item",
    "name": "item_dataset2",
    "description": "abc",
    "schemaName": "item_schema",
    "osInfo": {
        "region": "KR",
        "bucket": "aitems",
        "key": "bookmarks-items.csv"
    }
}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
datasetId String - 데이터셋 ID
type String - 데이터셋 타입
  • user | item | interaction
    • user: 사용자 정보(연령, 성별 등)를 담은 데이터
    • item: 상품 관련 정보(가격, 출시일, 카테고리 등)를 담은 데이터
    • interaction: 사용자와 상품 간 상호작용으로 얻은 기록을 담은 데이터
name String - 데이터셋 이름
description String - 데이터셋에 대한 설명
schemaName String - 데이터셋 스키마 이름
status String - 데이터셋 상태
  • enable | waiting | processing | upload_failed | disable | deleting
    • enable: 학습 가능
    • waiting, processing: 대기 중
    • upload_failed, disable, deleting: 업로드 실패
osInfo Object - 데이터 파일이 저장된 Object Storage 정보
osInfo.region String - 데이터 파일이 저장된 Object Storage의 리전
  • KR
osInfo.bucket String - 데이터 파일이 저장된 Object Storage의 버킷 이름
osInfo.key String - 데이터 파일이 저장된 Object Storage의 경로(Prefix)
connectedServices Array - 데이터셋을 사용 중인 서비스 정보
createdDate String - 데이터셋 생성 일시
updatedDate String - 데이터셋 최종 업데이트 일시

connectedServices

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

필드 타입 필수 여부 설명
serviceId String - 서비스 ID
name String - 서비스 이름

응답 상태 코드

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

응답 예시

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

{
    "datasetId": "g8rf6******",
    "type": "item",
    "name": "item_dataset",
    "description": "abc",
    "schemaName": "LogInfo",
    "status": "waiting",
    "osInfo": {
        "region": "KR",
        "bucket": "bucket",
        "key": "bookmarks-items.csv"
    },
    "connectedServices": [],
    "createdDate": "2024-07-29T16:46:35.968",
    "updatedDate": "2024-07-29T16:46:35.968"
}