Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
local 后端使用 LlamaIndex 的内存向量索引存储知识。知识文本先经 embedding 模型向量化，再写入进程内的向量索引，检索时按相似度召回。它无需任何外部服务，是 KnowledgeBase 的默认后端，最适合本地调试与快速验证。
pip install "veadk-python[extensions]"
from veadk import Agent
from veadk.knowledgebase import KnowledgeBase
kb = KnowledgeBase(backend="local", index="company_faq")
kb.add_from_text("公司的标准年假为每年 15 天，入职满一年起享受。")
agent = Agent(
name="demo",
instruction="回答用户问题，必要时用 `load_knowledgebase` 工具检索知识库。",
knowledgebase=kb,
)
backend_config 显式传入 embedding 配置：
from veadk.knowledgebase import KnowledgeBase
from veadk.configs.model_configs import EmbeddingModelConfig
kb = KnowledgeBase(
backend="local",
index="company_faq",
backend_config={
"index": "company_faq",
"embedding_config": EmbeddingModelConfig(
name="doubao-embedding-vision-250615",
dim=2048,
),
},
)
backend_config 支持以下配置项：
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
index | str | 无默认，由 KnowledgeBase 传入 | 知识库索引名。本地后端对命名无额外限制。 |
embedding_config | EmbeddingModelConfig | 自动从 MODEL_EMBEDDING_* 环境变量读取 | 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 服务的密钥。 |
# embedding 模型
export MODEL_EMBEDDING_NAME="doubao-embedding-vision-250615"
export MODEL_EMBEDDING_DIM=2048
export MODEL_EMBEDDING_API_KEY="your-ark-api-key"