LCIPA (LangChain Intelligent Personal Assistant)

一款使用LangChain和Streamlit构建的综合性个人智能助手， 本项目将助手分为普通版本和PLUS版本。

普通版本： 在原有OpenAI聊天机器人的基础之上增加了以下功能：

• 使用LangChain的Callback功能，结合streamlit可以显示机器人的思考过程，如下图所示：

• 增加了 GoogleSearch 和 Wikipedia 搜索功能，一种机器人只能使用一类Agent, 所以这里选择了搜索功能的Agent来保证机器人具有即时性，如果需要一个机器人具有多个Agent功能， 可以使用PLUS版本的机器人。

PLUS版本： 该版本的机器人依赖于 LangGraph 在上面普通版本的基础之上进行了以下修改：

• 由于LangGraph与LangChain中的Runnable调用起来有些区别，所以他对Callback貌似并不支持， 这就导致了原先的可以展示思考过程的可视化将无法使用，这里采用了自己实现的可视化展示， 界面并不优美但可以体现机器人的思考过程， 如下所示：

• 使用Multi-Agents，同一个机器人可以使用多个Agent进行协作，达到如上图所示， 将网络搜索功能和Gmail联系起来。

具体的技术实现和更多信息请参考技术文档， 该项目仅用于本科顺利毕业，并无什么含金量，仅提供一个思路...

使用方法

❗极为重要的一步❗

LangChain项目依赖很多api,本项目也不例外，如果要正确运行请查看 ‘config_example’ 目录 下面的配置文件， 将 config_example 目录重命名为 config，然后修改好配置文件，这里也说明一下配置文件都是什么， 以及如何进行修改。

目录树：

.
├── credentials.json    // gmail邮箱的权限文件，具体信息请看LangChain中的Gmail部分
├── config.ini          // 一些配置文件，不算太重要，想修改也可以修改一下
├── .env                // 所有的API token，OpenAI的等等。。。
├── passwd.yaml         // streamlit-authenticator所使用的登陆密码文件（这个项目也用了一个简单登陆管理）
└── token.json          // gmail权限申请之后自动生成的一个token文件，生成方法可以点开这个文件看看

本地运行

本项目使用 poetry 作为项目管理工具，需要提前安装好，具体安装过程请自行STFW

# 安装项目依赖
poetry install

# 切换至poetry环境
poetry shell

# 运行
streamlit run main.py

docker运行

(TODO: 还未完成)

使用虽然docker相关文件已经准备好了,但是使用docker部署会出现watchdog报错, 可能需要将streamlit降级使用,如果需要使用docker进行部署,可以把pyproject.toml中的streamlit版本降低一些. 没有测试过可能还是会有问题.

⚠️ 注意

有关Gmail认证

首先需要查看一下LangChain官方关于Gmail的实例, 里面有介绍如何认证.

在本项目中,按照官方示例的办法获取到了credentials.json之后,可以运行examples/LangChain_Gmail.ipynb中的代码, 成功运行之后会跳转到一个google认证界面,完成认证后会在example目录中创建一个token.json文件,将这个文件拷贝到config目录中即可.

有关OpenAI API

上文提到的两个聊天机器人只需要使用gpt-3.5-turbo就行了,但是需要使用直连api key,也就是需要官方api,在锅内搞官方api还是成本很高的， 推荐去某宝上买一个，搜索api key就可以了，openai这6个字母是不会在某宝上出现的 hh..

上述问题的原因是在使用锅内中转api时，使用create_openai_tools_agent这个函数创建出来的agent，在运行过程中会出现数据验证的问题， 本人并不知道如何解决这个bug，为了方便本人就直接使用了直连api。 但是👇这个项目又要用到gpt-4才能完美运行，好消息是下面这个项目使用中转api可以运行，折中之后，使用两个api, 一个直连的，一个中转的，然后用两个环境变量来保证项目的每个部分都能运行，详情见下文。

本机器人还把gpt_research 缝了进来,这个项目需要使用gpt4的API才能比较稳定的运行,如果在郭内使用中转的API的话,需要配置两个额外的支持gpt4的API的环境变量:

OPENAI_API_KEY_CN=sk-xxx
OPENAI_API_BASE_CN=https://xxx

把上述两个环境变量放到config/.env里面即可.

有关docs/BYLW目录

仅供参考

话说回来，这个项目只是一个用于混毕业的项目，本人将论文放在了这个目录中，有一些涉及个人信息的效果图已经被删除了，不过完全可以复现出来。

论文题目从原来的“聊天机器人”变成了“个人智能助手”，项目的名字就不改了，其实都差不多。。 （好吧，最后项目名字还是改了一下，还是用助手吧，前文中有很多内容还是使用的“聊天机器人做为称呼”，懒得改了都差不多） 论文的内容大多数都来自某乎，但查重复写率貌似只有个位数。

参考

本项目中的部分代码参考自下面的仓库(前两者为官方示例仓库)：

streamlit-agent

langgraph/examples

gpt_research