openai assistant

一個 NestJS 庫，用於使用 OpenAI Assistant API（聊天機器人）建立高效、可擴展且快速的解決方案。
在 15 分鐘內啟動您的 AI Assistant 開發

人工智慧助手

介紹 NestJS 庫。無論您是建立虛擬助手，還是建立具有吸引力的使用者體驗的互動式聊天機器人，我們的程式庫都可以讓您輕鬆利用尖端的人工智慧功能。

該庫提供了現成的 API 端點來處理您的助手和 WebSocket 伺服器，以實現客戶端和助手之間的即時通訊。安裝庫並貼上配置以使其運行。

觀看教學課程

影片 - 15 分鐘內的 AI 助手

特徵

AI助理庫功能

• 函數呼叫：建立函數，以便助手可以執行您的自訂邏輯！
• TTS（文字轉語音） ：將文字轉換為語音，這樣您就可以聽到助手的聲音！
• STT（語音轉文本） ：將語音轉換為文本，讓對話更輕鬆！
• 文件支援：為助手添加文件，這樣您就可以使用自訂資料擴充助手的知識庫！
• WebSockets ：建立WebSocket伺服器，用於客戶端和助理之間的即時通訊！
• REST API ：只需使用現成的 REST API 即可與助理通訊！
• 使用 GPT-4o 進行視覺- 使用 GPT-4o 使您的助手理解圖像並根據圖像生成文字！

儲存庫中的附加功能

該存儲庫包含一個庫，但也提供其他功能。您只需克隆存儲庫並立即使用它即可獲得所有功能：

• 嵌入式聊天機器人：透過JavaScript腳本將聊天機器人嵌入到各種網站上！
• 聊天機器人客戶端應用程式：將現成的客戶端應用程式（SPA）與聊天機器人一起使用！

？入門

在本節中，您將學習如何將 AI Assistant 庫整合到您的 NestJS 應用程式中。以下步驟將引導您完成設定庫和建立簡單功能的過程。

第 0 步：先決條件

• Node.js（ ^20.0.0版本）
• npm（ ^10.0.0版本）
• NestJS（ ^10.0.0版）
• OpenAI（ ^4.51.0版本）
• OpenAI API 金鑰

開啟或建立您想要整合 AI 助理的 NestJS 應用程式。要建立新的 NestJS 應用程序，請使用以下命令：

nest new project-name

現在您必須安裝軟體包。轉到下一步。

第1步：安裝

確保您位於專案的根目錄中。使用 npm 安裝庫和openai套件：

npm i @boldare/openai-assistant openai --save

該庫已安裝，但我們必須對其進行配置。轉到下一步。

第 2 步：環境變數

設定環境變量，在專案根目錄的.env檔案中建立環境變量，並使用必要的機密填充它。助理 ID 是可選的，用作您的助理的唯一識別碼。當沒有設定環境變數時，會自動建立助手。您可以使用助手ID連接現有的助手，建立助手後可以在OpenAI平台中找到該助手。

在專案的根目錄中建立一個.env文件，並使用必要的機密填充它：

touch .env

將以下內容新增至.env檔案：

 # OpenAI API Key
OPENAI_API_KEY =

# Assistant ID - leave it empty if you don't have an assistant to reuse
ASSISTANT_ID =

請注意， .env檔案不應提交到儲存庫。將.env檔案加入.gitignore檔案中以防止其被提交。

這是運行該庫所需的第一步。下一步是配置助手。

第三步：配置

該程式庫提供了一種使用AssistantModule.forRoot方法配置助手的方法。此方法採用配置物件作為參數。建立一個新的設定文件，如範例設定檔 (chat.config.ts) 所示，並填入必要的配置。

 // chat.config.ts file
import { AssistantConfigParams } from '@boldare/openai-assistant' ;
import { AssistantCreateParams } from 'openai/resources/beta' ;

// Default OpenAI configuration
export const assistantParams : AssistantCreateParams = {
  name : 'Your assistant name' ,
  instructions : `You are a chatbot assistant. Speak briefly and clearly.` ,
  tools : [ { type : 'file_search' } ] ,
  model : 'gpt-4-turbo' ,
  temperature : 0.05 ,
} ;

// Additional configuration for our assistant
export const assistantConfig : AssistantConfigParams = {
  id : process . env [ 'ASSISTANT_ID' ] ,
  params : assistantParams ,
  filesDir : './apps/api/src/app/knowledge' ,
  toolResources : {
    file_search : {
      // Provide files if you use file_search tool
      fileNames : [ 'example1.txt' , 'example2.txt' ] ,
    } ,
  } ,
} ;

有關配置的更多詳細資訊可以在 wiki 中找到。

這一步是做什麼用的？

從現在開始，您可以運行應用程式並呼叫助手。

第四步：函數調用

函數呼叫可讓您透過自訂邏輯擴展助手的功能。如果您不打算使用函數調用，您可以跳至：步驟 5：測試。

建立一個擴展AgentBase類別的新服務，填入定義並實作output方法。

• output方法是助手呼叫函數時將呼叫的主要方法。
• definition屬性是一個描述函數及其參數的對象，以便助手可以了解如何呼叫它。

關於函數呼叫的更多信息，可以參考OpenAI文件。

建立函數的說明可以在 wiki 中找到，而範例可以在代理目錄中找到。

這一步是做什麼用的？

如果您已經定義了函數和輸出方法，現在可以透過要求助手執行函數定義中所述的操作來從助手呼叫它。

第 5 步：運行應用程式並測試

運行您的應用程序，這將允許您測試助手。

 # use this if you are using the repository:
npm run start:dev

# if you are using your own NestJS application, please check the npm scripts in the package.json file
# defualt command for NestJS is:
npm run start

然後就可以測試助手了。

1. 首先，您需要建立一個線程。您可以透過向/assistant/threads端點傳送 POST 請求（主體中包含空物件）來建立一個。
2. 然後，您可以透過向/assistant/chat端點發送具有以下正文的 POST 請求來向助手發送訊息：

{
  "threadId" : " your-thread-id " ,
  "content" : " Hello, how are you? "
}

3. 助理將回覆一則訊息。您可以透過向/assistant/chat端點發送 POST 請求（其正文與步驟 2 相同）來向助手發送更多訊息。

恭喜！您已成功將 AI Assistant 庫整合到您的 NestJS 應用程式中。 ？

？你被困住了嗎？

有關如何使用儲存庫中的所有應用程式和庫運行演示的完整文件可以在 wiki 中找到。

Boldare 的工程師隨時為您提供協助。如果您對實施有任何疑問或需要協助，請隨時與我們的工程師預約通話。

詳細了解Boldare 如何協助您進行 AI 開發。

您也可以在 GitHub 討論部分提問。

貢獻

您想看看圖書館的新功能嗎？

• 您可以自由地為該專案做出貢獻！只需使用您的變更建立一個拉取請求即可。
• 與我們的工程師討論您的想法。
• 您也可以在這裡發布您的想法。

執照

@boldare/openai-assistant並且此儲存庫已獲得 MIT 許可