根據圖片查詢圖片 -

本文為您介紹SearchImageByPic的文法及樣本，用於根據圖片查詢Image Search執行個體中的圖片資訊。

使用說明

本介面用於根據圖片查詢Image Search執行個體中的圖片資訊。

說明

如需瞭解更多產品詳情和擷取支援人員，請單擊線上諮詢或通過DingTalk群（35035130）聯絡我們。

QPS限制

查詢操作預設的最大訪問頻率可在控制台中查看，為您購買時所選擇的訪問頻次（QPS），當前支援1QPS、5QPS、10QPS。

SDK版本說明

映像SDK版本升級到V3.1.1，可使用“多主體識別”、“相似性分數”功能。請參見Java SDK。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	SearchImageByPic	系統規定參數。取值：SearchImageByPic。
InstanceName	String	是	demoinstance1	圖搜執行個體名稱。最多支援20個字符。如果已經購買圖搜實例可登入Image Search管控台查看。如果沒有購買圖搜執行個體可參考開通服務和建立執行個體。說明這裡的實例名稱並非實例ID，使用時請區分。
PicContent	String	是	AAAANSUhEUgAAAPcAAAEVCAYAAAA8d3NuAAAAAXNSR0IArs......RK5CYII=	圖片內容。圖片大小要求不超過4 MB。圖片格式：PNG、JPG、JPEG、BMP、GIF、WEBP、TIFF、PPM。傳輸等待時間不超過5秒。服務類型為商標圖片搜尋時，圖片長和寬像素要求大於等於200PX且小於4096PX。服務類型為布料圖片搜尋時，圖片長和寬像素要求大於等於448PX且小於等於4096PX。服務類型為商品圖片搜尋和通用圖片搜尋時，圖片長和寬像素要求大於等於100PX且小於等於4096PX。圖片中不能包含旋轉資訊。說明使用SDK方式調用：如使用V3版本SDK，則無需填寫PicContent欄位，SDK已將本欄位封裝為PicContentObject欄位並自動轉化為Base64編碼。具體樣本參考JAVA SDK。 SDK不支援客戶直接傳遞圖片URL，V3版本SDK提供了一種變相實現URL上傳的方式。具體樣本參考JAVA SDK。使用阿里雲OpenAPI平台叫用：如使用2019-03-25版本，PicContent欄位請填寫圖片的Base64編碼。如使用2020-12-14版本，在PicContent欄位直接點擊上傳圖片即可。
CategoryId	Integer	否	88888888	商品類目。具體請參見類目參考。對於商品搜尋，如果設定類目，則以設定的為準；如果不設定類目，則由系統進行類目預測，預測的類目結果可以在Response中擷取。對於通用搜尋，不論是否設定類目，系統會將類目設定為88888888。
Crop	Boolean	否	true	是否需要進行主體識別。預設true。為true時，由系統進行主體識別，以識別的主體進行搜尋，主體識別結果可在Response中擷取。為false時，則不進行主體識別，以整張圖進行搜尋。
Region	String	否	280,486,232,351	圖片的主體地區，格式為`x1,x2,y1,y2,` 其中`x1,y1` 是左上方的點，`x2,y2`是右下角的點。說明若使用者佈建了Region，則不論Crop參數為何值，都將以使用者輸入Region進行搜尋。
Num	Integer	否	10	返回結果的數目。取值範圍：1~100。預設值為10。
Start	Integer	否	0	返回結果的起始位置。取值範圍：0~499。預設值為0。
Filter	String	否	int_attr=1000 AND str_attr="value1"	過濾條件。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	執行個體中命中結果數目。
SearchTime	Integer	95	搜尋耗時，單位毫秒。
RequestId	String	B3137727-7D6E-488C-BA21-0E034C38A879	請求ID。
Auctions	Array of Auction		所有返回的商品描述資訊。
ProductId	String	2092061_1	商品ID。
PicName	String	2092061_1.jpg	圖片名稱。
CategoryId	Integer	8888888	圖片類目。
SortExprValues	String	5.37633353624177e+24;0	系統打分資訊。說明當前欄位已棄用，建議使用Score。 SortExprValues是一個分號分隔的二元組，第一個值表示圖片的相關性分數，值越大表示和查詢的圖片相關性越高。由於演算法模型不同。當類目為0~2時，SortExprValues範圍範圍：0～7.33136443711219e+24。類目為其他值時，SortExprValues範圍範圍：0～5.37633353624177e+24。當兩個圖片完全一樣時，這個分值最大。
CustomContent	String	zidingyi	使用者自訂的內容。
Score	Float	1	圖片相似打分。取值範圍：0~1。說明需要版本升級至V3.1.1方可使用。
IntAttr	Integer	2	整數類型屬性。
IntAttr2	Integer	20	整數類型屬性。說明 2023年1月3號之後建立的實例才能使用。
StrAttr	String	2	字串類型屬性。
StrAttr2	String	test	字串類型屬性。說明 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	88888888	類目預測結果。若使用者請求中指定了類目，則以請求中為準。
MultiRegion	Array of reg		主體識別結果集合。說明需要版本升級至V3.1.1方可使用。
Region	String	280,486,232,351	主體識別結果。圖片的主體地區，格式為x1,x2,y1,y2，其中 x1,y1 是左上方的點，x2，y2是右下角的點。若使用者請求中指定了主體地區，則以請求中為準。
AllCategories	Array of Category		系統支援的所有類目資訊。
Name	String	other	類目名稱。
Id	Integer	88888888	類目ID。
Success	Boolean	true	請求是否成功。

樣本

請求樣本

{
        "InstanceName": "demoinstance",
        "PicContent": "${Base64ImageContent}"
}

正常返回樣本

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" : [ {
      "Region" : "604,1814,451,1358"
    }, {
      "Region" : "843,1615,687,1138"
    } ]
  },
  "RequestId" : "D61D869E-E92A-447F-AD67-9234F999E516",
  "Msg" : "success",
  "Success" : true,
  "Code" : 0
}

錯誤碼

HttpCode	錯誤碼	錯誤資訊	描述
400	BadRequest	The request has invalid parameters.	無效的參數
400	InvalidInstance	The specified instance name is invalid.	執行個體名錯誤
400	NoCaretSeperator	The body content is missing the ^ separator.	請求body缺少特定符號
400	EmptyMeta	The body content has an empty meta field.	請求body含有空的欄位
400	InvalidMetaItem	The meta field is invalid.	無效的元資訊欄位
400	NoPicList	The body content is missing the pic_list parameter.	未指定pic_list欄位
400	InvalidPicList	The specified pic_list parameter is invalid.	無效的pic_list欄位
400	InvalidCategory	The specified category is invalid.	無效的類目id
400	OverflowMaxResultNum	The specified number of total results exceeds the maximum of 500.	超過了最大的返回結果限制數500
400	OverflowMaxReturnNum	The specified number of results for each request exceeds the maximum of 100.	單次返回數超過限制值100
400	InvalidNumParameter	The specified parameter num is invalid.	無效的欄位num
400	InvalidIntAttr	The specified int_attr field is invalid.	無效的int過濾欄位
400	UnsupportedPicFormat	The specified image format is invalid.	無效的圖片格式
400	InvalidFilterClause	The specified filtering condition is invalid.	無效的過濾條件
400	InstanceOverQuota	The number of items exceeds the limit.	執行個體的圖片數量超過限制值
400	IncorrectOrientation	The image contains incorrect rotation flags in the meta data.	圖片包含不支援的旋轉參數
400	UnsupportedPicPixels	The specified pixels is not supported.	圖片像素值不支援
403	NoPermission	You are not authorized to perform this operation.	沒有許可權進行此操作，請先讓管理員帳號授權.
403	DeniedRequest	Your request was denied due to instance flow control.	請求被限流
500	UnknownException	An internal server error occurred.	未知異常
500	NetworkException	A network error occurred.	內部錯誤：請求網路異常
500	UnsupportedInstanceType	The instance type is not supported.	內部錯誤：不支援的執行個體類型
500	UnsupportedOperationType	The specified action is not supported.	內部錯誤：不支援的action
500	AccessEngineFailed	An error occurred while accessing the search engine.	內部錯誤：請求引擎失敗
500	InternalOssError	An internal OAS error occurred.	內部錯誤：請求內部演算法錯誤
500	InternalSwiftError	An internal SWIFT error occurred.	內部錯誤：請求內部訊息隊列錯誤
500	InternalTableStoreError	An internal Table Store error occurred.	內部錯誤：請求特徵儲存錯誤

訪問錯誤中心查看更多錯誤碼。

錯誤碼

請參見錯誤碼。