https://github.com/yuruotong1/xbrain
通过装饰器将函数接入OpenAI的Chat
https://github.com/yuruotong1/xbrain
agent ai aigc autogen autogpt dify langchain
Last synced: 2 months ago
JSON representation
通过装饰器将函数接入OpenAI的Chat
- Host: GitHub
- URL: https://github.com/yuruotong1/xbrain
- Owner: yuruotong1
- Created: 2024-10-09T04:13:23.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2025-03-09T14:06:19.000Z (3 months ago)
- Last Synced: 2025-03-15T09:37:00.485Z (3 months ago)
- Topics: agent, ai, aigc, autogen, autogpt, dify, langchain
- Language: Python
- Homepage:
- Size: 7.69 MB
- Stars: 43
- Watchers: 2
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## 🤔解决了什么问题
OpenAI的Funciton Call很有用，但每次都需要在 chat 接口中引用Json或者Pydantic Model，而XBrain只需要在Python函数上放一个装饰器，就能自动将函数接入到 chat 中。
## 📄文档
- [快速开始：新手上手指南，适合第一次接触的开发者](https://xbrain.notion.site/xbrain-11d42182d0a98003b272d5555c6e9448)
- [常见问题：你想知道的答案都在这里](https://xbrain.notion.site/b274c33d808a4ddea32244c3fd41719c)
- [开发者指南：欢迎加入我们](https://xbrain.notion.site/12842182d0a9803bb5dcdbfe71826915?pvs=4)
## Quick Start
安装xbrain:
`pip install pyxbrain`
在你的项目目录下创建一个`demo.py`文件，写入以下代码：
```python
from pydantic import BaseModel
from xbrain.core import xbrain_tool
class GenerateTag(BaseModel):
"""创建一个新的插件"""
pass
@xbrain_tool.Tool(model=GenerateTag)
def generate_tag():
print("hello")
```
在`__init__.py`文件中导入`demo.py`：
```python
from demo import *
```
在项目入口处配置并运行xbrain，此时`demo.py`中的`generate_tag`函数被成功接入了xbrain中：
```python
from xbrain.core.chat import run
from xbrain.utils.config import Config
config = Config()
config.set_openai_config(base_url="https://api.openai-next.com/v1", api_key="xxxxx", model="gpt-4o-2024-08-06")
messages = []
messages.append({"role": "user", "content": "配置tag"})
res = run(messages, user_prompt="从文章中提炼出关键信息")
```
## 🤝 如何贡献
你可以通过 Fork 项目、提交 PR 或在 Issue 中提出你的想法和建议。具体操作可参考[贡献指南](https://xbrain.notion.site/12842182d0a9803bb5dcdbfe71826915)。
> 强烈推荐阅读 [《提问的智慧》](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way)、[《如何向开源社区提问题》](https://github.com/seajs/seajs/issues/545) 和 [《如何有效地报告 Bug》](http://www.chiark.greenend.org.uk/%7Esgtatham/bugs-cn.html)、[《如何向开源项目提交无法解答的问题》](https://zhuanlan.zhihu.com/p/25795393)，更好的问题更容易获得帮助。
