학습 목록 조회

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

학습 진행을 요청한 전체 목록을 조회합니다.

요청

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

메서드	URI
GET	/services/{serviceId}/trains

요청 헤더

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

요청 쿼리 파라미터

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

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

요청 경로 파라미터

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

필드	타입	필수 여부	설명
`serviceId`	String	Required	서비스 ID 서비스 목록 조회를 통해 확인

요청 쿼리 파라미터

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

필드	타입	필수 여부	설명
`isRecent`	Boolean	Optional	타입별 최근 요청한 항목인지 여부 `true` \| `false` `true`: 최근 요청한 항목 `false`: 최근 요청한 항목 아님

요청 예시

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

curl --location --request GET 'https://aitems.apigw.ntruss.com/api/v1/services/6wxgu******/trains
?isRecent=true' \
--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'

응답

응답 형식을 설명합니다.

응답 바디

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

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

`trains`

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

필드	타입	필수 여부	설명
`serviceId`	String	-	서비스 ID
`type`	String	-	학습 요청 타입 `personalRecommend` \| `relatedItem` \| `pop` `personalRecommend`: 고객 서비스 이용자의 과거 이력을 바탕으로 개인별 추천 `relatedItem`: 아이템의 연관 이력을 바탕으로 개인별 추천 `pop`: 순위별 인기 아이템 추천
`hpConfig`	Object	-	HPO (Hyperparameter Optimization) 설정 정보
`hpConfig.is_enabled`	Boolean	-	HPO 설정 여부 `true` \| `false` `true`: HPO 설정. 최적의 훈련 모델 구현 가능 `false`: HPO 설정하지 않음. AiTEMS 내부의 자체 알고리즘으로 학습
`hpConfig.{option}`	String, Long, Boolean	-	설정된 HPO 값 값에 대한 세부 정보는 HPO 참조
`version`	String	-	학습 버전
`description`	String	-	학습에 대한 설명
`status`	String	-	학습 상태 `ready` \| `learning` \| `completed` \| `waiting` \| `requesting` \| `requestFailed` \| `refinedFailed` \| `stopping` \ `learningFailed` `ready`: 준비됨(학습 가능) `learning`: 학습 중 `completed`: 학습 완료 `waiting`: 학습 실행 대기 중 `requesting`: 학습 요청 중 `requestFailed`: 학습 요청 실패 `refinedFailed`: 데이터 정제 실패 `stopping`: 중지 중 `learningFailed`: 학습 실패
`createdDate`	String	-	서비스 생성 일시
`nextUpdateDate`	String	-	서비스의 다음 업데이트 예정 일시
`inference`	Boolean	-	추론 결과 여부 `true` \| `false` `true`: 결과 있음 `false`: 결과 없음

응답 상태 코드

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

응답 예시

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

{
    "trains": [
        {
            "serviceId": "6wxgu******",
            "type": "pop",
            "hpConfig": {
                "is_enabled": false
            },
            "version": "maqll******",
            "status": "stopping",
            "createdDate": "2024-07-30T11:25:36.558",
            "inference": false
        }
    ],
    "offset": 0,
    "limit": 1000
}