데이터셋 설명 수정

인쇄
공유
PDF

기사 요약

이 요약이 도움이 되었나요?

의견을 보내 주셔서 감사합니다.

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

데이터셋의 설명을 수정합니다.

요청

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

메서드	URI
PUT	/datasets/{datasetId}

요청 헤더

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

요청 경로 파라미터

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

필드	타입	필수 여부	설명
`datasetId`	String	Required	데이터셋 ID 데이터셋 목록 조회를 통해 확인

요청 바디

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

필드	타입	필수 여부	설명
`content`	String	Required	데이터셋에 대한 설명 0~100자

요청 예시

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

curl --location --request PUT 'https://aitems.apigw.ntruss.com/api/v1/datasets/g8rf6******' \
--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 '{
  "content": "description"
}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`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": "description",
    "schemaName": "item_schema",
    "status": "enable",
    "osInfo": {
        "region": "KR",
        "bucket": "aitems",
        "key": "movie-item.csv"
    },
    "connectedServices": [
        {
            "serviceId": "fboyb******",
            "name": "service"
        },
        {
            "serviceId": "xv94v******",
            "name": "service1"
        },
        {
            "serviceId": "6wxgu******",
            "name": "service3"
        }
    ],
    "createdDate": "2024-07-29T16:46:35.968",
    "updatedDate": "2024-07-30T15:58:07.768"
}

이 문서가 도움이 되었습니까?

What's Next

데이터셋 삭제

요청
응답

태그