README.md

XBrain

通过装饰器将函数接入OpenAI的Chat

📘详细文档|🎞️介绍视频|🗨English

🤔解决了什么问题

OpenAI的Funciton Call很有用，但每次都需要在 chat 接口中引用Json或者Pydantic Model，而XBrain只需要在Python函数上放一个装饰器，就能自动将函数接入到 chat 中。

📄文档

• 快速开始：新手上手指南，适合第一次接触的开发者
• 常见问题：你想知道的答案都在这里
• 开发者指南：欢迎加入我们

Quick Start

安装xbrain:

pip install pyxbrain

在你的项目目录下创建一个demo.py文件，写入以下代码：

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：

from demo import *

在项目入口处配置并运行xbrain，此时demo.py中的generate_tag函数被成功接入了xbrain中：

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 中提出你的想法和建议。具体操作可参考贡献指南。

强烈推荐阅读 《提问的智慧》、《如何向开源社区提问题》 和 《如何有效地报告 Bug》、《如何向开源项目提交无法解答的问题》，更好的问题更容易获得帮助。