Task 목록 조회

인쇄
공유
PDF

기사 요약

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

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

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

생성한 Task Model의 목록을 조회합니다.

요청

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

메서드	URI
GET	/api/v1/tasks

요청 헤더

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

요청 쿼리 파라미터

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

필드	타입	필수 여부	설명
`index`	Integer	Optional	Task 목록의 시작 위치 기본값: 0
`limit`	Integer	Optional	Task 목록 출력 제한값 1~100 (기본값: 20)

요청 예시

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

curl --location --request GET 'https://nclue.apigw.ntruss.com/api/v1/tasks?index=0&limit=20' \
--header 'X-NCP-APIGW-TIMESTAMP: {Timestamp}' \
--header 'X-NCP-IAM-ACCESS-KEY: {Access Key}' \
--header 'X-NCP-APIGW-SIGNATURE-V2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`index`	Integer	-	페이지 Index (0~N)
`limit`	Integer	-	Task 목록 출력 제한값 (1~100)
`total`	Integer	-	사용자가 생성한 Task 전체 개수
`tasks.task_id`	String	-	Task ID
`tasks.task_name`	String	-	사용자가 입력한 Task 이름
`tasks.status`	String	-	생성 유형 `registered` \| `pending` \| `in_progress` \| `completed` \| `failed` `registered`: 등록됨 `pending`: 대기 중 `in_progress`: 생성 중 `completed`: 사용 가능 `failed`: 실패
`tasks.created_at`	String	-	Task 생성 요청 날짜 (ISO 8601 형식)
`tasks.completed_at`	String	-	Task 생성 작업 완료 날짜 (ISO 8601 형식)
`tasks.train_feature_id`	String	-	Training Set용 Feature ID Train/Test 상세 설정을 하지 않은 경우, 입력한 Feature는 Train 항목으로 기본 표시됩니다.
`tasks.train_feature_name`	String	-	Training Set용 Feature 이름
`tasks.train_bucket`	String	-	정답 데이터셋 파일이 저장된 Object Storage 버킷명
`tasks.train_file_path`	String	-	train_bucket 버킷 내 정답 데이터셋 파일 경로
`tasks.test_feature_id`	String	-	학습된 모델 성능 평가를 위해 별도로 설정한 Test Set용 Feature ID
`tasks.test_feature_name`	String	-	Test Set용 Feature 이름
`tasks.test_bucket`	String	-	Test Set용 정답 데이터셋 파일이 저장된 Object Storage 버킷명
`tasks.test_file_path`	String	-	test_bucket 버킷 내 Test Set용 정답 데이터셋 파일 경로
`tasks.AUROC`	Double	-	생성된 Task 모델의 성능 ROC 곡선 아래 면적으로 산출한 0~1 사이의 값
`tasks.line_count`	Integer	-	Task 생성에 사용한 Feature의 라인수
`tasks.disk_usage`	Integer	-	생성된 Task의 용량 (Byte)
`tasks.fail_message`	String	-	생성 실패 시 메시지. NCLUE 문제 해결 참조

응답 예시

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

성공

호출이 성공한 경우의 응답 예시는 다음과 같습니다.

{
    "index": 0,
    "limit": 20,
    "total: 172,
    "tasks": [
        {
            "task_id": "7db18fb6-55ca-4774-94f5-1e8736757249",
            "task_name": "펫푸드 구매관심 예측모델",
            "status": "completed",
            "created_at": "2024-11-11T11:01:30",
            "completed_at": "2024-11-11T11:06:44",
            "train_feature_id":"79eb85b5-8ec5-4e1a-8617-64a1977c8062",
            "train_feature_name":"쇼핑 행동시퀀스 - 2024년",
            "train_bucket":"your.bucket.name",
            "train_file_path":"task_dataset/pet_food.tsv",
            "test_feature_id":null,
            "test_feature_name":null,
            "test_bucket":null,
            "test_file_path":null,
            "AUROC":0.9054,
            "line_count": 1209478,
            "disk_usage": 72582684,
            "fail_message":null
        },
        ...
    ]

실패

호출이 실패한 경우의 응답 예시는 응답 상태 코드를 참고해 주십시오.

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

What's Next

Task 생성

요청
응답