陈列知识库内容批量修改(同步)
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
aidge:UpdateDisplayKnowledge |
none |
*全部资源
|
无 | 无 |
请求语法
POST HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RagId |
string |
是 |
知识库 ID |
rag_xxx |
| Records |
array<object> |
是 |
待修改记录,最多 500 条 |
|
|
object |
否 |
|||
| RecordId |
integer |
否 |
记录 ID |
1489638581 |
| SkuId |
string |
否 |
SKU ID;非空时覆盖原值 |
sku-001 |
| SkuName |
string |
否 |
SKU 名称 |
商品正面图 |
| ImageUrl |
string |
否 |
商品图片 HTTP(S) URL |
https://xxxx/96f21ebdaeeba27a.jpg |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求 ID |
39E8A74B-F99E-1195-A5FF-3ECC5F94F304 |
| Code |
string |
错误码 |
success |
| Success |
boolean |
是否调用成功 |
True |
| Message |
string |
返回信息或失败说明 |
success |
| Data |
object |
陈列知识库内容修改结果 |
|
| UsageMap |
object |
用量信息;免费接口为空 |
|
|
integer |
用量信息(key 为用量名称,value 为计数) |
{"ProcessedImageCount":1} |
|
| TaskId |
string |
异步任务 ID;同步接口为空 |
ed9d8504-6141-9fbb-8345-4fa36433483f |
| Success |
boolean |
业务处理是否成功 |
True |
| ErrorCode |
string |
业务错误码 |
success |
| ErrorMessage |
string |
业务错误信息 |
success |
| RagId |
string |
知识库 ID |
rag_001 |
| KnowledgeBaseStatus |
string |
知识库状态 |
UPDATING |
| AcceptedCount |
integer |
受理条数 |
10 |
| FailedCount |
integer |
失败条数 |
0 |
| Results |
array<object> |
逐条处理结果 |
|
|
object |
返回集合。 |
||
| Index |
integer |
原请求数组下标 |
1 |
| Success |
boolean |
是否受理 |
True |
| RecordId |
integer |
记录 ID |
32238 |
| SkuId |
string |
生效的 SKU ID |
sku-001 |
| Status |
string |
记录状态 |
UPDATING |
| ErrorCode |
string |
失败错误码 |
success |
| ErrorMessage |
string |
失败原因 |
Success |
示例
正常返回示例
JSON格式
{
"RequestId": "39E8A74B-F99E-1195-A5FF-3ECC5F94F304",
"Code": "success",
"Success": true,
"Message": "success",
"Data": {
"UsageMap": {
"key": 0
},
"TaskId": "ed9d8504-6141-9fbb-8345-4fa36433483f",
"Success": true,
"ErrorCode": "success",
"ErrorMessage": "success",
"RagId": "rag_001",
"KnowledgeBaseStatus": "UPDATING",
"AcceptedCount": 10,
"FailedCount": 0,
"Results": [
{
"Index": 1,
"Success": true,
"RecordId": 32238,
"SkuId": "sku-001",
"Status": "UPDATING",
"ErrorCode": "success",
"ErrorMessage": "Success"
}
]
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。