AI Service > AI Fashion > Maker API 가이드

• AI Fashion Maker 서비스를 사용하는 데 필요한 API를 설명합니다.

API 공통 정보

사전 준비

• API 사용을 위해서는 프로젝트 통합 Appkey 또는 서비스 Appkey가 필요합니다.
  • 프로젝트 통합 Appkey 사용을 권장합니다.
  • 프로젝트 통합 Appkey는 프로젝트 설정 페이지의 API 보안 설정에서 생성해 사용할 수 있습니다.
  • 서비스 Appkey는 콘솔 상단 URL & Appkey 메뉴에서 확인이 가능합니다.

색인 입력 파일 정보

• utf-8로 인코딩된 .jsonl, .csv 파일 형식을 지원합니다.
  • .csv 파일을 작성할 때는 첫 줄부터 실제 데이터로 채워야 합니다.
  • 파일에 빈 줄이 없어야 합니다.
• 파일 크기는 최대 20MB 까지 가능하고, 최대 허용 문서 수는 10,000개입니다.
• 1일 최대 4회까지 업로드가 가능하며 매일 한국 시간 0시에 초기화됩니다.
• Service ID 당 색인 가능한 최대 문서 수는 100,000개입니다.

요청 공통 정보

• API를 사용하기 위해서는 보안 키 인증 처리가 필요합니다.

[API 도메인]

응답 공통 정보

• 모든 API 요청에 '200 OK'로 응답합니다. 자세한 응답 결과는 응답 본문 헤더를 참고합니다.

[응답 본문 헤더]

[성공 응답 본문 예]

{
        "header": {
                "isSuccessful": true,
                "resultCode": 0,
                "resultMessage": "SUCCESS"
        }
}

[실패 응답 본문 예]

{
        "header": {
                "isSuccessful": false,
                "resultCode": -40000,
                "resultMessage": "InvalidParam"
        }
}

API 목차

색인 요청

• 인덱싱할 데이터를 전달합니다.
• 전달된 파일의 첫 번째 줄을 분석하여 포맷 오류 여부를 검사합니다.
• 첫 번째 줄에서 오류가 발견되지 않으면 색인을 위한 대기열에 들어간 뒤 스케줄에 따라 색인됩니다.

파일 데이터 포맷

이미지 가이드

• 이미지의 패션 아이템의 너비와 높이가 둘 다 20px 이하인 경우는 인식하지 않습니다.
• 이미지 크기가 커질수록 패션 아이템의 크기도 커져야 더 정확하게 인식이 가능합니다.
• 이미지에서 패션 아이템이 차지하는 비중이 클수록 더 정확하게 인식이 가능합니다.
• 이미지 파일의 최대 크기: 5,000,000 bytes
• 지원 이미지 포맷: PNG, JPEG, GIF
• 이미지 URL에 포트를 직접 지정하는 경우 80, 443, 10000~12000 포트만 사용 가능합니다.

jsonl 예

{"product_id": "10001", "status": "enable", "name": "AAA red onepiece", "category_id1": "1", "category_id2": "1", "category_id3": "2", "image_url": "http://aaaaaaa.bbbbb.jpg", "s1": "1", "s2": "2"}
{"product_id": "10002", "status": "disable", "name": "BBB blue onepiece", "category_id1": "1", "category_id2": "1", "category_id3": "2", "image_url": "http://bbbbbbb.ccccc.jpg", "s1": "s1", "s2": "2"}
{"product_id": "10003", "status": "enable", "name": "BBB blue blouse", "category_id1": "1", "category_id2": "1", "category_id3": "3", "image_url": "http://bbbbbbb.ddddd.jpg", "s1": "", "s2": "s2"}
...

csv 예

10001,enable,AAA red onepiece,1,1,2,http://aaaaaaa.bbbbb.jpg,1,2
10002,disable,BBB blue onepiece,1,1,2,http://bbbbbbb.ccccc.jpg,s1,2
10003,enable,BBB blue blouse,1,1,3,http://bbbbbbb.ddddd.jpg,,s2
...

요청

• 직접 데이터 파일을 전송하거나 다운로드 가능한 URL로 데이터 파일을 전달할 수 있습니다.

[URI]

[Path Variable]

[URL Parameter]

[Form Data]

curl -X POST "/nhn-ai-fashion-maker/v1.0/appkeys/{appKey}/service/{serviceID}/index?format=jsonl" -H "Content-Type: multipart/form-data" -F "file=@/home/user1/202106251000_product.jsonl"

curl -X POST "/nhn-ai-fashion-maker/v1.0/appkeys/{appKey}/service/{serviceID}/index?format=jsonl" -F "link=https://cdn.my-domain.com/202106251000_product.jsonl"

응답

• [응답 본문 헤더 설명 생략]
  • 응답 공통 정보에서 확인 가능

[응답 본문 데이터]

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "data": {
        "indexID": "24bb94b3-8a6b-488e-b038-4f6038da2596"
    }
}

오류 코드

서비스 정보

• 서비스들의 현재 정보를 확인합니다.
  • 서비스별로 남은 색인 횟수
  • 서비스별 색인된 문서 개수

요청

[URI]

curl -X GET "/nhn-ai-fashion-maker/v1.0/appkeys/{appKey}/services" -H "Content-Type: application/json"

응답

• [응답 본문 헤더 설명 생략]
  • 응답 공통 정보에서 확인 가능

[응답 본문 데이터]

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "data": {
        "totalService": 3
        "items": [
            {
                "service": "aaa",
                "remainInsertCnt": 3,
                "documentCnt": 51128
            },
            {
                "service": "bbb",
                "remainInsertCnt": 2,
                "documentCnt": 9778
            },
            {
                "service": "ccc",
                "remainInsertCnt": 0,
                "documentCnt": 29841
            }
        ]
    }
}

오류 코드

색인 상태 조회

• 요청된 색인들의 현재 상태를 확인합니다.
• 색인 상태의 최대 보관 기간은 등록 시간 기준 6개월입니다.

요청

[URI]

[Path Variable]

[URL Parameter]

Paging

• start와 limit 파라미터로 페이징이 가능합니다.
  • start: 0부터 시작합니다.
  • limit: 0보다 커야 하며 최대 100까지 가능합니다.
• 최대 페이징 가능한 숫자는 1000입니다.
  • 가능:
    • start: 900
    • end: 100
  • 불가능:
    • start: 901
    • end: 100
    • 최대 가능 페이징 수인 1000을 넘어가기 때문에 불가능합니다.

정렬

• 응답 문서의 정렬 파라미터
• 파라미터 형식.
  • {정렬 가능 항목}:{정렬 방식}
• 정렬 가능 항목
  • reservedTime: 색인 요청 등록 시간
  • startTime: 색인 시작 시간
  • finishTime: 색인 종료 시간
  • addCnt: 추가된 문서 수
  • failCnt: 실패 문서 수
  • deleteCnt: 삭제 문서 수
  • updateCnt: 수정 문서 수
  • totalCnt: 전체 문서 수
• 정렬 방식
  • asc: 오름차순
  • desc: 내림차순

색인 상태

• 색인 상탯값을 조건으로 검색할 수 있습니다.
  • reserved: 대기
  • running: 진행 중
  • failed: 전체 실패
  • finished: 완료(부분 실패 포함)

curl -X GET "/nhn-ai-fashion-maker/v1.0/appkeys/{appKey}/service/{serviceID}/indexes?start=0&limit=100&status=running&order=startTime:desc"  -H "Content-Type: application/json"

응답

• [응답 본문 헤더 설명 생략]
  • 응답 공통 정보에서 확인 가능

[응답 본문 데이터]

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "data": {
        "total": 100,
        "items":[{
            "service": "testserviceid"
            "id": "24bb94b3-8a6b-488e-b038-4f6038da2596",
            "filename": "202106251000_product.jsonl",
            "status": "reserved",
            "reservedTime": 1627018935,
            "startTime": 1627018935,
            "finishTime": 1627018935,
            "addCnt": 234,
            "failCnt": 31,
            "deleteCnt": 31,
            "updateCnt": 592,
            "totalCnt": 888
        }]
    }
}

오류 코드