Image Search インスタンスに画像を追加します。

この API を呼び出す前に、URL にinstanceName パラメーターを指定して、画像を追加するインスタンスを指定する必要があります。 リクエスト本文を作成するには、他のパラメータも指定した形式で指定する必要があります。 リクエスト URL は /item/add です。

リクエストパラメーター

  • URL のパラメーター
    パラメーター データ型 必須/任意 説明
    instanceName String 必須 画像を追加する Image Search インスタンスの名前を指定します。
  • リクエスト本文のパラメーター
    パラメーター データ型 必須/任意 説明
    item_id String 必須 商品または画像の ID を設定します。
    cat_id String
    • 商品画像検索の場合、このパラメーターの指定は必須です。
    • 一般画像検索の場合、このパラメーターの指定は任意です。
    		 親カテゴリの ID を指定します。
    crop ブール値 任意 画像内の被写体を検出し、検出した被写体に基づいて画像を検索するかどうかを指定します。 設定可能な値は、true および false です。 デフォルト値は true です。
    region String 任意 画像内の被写体の領域を設定します。 被写体の領域は、x1,x2,y1,y2 の形式です。x1 and y1 は、左上のピクセルを表します。x2 and y2 は、右下のピクセルを表します。 デフォルトでは、システムは被写体の領域を自動的に検出します。
    cust_content String 必須 ユーザー定義のコンテンツを指定します。
    pic_list List 必須 画像名をリスト形式で設定します。
    pic_map Map 必須 各画像の内容を設定します。
  • 本文の構造
    本文の形式は以下のとおりです。
    key1,key1_start_offset,key1_end_offset#...#keyn,keyn_start_offset,keyn_end_offset^key1_content...keyn_content

    本文は、画像メタデータと画像コンテンツの 2 つの部分に分かれており、曲折アクセント記号 (^) で区切られます。 メタデータには、キーのセットとコンテンツ内の各キー値のオフセットが含まれます。 すべてのキーは、番号記号 (#) で区切られます。 各キーは、キー名、開始オフセット値および終了オフセット値からなり、コンマ (,)で区切られます。 開始オフセット値および終了オフセット値は、画像コンテンツにおけるキーの開始位置および終了位置です。 pic_list パラメーターには、Base64 でエンコードされた画像名をコンマ (,) で区切って指定します。 pic_map パラメーターには 、Base64 でエンコードされた画像コンテンツを指定します。 pic_map パラメーターで指定された各キーは、pic_list パラメーターで指定されたキーとペアにする必要があります。

レスポンスパラメーター

パラメーター データ型 説明
Success Boolean 呼び出しが成功したかどうかを示します。
RequestId String リクエストの ID を示します。
Code int エラーコードを示します。 値が 0 の場合、リクエストが成功したことを示します。 値が 0 でない場合は、リクエストの失敗を示します。
Message String 返されたメッセージを示します。

レスポンスの形式

{ "Message":"success", "RequestId":"73B5133C-84EE-4F0A-B972-23CCCBFB7CD5", "Success":true, "Code":0}

例

以下に、goodssearch という名前の Image Search インスタンスに商品の写真を追加する方法の例を示します。 この例では、item_id パラメーターの値は 1000 です。 cat_id パラメーターの値は 0 です。 cust_content パラメーターの値は {"key1":"value1"} です。 商品画像 shoes1.jpg と shoes2.jpg が追加されます。 画像 shoes1.jpg のコンテンツは pic_content1、画像 shoes2.jpg のコンテンツは pic_content2 です。 この場合、リクエストは以下のとおりです。
URL: /item/add? instaneName=goodssearch
POST Body:
cust_content,0,17#item_id,17,21#c2hvZXMyLmpwZw==,21,37#cat_id,37,38#pic_list,38,71#c2hvZXMxLmpwZw==,71,87^{"key1":"value1"}1000cGljX2NvbnRlbnQy0c2hvZXMyLmpwZw==,c2hvZXMxLmpwZw==cGljX2NvbnRlbnQx
Note: c2hvZXMyLmpwZw== represents the Base64-encoded image name shoes1.jpg and c2hvZXMxLmpwZw== represents the Base64-encoded image name shoes2.jpg.