Skip to content

QUICKSTART.md

Latest commit

 

History

History
96 lines (69 loc) · 1.96 KB

QUICKSTART.md

File metadata and controls

96 lines (69 loc) · 1.96 KB

快速開始指南

三步驟啟動雅婷逐字稿管理系統

步驟 1：安裝 Python 依賴

cd stt_project/backend
pip install -r requirements.txt

步驟 2：設定 API Key

  1. 複製環境變數範本：
cd ..  # 回到 stt_project 目錄
cp .env.example .env
  1. 編輯 .env 檔案，填入您的雅婷 API Key：
nano .env

將 your_api_key_here 替換為您的實際 API Key：

YATING_API_KEY=您的API金鑰

步驟 3：啟動服務

使用啟動腳本（推薦）：

./start.sh

或手動啟動：

cd backend
python main.py

開始使用

開啟瀏覽器訪問：

http://localhost:8000

取得雅婷 API Key

  1. 前往 雅婷開發者平台
  2. 註冊或登入帳號
  3. 在控制台中建立新專案
  4. 複製產生的 API Key

功能概覽

上傳音檔

  • 支援拖放上傳或點擊選擇檔案
  • 支援格式：MP3, WAV, MOV, MP4

開始辨識

  • 點擊檔案列表中的「開始辨識」按鈕
  • 選擇模型（中英文/中台語）
  • 設定說話者數量（可自動偵測）
  • 可選擇啟用情緒分析

查看結果

  • 系統自動每 5 秒更新辨識狀態
  • 完成後可下載 TXT 或 CSV 格式
  • 點擊「查看」可在網頁上查看完整逐字稿

常見問題

Q: 上傳失敗怎麼辦？

A: 檢查 API Key 是否正確設定在 .env 檔案中。

Q: 辨識一直顯示「處理中」？

A: 這是正常的，根據音檔長度，辨識可能需要數分鐘。系統會自動更新狀態。

Q: 檔案過期了怎麼辦？

A: 雅婷 API 的檔案和結果會在 24 小時後自動過期，請重新上傳檔案。

Q: 可以同時辨識多個檔案嗎？

A: 可以，但雅婷 API 限制最多同時 3 個辨識任務。

系統需求

  • Python 3.8+
  • 網路連線（需要連接雅婷 API）
  • 現代瀏覽器（Chrome, Firefox, Safari, Edge）

下一步

查看完整說明文件：README.md