AddImage - Image Search - Alibaba Cloud ドキュメントセンター

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

使用方法

この操作を呼び出して、Image Search インスタンスに画像を追加できます。

QPS 制限

デフォルトでは、画像容量が 10 万枚のインスタンスに画像を追加する場合の同時実行制限は 1 です。これは、システムが画像を追加するリクエストを 1 秒あたり最大 1 つ処理できることを意味します。

デフォルトでは、その他の画像容量仕様のインスタンスに画像を追加する場合の同時実行制限は 5 です。これは、システムが画像を追加するリクエストを 1 秒あたり最大 5 つ処理できることを意味します。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK の操作のサンプルコードを動的に生成します。

リクエストパラメータ

パラメータ	タイプ	必須	例	説明
Action	String	はい	AddImage	実行する操作。値を AddImage に設定します。
InstanceName	String	はい	demoinstance1	Image Search インスタンスの名前。名前は最大 20 文字までです。 Image Search インスタンスを購入した場合は、Image Search コンソールにログインしてインスタンスを表示できます。 Image Search インスタンスを購入していない場合は、インスタンスを購入する必要があります。詳細については、「Image Search をアクティブ化する」および「インスタンスを作成する」をご参照ください。説明インスタンス名はインスタンス ID ではありません。
ProductId	String	はい	2092061_1	商品 ID。ID は最大 512 文字までです。説明 1 つの商品に複数の画像を含めることができます。
PicName	String	はい	2092061_1.jpg	画像の名前。名前は最大 512 文字までです。説明画像は、ProductId と PicName の値によって一意に識別されます。商品 ID（ProductId）と画像名（PicName）が既存の画像と同じ画像を追加すると、新しく追加された画像が既存の画像を上書きします。
PicContent	String	はい	AAAANSUhEUgAAAPcAAAEVCAYAAAA8d3NuAAAAAXNSR0IArs......RK5CYII=	画像ファイル。画像のファイルサイズは 4 MB を超えることはできません。サポートされている画像形式は、PNG、JPG、JPEG、BMP、GIF、WebP、TIFF、PPM です。送信タイムアウト期間は 5 秒を超えることはできません。商標画像検索の場合、画像の長さと幅は 200 ピクセルから 4,096 ピクセルの範囲である必要があります。布地画像検索の場合、画像の長さと幅は 448 ピクセルから 4,096 ピクセルの範囲である必要があります。商品画像検索と汎用画像検索の場合、画像の長さと幅は 100 ピクセルから 4,096 ピクセルの範囲である必要があります。画像に回転設定を含めることはできません。説明 SDK を使用してこの操作を呼び出す場合、PicContent を指定する必要はありません。 SDK はこのパラメータをカプセル化し、その値を Base64 で自動的にエンコードします。Java 用 Image Search SDK の使用方法の詳細については、「Java 用 SDK」をご参照ください。 OpenAPI Explorer を使用してこの操作を呼び出す場合、2019-03-25 バージョンのみを選択できます。他のバージョンのこの操作を呼び出す場合、PicContent の値を Base64 でエンコードすることはできません。
CategoryId	Integer	いいえ	88888888	画像のカテゴリ ID。詳細については、「カテゴリのリファレンス」をご参照ください。説明商品画像検索の場合、画像にカテゴリを指定すると、指定したカテゴリが優先されます。画像にカテゴリを指定しない場合、システムはカテゴリを予測し、レスポンスで予測結果を返します。汎用画像検索の場合、カテゴリが指定されているかどうかに関係なく、レスポンスではこのパラメータに 88888888 のみが返されます。
Crop	Boolean	いいえ	true	画像内の被写体を識別し、被写体識別結果に基づいて画像を検索するかどうかを指定します。デフォルト値: true。有効な値: true: システムは画像内の被写体を識別し、被写体識別結果に基づいて画像を検索します。被写体識別結果はレスポンスに含まれます。 false: システムは画像内の被写体を識別せず、画像全体に基づいて画像を検索します。
Region	String	いいえ	280,486,232,351	画像の主題領域。`x1,x2,y1,y2` の形式。`x1 と y1` は左上点を表します。`x2 と y2` は右下点を表します。説明 Region を指定した場合、システムは Crop の値に関係なく Region の値に基づいて画像を検索します。 Region の値に単位はありません。値は画像の長さと幅に基づいて生成されます。画像の長さと幅を拡大縮小する場合は、Region の値を比例的に調整する必要があります。
CustomContent	String	いいえ	zidingyi	ユーザー定義コンテンツ。値は最大 4,096 文字までです。説明このパラメータを指定すると、レスポンスにはこのパラメータとその値が含まれます。画像の説明などのテキストを追加できます。
IntAttr	Integer	いいえ	22	属性（整数）。この属性は、画像を検索するときに画像をフィルタリングするために使用できます。このパラメータを指定すると、レスポンスにはこのパラメータとその値が含まれます。
StrAttr	String	いいえ	ss	属性（文字列）。値は最大 128 文字までです。この属性は、画像を検索するときに画像をフィルタリングするために使用できます。このパラメータを指定すると、レスポンスにはこのパラメータとその値が含まれます。説明値には、次の特殊文字を含めることはできません: \ ¥ $ & %
IntAttr2	Integer	いいえ	22	属性（整数）。この属性は、画像を検索するときに画像をフィルタリングするために使用できます。このパラメータを指定すると、レスポンスにはこのパラメータとその値が含まれます。説明このパラメータは、2023 年 1 月 3 日以降に作成されたインスタンスにのみ適用されます。
StrAttr2	String	いいえ	ss	属性（文字列）。値は最大 128 文字までです。この属性は、画像を検索するときに画像をフィルタリングするために使用できます。このパラメータを指定すると、レスポンスにはこのパラメータとその値が含まれます。説明値には、次の特殊文字を含めることはできません: \ ¥ $ & % このパラメータは、2023 年 1 月 3 日以降に作成されたインスタンスにのみ適用されます。

レスポンスパラメータ

パラメータ	タイプ	例	説明
Message	String	success	返されたメッセージ。説明リクエストが成功した場合は値は返されず、リクエストが失敗した場合はエラーメッセージが返されます。
RequestId	String	E0845DE6-52AF-4B50-9F15-51ED4044E6AB	リクエスト ID。
Code	Integer	0	レスポンスコード。値 0 は、リクエストが成功したことを示します。 0 以外の値は、リクエストが失敗したことを示します。
PicInfo	Object		カテゴリ予測と被写体識別の結果。
Region	String	94,691,206,650	被写体識別の結果。画像の主題領域は、`x1,x2,y1,y2` の形式です。`x1 と y1` は左上点を表します。`x2 と y2` は右下点を表します。リクエストで主題領域が指定されている場合、指定された主題領域が優先されます。
CategoryId	Integer	88888888	カテゴリ予測の結果。リクエストでカテゴリが指定されている場合、指定されたカテゴリが優先されます。
Success	Boolean	true	リクエストが成功したかどうかを示します。

例

リクエストの例

{
        "InstanceName": "demoinstance",
        "PicName": "test",
        "CustomContent": "demo content",
        "PicContent": "${Base64ImageContent}",
        "ProductId": "test",
        "IntAttr": "0",
        "StrAttr": "demo str attr"
    }

成功レスポンスの例

JSON 形式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PicInfo" : {
    "Region" : "111,697,XX,XX",
    "CategoryId" : 0
  },
  "Message" : "success",
  "RequestId" : "B253A127-DF89-4DDC-A295-618DD22B00B2",
  "Success" : true,
  "Code" : 0
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	BadRequest	リクエストに無効なパラメータがあります。	1 つ以上のパラメータが無効です。
400	InvalidInstance	指定されたインスタンス名が無効です。	インスタンス名が無効です。
400	NoCaretSeperator	本文コンテンツに ^ 区切り文字がありません。	リクエスト本文に特定の記号がありません。
400	EmptyMeta	本文コンテンツに空のメタフィールドがあります。	リクエスト本文に空のメタパラメータが含まれています。
400	InvalidMetaItem	メタフィールドが無効です。	メタパラメータが無効な値に設定されています。
400	NoPicList	本文コンテンツに pic_list パラメータがありません。	pic_list パラメータが無効な値に設定されています。
400	NoSpecifiedPic	HTTP POST 本文で画像のコンテンツが指定されていません。	画像が指定されていません。
400	InvalidCategory	指定されたカテゴリが無効です。	カテゴリ ID が無効です。
400	OverflowMaxResultNum	指定された合計結果数が最大値 500 を超えています。	指定された返すエントリの合計数が上限の 500 を超えています。
400	OverflowMaxReturnNum	指定されたリクエストごとの結果数が最大値 100 を超えています。	1 つのリクエストで返すように指定されたエントリ数が上限の 100 を超えています。
400	InvalidIntAttr	指定された int_attr フィールドが無効です。	IntAttr パラメータが無効な値に設定されています。
400	UnsupportedPicFormat	指定された画像形式が無効です。	画像形式が無効です。
400	InvalidFilterClause	指定されたフィルタリング条件が無効です。	フィルタ条件が無効です。
400	InstanceOverQuota	アイテム数が制限を超えています。	インスタンス内の画像数が上限を超えています。
400	IncorrectOrientation	画像のメタデータに誤った回転フラグが含まれています。	画像に回転設定が含まれています。回転設定はサポートされていません。
400	UnsupportedPicPixels	指定されたピクセルはサポートされていません。	指定された画像の画素値はサポートされていません。
403	NoPermission	この操作を実行する権限がありません。	必要な権限がありません。管理者に権限の付与を依頼してください。
403	DeniedRequest	インスタンスのフロー制御により、リクエストが拒否されました。	速度制限により、リクエストが拒否されました。
500	UnknownException	内部サーバーエラーが発生しました。	不明なエラーが発生しました。
500	NetworkException	ネットワークエラーが発生しました。	ネットワークエラーが発生しました。
500	UnsupportedInstanceType	インスタンスタイプはサポートされていません。	インスタンスタイプはサポートされていません。
500	UnsupportedOperationType	指定された操作はサポートされていません。	指定された操作はサポートされていません。
500	AccessEngineFailed	検索エンジンへのアクセス中にエラーが発生しました。	検索エンジンでエラーが発生しました。
500	InternalOssError	内部 OAS エラーが発生しました。	内部アルゴリズムエラーが発生しました。
500	InternalSwiftError	内部 SWIFT エラーが発生しました。	内部メッセージキューエラーが発生しました。
500	InternalTableStoreError	内部 Table Store エラーが発生しました。	内部ストレージエラーが発生しました。

エラーコードのリストについては、「サービスエラーコード」をご参照ください。

エラーコード

エラーコードのリストについては、「サービスエラーコード」をご参照ください。