AISearchResourceUpdate - 更新AISearch结构化资源

更新时间:
复制为 MD 格式

修改AISearch项目中的结构化元素,目前支持的结构化元素类型为【小程序】(miniapp)&【商品】(product)。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求语法

POST /api/v1/aiSearch/resource/update HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

body

object

请求参数

type

string

结构化元素类型

枚举值:

  • product :

    product

  • miniapp :

    miniapp

miniapp

resourceId

string

结构化元素资源 ID,是该资源在数据库中唯一且不可变的标识符

WzMGQZwB7nQEs3Qk3ajH

data

any

对指定资源的信息进行更新,本字段需要按照规定的格式以 JSON 形式传递需要更新的字段,未传递的字段则默认不做修改

当更新类型为【小程序】(miniapp)时,可更新的字段信息如下

  • "miniappId": "小程序唯一标识"

  • "title": 小程序名称"

  • "version": "版本号"

  • "description": "简要描述",

  • "detailDesc": "详细描述",

  • "slogan": "标语"

  • "icon": "图标 URL",

  • "url": "小程序链接"

当类型为【商品】(product)时,可更新的字段信息如下

  • "title": "商品名称"

  • "description": "商品描述",

  • "icon": "商品图标 URL",

  • "url": "商品链接",

  • "price": "价格",

  • "extra": "扩展字段,任意 key-value 对象"

{ "title": "update title" }

字段 type 本质上为枚举类型,仅支持规定的取值范围,超出范围的值将导致接口无法正常工作;后续将根据需求扩展更多结构化内容。

返回参数

名称

类型

描述

示例值

object

Schema of Response

requestId

string

Id of the request

FDE51A3B-09C0-57E5-96FC-31E85EEFF318

data

object

请求返回结果。

type

string

结构化元素类型

枚举值:

  • product :

    product

  • miniapp :

    miniapp

miniapp

resourceId

string

结构化元素资源 ID,是该资源在数据库中唯一且不可变的标识符

WzMGQZwB7nQEs3Qk3ajH

示例

正常返回示例

JSON格式

{
  "requestId": "FDE51A3B-09C0-57E5-96FC-31E85EEFF318",
  "data": {
    "type": "miniapp",
    "resourceId": "WzMGQZwB7nQEs3Qk3ajH"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情