添加画像记忆-AddProfile--向量数据库VikingDB-火山引擎

文档中心

立即注册

导航

向量数据库VikingDB

添加画像记忆-AddProfile

最近更新时间：2025.11.18 15:59:36首次发布时间：2025.11.07 14:07:19

概述

用于添加画像记忆。

请求接口

URL	/api/memory/profile/add	统一资源标识符
请求方法	POST	客户端对记忆库服务器请求的操作类型
请求头	Content-Type: application/json	请求消息类型
请求头	Authorization: HMAC-SHA256 ***	基于AK/SK生成的签名信息

请求参数

参数	类型	是否必须	参数说明
collection_name	String	否	目标记忆库的名称。
project_name	String	否	记忆库所属项目。
resource_id	String	否	记忆库唯一的资源 id。可选择直接传 resource_id，或同时传 collection_name 和 project_name 作为记忆库的唯一标识。
profile_type	String	是	画像类型。
memory_info	Object	是	画像记忆的内容。对于内置画像sys_profile_v1只有user_profile；对于自定义画像，按照自定义的属性字段写入。需要注意的是，其格式必须遵循在记忆库中已定义的格式。
user_id	String	是	画像关联的用户ID。
assistant_id	String	是	画像关联的助手ID。
group_id	String	否	群组ID。用于隔离不同的会话或场景。
is_upsert	Boolean	否	已存在记忆是否使用本次写入进行更新，默认为false，即不更新。 false：查找是否存在记录，存在则报错，不存在则新增。 true：先查找是否存在记录，存在则更新，不存在则新增。

响应消息

参数	类型	参数说明
code	Integer	状态码，0表示成功，其他表示错误。
message	String	返回信息，成功时通常为 "success"。
data	Object	返回的详细数据。
profile_id	String	画像的唯一ID。
memory_info	Object	画像记忆的内容。
primary_key	String	画像主键。
profile_type	String	画像类型。
usage	Object	画像记忆写入消耗的token。
embedding_tokens	Integer	Embedding token消耗。
request_id	String	标识每个请求的唯一ID。

完整示例

请求消息

Python请求

import os
import time
from vikingdb.memory import VikingMem
from vikingdb import APIKey

API_KEY = os.getenv("MEMORY_API_KEY", "your_key")

client = VikingMem(
    host = "api-knowledgebase.mlp.cn-beijing.volces.com",
    region = "cn-beijing",
    auth= APIKey(api_key=API_KEY),
    scheme="http",
)

# 获取记忆库集合
collection = client.get_collection(
    collection_name="my_first_memory_collection1",  # 用您的记忆库名称替代
    project_name="default"
)

# 添加用户画像
result = collection.add_profile(
    profile_type="sys_profile_v1",
    memory_info={
        "user_profile": "基础信息:性别 女/年龄 28/家乡 广州/职业 产品经理"
    },
    user_id="user1"
)

print("\n=== 添加用户画像结果 ===")
print(json.dumps(result, indent=2, ensure_ascii=False))

响应消息

执行成功返回

{
    "code":0,
    "message":"success",
    "data": {
        "profile_id": "68a6a078f2b275b6a41fec42",
        "primary_key":"",
        "profile_type": "sys_profile_v1",
        "memory_info":{
            "user_profile": "基础信息:性别 女/年龄 28/家乡 广州/职业 产品经理"  
        },
        "usage": {
            "embedding_tokens":68
        }
    }
    "request_id":"021695029537650fd001de666660000000000000000000230da93"
}