Image Search インスタンスで画像名を基に画像を検索します。

使用方法

この操作を呼び出して、ProductId と PicName の値に基づいて Image Search インスタンス内の画像を検索できます。

QPS 制限

Image Search コンソールで、デフォルトのクエリ/秒（QPS）の最大数を確認できます。上限は、Image Search インスタンスの購入時に指定されます。上限は 1 QPS、5 QPS、または 10 QPS に設定できます。

デバッグ

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

リクエストパラメータ

パラメータ	タイプ	必須	例	説明
Action	String	はい	SearchImageByName	実行する操作。値を SearchImageByName に設定します。
InstanceName	String	はい	demoinstance1	Image Search インスタンスの名前。名前は最大 20 文字まで使用できます。 Image Search インスタンスが購入されている場合は、Image Search コンソールにログインしてインスタンスを表示できます。 Image Search インスタンスが購入されていない場合は、インスタンスを購入する必要があります。詳細については、「Image Search をアクティブ化する」および「Image Search インスタンスを作成する」をご参照ください。説明インスタンス名はインスタンス ID ではありません。
ProductId	String	はい	2092061_1	プロダクト ID。
PicName	String	はい	2092061_1.jpg	画像の名前。
CategoryId	Integer	いいえ	88888888	プロダクトカテゴリの ID。詳細については、「カテゴリのリファレンス」をご参照ください。商品画像検索：カテゴリが指定されている場合は、指定されたカテゴリが優先されます。カテゴリが指定されていない場合は、システムがカテゴリを予測して選択します。システムによって選択されたカテゴリはレスポンスに含まれます。汎用画像検索：カテゴリが指定されているかどうかに関係なく、カテゴリ ID は 88888888 に設定されます。
Num	Integer	いいえ	10	返されるエントリの数。有効値：1 ～ 100。デフォルト値：10。
Start	Integer	いいえ	0	返される最初のエントリの序数。有効値：0 ～ 499。デフォルト値：0。
Filter	String	いいえ	int_attr>=100	フィルタ条件。 int_attr は、>、>=、<、<=、および = の演算子をサポートしています。 str_attr は、= および != の演算子をサポートしています。条件間の論理演算子を AND または OR に設定できます。例： int_attr>=100 str_attr!="value1" int_attr=1000 AND str_attr="value1" 説明値は最大 256 文字まで使用できます。

レスポンスパラメータ

パラメータ	タイプ	例	説明
Msg	String	success	返されたメッセージ。
Head	Object		検索結果の概要。
DocsFound	Integer	10	返された画像の数。
DocsReturn	Integer	10000	Image Search インスタンス内で検索条件に一致する画像の数。
SearchTime	Integer	95	検索処理の継続時間。単位：ミリ秒。
RequestId	String	36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1	リクエスト ID。
Auctions	Auction の配列		返されたプロダクトの説明。
ProductId	String	2092061_1	プロダクト ID。
PicName	String	2092061_1.jpg	画像の名前。
CategoryId	Integer	20	画像のカテゴリ ID。
SortExprValues	String	5.37633353624177e+24;0	画像のスコア情報。説明このパラメータは使用されなくなりました。Score を使用することをお勧めします。 SortExprValues は、値がセミコロン（;）で区切られた 2 タプルを示します。最初の値は、返された画像の相関スコアを示します。値が大きいほど、サンプル画像との相関が高いことを示します。 SortExprValues の値は、アルゴリズムによって異なります。 CategoryId の値が 0 ～ 2 の場合、SortExprValues の値は 0 ～ 7.33136443711219e+24 です。 CategoryId の値が 0 ～ 2 の範囲外の場合、SortExprValues の値は 0 ～ 5.37633353624177e+24 です。返された画像がサンプル画像と同一の場合、最高の相関スコアが生成されます。
CustomContent	String	zidingyi	ユーザー定義コンテンツ。
Score	Float	1	画像の類似度スコア。有効値：0 ～ 1。説明このパラメータを使用するには、Image Search SDK をバージョン 3.1.1 に更新する必要があります。
IntAttr	Integer	2	INT タイプの属性。
IntAttr2	Integer	20	INT タイプの属性。
StrAttr	String	ss	STRING タイプの属性。説明このパラメータは、2023 年 1 月 3 日以降に作成されたインスタンスにのみ表示されます。
StrAttr2	String	test	STRING タイプの属性。説明このパラメータは、2023 年 1 月 3 日以降に作成されたインスタンスにのみ表示されます。
Code	Integer	0	レスポンスコード。値 0 は、リクエストが成功したことを示します。 0 以外の値は、リクエストが失敗したことを示します。
PicInfo	Object		カテゴリ予測と被写体識別の結果。
Region	String	280,486,232,351	被写体識別の結果。この値は、画像の主題領域を x1,x2,y1,y2 の形式で示します。具体的には、x1 と y1 は左上の画素を示し、x2 と y2 は右下の画素を示します。リクエストで主題領域が指定されている場合は、指定された主題領域が優先されます。
CategoryId	Integer	20	カテゴリ予測の結果。リクエストでカテゴリが指定されている場合は、指定されたカテゴリが優先されます。
MultiRegion	reg の配列		識別された被写体。
Region	String	280,486,232,351	被写体識別の結果。この値は、画像の主題領域を x1,x2,y1,y2 の形式で示します。具体的には、x1 と y1 は左上の画素を示し、x2 と y2 は右下の画素を示します。リクエストで主題領域が指定されている場合は、指定された主題領域が優先されます。
AllCategories	Category の配列		システムでサポートされているカテゴリ。
Name	String	other	カテゴリの名前。
Id	Integer	88888888	カテゴリ ID。
Success	Boolean	true	リクエストが成功したかどうかを示します。

例

サンプルリクエスト

{
        "InstanceName": "demoinstance",
        "ProductId": "ProductId",
        "PicName": "PicName"
}

サンプル成功レスポンス

JSON 形式

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

{
  "Auctions" : [ {
    "CategoryId" : 0,
    "PicName" : "demo",
    "SortExprValues" : "7.33136443711219e+24;0",
    "Score" : 1.0,
    "ProductId" : "demo"
  } ],
  "Head" : {
    "DocsReturn" : 1,
    "DocsFound" : 1,
    "SearchTime" : 155
  },
  "PicInfo" : {
    "CategoryId" : 0,
    "Region" : "111,697,113,774",
    "AllCategories" : [ {
      "Name" : "Tops",
      "Id" : 0
    }, {
      "Name" : "Dress",
      "Id" : 1
    }, {
      "Name" : "Bottoms",
      "Id" : 2
    }, {
      "Name" : "Bag",
      "Id" : 3
    }, {
      "Name" : "Shoes",
      "Id" : 4
    }, {
      "Name" : "Accessories",
      "Id" : 5
    }, {
      "Name" : "Snack",
      "Id" : 6
    }, {
      "Name" : "Makeup",
      "Id" : 7
    }, {
      "Name" : "Bottle",
      "Id" : 8
    }, {
      "Name" : "Furniture",
      "Id" : 9
    }, {
      "Name" : "Toy",
      "Id" : 20
    }, {
      "Name" : "Underwear",
      "Id" : 21
    }, {
      "Name" : "Digital device",
      "Id" : 22
    }, {
      "Name" : "Other",
      "Id" : 88888888
    } ],
    "MultiRegion" : [ ]
  },
  "RequestId" : "D61D869E-E92A-447F-AD67-9234F999E516",
  "Msg" : "success",
  "Success" : true,
  "Code" : 0
}

エラーコード

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

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

エラーコード

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