Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
JustinHsu1019 authored Nov 13, 2024
1 parent c6c0374 commit c02d23e
Showing 1 changed file with 11 additions and 13 deletions.
24 changes: 11 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,40 +65,38 @@ To set up the development environment, follow these steps:
cp config_example.ini config.ini
```

4. Manually add your `secret key` to the `config.ini`.
```
[OpenAI] 的 api_key 可以在 openai 官網註冊取得
[VoyageAI] 的 api_key 可以在 voyageai 官網註冊取得
[Api_docs] 的 password 可以自己隨意輸入 (flask_app.py 啟動後,
直接訪問 http://127.0.0.1:5000/ 即可看到 swagger api_docs 頁面)
```
4. Manually add your `secret key` to the `config.ini`:

- [OpenAI] 的 api_key 可以在 openai 官網註冊取得
- [VoyageAI] 的 api_key 可以在 voyageai 官網註冊取得
- [Api_docs] 的 password 可以自己隨意輸入 (flask_app.py 啟動後,直接訪問 http://127.0.0.1:5000/ 即可看到 swagger api_docs 頁面)

5. Create a `logs` directory:
6. Create a `logs` directory:
```
mkdir logs
```

6. Navigate to the `docker` directory:
7. Navigate to the `docker` directory:
```
cd docker
```

7. Start the Docker environment (weaviate database):
8. Start the Docker environment (weaviate database):
```
docker-compose up -d
```

8. Data preprocessing:
9. Data preprocessing:
```
(TODO: 等 data 那邊處理好)
```

9. Data insert to weaviate:
10. Data insert to weaviate:
```
python3 Preprocess/insert_data.py
```

10. Run the Flask app (/ 是 API Docs, /api/chat/ 是我們的 Retrieval API):
11. Run the Flask app (/ 是 API Docs, /api/chat/ 是我們的 Retrieval API):
```
python3 Model/flask_app.py
```
Expand Down

0 comments on commit c02d23e

Please sign in to comment.