voicepeak_api/README.md

79 lines
2.2 KiB
Markdown
Raw Normal View History

2024-08-03 11:12:30 +00:00
# VoicePeak API Service
このプロジェクトは、VoicePeakを使用して音声を生成し、生成された音声データを提供するAPIサーバーです。
PythonのFlaskフレームワークを使用し、Ubuntu上で動作します。
## プロジェクト構成
```
/path/to/your/project
├── app.py
├── requirements.txt
├── venv/
└── voicepeak-api.service
```
## 前提条件
- Ubuntuがインストールされたシステム
- VoicePeakがホストOSにインストールされ、動作すること
## セットアップ手順
### 1. リポジトリのクローン
リポジトリをクローンします。
```bash
git clone *******
```
### 2. Pythonの仮想環境を作成
仮想環境を作成し、必要なパッケージをインストールします。
```bash
# 仮想環境の作成
python3 -m venv venv
# 仮想環境のアクティベート
source venv/bin/activate
# 必要なパッケージのインストール
pip install -r requirements.txt
```
### 3. Systemdサービスの設定
`voicepeak-api.service`ファイルを適切な内容に編集します。
`voicepeak-api.service`ファイルをシステムのsystemdサービスディレクトリにシンボリックリンクを作成します。
```bash
sudo ln -s /path/to/your/project/voicepeak-api.service /etc/systemd/system/voicepeak-api.service
```
### 4. サービスのリロードと起動
systemdに新しいサービスを認識させ、サービスを起動します。
```bash
# systemdデーモンのリロード
sudo systemctl daemon-reload
# サービスの開始
sudo systemctl start voicepeak-api.service
# サービスの有効化(再起動後も自動で起動するようにする)
sudo systemctl enable voicepeak-api.service
```
### 5. 動作確認
サービスが正常に起動しているか確認します。
```bash
sudo systemctl status voicepeak-api.service
```
## 使用方法
サービスが正常に起動している場合、以下のようにリクエストを送信して音声を生成できます。
```bash
curl -X POST http://127.0.0.1:5000/generate_voice -H "Content-Type: application/json" -d '{"text": "こんにちは"}' --output output.wav
```