README.md を更新

This commit is contained in:
ntki72 2024-08-26 13:07:41 +00:00
parent 50fa972daf
commit bf349da0ea

View File

@ -1,27 +1,14 @@
# VoicePeak API Service
このプロジェクトは、VoicePeakを使用して音声を生成し、生成された音声データを提供するAPIサーバーです。
# VOICEPEAK API Service
VOICEPEAKを使用して音声を生成し、生成された音声データを提供するAPIサーバーです。
PythonのFlaskフレームワークを使用し、Ubuntu上で動作します。
## プロジェクト構成
```
/path/to/your/project
├── app.py
├── requirements.txt
├── venv/
└── voicepeak-api.service
```
## 前提条件
- Ubuntuがインストールされたシステム
- VoicePeakがホストOSにインストールされ、動作すること
- VOICEPEAKがインストールされ、動作すること
## セットアップ手順
### 1. リポジトリのクローン
リポジトリをクローンします。
```bash
git clone *******
git clone https://ntki-personal-web.access.ly/ntki72/voicepeak_api.git
```
### 2. Pythonの仮想環境を作成
@ -39,15 +26,14 @@ pip install -r requirements.txt
```
### 3. Systemdサービスの設定
`voicepeak-api.service`ファイルを適切な内容に編集します。
`_voicepeak-api.service`をコピーし`voicepeak-api.service`にリネームします。
`voicepeak-api.service`を開き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
@ -61,18 +47,14 @@ sudo systemctl start voicepeak-api.service
sudo systemctl enable voicepeak-api.service
```
### 5. 動作確認
### 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
```