使用 Redis 存储

redis 后端使用 Redis 作为向量存储。知识文本先经 embedding 模型向量化，再通过 LlamaIndex 写入 Redis，检索时按相似度召回。索引集合名即 index。

何时使用

已有 Redis 实例并开启了 RediSearch 模块；
希望用 Redis 作为低延迟的向量检索后端，并需要持久化与多实例共享。

依赖

pip install "veadk-python[extensions]"

Redis 需支持 RediSearch（向量检索）能力。

使用示例

from veadk import Agent
from veadk.knowledgebase import KnowledgeBase

kb = KnowledgeBase(backend="redis", index="company_faq")
kb.add_from_text("公司的标准年假为每年 15 天，入职满一年起享受。")

agent = Agent(
    name="demo",
    instruction="回答用户问题，必要时用 `load_knowledgebase` 工具检索知识库。",
    knowledgebase=kb,
)

也可以通过 backend_config 显式传入连接配置：

from veadk.knowledgebase import KnowledgeBase
from veadk.configs.database_configs import RedisConfig

kb = KnowledgeBase(
    backend="redis",
    index="company_faq",
    backend_config={
        "index": "company_faq",
        "redis_config": RedisConfig(
            host="localhost",
            port=6379,
            password="your-password",
            db=0,
        ),
    },
)

参数

构造参数

backend_config 支持以下配置项：

参数	类型	默认值	说明
`index`	`str`	无默认，由 `KnowledgeBase` 传入	知识库索引名。Redis 后端对命名无额外限制。
`redis_config`	`RedisConfig`	自动从 `DATABASE_REDIS_*` 环境变量读取	Redis 连接配置。
`embedding_config`	`EmbeddingModelConfig`	自动从 `MODEL_EMBEDDING_*` 环境变量读取	embedding 模型配置。

Redis 连接配置

redis_config 为 RedisConfig，环境变量前缀 DATABASE_REDIS_：

配置项	环境变量	类型	默认值	说明
`host`	`DATABASE_REDIS_HOST`	`str`	`""`	Redis 主机地址。
`port`	`DATABASE_REDIS_PORT`	`int`	`6379`	端口。
`username`	`DATABASE_REDIS_USERNAME`	`str \| None`	`None`	用户名，可选。
`password`	`DATABASE_REDIS_PASSWORD`	`str`	`""`	密码。
`db`	`DATABASE_REDIS_DB`	`int`	`0`	数据库编号。
`secret_token`	`DATABASE_REDIS_SECRET_TOKEN`	`str`	`""`	STS 临时凭证令牌，暂未启用。

embedding 配置

embedding_config 为 EmbeddingModelConfig，环境变量前缀 MODEL_EMBEDDING_：

配置项	环境变量	类型	默认值	说明
`name`	`MODEL_EMBEDDING_NAME`	`str`	`doubao-embedding-vision-250615`	embedding 模型名。
`dim`	`MODEL_EMBEDDING_DIM`	`int`	`2048`	embedding 向量维度，用于设置向量字段维度。
`api_base`	`MODEL_EMBEDDING_API_BASE`	`str`	`https://ark.cn-beijing.volces.com/api/v3/`	embedding 服务的 API 地址。
`api_key`	`MODEL_EMBEDDING_API_KEY`	`str`	依次回退到 `MODEL_AGENT_API_KEY` 或自动获取的 Ark 令牌	访问 embedding 服务的密钥。

环境变量配置

# Redis 连接
export DATABASE_REDIS_HOST="localhost"
export DATABASE_REDIS_PORT=6379
export DATABASE_REDIS_PASSWORD="your-password"
export DATABASE_REDIS_DB=0

# embedding 模型
export MODEL_EMBEDDING_NAME="doubao-embedding-vision-250615"
export MODEL_EMBEDDING_DIM=2048
export MODEL_EMBEDDING_API_KEY="your-ark-api-key"

向量字段维度取自 embedding 配置（MODEL_EMBEDDING_DIM）。Redis 实例必须启用 RediSearch 模块，否则无法创建向量索引。

概览

快速开始

核心组件

可观测

扩展

前端

安全

部署

何时使用

依赖

使用示例

参数

构造参数

Redis 连接配置

embedding 配置

环境变量配置

​何时使用

​依赖

​使用示例

​参数

​构造参数

​Redis 连接配置

​embedding 配置

​环境变量配置

何时使用

依赖

使用示例

参数

构造参数

Redis 连接配置

embedding 配置

环境变量配置