场景图背景推荐与查询 API 调用说明

场景图背景推荐与查询

POST /ai/image/background/generation/scene/query

产品描述

我们提前预设了大量不同风格的场景，供用户自由选择。通过该API可以传入商品信息获得自动推荐场景背景模板，同时也可查询预设场景，返回包括场景ID、名称、封面、标签等信息。

请求参数

参数	类型	必填	参数描述及示例值
productTitle	String	否	根据传入的商品标题推荐场景。仅支持中文或英文的商品标题。
imageUrl	String	否	根据传入的商品图片推荐场景。
categoryType	String	否	根据指定的商品类目查询场景。 目前支持11个商品类别的选择。如果不设置，默认查询所有类目的场景。 取值范围： "General Purpose"=通用； "Consumer Electronics"=消费电子； "Home & Garden"=家居&园艺； "Automobiles, Parts & Accessories"=汽车配件； "Computer & Office"=电脑&办公配件； "Sports & Entertainment"=休闲娱乐； "Fashion"=服饰； "Beauty & Health"=美妆； "Tools"=工具五金； "Toys & Hobbies"=玩具； "Phones & Telecommunications"=手机
sceneType	String	否	根据指定的场景类型查询场景。 目前支持4种场景类型的选择。如果不设置，默认查询所有类型的场景。 取值范围： "Indoor"=室内； "Outdoor"=室外； "Atmosphere"=氛围； "Promotion"=营销节点；
count	Number	否	返回的最大场景数量。如果不设置，默认返回查询的所有数量。 取值范围：1-100

请求示例

Java

IopClient client = new IopClient(url, appkey, appSecret);
IopRequest request = new IopRequest();
request.setApiName("/ai/image/background/generation/scene/query");
request.addApiParameter("productTitle", "Twin XL Mattress Pad Pillow Top Quilted Fitted Mattress Cover/ Protector Extra Long Cotton Top 8-21" Deep Pocket Cooling Mattress Topper");
request.addApiParameter("sceneType", "Indoor");
request.addApiParameter("count", "1");
request.addApiParameter("imageUrl", "https://ae01.alicdn.com/kf/S2d0d88e656384da894b7cfe9c59b0c0du.jpg");
request.addApiParameter("categoryType", "Beauty & Health");
IopResponse response = client.execute(request);
System.out.println(response.getBody());
Thread.sleep(10);

响应参数

参数	类型	描述
resCode	Number	返回的结果码，其中200代表成功，详细错误码请参考错误码列表。
requestId	String	唯一的请求ID，用于排查问题。
data	Object	返回的JSON结果数据。
modelNum	String	场景的唯一编号码。
coverUrl	String	场景对应的封面图。
name	String	场景名称。
categoryNameList	list	场景适用的类别标签。一个场景可能会对应多个类别标签。
sceneNameList	list	场景的类型标签。一个场景可能会对应多个类型标签。
success	Boolean	返回的请求状态，代表请求是否成功。
resMessage	String	返回的错误信息。

响应示例

Java

{
  "data": [],
  "success": true,
  "code": "0",
  "request_id": "2101725817192325338225104",
  "_trace_id_": "2140d3ff17192325338207538e8d37"
}

错误码

错误码	错误信息	描述
500	system error	System error.服务器内部错误
501	rate limit exceed	当前接口已达到限流上限,请搜索Aidge产品咨询&服务群钉钉群号：105455001046，入群联系我们增加当前限制值。
700	invalid input	输入参数的格式不符合要求，resMessage 将返回详细的不符合要求的字段。
801	model failed	内部调用异常，请搜索Aidge产品咨询&服务群钉钉群号：105455001046，入群联系我们进行故障排除。
1000	content has sensitive data, please try other input	内容包含敏感数据，无法处理，请尝试其他输入。
1001	content control failed, please retry	风控服务运行异常，请搜索Aidge产品咨询&服务群钉钉群号：105455001046，入群联系我们。
1002	content risk filter failed, please contact us	风控服务运行异常，请搜索Aidge产品咨询&服务群钉钉群号：105455001046，入群联系我们。