oai

OAI- OpenAI助理界面

您的系统上的chatgpt

目录

• 为什么OAI
• 示例用法
• 安装
• 配置
• CLI用法
  • 全球访问
  • 命令
• 向量存储
• 工具
  • 可用工具
  • 如何添加工具？
• 调试

为什么OAI

Openai Assistant API处理代理，对话历史记录，矢量存储和运行工具，这些工具需要大量的样板代码才能设置。

我们使用OAI的目标是提供一个简单而直观的界面来与此API进行交互。

当前版本提供了一个CLI接口，但将来会有更多。

示例用法

• 与托管矢量商店与最新文档聊天
• 通过利用工具询问有关您的代码库的问题
• 要求您的助手将代码直接写入文件
• 让您的助手管理和访问您的系统
• 配置和测试助手的另一集成
• 无论您想到什么

只需从命令行运行oai即可交互

安装

OAI当前依赖BUN，并且需要在系统上安装它才能运行该项目。

以后的版本可以允许使用node运行时，但是目前仅支持bun 。

git clone [email protected]:pAIrprogio/gpt-assistant-cli-playground.git
bun install

配置

• 在OpenAI平台上创建一个项目
• 创建一个API键
• 使用OPENAI_API_KEY=your-key将OpenAI API键添加到.env文件中

CLI用法

全球访问

要在全球安装您的助手并使用oai命令访问它，请在项目文件夹中运行bun link 。

对项目进行的任何更改都将反映在Global命令中，而无需任何额外的构建步骤。

命令

• oai或oai chat ：与助手开始聊天
• oai a|assistant ：管理您的助手
  • oai a ls|list ：列表可用助手
  • oai a add|create|new ：创建新助手
  • oai a rm|remove|delete ：删除助手
  • oai ae|edit ：编辑助手
• oai vs|vector-store ：管理您的矢量商店
  • oai vs ls|list ：列表可用矢量商店
  • oai vs add|create|new ：创建一个新的向量存储
  • oai vs rm|remove|delete ：删除矢量存储
  • oai vs e|edit ：编辑矢量商店
  • oai vs sync ：同步托管向量存储

向量存储

启用file search的助手使用矢量存储，以动态获取相关信息。 OAI帮助您管理自定义同步。

• 站点地图同步：从站点地图获取URL，并将每个页面同步到矢量存储
• 页面URL同步：从页面获取URL，并将每个URL同步到矢量存储
• 还有更多

设置后，请确保运行oai vs sync以同步您的矢量存储。

工具

可用工具

• LS：git意识到文件列表
• 阅读文件：阅读文件
• 写文件：写信给文件，如果需要，创建目录
• 附加到文件：附加到现有文件
• 提交：提交当前分支的更改
• Create-Dir：如果需要，请与父母创建一个目录
• 执行命令：执行命令（配x不会要求确认）
• get-url-content：获取URL的内容
• 文件 - 差：读取文件的当前差异

如何添加工具？

按照文档/添加new-tool.md中的步骤

调试

由于BUN-VSCODE中的问题，您需要通过外部调试器进行检查。

要调试项目，请在项目文件夹中运行bun debug 。