open assistant api

公開助理API

開箱即用的AI智能助手API

英語| 簡體中文| 日本語

介紹

Open Assistant API是一個開源的，自託管的AI智能助理API，與官方的OpenAI界面兼容。它可以直接與官方OpenAI客戶端一起構建LLM應用程序。

它支持一個API與更多的商業和私人模型集成。

它支持R2R抹布發動機。

用法

以下是使用官方Openai Python openai圖書館的一個示例：

 import openai

client = openai . OpenAI (
    base_url = "http://127.0.0.1:8086/api/v1" ,
    api_key = "xxx"
)

assistant = client . beta . assistants . create (
    name = "demo" ,
    instructions = "You are a helpful assistant." ,
    model = "gpt-4-1106-preview"
)

為什麼選擇開放助理API

特徵	公開助理API	Openai Assistant API
生態系統策略	開源	封閉的來源
抹布引擎	支持R2R	支持
互聯網搜索	支持	不支持
自定義功能	支持	支持
內置工具	可擴展	不可擴展
代碼解釋器	正在開發	支持
多模式	支持	支持
LLM支持	支持更多的LLM	只有GPT
消息流輸出	支持	支持
本地部署	支持	不支持

• LLM支持：與官方的OpenAI版本相比，可以通過與一個API集成來支持更多模型。
• 工具：目前支持在線搜索；可以輕鬆擴展更多工具。
• 抹布引擎：當前支持的文件類型是TXT，HTML，Markdown，PDF，DOCX，PPTX，XLSX，PNG，PNG，MP3，MP4等。我們提供了初步實現。
• 消息流輸出：支持消息流輸出，以提供更順暢的用戶體驗。
• 生態系統策略：開源，您可以在本地部署服務並擴展現有功能。

快速開始

啟動開放助手API的最簡單方法是運行Docker-compose.yml文件。在運行之前，請確保在計算機上安裝Docker和Docker Compose。

配置

轉到項目根目錄，Open docker-compose.yml ，填寫OpenAI API_KEY和BING SEARCH鍵（可選）。

 # openai api_key (supports OneAPI api_key)
OPENAI_API_KEY= < openai_api_key >

# bing search key (optional)
BING_SUBSCRIPTION_KEY= < bing_subscription_key >

建議配置R2R RAG引擎以替換默認的RAG實現，以提供更好的RAG功能。您可以通過R2R GITHUB存儲庫來了解並使用R2R。

 # RAG config
# FILE_SERVICE_MODULE=app.services.file.impl.oss_file.OSSFileService
FILE_SERVICE_MODULE=app.services.file.impl.r2r_file.R2RFileService
R2R_BASE_URL=http:// < r2r_api_address >
R2R_USERNAME= < r2r_username >
R2R_PASSWORD= < r2r_password >

跑步

與Docker合作運行：

docker compose up -d

訪問API

API基礎網址：http：//127.0.0.1:8086/api/v1

接口文檔地址：http：//127.0.0.1:8086/docs

完整的用法示例

在此示例中，使用官方的OpenAI客戶端庫創建並運行AI助手。如果您需要探索其他用法方法，例如流量輸出，工具（Web_search，檢索，功能）等，則可以在示例目錄中找到相應的代碼。在運行之前，您需要運行pip install openai來安裝Python openai庫。

 # !pip install openai
export PYTHONPATH= $( pwd )
python examples/run_assistant.py

權限

根據令牌提供簡單的用戶隔離，以滿足SaaS部署要求。可以通過配置APP_AUTH_ENABLE來啟用它。

1. 身份驗證方法是承載令牌。您可以在標題中包含Authorization: Bearer ***以進行身份​​驗證。
2. 代幣管理在API文檔的令牌部分中進行了描述。需要用管理令牌對相關的API進行身份驗證，該令牌被配置為APP_AUTH_ADMIN_TOKEN ，默認為“ Admin”。
3. 創建令牌時，您需要提供大型模型的基本URL和API鍵。創建的助手將使用相應的配置訪問大型模型。

工具

根據OpenAPI/Swagger規範，它允許將各種工具集成到助手中，賦予和增強其與外部世界建立聯繫的能力。

1. 促進將您的應用程序與其他系統或服務連接起來，從而與外部環境（例如代碼執行或訪問專有信息源）進行交互。
2. 在使用過程中，您需要先創建工具，然後可以將其與助手集成。請參閱測試用例以獲取更多細節。
3. 如果您需要使用帶有身份驗證信息的工具，請在運行時添加身份驗證信息。特定參數格式可以在API文檔中找到。有關更多詳細信息，請參閱測試用例。運行Auth Action

社區和支持

• 加入Slack頻道，查看新的版本，討論問題並參與社區互動。

• 加入Discord頻道與其他社區成員互動。

• 加入微信組：

  

特別感謝

我們主要提到並依靠以下項目：

• OpenOpenai：在節點中實現的助理API
• 一個API：多模型管理工具
• R2R：抹布引擎
• Openai-Python：Openai Python客戶
• OpenAI API：OpenAI界面定義
• Langchain：LLM應用程序開發庫
• OpenGPTS：Langchain GPTS
• Taskingai：Taskingai客戶端SDK

貢獻

請閱讀我們的貢獻文件，以了解如何貢獻。

開源許可證

該存儲庫遵循MIT開源許可證。有關更多信息，請參閱許可證文件。