데이터셋 목록 조회

Prev Next

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

생성된 데이터셋의 전체 목록을 조회합니다.

요청

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

메서드 URI
GET /datasets

요청 헤더

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

요청 쿼리 파라미터

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

필드 타입 필수 여부 설명
offset Integer Optional 조회 데이터의 시작 위치
  • 기본값: 0
limit Integer Optional 조회 데이터의 최대 개수
  • 기본값: 1,000

요청 예시

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

curl --location --request GET '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'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
datasets Array - 데이터세 정보
offset Integer - 조회 데이터의 시작 위치
limit Integer - 조회 데이터의 최대 개수

datasets

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

필드 타입 필수 여부 설명
datasetId String - 데이터셋에 부여된 고유 ID
type String - 데이터셋 타입
  • user | item | interaction
    • user: 사용자 정보(연령, 성별 등)를 담은 데이터
    • item: 상품 관련 정보(가격, 출시일, 카테고리 등)를 담은 데이터
    • interaction: 사용자와 상품 간 상호작용으로 얻은 기록을 담은 데이터
name String - 데이터셋 이름
status String - 데이터셋 상태
  • enable | waiting | processing | upload_failed | disable | deleting
    • enable: 학습 가능
    • waiting, processing: 대기 중
    • upload_failed, disable, deleting: 업로드 실패
createdDate String - 데이터셋 생성 일시
actionName String - 조회한 항목에 대한 Sub Account 권한
permission String - Sub Account 권한 허용 여부

응답 상태 코드

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

응답 예시

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

{
    "datasets": [
        {
            "datasetId": "bu457******",
            "type": "interaction",
            "name": "interaction_dataset",
            "status": "enable",
            "createdDate": "2024-07-30T09:49:19.254",
            "actionName": "View/getDatasetDetail",
            "permission": "Allow"
        },
        {
            "datasetId": "oeq4i******",
            "type": "user",
            "name": "user_dataset",
            "status": "enable",
            "createdDate": "2024-07-30T08:58:00.662",
            "actionName": "View/getDatasetDetail",
            "permission": "Allow"
        },
        {
            "datasetId": "g8rf6******",
            "type": "item",
            "name": "item_dataset",
            "status": "enable",
            "createdDate": "2024-07-29T16:46:35.968",
            "actionName": "View/getDatasetDetail",
            "permission": "Allow"
        }
    ],
    "offset": 0,
    "limit": 1000
}