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

リクエスト URL

プロトコル URL メソッド パラメーター
HTTPS ${HOST}/v2/image/add POST JSON
${HOST} の詳細については、「リクエストの構文」をご参照ください。

リクエストパラメーター

パラメーター タイプ 必須/任意 説明　
InstanceName String 必須 Image Search インスタンスの名前を設定します。
ProductId String 必須 商品を識別する一意の ID を設定します。 ID の長さは、最大 512 文字です。
注 商品 ID は、複数の画像名に対応できます。
PicName String 必須 画像名を設定します。 名前の長さは、最大 512 文字です。
注
  • 画像は、ProductId パラメーターと PicName パラメーターの値によって一意に識別されます。
  • 同じ ProductId とPicName を持つ画像を複数回追加すると、前の操作で追加された画像は最後の操作で追加された画像で上書きされます。
PicContent String 必須 画像ファイルを指定します。 画像ファイルは Base64 でエンコードされます。
  • ファイルサイズは 4 MB 以下とする必要があります。
  • 画像検索は、PNG、JPG、JPEG、BMP、GIF、WEBP、TIFF、および PPM の画像形式をサポートしています。
  • 送信タイムアウト時間は 5 秒です。
  • 商品および一般画像検索の場合、画像の高さと幅は 100 ピクセルから 4096 ピクセルの範囲とする必要があります。
  • 画像に回転情報を含めることはできません。
CategoryId Integer No 画像のカテゴリを設定します。 詳細については、「カテゴリリファレンス」をご参照ください。
注
  • 商品画像検索の場合、画像のカテゴリを指定すると、指定したカテゴリが優先されます。 画像のカテゴリを指定しない場合、システムはカテゴリを予測し、予測結果をレスポンスで返します。
  • 一般画像検索の場合、画像のカテゴリを指定するかどうかに関係なく、システムはカテゴリ ID を88888888 に設定します。
Crop Boolean 任意 画像内の被写体を検出し、検出した被写体に基づいて画像を検索するかどうかを指定します。 有効な値: true と false。 デフォルト値: true。
  • true：システムは画像内の被写体を検出し、検出された被写体に基づいて画像を検索します。 レスポンスで認識結果を取得できます。
  • false：システムは画像の被写体を検出せず、画像全体に基づいて画像を検索します。
Region String 任意 画像内の被写体の領域を指定します。 被写体の領域は、 x1,x2,y1,y2 の形式です。x1 and y1 は、左上のピクセルを表します。x2 and y2 は、右下のピクセルを表します。
CustomContent String 任意 ユーザー定義のコンテンツを指定します。 値の長さは、最大 4096 文字です。
注 このパラメーターを指定すると、レスポンスにこのパラメーターとその値が含まれます。 画像の説明などのテキストを追加できます。
IntAttr Integer 任意 整数属性を設定します。 この属性を使用して、画像検索時に画像をフィルタリングできます。 このパラメーターを指定すると、レスポンスにこのパラメーターとその値が含まれます。
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 and y1 は、左上のピクセルを表します。x2 and y2 は、右下のピクセルを表します。 リクエストに被写体の領域が指定されている場合は、指定された被写体の領域が優先されます。

例

  • リクエスト例
    URL: ${HOST}/v2/image/add
POST Body:
 {
        "InstanceName": "demoinstance",
        "PicName": "test",
        "CustomContent": "demo content",
        "PicContent": "${Base64ImageContent}",
        "ProductId": "test",
        "IntAttr": "0",
        "StrAttr": "demo str attr"
    }
  • レスポンスの例
    {
    "PicInfo": {
        "Region": "111,697,XX,XX",
        "CategoryId": 0
    },
    "Message": "success",
    "RequestId": "B253A127-DF89-4DDC-A295-618DD22B00B2",
    "Success": true,
    "Code": 0
}

エラーコード

詳細については、「エラーコード」をご参照ください。