Report.ai
1.0.0
目錄
概述
特徵
儲存庫結構
模組
入門
安裝
運行報告.ai
快速入門
路線圖
貢獻
執照
致謝
在 Report.ai，我們的使命很明確：為您提供強大的人工智慧驅動的報告體驗。我們已經超越了傳統的基於文本長度的分割的限制，選擇了一種更聰明的方法——語義分割。這種創新方法可確保以無與倫比的精度識別內容中的整體主題和細微差別。的內容。
Report.ai 不依賴文字長度，而是根據報告的含義對報告進行分段。這樣可以更準確地分解內容，增強您對材料的理解。
我們的報告不僅僅是文字表述。每個語義區塊都與互動式文字記錄一起呈現，使您可以無縫導航和引用原始音訊片段。
我們將客製化的力量交給您。使用我們的可自訂範本輕鬆自訂您的分析，使您能夠提取對您重要的見解。
無論您是使用 YouTube 連結、WAV 格式的音訊檔案還是 TXT 格式的文字轉錄，我們都能滿足您的需求。 Report.ai無縫處理各種多媒體輸入，讓您的體驗全面、便利。
對於尋求建立專業資料庫的人來說，我們的儲存庫提供了與 Pinecone 和 Chroma 的無縫整合。這些先進的工具提供卓越的資料管理和檢索功能，提高您的報告工作的價值。
└── 自述文件/
├── .env
├── VAD.py
├── 除法.py
├── 例子/
│ ├── WATCH_LIVE_Nvidia_Q2_Earnings_Call_NVDA
│ └── 批次.txt
├── main.py
├── 需求.txt
├── s2t_whisper.py
├── 儲存向量.py
├── 總結.py
├── 模板/
│ ├── 一般.txt
│ └── 個體.txt
└── utils.py| 文件 | 概括 |
|---|---|
| 要求.txt | 提供對於程式碼正常運作至關重要的基本依賴項清單。 |
| .env | .env檔案用作與各種 API 相關的配置設定的儲存庫，包括來自 OpenAI、Azure OpenAI 和 Pinecone 的配置設定。在此文件中，您將找到 API 金鑰、型號名稱和儲存配置等基本資訊。 |
| 實用程式.py | 在utils.py檔案中，您將發現一系列全面的實用程式函數。這些函數用途廣泛，涵蓋各種基本任務，包括： fuzzy_match：用於執行模糊字串匹配。 validate_filetype：確保檔案類型驗證。 detector_language：偵測文字檔案的語言。 get_items：從模板檔案中提取項目。 add_hyperlink：在Word文件中新增超連結。 split_audio：將音訊檔案分割成片段。 get_file_list：檢索檔案路徑清單。 |
| 總結.py | summarize.py腳本專門用於根據 template/general.txt 和 template/individual.txt 中找到的範本產生摘要。如果需要，可以翻譯這些摘要，然後將其轉換為 Microsoft Word 文件格式 (.docx)。在整個過程中，文件中包含了超連結和其他上下文詳細資訊。 |
| s2t_whisper.py | s2t_whisper.py提供下載 YouTube 影片、提取音訊、消除靜音、將語音轉換為帶有時間戳的文字以及為中文內容添加標點符號的功能。產生的文字以 JSON 和 TXT 格式儲存。 |
| VAD.py | VAD.py用於從音訊檔案中提取人聲。它將音訊分成 10 分鐘的區塊，將每個區塊匯出為單獨的文件，並使用 Spleeter 庫提取人聲。然後將提取的聲音組合成一個音訊檔案。 |
| 除法.py | divide.py的作用是根據文章的文字記錄將其劃分為子主題。類別有幾個私有方法： _string_cleaner清理輸入字串， _get_timestamp_list從 JSON 檔案中提取時間戳， _add_timestamp將時間戳新增到子主題， _add_transcript將記錄新增到子主題中， _divide_by_subtopics使用語言模型將文章分割為區塊。 |
| 主要.py | main.py是一個多功能腳本，專為文件分析和摘要生成而設計。它透過接受各種命令列參數提供了廣泛的靈活性，包括： File Path ：指定要分析的檔案。 Chunk Size ：允許您定義文字段的大小。 Temperature of Language Model ：微調語言模型的行為。 Batch Mode ：使您能夠指示腳本是否應以批次模式執行。 Report Generation ：提供建立報告的選項。 Vector Database Selection ：允許您在 Pinecone 和 Chroma 向量資料庫之間進行選擇。 ASR (Automatic Speech Recognition) Model ：用於選擇要使用的適當的 ASR 模型。 |
| 儲存向量.py | storage_vector.py腳本提供了兩個基本函數：pinecone_storage 和 chroma_storage，這兩個函數都旨在促進向量資料庫中結果的儲存。 |
| 文件 | 概括 |
|---|---|
| 個人.txt | individuel.txt的內容提供了每個子主題中分析的項目。 |
| 一般.txt | general.txt的內容提供了在整個記錄中分析的項目。 |
| 文件 | 概括 |
|---|---|
| 批次.txt | batch.txt文件，用於方便處理多個文件。它透過列出檔案路徑（用逗號分隔）來指示要按順序處理哪些多個檔案來實現此目的。 |
| WATCH_LIVE_Nvidia_Q2_Earnings_Call_NVDA.txt | WATCH_LIVE_Nvidia_Q2_Earnings_Call_NVDA.txt包含 NVIDIA 2023 年第二季財務業績和問答網路廣播的文字記錄。 |
| 短旗 | 長旗 | 描述 | 類型 | 地位 |
|---|---|---|---|---|
| -o | --輸出目錄 | 設定報告的輸出目錄，預設為./docx | 細繩 | 選項 |
| -c | --區塊 | 設定分析塊大小。建議（GPT-3.5：en 為 10000，zh 為 2000，GPT-4：en 為 18000，zh 為 3600），預設值為 2000 | 細繩 | 選項 |
| -t | - 溫度 | 在0到2範圍內調整LLM的溫度，溫度越高創造力越強，預設為0.1 | 漂浮 | 選項 |
| -e | - 提煉 | 是否從音訊中提取人聲（不支援帶有蘋果晶片的 Mac），預設為 False | 布林值 | 選項 |
| -b | - 批 | 如果輸入文字檔案包含多個檔案路徑，則使用“True”，預設值為 False | 布林值 | 選項 |
| -v | --向量資料庫 | 選擇向量資料庫（松果烯或色度），預設為無 | 細繩 | 選項 |
| - 米 | - 模型 | 選擇耳語模型（'tiny'、'base'、'small'、'medium'、'large-v2'），預設為medium | 細繩 | 選項 |
依賴關係
請確保您的系統上安裝了以下依賴項：
- Aanaconda or Miniconda
- python >=3.7, <=3.9 (Apple silicon python >= 3.8, <=3.9)
- pytorch
克隆 Report.ai 儲存庫：
git 克隆 https://github.com/Shou-Hsu/Report.ai.git
切換到專案目錄：
cd 報告.ai
安裝康達：
透過 https://docs.conda.io/projects/miniconda/en/latest/miniconda-install.html 安裝 minicode
建立虛擬環境：
conda create -n Report.ai python=3.9
啟動虛擬環境：
conda 啟動 Report.ai
安裝pytorch：
透過 https://pytorch.org/get-started/locally/ 安裝 pytorch
安裝 ffmpeg 和 libsndfile：
conda 安裝-c conda-forge ffmpeg libsndfile
安裝依賴項：
pip install -r 要求.txt
（僅限 Mac）更新依賴項：
pip安裝-U numba
python main.py <檔案路徑> -c 10000
在 .env 檔案中設定 Openai 或 Azure openai 憑證。此外，如果旨在將資料儲存在 VectorDB 中，請設定 Pinecone 或 Chroma 的憑證。
# 選擇 gpt 模型提供者 Azure 或 OpenAI 之一# Azure openAI 憑證AZURE_OPENAI_API_KEY= AZURE_OPENAI_API_BASE= AZURE_OPENAI_API_VERSION= AZURE_OPENAI_API_TYPE= AZURE_DEPLOYMENT_NAME= EMBEDDING_DEPLOYMENT_NAME= #僅當您使用 Azure OpenAI# # OpenAI 憑證OPENAI_API_KEY= MODEL_NAME=# # pinecone 憑證（選項）PINECONE_API_KEY= PINECONE_ENV=# ChromaDB（選項）PERSIST_DIR= COLLCTION_NAME=
修改tempelete/general.txt和tempelete/individuel.txt（分析項目以「,」分隔）
#例如，如果您要分析「財報電話會議」：您可以在tempelete/中設定「主題、摘要、CFO對短期財務狀況的解釋、CEO對公司前景的描述、市場關注的問題」一般.txt
同時在tempelete/individuel.txt中設定「摘要、投資洞察、關鍵字」#如果您要建立「例行會議」的簡要摘要：您可以在tempelete/中設定「主題、摘要、專題工作」一般.txt
同時在tempelete/individuel.txt中設定“摘要、操作項目、關鍵字”在命令列中運行 Report.ai
python main.py 範例/WATCH_LIVE_Nvidia_Q2_Earnings_Call_NVDA.txt -c 10000
Publish project as a Python library via PyPI for easy installation.
Make project available as a Docker image on Docker Hub.
討論
在這裡加入討論。
新一期
在此報告錯誤或請求功能。
貢獻指南
麻省理工學院。
Langchain、OpenAI、Pinecone、Chroma、Spleter
返回
