知识库

更新知识库

修改指定知识库的描述信息

POST

/api/v1/indices/rag/index/update

cURL

curl -X POST "https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/indices/rag/index/update" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "your_index_id",
    "description": "更新后的知识库描述"
  }'

{
  "code": "Success",
  "status_code": 200,
  "data": {
    "updated_at": 1782191157000,
    "created_at": 1782180218000,
    "id": "your_kb_id"
  },
  "success": true,
  "message": "success",
  "request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "status": "SUCCESS"
}

参数名为 id，不是 index_id 或 indexId。请注意与其他接口的命名差异。

Authorizations

string

header

required

DashScope API Key，在控制台 API Key 页面（https://rag.console.aliyun.com/settings/apikey）获取。

Body

application/json

string

required

知识库 ID。注意参数名为 id，不是 index_id 或 indexId。

string

知识库描述信息。

Response

200-application/json

string

响应码，成功时为 Success。

integer

HTTP 状态码。

string

请求唯一标识，排查问题时请提供此 ID。

object

Show child attributes

string

知识库 ID。

integer

更新时间（毫秒级 Unix 时间戳）。

integer

创建时间（毫秒级 Unix 时间戳）。

cURL

curl -X POST "https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/indices/rag/index/update" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "your_index_id",
    "description": "更新后的知识库描述"
  }'

{
  "code": "Success",
  "status_code": 200,
  "data": {
    "updated_at": 1782191157000,
    "created_at": 1782180218000,
    "id": "your_kb_id"
  },
  "success": true,
  "message": "success",
  "request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "status": "SUCCESS"
}