Tianji

环境要求

• Python 环境（项目为 Python 项目，需可执行 python3 / pip）
• 能够访问 pip 源，用于执行 pip install -e .
• 可用的 ZhipuAI 与 Siliconflow（OpenAI 兼容）API Key
• 可选：Hugging Face Token（下载受限模型时需要）
• 可选：Tavily API Key（使用 Agent 网络搜索工具时需要）

安装与启动步骤

1. 1获取项目代码

   从 GitHub 克隆 Tianji 仓库并进入项目根目录，后续所有命令都在项目根目录执行。

   git clone https://github.com/SocialAI-tianji/Tianji.git
   cd Tianji

   复制

2. 2安装项目依赖

   在项目根目录执行可编辑安装，README 明确说明该指令即可完成项目安装。

   pip install -e .

   复制

3. 3配置 API 密钥

   在项目内新建 .env 文件，填入 ZhipuAI 与 Siliconflow 的密钥；Prompt demo 用 ZhipuAI，RAG 与 Agent demo 用 Siliconflow。

   OPENAI_API_KEY=sk-xxxxxxxx
   ZHIPUAI_API_KEY=xxxxxxxxxxxxxxxx

   复制

4. 4配置可选变量

   若 Hugging Face 下载慢可设 HF_ENDPOINT 镜像；受限模型需 HF_TOKEN；Agent 联网搜索需 TAVILY_API_KEY。

   HF_HOME='temp/huggingface_cache/'
   HF_ENDPOINT='https://hf-mirror.com'
   HF_TOKEN=xxxxxxxx
   TAVILY_API_KEY=tvly-xxxxxxxx

   复制

5. 5运行 Prompt 前端

   启动 Prompt 版 WebUI 前端，确认 .env 已创建后再执行，默认调用 ZhipuAI。

   python3 run/tianji_prompt_webui.py

   复制

6. 6运行 Agent 前端

   用 streamlit 启动 Metagpt 智能体前端，需要已填写 Siliconflow 与（可选）Tavily 密钥。

   streamlit run run/metagpt_webui.py

   复制

7. 7运行 RAG 示例

   启动基于 LangChain 的在线 LLM 知识库问答示例，默认走 Siliconflow 在线模型。

   python run/demo_rag_langchain_onlinellm.py

   复制

8. 8配置提交检查(可选)

   参与开发贡献时安装 pre-commit，commit 阶段会自动修正格式问题。

   pip install pre-commit
   pre-commit install

   复制

关键配置

如何确认成功

执行 python3 run/tianji_prompt_webui.py 后前端正常启动并可在页面提问并获得回答，即表示安装与密钥配置成功。

常见问题

注意事项

• 所有命令需在项目根目录执行，且运行前必须先在项目内新建 .env 文件。
• 密钥属于敏感信息，不要提交到 Git 仓库或公开分享。
• README 中的 Agent 链接标注为修复中，相关功能可能暂时不可用。
• 模型微调、数据制造等进阶内容需参考文档站与仓库子目录，本文仅覆盖 README 给出的安装与运行方式。