OpenAI Sublime Text 插件技术文档

OpenAI Sublime Text 插件技术文档

OpenAI-sublime-text Sublime Text OpenAI completion plugin with GPT-4 support! 项目地址: https://gitcode.com/gh_mirrors/op/OpenAI-sublime-text

安装指南

系统要求

• Sublime Text 4
• llama.cpp 或 ollama 已安装，或者
• 远程LLM服务提供商的API密钥，例如 OpenAI

安装步骤

1. 如果你还没有安装Sublime Text的Package Control插件，请先安装。
2. 打开命令面板，输入 Package Control: Install Package。
3. 输入 OpenAI 并按 Enter。

项目使用说明

AI辅助使用案例

1. 选择一些文本或整个标签页以包含在请求中。
2. 运行 OpenAI: Chat Model Select 或 OpenAI: Chat Model Select With Tabs 命令。
3. 在输入窗口中输入请求（如果有）。
4. 模型将在输出面板中打印响应，默认情况下，但你可以在单独的标签页中切换显示 OpenAI: Open in Tab。
5. 要获取现有聊天的新窗口，请运行 OpenAI: Refresh Chat。
6. 要重置历史记录，请运行 OpenAI: Reset Chat History 命令。

聊天历史管理

你可以通过将以下代码片段附加到项目设置中，为给定项目分离聊天历史记录和助手设置：

{   
    "settings": {
        "ai_assistant": {
            "cache_prefix": "your_name_project"
        }
    }
}

额外请求上下文管理

你可以在请求中添加以下内容：

• 单个文件中的多行选择
• 单个视图组中的多个文件

缓冲区LLM使用案例

1. 你可以选择以下模式之一：append、replace、insert。它们非常直观。它们应在助手设置中设置以生效。
2. 选择一些文本（否则它们是无用的）以进行操作，并点击 OpenAI: New Message。
3. 插件将相应地响应，追加、替换或插入一些文本。

项目API使用文档

开源模型支持（llama.cpp, ollama）

1. 将给定模型的 "url" 设置替换为指向你服务器运行的任何主机（例如 "http://localhost:8080"）。
2. [可选] 如果提供商需要，请提供 "token"。
3. 将 "chat_model" 调整为你的选择模型，你就设置好了。

设置

OpenAI Completion插件有一个设置文件，你可以在其中设置你的OpenAI API密钥。大多数提供商需要此密钥才能工作。要设置你的API密钥，请在 Preferences -> Package Settings -> OpenAI -> Settings 中打开设置，并将你的API密钥粘贴到token属性中，如下所示：

{
    "token": "sk-your-token",
}

键绑定

你可以在 Preferences -> Package Settings -> OpenAI -> Key Bindings 中为给定插件命令绑定键。例如，你可以像这样绑定“New Message”命令：

{
    "keys": [ "super+k", "super+'" ],
    "command": "openai",
    "args": { "mode": "chat_completion" }
},

代理支持

你可以通过在 OpenAI completion 设置中覆盖代理属性来设置它，如下所示：

"proxy": {
    "address": "127.0.0.1", // 必需
    "port": 9898, // 必需
    "username": "account",
    "password": "sOmEpAsSwOrD"
}

项目安装方式

通过Package Control安装

1. 安装Sublime Text的Package Control插件。
2. 打开命令面板，输入 Package Control: Install Package。
3. 输入 OpenAI 并按 Enter。

手动安装

1. 克隆或下载项目代码。
2. 将代码放入Sublime Text的Packages目录中。
3. 重启Sublime Text。

其他功能

多Markdown语法与语法高亮支持

它直接工作。

警告与注意事项

• 所有选定的代码将被发送到OpenAI服务器（如果不使用自定义API提供商）进行处理，因此请确保你有所有必要的权限。
• 这是一个纯魔法，我发誓！

OpenAI-sublime-text Sublime Text OpenAI completion plugin with GPT-4 support! 项目地址: https://gitcode.com/gh_mirrors/op/OpenAI-sublime-text