新增圖片
本文為您介紹AddImage接口的語法及示例,用于向圖像搜索實(shí)例中添加圖片信息。
使用說明
本接口用于向圖像搜索實(shí)例中添加圖片信息。
QPS限制
10W圖片容量的實(shí)例默認(rèn)的并發(fā)量為1,也就是每秒鐘最多處理1個(gè)圖片新增請求。
其他圖片容量的實(shí)例默認(rèn)的并發(fā)量為5,也就是每秒鐘最多處理5個(gè)圖片新增請求。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數(shù)
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
Action | String | 是 | AddImage | 系統(tǒng)規(guī)定參數(shù)。取值:AddImage。 |
InstanceName | String | 是 | demoinstance1 | 圖搜實(shí)例名稱。最多支持20個(gè)字符。 如果已經(jīng)購買圖搜實(shí)例可登錄圖像搜索管控臺查看。 如果沒有購買圖搜實(shí)例可參考開通服務(wù)和創(chuàng)建實(shí)例。 說明 這里的實(shí)例名稱并非實(shí)例ID,使用時(shí)請區(qū)分。 |
ProductId | String | 是 | 2092061_1 | 商品ID,最多支持512個(gè)字符。 說明 一個(gè)商品可以有多張圖片。 |
PicName | String | 是 | 2092061_1.jpg | 圖片名稱,最多支持512個(gè)字符。 說明
|
PicContent | String | 是 | AAAANSUhEUgAAAPcAAAEVCAYAAAA8d3NuAAAAAXNSR0IArs......RK5CYII= | 圖片內(nèi)容。
說明
|
CategoryId | Integer | 否 | 88888888 | 圖片類目。具體請參考類目參考。 說明
|
Crop | Boolean | 否 | true | 是否需要進(jìn)行主體識別。默認(rèn)true。
對于布料圖片搜索,此參數(shù)會被忽略,系統(tǒng)會以整張圖進(jìn)行搜索。 |
Region | String | 否 | 280,486,232,351 | 圖片的主體區(qū)域,格式為 說明
|
CustomContent | String | 否 | zidingyi | 用戶自定義的內(nèi)容,最多支持4096個(gè)字符。 說明 查詢時(shí)會返回該字段。例如可添加圖片的描述等文本。 |
IntAttr | Integer | 否 | 22 | 整數(shù)類型屬性,可用于查詢時(shí)過濾,查詢時(shí)會返回該字段。 |
StrAttr | String | 否 | ss | 字符串類型屬性,最多支持128個(gè)字符。可用于查詢時(shí)過濾,查詢時(shí)會返回該字段。 說明 不支持特殊字符比如:\¥$&% |
IntAttr2 | Integer | 否 | 22 | 整數(shù)類型屬性,可用于查詢時(shí)過濾,查詢時(shí)會返回該字段。 說明 2023年1月3號之后創(chuàng)建的實(shí)例才能使用。 |
StrAttr2 | String | 否 | ss | 字符串類型屬性,最多支持128個(gè)字符。可用于查詢時(shí)過濾,查詢時(shí)會返回該字段。 說明
|
返回?cái)?shù)據(jù)
名稱 |
類型 |
示例值 |
描述 |
Message | String | success | 錯(cuò)誤信息。 說明 成功請求不返回?cái)?shù)據(jù),失敗請求返回錯(cuò)誤信息。 |
RequestId | String | E0845DE6-52AF-4B50-9F15-51ED4044E6AB | 請求ID。 |
Code | Integer | 0 | 錯(cuò)誤碼。
|
PicInfo | Object | 類目預(yù)測、主體識別結(jié)果。 |
|
Region | String | 94,691,206,650 | 主體識別結(jié)果。圖片的主體區(qū)域,格式為 |
CategoryId | Integer | 88888888 | 類目預(yù)測結(jié)果。若用戶請求中指定了類目,則以請求中為準(zhǔn)。 |
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
}
錯(cuò)誤碼
請參見錯(cuò)誤碼。