添加AISearch项目中的结构化元素,目前支持的结构化元素类型为【小程序】(miniapp)&【商品】(product)。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST /api/v1/aiSearch/resource/add HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| body |
object |
否 |
请求 Body 参数 |
|
| type |
string |
是 |
结构化元素类型 枚举值:
|
miniapp |
| data |
any |
否 |
与 type 对应的结构化元素信息,本字段需要按照规定的格式以 JSON 形式传递参数 |
{ "miniapp_id": "test_miniapp", "title": "testApp", "version": "1.0.5", "description": "description-mock", "slogan": "slogan-mock", "icon": "https://img.alicdn.com/test_icon.png", "detail_desc": "detail-mock" } |
字段 type 本质上为枚举类型,仅支持规定的取值范围,超出范围的值将导致接口无法正常工作;后续将根据需求扩展更多结构化内容。
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| requestId |
string |
Id of the request |
4A0AEC56-5C9A-5D47-93DF-7227836FFF82 |
| data |
object |
返回数据。 |
|
| type |
string |
结构化元素类型,与请求入参中的 type 字段内容一致 枚举值:
|
miniapp |
| resourceId |
string |
结构化元素资源 ID,是该资源在数据库中唯一且不可变的标识符,用于后续的修改、删除和查询操作 |
WzMGQZwB7nQEs3Qk3ajH |
示例
正常返回示例
JSON格式
{
"requestId": "4A0AEC56-5C9A-5D47-93DF-7227836FFF82",
"data": {
"type": "miniapp",
"resourceId": "WzMGQZwB7nQEs3Qk3ajH"
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。