서비스 생성

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

AiTEMS 서비스를 이용하기 위해 새로운 서비스를 생성합니다.

요청

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

메서드	URI
POST	/services

요청 헤더

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

요청 바디

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

필드	타입	필수 여부	설명
`name`	String	Required	서비스 이름 3~20자로 영문자, 숫자, 특수 문자 '_', '-'를 허용하며 영문자 또는 '_'로 시작해야 함
`description`	String	Optional	서비스에 대한 설명 0~100자
`type`	String	Optional	서비스 구분 `batch` (기본값) \| `interval` `batch`: 학습 진행 시 1회 학습 `interval`: 학습 진행 후 일정 주기로 재학습

요청 예시

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

curl --location --request POST 'https://aitems.apigw.ntruss.com/api/v1/services' \
--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 '{
    "name": "service",
    "description": "test",
    "type": "batch"
}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`serviceId`	String	-	서비스 ID
`name`	String	-	서비스 이름
`description`	String	-	서비스에 대한 설명
`status`	String	-	서비스 상태 `scheduled` \| `scheduledLearning` \| `learnable` \| `learning` \| `deleting` \| `deleted` \| `disable` \| `drafted` \| `requestLearning` \| `datasetRequired` `scheduled`: 예약됨 `scheduledLearning`: 예약된 학습 중 `learnable`: 학습 가능 `learning`: 학습 진행 중 `deleting`: 삭제 중 `deleted`: 삭제됨 `disable`: 학습 불가 `drafted`: 임시 저장 상태 `requestLearning`: 학습 요청 상태 `datasetRequired`: 서비스 생성 후 데이터셋을 지정하지 않은 상태
`datasets`	Array	-	서비스에 설정된 데이터셋 정보
`hpConfig`	Object	-	HPO (Hyperparameter Optimization) 설정 정보
`hpConfig.is_enabled`	Boolean	-	HPO 설정 여부 `true` \| `false` `true`: HPO 설정. 최적의 훈련 모델 구현 가능 `false`: HPO 설정 안 함. AiTEMS 내부의 자체 알고리즘으로 학습
`hpConfig.{option}`	String, Long, Boolean	-	설정된 HPO 값 값에 대한 세부 정보는 HPO 참조
`infers`	Array	-	학습 결과 정보 `type`이 `interval`인 경우에만 표시
`createdDate`	String	-	서비스 생성 일시
`updatedDate`	String	-	서비스 최종 업데이트 일시
`type`	String	-	서비스 타입 `batch` \| `interval` `batch`: 학습 진행 시 1회 학습 `interval`: 학습 진행 후 일정 주기로 재학습

`datasets`

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

필드	타입	필수 여부	설명
`datasetId`	String	-	서비스에 설정된 데이터셋 ID
`type`	String	-	서비스에 설정된 데이터셋 타입 `user` \| `item` \| `interaction` `user`: 사용자 정보(연령, 성별 등)를 담은 데이터 `item`: 상품 관련 정보(가격, 출시일, 카테고리 등)를 담은 데이터 `interaction`: 사용자와 상품 간 상호작용으로 얻은 기록을 담은 데이터
`name`	String	-	서비스에 설정된 데이터셋 이름
`schemaName`	String	-	서비스에 설정된 데이터셋 스키마 이름
`status`	String	-	서비스에 설정된 데이터셋 상태 `learnable` \| `disable` \| `uploading` \| `updateRequired` `learnable`: 학습 가능 `disable`: 학습 불가 `uploading`: 업로드 중 `updatedRequired`: 업데이트된 데이터셋 등록 필요(학습 시 자동으로 등록됨)
`createdDate`	String	-	서비스에 설정된 데이터셋 생성 일시
`updatedDate`	String	-	서비스에 설정된 데이터셋 최종 업데이트 일시

`infers`

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

필드	타입	필수 여부	설명
`dataType`	String	-	학습 결과의 데이터셋 타입 `user` \| `item` \| `interaction` `user`: 사용자 정보(연령, 성별 등)를 담은 데이터 `item`: 상품 관련 정보(가격, 출시일, 카테고리 등)를 담은 데이터 `interaction`: 사용자와 상품 간 상호작용으로 얻은 기록을 담은 데이터
`trainVersion`	String	-	학습 결과 버전
`status`	String	-	학습 결과 상태 `enable` \| `waiting` \| `pending` \| `processing` \| `updateFailed` \| `disable` `enable`: 업데이트 가능 `waiting`: 업데이트 대기 중 `pending`: 업데이트 대기 중 `processing`: 업데이트 중 `updateFailed`: 업데이트 실패 `disable`: 업데이트 불가
`rowCount`	String	-	결과 데이터 개수

응답 상태 코드

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

응답 예시

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

{
    "serviceId": "fboyb******",
    "name": "service",
    "description": "test",
    "status": "datasetRequired",
    "datasets": [],
    "hpConfig": {
        "is_enabled": false
    },
    "infers": [],
    "createdDate": "2024-07-29T16:17:37.235",
    "updatedDate": "2024-07-29T16:17:37.235",
    "type": "batch"
}