edit-icon download-icon

画像の追加

最終更新日: May 24, 2019

説明

このインターフェイスは、Image Search インスタンスに画像を追加するのに使用します。

リクエストパス

プロトコル URL 方法 パラメーター
HTTPS ${HOST}/v2/image/add POST JSON

${HOST} はリクエスト構造をご参照ください。

リクエストパラメーター

名前 必須 説明
InstanceName String はい Image Search インスタンス名
ProductId String はい 商品 ID。最大 512 文字をサポートします。
説明: 1 つの商品に複数の画像を含めることができます。
PicName String はい 画像名。最大 512 文字をサポートします。
説明:
1. ProductId + PicName で画像を特定します。
2. 複数回追加した画像に同じ ProductId + PicName がある場合、前に追加された画像が最後の画像に上書きされます。
PicContent String はい Base64 でエンコードした画像コンテンツ。最大 2 MB サイズの画像と 5 秒の送信待ち時間をサポートします。現在 jpg および png の画像形式のみサポートしています。縦と横の画素数は共に 200 以上 1024 以下でなければならず、画像に回転情報を含めることはできません。
CategoryId Integer いいえ 画像カテゴリ。カテゴリの参照
説明:
1. 商品画像検索の場合:カテゴリが設定されている場合はその設定が優先され、設定されていない場合はシステムがカテゴリ予測を実行し、予測されたカテゴリの結果を Response で取得できます。
2. 一般画像検索の場合:カテゴリが設定されているかどうかに関わらず、システムによりカテゴリが 88888888 に設定されます。
Crop Boolean いいえ 被写体認識の要否。デフォルトは true です。
説明:
1.true の場合、システムにより被写体認識が行われ、認識された被写体による検索が実行されます。被写体認識結果を Response で取得できます。
2. false の場合、被写体は認識されず、画像全体として検索されます。
Region String いいえ x1、x2、y1、y2 の形式で表される画像の被写体範囲。x1、y1 は左上の点、x2、y2 は右下の点です。
説明: ユーザーが Region を設定した場合、Crop パラメーターの値に関わらず、その Region で検索を実行します。
CustomContent String いいえ ユーザーがカスタマイズした内容。最大 4096 文字をサポートします。
説明: 検索された際にこのフィールドが返されます。たとえば、画像の説明などのテキストを追加できます。
IntAttr Integer いいえ 整数型属性。検索時のフィルタリングに使用できます。検索された際にこのフィールドが返されます。
説明: たとえば、サイトの画像 / ユーザーの画像ごとに IntAttr をそれぞれ設定することができ、検索された際にフィルタリングすることで分離できます。
StrAttr String いいえ 文字列型属性。最大 128 文字をサポートします。検索された際のフィルタリングに使用できます。検索された際にこのフィールドが返されます。

リターンパラメーター

名前 説明
Success Boolean true リクエストの成功是非
RequestId String 36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1 リクエストの ID
Code Integer 0 エラーコード。0 は成功、0 以外は失敗を意味します。
Message String success エラーメッセージ
PicInfo カテゴリ予測、被写体認識結果。
└ CategoryId Integer 88888888 カテゴリ予測結果。カテゴリがユーザーのリクエストで指定されている場合は、その指定が優先されます。
└ Region String 280,486,232,351 被写体認識結果。x1、x2、y1、y2 の形式で表される画像の被写体範囲。x1、y1 は左上の点、x2、y2 は右下の点です。被写体範囲がユーザーのリクエストで指定されている場合は、その指定が優先されます。

リクエスト例

  1. URL: ${HOST}/v2/image/add
  2. POST Body:
  3. {
  4. "InstanceName": "demoinstance",
  5. "PicName": "test",
  6. "CustomContent": "demo content",
  7. "PicContent": "${Base64ImageContent}",
  8. "ProductId": "test",
  9. "IntAttr": "0",
  10. "StrAttr": "demo str attr"
  11. }

リクエスト結果例

  1. {
  2. "PicInfo": {
  3. "Region": "111,697,113,774",
  4. "CategoryId": 0
  5. },
  6. "Message": "success",
  7. "RequestId": "B253A127-DF89-4DDC-A295-618DD22B00B2",
  8. "Success": true,
  9. "Code": 0
  10. }

エラーコード

エラーコードをご参照ください。