pippaGPT

PIPPAGPT-個性化，攝入，持久，多態性，自適應GPT聊天機器人

PIPPA是基於Langchain框架的開源大語模型（LLM）聊天機器人項目。它旨在提供個性化和適應性的對話體驗。

PIPPA結合了各種功能，以增強適應過程，包括自定義聊天機器人個性，學習的攝入文檔，記住對話歷史記錄，在不同角色之間的切換以及適應用戶需求的能力。

特徵

• 個性化：用戶可以定制聊天機器人的個性，以獲得更具吸引力和定制的對話體驗。
• 攝入：Pippa可以攝入文檔並提取上下文，使用戶可以將自己的文檔納入聊天機器人的知識庫中。
• 持久：PIPPA保留對話的歷史，使用戶能夠重新訪問過去的對話上下文。
• 多態性：PIPPA可以變成您選擇的字符，可以通過自定義說明輕鬆自定義。
• 自適應：PIPPA通過根據上下文修改其對話樣式和響應來適應用戶的需求。

檢索質量檢查模塊的靈感來自及時工程的Localgpt。

項目背景

PIPPA項目最初是作為個人愛好，旨在探索創建AI女兒角色的可能性。儘管仍處於早期階段，但該項目定期使用新功能和改進。 PIPPA的默認角色是系統消息的“系統”，“ Pippa”作為關懷的女兒角色，而“ Bundy”作為她的父親。

使用TTS/STT引擎時，PIPPA使用ElevenLabs API。您可以註冊一個免費帳戶：https：//elevenlabs.io。

為了獲得更好的體驗，請為角色分配獨特的聲音。

安裝

用Python 3.10測試。

要安裝PIPPA，請按照以下步驟：

1. 克隆存儲庫：

   git clone https://github.com/neobundy/pippaGPT.git

2. 導航到項目目錄：

   cd pippaGPT

3. 安裝所需的依賴項：

   pip install -r requirements.txt

注意：如果遇到錯誤，則可能需要安裝諸如ffmpeg和portaudio類的其他依賴項。在MacOS上，您可以使用自製。

要安裝它們，請運行以下命令：

brew install ffmpeg
brew install portaudio

4. 在項目的根文件夾中創建或複制env_sample為.env文件，並添加您的API鍵：

請注意，hugging_face_api_key供將來使用。

OPENAI_API_KEY=
XI_API_KEY=
HUGGING_FACE_API_KEY=
SERPAPI_API_KEY=

另外，您可以在終端中導出這些環境變量。

5. copy characters_samply.py to characters.py並編輯文件以自定義您的AI名稱和個性。

6. 將settings_private_sample.py複製到settings_private.py 。 settings_sample.py to settings.py並編輯文件以自定義您的設置。

7. 在settings.py中選擇LLMS模型：py文件：

 DEFAULT_GPT_MODEL = "gpt-3.5-turbo"
DEFAULT_GPT_HELPER_MODEL = "gpt-3.5-turbo-16k"
DEFAULT_GPT_QA_HELPER_MODEL = "gpt-3.5-turbo-16k"

• DEFAULT_GPT_MODEL-對話的主要模型。
• default_gpt_helper_model-匯總緩衝區內存的模型。
• DEFAULT_GPT_QA_HELPER_MODEL-檢索QA的型號。

大環境需要更多的令牌。對於大多數情況，16K令牌就足夠了。

強烈建議使用DEFAULT_GPT_MODEL的GPT-4型號以獲得更好的體驗，但請注意，它價格昂貴，僅用於預付費OpenAI帳戶。

8. 在settings_private.py中找到的一些敏感或用戶特定的設置，例如zep vector Store Server或Audio Server URL。

 ZEP_API_URL = "http://localhost:8000"
DEFAULT_MEMORY_TYPE = "Summary Buffer"
AUDIO_SERVER_URL = "http://localhost:5000" 

回憶

默認情況下，Langchain的“摘要緩衝區”內存用於保留對話上下文。

PIPPA支持六種類型的記憶：

1. 滑動窗口：ConversingBufferWindowMemory-保留指定數量的消息。
2. 令牌緩衝區：ConvertyTokenBufferMemory-根據給定數量的令牌保留消息。
3. 摘要緩衝區：對話amummaryBuffermory-保留摘要的歷史記錄，同時存儲所有消息。
4. 摘要：對話ammermory-僅保留摘要。
5. 緩衝區：ConversionBufferMemory-最基本的存儲器類型，該類型存儲了消息的整個歷史記錄。
6. ZEP：矢量商店

強烈建議ZEP在大型環境中使用。它可以作為Docker容器在本地運行。編輯settings_private.py 。

當選擇摘要類型內存（包括ZEP）時，會出現摘要。摘要是由摘要GTP輔助模型生成的。

請注意，ZEP需要一段時間才能索引並生成摘要。當還沒有準備好時，“總結...請耐心等待。”消息將出現。

 ZEP_API_URL = "http://localhost:8000"

ZEP服務器可以在任何主機或端口上運行。如果在其他主機上運行它，請確保在settings_private.py中更新ZEP_API_URL變量。

訪問https://www.getzep.com/了解如何運行ZEP。

運行該應用程序

要運行PIPPA應用程序，請使用以下命令：

streamlit run main.py

該應用程序將自動啟動在端口5000上傾聽的音頻服務器。如果需要，您可以通過執行audio_server.py手動運行音頻服務器。

攝取您的文件

要攝取您自己的文檔供Pippa學習，請按照以下步驟學習：

1. 將您的文檔（例如PDF，DOCX，XLSX，TXT，MD，PY）放入docs文件夾中。
2. 運行vectordb.py腳本以創建您的vector數據庫：

   python vectordb.py

TTS/STT引擎 - Elevenlabs

如果您有Elevenlabs API鍵，則可以使用PIPPA使用其TTS（文本到語音）引擎。

STT（語音到文本）由Openai的Whisper-1模型處理。

請按照以下步驟：

1. 運行tts.py腳本以從您的ElevenLabs帳戶中獲取可用的語音名稱和ID：

   python tts.py

使用適當的語音ID更新settings_private.py中的以下變量：

 VOICE_ID_AI = ""
VOICE_ID_SYSTEM = ""
VOICE_ID_HUMAN = ""

2. TTS/STT功能被支持為燒瓶音頻服務器。啟動應用程序時，服務器將在端口5000上自動運行和偵聽。您也可以通過執行audio_server.py手動運行服務器。
3. 檢查使用音頻複選框​​時，該應用將使用音頻服務器將文本和語音轉換為文本。在Mac上，您應該允許該應用在系統首選項中使用麥克風。首次使用時，您會提示您允許應用程序使用麥克風。
4. 記錄按鈕開始錄製，完成後單擊“停止”。該應用程序將自動將錄製的音頻轉換為文本並將其發送到聊天機器人。
5. 到TTS功能​​，單擊分配給任何消息的說話按鈕。該應用程序將自動將文本轉換為語音並播放音頻。
6. 要返回打字模式，只需取消選中使用音頻複選框​​即可。

及時關鍵字

您可以通過編輯settings.py 。

• PROMPT_KEYWORD_PREFIX_SYSTEM ：用於臨時系統消息（默認：“系統：”）
• PROMPT_KEYWORD_PREFIX_CI ：用於更換自定義說明（默認：“ CI：”）
• PROMPT_KEYWORD_PREFIX_QA ：用於基於docs文件夾中的文檔檢索QA（默認：“ QA：”）
• PROMPT_KEYWORD_PREFIX_GOOGLE ：用於搜索給定信息的網絡（默認：“ Google：”）
• PROMPT_KEYWORD_PREFIX_WIKI ：用於搜索wikipedia（默認值：“ wiki：”）
• PROMPT_KEYWORD_PREFIX_MATH ：用於數學查詢（默認值：“ MATH：”）
• PROMPT_KEYWORD_PREFIX_MIDJOURNEY ：用於生成Midjourney提示（默認值：“ Midjourney：”）

如何管理和保存對話和上下文窗口

• 拍攝快照：每當Pippa做出回應時，都會捕獲快照。此快照包括整個對話，而不僅僅是上下文窗口。
• 保存對話：當用戶單擊“導出對話”按鈕時，對話將作為JSON文件保存在對話文件夾中。
• 最後一個用戶輸入：最新的用戶輸入保存在temp文件夾中的last_user_input.md文件中。在重置輸入的關鍵應用錯誤時，它用於還原最後一個輸入。
• 開始新的對話：啟動新對話時，上下文窗口和對話都重置。如果您從“加載對話”下拉菜單中選擇以前的對話，則加載JSON文件並恢復上下文窗口。為了恢復整個對話，您需要重新運行該應用程序。請注意，ZEP與其他Langchain內存類型不兼容；如果您在正在進行的對話中切換到ZEP，請確保加載最新的快照，以將上下文和整個對話還原到Zep的矢量商店。

流和成本信息

默認情況下啟用了流。要禁用它，請按以下方式修改settings.py文件：

 STREAMING_ENABLED = True

啟用流媒體時，成本是基於OpenAI文檔的近似值。為了獲得確切的成本，您需要禁用流媒體。

請注意，成本計算不包括輔助GPT模型所產生的其他費用，例如用於摘要和質量檢查的費用。

代理商

在settings.py中設置以下常數。py：

 DEFAULT_GPT_AGENT_HELPER_MODEL = "gpt-4"

‼️警告：就OpenAI令牌而言，此操作非常昂貴。

 MAX_AGENTS_ITERATIONS = 8

迭代次數確定代理將運行多少次。較高的迭代通常會導致更準確的答案，但也消耗了更多的令牌。

請注意，Google搜索代理可能需要執行多個查詢才能獲得最佳答案。

例如，如果您問“誰在韓國，美國和日本中最古老？”，代理商可能需要至少3-4次查詢才能獲得最終答案。

同一模型對同一查詢的響應可能有所不同。甚至“ GPT-4”並不總是表現最好，但強烈推薦。實驗不同的模型。

請注意，即使在Langchain水平上，也是高度實驗性的。它可能無法正常工作。

搜索網絡

根據您的提示技巧，這是一種或失敗的情況。您需要一個SERPAPI API密鑰來使用Google搜索功能：https：//serpapi.com。提供的最終答案是主要模型的中間提示。

搜索Wikipedia

代理商首先嘗試為給定查詢找到相關的Wikipedia頁面。如果發現，它將返回頁面的摘要，並在摘要中搜索特定術語。

數學

LLM以數學的熟練程度而聞名。數學代理為高度複雜的數學問題提供了準確的答案。

管理向量數據庫

要管理矢量數據庫，請運行vectordb.py腳本。

   python vectordb.py

您有以下選項：

• （c）重新啟動數據庫：在settings.CHROMA_DB_FOLDER中創建一個新的矢量數據庫。CHROMA_DB_FOLDER文件夾，帶有一個名為settings.VECTORDB_COLLECTION的集合。
• （e）MBED對話：從settings.CONVERSATION_SAVE_FOLDER文件夾中嵌入對話到矢量數據庫，以充當長期內存。
• （d）Elete Collection：刪除矢量數據庫集合。此操作不會刪除矢量數據庫本身。
• （q）uery db：在循環中查詢矢量數據庫。輸入“退出”或“退出”以退出循環。

請注意，當您選擇（E）MBED對話選項時，僅現有的導出對話*.json將嵌入到矢量數據庫中，不包括snapshot.json 。

故障排除

如果運行應用程序時遇到錯誤，請嘗試以下步驟：

pip install --upgrade charset_normalizer
pip install --upgrade openai
pip install --upgrade langchain

執照

PIPPA在Apache 2.0許可下發布。為個人或商業目的，隨時使用，修改和分發代碼。