安装与初始化--向量数据库VikingDB-火山引擎

文档中心

向量数据库VikingDB

请输入

SDK参考

安装与初始化

Viking 长期记忆支持通过 Python SDK 操作记忆库，Python SDK 提供了高层次的抽象和易于使用的接口，简化开发人员的工作。在使用 Python SDK 之前，需要先完成安装 SDK 和初始化 SDK 步骤。

前提条件

已通过注册账号及开通服务操作完成注册账号及开通服务。
获取安全凭证。Access Key（访问密钥）是访问火山引擎服务的安全凭证，包含Access Key ID（简称为AK）和Secret Access Key（简称为SK）两部分。可登录火山引擎控制台并前往【密钥管理】查看当前账号的 AK / SK，更多详情请参考 Access Key（密钥）管理。

安装 SDK

首次使用可通过 pip 安装 SDK for Python，支持 Python 3.7 及以上版本。

pip install volcengine-python-sdk
pip install vikingdb-python-sdk

如需更新 SDK 版本，可使用以下命令：

pip install --upgrade volcengine-python-sdk
pip install --upgrade vikingdb-python-sdk

初始化 SDK

配置安全凭证，根据记忆库名和项目名或资源 ID 初始化客户端。

说明

代码中 your_ak 及 your_sk 需要分别替换为您的 AK 及 SK。

import os
from vikingdb import IAM
from vikingdb.memory import VikingMem

_auth = IAM(
    ak=os.getenv("VIKINGDB_AK", "your_ak"),
    sk=os.getenv("VIKINGDB_SK", "your_sk"),
)
client = VikingMem(
    host="api-knowledgebase.mlp.cn-beijing.volces.com",
    region="cn-beijing",
    auth=_auth,
    scheme="https",
)

print("Client initialized successfully")

if __name__ == "__main__":

    client.ping()

    ## 示例 1: 使用 collection_name 和 project_name
    collection1 = client.get_collection(
        collection_name="sdk_test",  # 替换为您的记忆库名称
        project_name="default"
    )

    ## 示例 2: 使用 resource_id
    collection2 = client.get_collection(
        resource_id="col-abc123xyz"
    )

最近更新时间：2026.04.21 20:42:18

这个页面对您有帮助吗？

有用

无用