스키마 유효성 체크

인쇄
공유
PDF

기사 요약

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

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

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

입력한 스키마 정보의 사용 가능 여부를 검증합니다.

요청

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

메서드	URI
POST	/schemas/validation-check

요청 헤더

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

요청 바디

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

필드	타입	필수 여부	설명
`datasetType`	String	Required	데이터셋 타입 `user` \| `item` \| `interaction` `user`: 사용자 정보(연령, 성별 등)를 담은 데이터 `item`: 상품 관련 정보(가격, 출시일, 카테고리 등)를 담은 데이터 `interaction`: 사용자와 상품 간 상호작용으로 얻은 기록을 담은 데이터
`name`	String	Required	스키마 이름 3~20자로 영문자, 숫자, 특수 문자 '_'를 허용하며 영문자로 시작해야 함
`fields`	Array	Required	스키마 필드 정보
`description`	String	Required	스키마에 대한 설명 0~100자

`fields`

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

필드	타입	필수 여부	설명
`name`	String	Required	스키마 필드 이름 데이터 파일의 필드 이름과 동일하게 입력 기본 스키마 정보 조회를 통해 데이터셋의 타입별 기본 스키마 필드를 확인 가능
`type`	Array	Required	스키마 필드의 데이터 타입 `string` \| `int` \| `long` \| `boolean` \| `null`
`categorical`	Boolean	Required	범주형 필드 여부 `true` \| `false` `true`: 범주가 정해진 데이터 `false`: 범주가 정해지지 않은 데이터

요청 예시

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

curl --location --request POST 'https://aitems.apigw.ntruss.com/api/v1/schemas/validation-check' \
--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 '{
    "datasetType": "user",
    "name": "user_schema",
    "fields": [
        {
            "name": "USER_ID",
            "type": [
                "string"
            ],
            "categorical": false
        }
    ],
    "description": "desc"
}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`name`	String	-	스키마 필드 이름
`type`	Array	-	스키마 필드의 데이터 타입 `string` \| `int` \| `long` \| `boolean` \| `null`
`categorical`	Boolean	-	범주형 필드 여부 `true` \| `false` `true`: 범주가 정해진 데이터 `false`: 범주가 정해지지 않은 데이터 `false`일 경우 표시되지 않음

응답 상태 코드

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

응답 예시

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

[
    {
        "name": "USER_ID",
        "type": [
            "string"
        ]
    }
]

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

What's Next

기본 스키마 정보 조회

요청
응답

태그