# 自定義服務商

Cherry Studio 唔單止整合咗主流嘅 AI 模型服務，仲畀咗您強大嘅自訂能力。透過 **自訂 AI 服務商** 功能，您可以輕鬆接入任何您需要嘅 AI 模型。

## 點解需要自訂 AI 服務商？

* **彈性：** 唔再受限於預設嘅服務商列表，可以自由揀最啱您需求嘅 AI 模型。
* **多樣性：** 試用唔同平台嘅 AI 模型，發掘佢哋獨特嘅優勢。
* **可控性：** 直接管理您嘅 API 密鑰同訪問地址，確保安全同私隱。
* **定制化：** 接入私有化部署嘅模型，滿足特定業務場景嘅需求。

## 點樣添加自訂 AI 服務商？

只需要簡單幾步，就可以喺 Cherry Studio 入面添加您嘅自訂 AI 服務商：

<figure><img src="/files/7dd770b0b148035a42945ac895722bf509b1542d" alt=""><figcaption></figcaption></figure>

1. **打開設定：** 喺 Cherry Studio 介面左側導覽欄中，點擊「設定」（齒輪圖示）。
2. **進入模型服務：** 喺設定頁面中，選擇「模型服務」分頁。
3. **新增提供商：** 喺「模型服務」頁面入面，您會見到已有嘅服務商列表。撳列表下方嘅「+ 添加」按鈕，打開「添加提供商」彈窗。
4. **填寫資訊：** 喺彈窗入面，您需要填寫以下資訊：
   * **提供商名稱：** 為您嘅自訂服務商改一個容易識別嘅名稱（例如：MyCustomOpenAI）。
   * **提供商類型：** 喺下拉列表入面揀您嘅服務商類型。目前支援：
     * OpenAI
     * Gemini
     * Anthropic
     * Azure OpenAI
5. **儲存配置：** 填寫完成之後，撳「添加」按鈕儲存您嘅配置。

## 配置自訂 AI 服務商

<figure><img src="/files/cb5d7b086185154b9a1c075efb604bf7e5b0254b" alt=""><figcaption></figcaption></figure>

添加完成之後，您需要喺列表入面搵返您啱啱添加嘅服務商，並進行詳細配置：

1. **啟用狀態** 自訂服務商列表最右邊有一個啟用開關，撳開代表啟用呢個自訂服務。
2. **API 密鑰：**
   * 填寫您嘅 AI 服務商提供嘅 API 密鑰（API Key）。
   * 撳右邊嘅「檢查」按鈕，可以驗證密鑰嘅有效性。
3. **API 地址：**
   * 填寫 AI 服務嘅 API 訪問地址（Base URL）。
   * 請務必參考您嘅 AI 服務商提供嘅官方文檔，攞到正確嘅 API 地址。
4. **模型管理：**

   * 撳「+ 添加」按鈕，手動添加呢個提供商底下您想用嘅模型 ID。例如 `gpt-3.5-turbo`、`gemini-pro` 等等。

   <figure><img src="/files/60b380d9d0605006ad5021e39c551d9f3a7f878a" alt=""><figcaption></figcaption></figure>

   * 如果您唔確定具體嘅模型名稱，請參考您嘅 AI 服務商提供嘅官方文檔。
   * 撳「管理」按鈕，可以對已經添加嘅模型進行編輯或者刪除。

## 開始使用

完成以上配置之後，您就可以喺 Cherry Studio 嘅聊天界面入面，選擇您自訂嘅 AI 服務商同模型，開始同 AI 對話喇！

## 用 vLLM 做自訂 AI 服務商

vLLM 係一個類似 Ollama 嘅快速而且易用嘅 LLM 推理庫。以下係點樣將 vLLM 整合入 Cherry Studio 嘅步驟：

1. **安裝 vLLM：** 按照 vLLM 官方文檔（<https://docs.vllm.ai/en/latest/getting_started/quickstart.html>）安裝 vLLM。

   ```sh
   pip install vllm # 如果你使用 pip
   uv pip install vllm # 如果你使用 uv
   ```
2. **啟動 vLLM 服務：** 使用 vLLM 提供嘅 OpenAI 相容接口啟動服務。主要有兩種方式，分別如下：

   * 使用`vllm.entrypoints.openai.api_server`啟動

   ```sh
   python -m vllm.entrypoints.openai.api_server --model gpt2
   ```

   * 使用`uvicorn`啟動

   ```sh
   vllm --model gpt2 --served-model-name gpt2
   ```

確保服務成功啟動，並且監聽喺預設端口 `8000` 上。 當然， 您亦都可以透過參數`--port`指定 vLLM 服務嘅端口號。

3. **喺 Cherry Studio 入面添加 vLLM 服務商：**
   * 按照前面描述嘅步驟，喺 Cherry Studio 入面添加一個新嘅自訂 AI 服務商。
   * **提供商名稱：** `vLLM`
   * **提供商類型：** 選擇 `OpenAI`。
4. **配置 vLLM 服務商：**
   * **API 密鑰：** 因為 vLLM 唔需要 API 密鑰，可以將呢個欄位留空，或者填任何內容。
   * **API 地址：** 填寫 vLLM 服務嘅 API 地址。預設情況下，地址為： `http://localhost:8000/`（如果用咗唔同嘅端口，請相應修改）。
   * **模型管理：** 添加您喺 vLLM 入面載入嘅模型名稱。喺上面運行`python -m vllm.entrypoints.openai.api_server --model gpt2`嘅例子中，應該喺呢度填入`gpt2`
5. **開始對話：** 而家，您可以喺 Cherry Studio 入面揀 vLLM 服務商同 `gpt2` 模型，開始同 vLLM 驅動嘅 LLM 對話喇！

## 提示同技巧

* **仔細閱讀文檔：** 喺添加自訂服務商之前，請務必仔細閱讀您所使用嘅 AI 服務商官方文檔，了解 API 密鑰、訪問地址、模型名稱等關鍵資訊。
* **檢查 API 密鑰：** 用「檢查」按鈕可以快速驗證 API 密鑰嘅有效性，避免因為密鑰錯誤導致無法使用。
* **留意 API 地址：** 唔同嘅 AI 服務商同模型，API 地址可能會唔同，請務必填寫正確嘅地址。
* **模型按需要添加:** 請只添加您實際上會用到嘅模型，避免添加太多冇用嘅模型.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.cherry-ai.com/docs/zhong-wen-fan-ti/pre-basic/providers/zi-ding-yi-fu-wu-shang.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
