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

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"}
{"product_id": "10002", "status": "disable", "name": "BBB blue onepiece", "category_id1": "1", "category_id2": "1", "category_id3": "2", "image_url": "http://bbbbbbb.ccccc.jpg"}
{"product_id": "10003", "status": "enable", "name": "BBB blue blouse", "category_id1": "1", "category_id2": "1", "category_id3": "3", "image_url": "http://bbbbbbb.ddddd.jpg"}
...

csv例

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

リクエスト

• 直接データファイルを転送するか、ダウンロード可能な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",
        "docCnt": 1000
    }
}

エラーコード

サービス情報

• サービスの現在情報を確認します。
  • サービス別の残りインデックス回数
  • サービス別のインデックスされた文書数

リクエスト

[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}/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
        }]
    }
}

エラーコード