新增圖片 - Image Search

本介面用於向Image Search執行個體中添加圖片。

請求路徑

協議	URL	方法	參數
HTTPS	${HOST}/v2/image/add	POST	JSON

${HOST}參見服務節點地址及內網（VPC）調用方式。

請求參數

名稱	類型	是否必須	描述
InstanceName	String	是	Image Search執行個體名稱。
ProductId	String	是	商品ID，最多支援512個字元。說明一個商品可以有多張圖片。
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	否	圖片類目。具體請參見類目參考。說明對於商品搜尋，若設定類目，則以設定的為準；若不設定類目，將由系統進行類目預測，預測的類目結果可在Response中擷取。對於通用搜尋，不論是否設定類目，系統會將類目設定為88888888。
Crop	Boolean	否	是否需要進行主體識別。預設true。為true時，由系統進行主體識別，以識別的主體進行搜尋，主體識別結果可在Response中擷取。為false時，則不進行主體識別，以整張圖進行搜尋。
Region	String	否	圖片的主體地區，格式為`x1,x2,y1,y2`, 其中`x1,y1` 是左上方的點，`x2,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,y1`是左上方的點，`x2,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
}

錯誤碼

請參見錯誤碼。