API Documentation

Pipeline

1. Run Pipeline

POST /run_pipeline

새로운 파이프라인 작업을 시작합니다. 데이터셋에 대한 처리 파이프라인을 실행하며, 바다 오탐지 제거와 빛반사 제거 옵션을 선택할 수 있습니다.

Parameters

• job_id (integer): 작업 식별자

• user_id (integer): 사용자 식별자

• dataset_id (string): 처리할 데이터셋 ID

• remove_fp (boolean, optional): False Positive 제거 여부

• remove_light (boolean, optional): 조명 효과 제거 여부

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Body

Name	Type	Description
name	string	Name of the user
age	number	Age of the user

Response

200

{
    "message": "Pipeline started for job_id: 123",
    "task_ids": {
        "minio_download": "task-id-1",
        "detect": "task-id-2",
        "track": "task-id-3",
        "segment": "task-id-4",
        "minio_upload": "task-id-5"
    }
}

2. Task Status

GET /task_status/{task_id}

Description

특정 작업의 상태를 조회합니다.

Parameters

• task_id (string): 조회할 작업의 ID

Response States

• PENDING: 작업 대기 중

• STARTED: 작업 실행 중

• SUCCESS: 작업 완료

• FAILURE: 작업 실패

3. Pipeline Status

GET /pipeline_status/

Description

전체 파이프라인의 상태를 조회합니다.

Query Parameters

• minio_download_job_id (string): MinIO 다운로드 작업 ID

• detect_job_id (string): 객체 감지 작업 ID

• track_job_id (string): 객체 추적 작업 ID

• segment_job_id (string): 세그멘테이션 작업 ID

• minio_upload_job_id (string): MinIO 업로드 작업 ID

Response

200

{
    "minio_download_job_status": "SUCCESS",
    "detect_job_status": "STARTED",
    "track_job_status": "PENDING",
    "segment_job_status": "PENDING",
    "minio_upload_job_status": "PENDING"
}

4. Cancel Task

DELETE /cancel_task/{task_id}

Description

실행 중이거나 대기 중인 작업을 취소합니다.

Parameters

• task_id (string): 취소할 작업의 ID

Response

200

{   
    "task_id": {task_id}, 
    "status": "Task has been revoked and terminated."
}

400

5. Health Check

GET /health

Description

서비스의 상태를 확인합니다.

Response

200

{
    "status": "ok"
}

모델 서빙

1. YOLOv8-OBB Detection API

POST /detect

Description

객체 감지 및 방향성 바운딩 박스(OBB) 생성을 위한 API

Example Request

{
  "dataframe_split": {
    "columns": [
      "image_folder",
      "job_id",
      "result_path"
    ],
    "data": [
      [
        "/mnt/sdb/data/detection_dummy/mini_frames",
        "test_job_241111_001",
        "/mnt/sdb/pipeline/test_job_241111_001/new_merge_result.txt"
      ]
    ]
  }
}

Example Response

{
  "predictions": [
    {
      "results": "/mnt/sdb/pipeline/test_job_241111_001/new_merge_result.txt",
      "status": "Succeed",
      "status_message": "None"
    }
  ]
}

2. RemovalLight API

POST /removal-light

Description

이미지에서 빛반사를 제거하는 API

Example Request

{
  "dataframe_split": {
    "columns": [
      "image_folder",
      "result_image_folder"
    ],
    "data": [
      [
        "/mnt/sdb/data/detection_dummy/mini_frames",
        "/mnt/sdb/data/detection_dummy/mini_frames_removal_light"
      ]
    ]
  }
}

Example Response

{
  "predictions": [
    {
      "results": "/mnt/sdb/data/detection_dummy/mini_frames_removal_light",
      "status": "Succeed",
      "status_message": "None"
    }
  ]
}

3. BotSort Tracking API

POST /track

Description

객체 추적을 위한 API. YOLOv8-OBB의 감지 결과를 입력으로 받아 객체 추적을 수행합니다.

Example Request

{
  "dataframe_split": {
    "columns": [
      "image_folder",
      "det_result_path",
      "job_id"
    ],
    "data": [
      [
        "/mnt/sdb/data/detection_dummy/frames_6",
        "/mnt/sdb/pipeline/test_job_241109_001/new_merge_result.txt",
        "test_job_241109_002"
      ]
    ]
  }
}

Example Response

{
  "predictions": [
    {
      "results": "/mnt/sdb/pipeline/test_job_241109_002/final_result.json",
      "status": "Succeed",
      "status_message": "None"
    }
  ]
}

4. Remove FP (False Positive) API

POST /remove-fp

Description

객체 추적 결과에서 바다 위 오탐지를 제거하는 API.

BotSort의 추적 결과를 입력으로 받아 처리합니다.

Example Request

{
  "dataframe_split": {
    "columns": [
      "image_folder",
      "track_result_path",
      "result_path"
    ],
    "data": [
      [
        "/mnt/sdb/data/detection_dummy/mini_frames",
        "/mnt/sdb/pipeline/test_job_241109_002/final_result.json",
        "/mnt/sdb/pipeline/test_job_241109_002/final_result.json"
      ]
    ]
  }
}

Example Response

{
  "predictions": [
    {
      "results": "/mnt/sdb/pipeline/test_job_241109_002/final_result.json",
      "status": "Succeed",
      "status_message": "None"
    }
  ]
}

공통 에러 코드

Status Code	Description	Example
400	Bad Request - 잘못된 요청 구문	{"error": "Invalid input format"}
404	Not Found - 리소스를 찾을 수 없음	{"error": "Image folder not found"}
500	Internal Server Error - 서버 오류	{"error": "Model prediction failed"}
503	Service Unavailable - 서비스 사용 불가	{"error": "System memory is critically low"}