ResetOpenVikingMemoryTemplate 用于移除指定库、数据空间和记忆类型的自定义模板配置,恢复使用当前系统默认值。每次调用仅恢复一个记忆类型,不影响其他类型和其他数据空间,也不会删除已有记忆。
个人版的数据空间固定为 default;企业版恢复后,所选数据空间内所有 User 及其 Peer 共用该类型的默认模板。
密钥和公共请求约定见数据库管理 API 使用说明;签名流程见API 签名调用指南。
项目 | 值 |
|---|---|
Action | ResetOpenVikingMemoryTemplate |
Version | 2025-06-09 |
请求方法 | POST |
公网请求地址 | https://vikingdb.cn-beijing.volcengineapi.com/ |
Content-Type | application/json |
签名 Service / Region | vikingdb / cn-beijing |
POST /?Action=ResetOpenVikingMemoryTemplate&Version=2025-06-09 HTTP/1.1 Host: vikingdb.cn-beijing.volcengineapi.com Content-Type: application/json X-Date: <签名生成的 UTC 时间> X-Content-Sha256: <请求体 SHA-256> Authorization: <火山引擎 AK/SK 签名>
Action、Version 放在 URL 查询参数中,其余业务参数放在 JSON 请求体中。
字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
ResourceID | string | 是 | OpenViking 库 ID,例如 ov-example。 |
OpenVikingAccountID | string | 否 | 库内已有的数据空间 ID。省略、null、空字符串或纯空白时使用 default;显式传值时去除两端空白。
|
MemoryType | string | 是 | 严格小写,取值:profile、preferences、entities、events、soul、identity。 |
请求超时或响应不明时,先调用 Get 核对 Status 和 Effective;确认尚未恢复且仍需执行后再重试。恢复完成的验证条件为 system_default、UpdatedAt=null,且 Effective 与 Defaults 一致,无需轮询 Task。
响应包含 ResponseMetadata 和 Result,无额外的 Success 字段。失败时读取 ResponseMetadata.Error.Code、Error.Message,并保留 RequestId。
Result 字段 | 类型 | 说明 |
|---|---|---|
OpenVikingAccountID | string | 实际恢复的数据空间 ID。 |
MemoryType | string | 本次恢复的记忆类型。 |
Status | string | 成功恢复后为 system_default。 |
UpdatedAt | string / null | 成功恢复后为 null。 |
Defaults | TemplateConfig | 当前系统默认的开放配置。 |
Effective | TemplateConfig | 恢复后的生效配置,与 Defaults 一致。 |
字段 | 类型 | 说明 |
|---|---|---|
description | string | 记忆类型抽取说明。 |
fields | array[object] | 开放字段说明列表。 |
fields[].name | string | 既有字段名称,客户端应按 name 定位。 |
fields[].description | string / null | 字段生成说明,通常为字符串,客户端应兼容 null。 |
content_template | string | 仅 events、soul、identity 返回。其他类型不包含此键。 |
这些对象仅包含开放配置,不包含完整 YAML;内部键名使用小写。具体可编辑范围见自定义记忆抽取指令
HTTP 状态码 | 错误码 | 说明及处理建议 |
|---|---|---|
400 | InvalidParameter | 参数错误,或个人版选择了非 default 空间。检查请求。 |
400 | InvalidRequest | 当前内核不支持模板接口。联系维护人员确认升级。 |
401 / 403 | AuthenticationError | 签名缺失、无效或身份校验失败。检查 AK/SK、时间和实际发送内容。 |
403 | AccessDenied | 无权操作目标资源。检查授权,不自动重试写请求。 |
404 | ResourceNotExist | 库、数据空间或模板不存在。核对目标,不自动切换 default。 |
409 | OperationConflict | 另一模板操作占用锁。重新查询当前配置并确认恢复意图后重试。 |
412 | FailedPrecondition | 存储配置损坏或当前配置不可用。联系维护人员检查,Reset 不保证修复此类问题。 |
429 | QuotaExceeded | 超出配额或触发限流。退避后先核对状态。 |
500 | InternalError | 服务内部异常。保留 RequestId,核对当前状态后再处理。 |
公共鉴权和网关错误见数据库管理 API 使用说明。具体频率配额以服务配置为准;本接口无分页参数。
以下恢复个人版 default 数据空间的 profile 模板。企业版可替换为目标数据空间 ID,执行前确认其影响范围。
{ "ResourceID": "ov-example", "OpenVikingAccountID": "default", "MemoryType": "profile" }
安装 volcengine 和 requests,在服务端环境配置 VOLC_ACCESSKEY、VOLC_SECRETKEY。此示例会移除目标类型的自定义配置;确认已保存需要保留的配置后再执行。
pip install volcengine requests
import json import os import requests from volcengine.auth.SignerV4 import SignerV4 from volcengine.base.Request import Request from volcengine.Credentials import Credentials HOST = "vikingdb.cn-beijing.volcengineapi.com" ACTION = "ResetOpenVikingMemoryTemplate" BODY = { "ResourceID": "ov-example", "OpenVikingAccountID": "default", "MemoryType": "profile" } # 只序列化一次,签名和发送使用相同的请求体。 payload = json.dumps(BODY, ensure_ascii=True, separators=(",", ":")) query = {"Action": ACTION, "Version": "2025-06-09"} request = Request() request.set_method("POST") request.set_host(HOST) request.set_path("/") request.set_headers({"Host": HOST, "Content-Type": "application/json"}) request.set_query(query) request.set_body(payload) credentials = Credentials( os.environ["VOLC_ACCESSKEY"], os.environ["VOLC_SECRETKEY"], "vikingdb", "cn-beijing", ) SignerV4.sign(request, credentials) response = requests.post( "https://" + HOST + "/", params=query, headers=request.headers, data=payload.encode("utf-8"), timeout=30, ) result = response.json() error = result.get("ResponseMetadata", {}).get("Error") if not response.ok or error: raise RuntimeError({"http_status": response.status_code, "response": result}) print(json.dumps(result, ensure_ascii=False, indent=2))
签名 SDK 见火山引擎 Python SDK。请求体序列化后用于签名并原样发送,签名后不得修改。示例已完成离线语法与签名结构校验,未执行线上恢复。
以下默认文本仅为结构示意,以实际返回为准。
{ "ResponseMetadata": { "RequestId": "example-reset-request-id", "Action": "ResetOpenVikingMemoryTemplate", "Version": "2025-06-09", "Service": "vikingdb", "Region": "cn-beijing" }, "Result": { "OpenVikingAccountID": "default", "MemoryType": "profile", "Status": "system_default", "UpdatedAt": null, "Defaults": { "description": "<系统默认的画像抽取说明>", "fields": [ {"name": "content", "description": "<系统默认的画像正文生成说明>"} ] }, "Effective": { "description": "<系统默认的画像抽取说明>", "fields": [ {"name": "content", "description": "<系统默认的画像正文生成说明>"} ] } } }