Skip to content

Latest commit

 

History

History
211 lines (146 loc) · 7.43 KB

README.zh.md

File metadata and controls

211 lines (146 loc) · 7.43 KB
Raw

Raycast AI 代理

这是一个简单的 Raycast AIAPI代理。它允许您在不订阅的情况下使用 Raycast AI 应用。它是一个简单的代理，将raycast的请求转换格式转发到 OpenAI 的 API，响应后再实时转换格式返回。

English | 中文 | 日本語

介绍

本项目是通过使用中间人代理的方式，将raycast的请求转发到OpenAI的API，然后再将OpenAI的响应转发到raycast。

本项目主要mapping了以下几个接口：

  • GET /api/v1/me 修改用户支持AI功能的flag
  • POST /api/v1/translations 翻译接口
  • POST /api/v1/ai/chat_completions AI功能共同接口
  • GET /api/v1/ai/models AI模型列表接口

中间人代理的简单原理是，通过修改DNS，将raycast的请求的IP指向到本项目的地址，然后本项目再将请求转发到OpenAI的API，然后再将OpenAI的响应转发到raycast。但是raycast和raycast api之间使用的https，所以本项目需要提供自签名证书，并且让raycast信任这个证书。更多关于中间人代理的原理，可以参考mitmproxy

支持的模型

多个模型可以同时使用，只需设置相应的环境变量即可

模型provider 模型 测试状态 环境变量 图片生成
openai gpt-3.5-turbo,gpt-4-turbo, gpt-4o 已测试 OPENAI_API_KEY 已支持
azure openai 同上 已测试 AZURE_OPENAI_API_KEY, AZURE_DEPLOYMENT_ID, OPENAI_AZURE_ENDPOINT 已支持
google gemini-pro,gemini-1.5-pro 已测试 GOOGLE_API_KEY x
anthropic claude-3-sonnet, claude-3-opus, claude-3-5-opus 已测试 ANTHROPIC_API_KEY x

Ai chat

ai chat

Translate

translate

Image Generation

只有OpenAI API支持图片生成。

使用方法

安装和配置

1. 生成证书

pip3 install mitmproxy
python -c "$(curl -fsSL https://raw.githubusercontent.com/yufeikang/raycast_api_proxy/main/scripts/cert_gen.py)"  --domain backend.raycast.com  --out ./cert

或

clone 本仓库，然后运行

pdm run cert_gen

2. 将证书信任添加到系统钥匙链

打开 cert 文件夹中的 ca 证书，并将其添加到系统钥匙链并信任。 这是必须的，因为 Raycast AI 代理使用自签名证书，必须信任它才能正常工作。

注意：

在Apple Silicon的macOS上使用时，如果在手动向钥匙串访问添加CA证书时遇到应用程序挂起的问题，您可以在终端使用以下命令作为替代方法：

mitmproxy document

sudo security add-trusted-cert -d -p ssl -p basic -k /Library/Keychains/System.keychain ~/.mitmproxy/mitmproxy-ca-cert.pem

3. 修改 /etc/host 以添加以下行

127.0.0.1 backend.raycast.com
::1 backend.raycast.com

此修改的目的是为了把 backend.raycast.com 指定到本地，而不是真正的 backend.raycast.com。当然你也可以在你的dns server中添加这个记录。

当然，这里你也可以在你自己的dns server中添加这个记录。其终极目的是让 backend.raycast.com 指向到本项目的部署地址。 这里的127.0.0.1也可以替换为你的部署地址。如果你把这个项目部署到了云上，或者你的局域网中，你可以把这个地址指向到你的部署地址。

4. 启动服务

docker run --name raycast \
    -e OPENAI_API_KEY=$OPENAI_API_KEY \
    -p 443:443 \
    --dns 1.1.1.1 \
    -v $PWD/cert/:/data/cert \
    -e CERT_FILE=/data/cert/backend.raycast.com.cert.pem \
    -e CERT_KEY=/data/cert/backend.raycast.com.key.pem \
    -e LOG_LEVEL=INFO \
    -d \
    ghcr.io/yufeikang/raycast_api_proxy:main

你也可以把这个服务部署云服务上，或者局域网中，只要你的raycast可以访问到这个地址即可。

之后，重启 Raycast，然后就可以使用了。

高级配置

1. 使用 Azure OpenAI API

参考 How to switch between OpenAI and Azure OpenAI endpoints with Python

只需要修改相应的环境变量即可。

docker run --name raycast \
    -e OPENAI_API_KEY=$OPENAI_API_KEY \
    -e OPENAI_BASE_URL=https://your-resource.openai.azure.com \
    -e OPENAI_API_VERSION=2023-05-15 \
    -e OPENAI_API_TYPE=azure \
    -e AZURE_DEPLOYMENT_ID=your-deployment-id \
    -p 443:443 \
    --dns 1.1.1.1 \
    -v $PWD/cert/:/data/cert \
    -e CERT_FILE=/data/cert/backend.raycast.com.cert.pem \
    -e CERT_KEY=/data/cert/backend.raycast.com.key.pem \
    -e LOG_LEVEL=INFO \
    -d \
    ghcr.io/yufeikang/raycast_api_proxy:main

2. Google Gemini API

可同时和 OpenAI API 一起使用，只需设置相应的环境变量即可

获取你的 Google API Key 然后 export 为 GOOGLE_API_KEY.

# git clone this repo and cd to it
docker build -t raycast .
docker run --name raycast \
    -e GOOGLE_API_KEY=$GOOGLE_API_KEY \
    -p 443:443 \
    --dns 1.1.1.1 \
    -v $PWD/cert/:/data/cert \
    -e CERT_FILE=/data/cert/backend.raycast.com.cert.pem \
    -e CERT_KEY=/data/cert/backend.raycast.com.key.pem \
    -e LOG_LEVEL=INFO \
    -d \
    raycast:latest

3. 本地手动运行

  1. clone 本仓库
  2. 使用 pdm install 安装依赖项
  3. 创建环境变量
export OPENAI_API_KEY=<your openai api key>
  1. 使用 ./scripts/cert_gen.py --domain backend.raycast.com --out ./cert 生成自签名证书
  2. 用python ./app/main.py启动服务

4. 本地开发

因为你可能修改了本级的DNS，所以你在本地开发的时候，很可能导致DNS死循环。所以你可以在本地开发的时候，可以使用docker。然后通过指定dns的方式启动开发环境。

参考：

sh ./local_docker.sh

5. 使用custom mapping

你可以参考项目目录中的custom_mapping.yml.example文件，自定义修改一些接口的返回值。

"api/v1/me/trial_status":
  get:
    response:
      body:
        # json path replace
        "$.trial_limits.commands_limit": 30

例如上面的配置，将会把 GET api/v1/me/trial_status 接口的返回值中的 $.trial_limits.commands_limit 替换为 30。 其中 $.trial_limits.commands_limit 是一个 json path。

目前只支持response body的替换。

6. 多用户共享服务

如果你想要多个用户共享这个服务，或者你把服务部署在公网上，你需要限制哪些用户可以使用这个服务。你可以使用ALLOWED_USERS环境变量来限制哪些用户可以使用这个服务。

ALLOWED_USERS="[email protected],[email protected]"

email地址是raycast的用户email地址，多个用户之间用逗号分隔。

注意事项

  1. DNS指定 由于GFW的存在，如果你在中国大陆使用，你可能需要指定一个国内的DNS服务器，否则可能会出现无法解析域名的情况。 如： --dns 223.5.5.5

  2. DNS不生效 macOS上有时候会出现修改了/etc/hosts文件，但是DNS不生效的情况，目前没有找到解决办法，有时候重启raycast可以生效，有时候再次修改/etc/hosts文件可以生效。