Commit ·
1bc8544
1
Parent(s): 33529b2
docs: add Python environment setup step with version compatibility note
Browse filesPython 3.14+ is not supported due to ChromaDB/Pydantic compatibility.
Recommend conda with Python 3.12; support 3.11--3.13.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
README.md
CHANGED
|
@@ -101,7 +101,18 @@ If you don't have `git`, download the ZIP file from GitHub and unzip it. Then op
|
|
| 101 |
cd path/to/chatbotsample_api
|
| 102 |
```
|
| 103 |
|
| 104 |
-
### 2.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 105 |
|
| 106 |
```bash
|
| 107 |
pip install -r requirements.txt
|
|
@@ -111,7 +122,7 @@ This installs all the libraries the chatbot needs (AI providers, document reader
|
|
| 111 |
|
| 112 |
> **Tip:** If `pip` doesn't work, try `pip3` instead. On some systems, Python 3 uses `pip3`.
|
| 113 |
|
| 114 |
-
###
|
| 115 |
|
| 116 |
```bash
|
| 117 |
python setup.py
|
|
@@ -132,7 +143,7 @@ The wizard creates two files:
|
|
| 132 |
- `config.yaml` -- your chatbot's settings
|
| 133 |
- `.env` -- your API key (kept private, never uploaded to GitHub)
|
| 134 |
|
| 135 |
-
###
|
| 136 |
|
| 137 |
Copy your research files into the `knowledge_base/` folder. You can organize them into subfolders:
|
| 138 |
|
|
@@ -148,7 +159,7 @@ knowledge_base/
|
|
| 148 |
notes.txt
|
| 149 |
```
|
| 150 |
|
| 151 |
-
###
|
| 152 |
|
| 153 |
```bash
|
| 154 |
python ingest.py
|
|
@@ -171,7 +182,7 @@ Processing: NAVCO 2.0/NAVCO2JPRcodebook2013.pdf
|
|
| 171 |
Ingestion complete: 89 chunks from 5 files.
|
| 172 |
```
|
| 173 |
|
| 174 |
-
###
|
| 175 |
|
| 176 |
**Terminal interface** (recommended for getting started):
|
| 177 |
|
|
|
|
| 101 |
cd path/to/chatbotsample_api
|
| 102 |
```
|
| 103 |
|
| 104 |
+
### 2. Set up a Python environment
|
| 105 |
+
|
| 106 |
+
We recommend using a conda environment with **Python 3.12** (the most widely compatible version). Python 3.14+ is **not supported** due to dependency compatibility issues.
|
| 107 |
+
|
| 108 |
+
```bash
|
| 109 |
+
conda create -n chatbot python=3.12 -y
|
| 110 |
+
conda activate chatbot
|
| 111 |
+
```
|
| 112 |
+
|
| 113 |
+
If you don't use conda, any Python 3.11--3.13 installation will work.
|
| 114 |
+
|
| 115 |
+
### 3. Install dependencies
|
| 116 |
|
| 117 |
```bash
|
| 118 |
pip install -r requirements.txt
|
|
|
|
| 122 |
|
| 123 |
> **Tip:** If `pip` doesn't work, try `pip3` instead. On some systems, Python 3 uses `pip3`.
|
| 124 |
|
| 125 |
+
### 4. Run the setup wizard
|
| 126 |
|
| 127 |
```bash
|
| 128 |
python setup.py
|
|
|
|
| 143 |
- `config.yaml` -- your chatbot's settings
|
| 144 |
- `.env` -- your API key (kept private, never uploaded to GitHub)
|
| 145 |
|
| 146 |
+
### 5. Add your documents
|
| 147 |
|
| 148 |
Copy your research files into the `knowledge_base/` folder. You can organize them into subfolders:
|
| 149 |
|
|
|
|
| 159 |
notes.txt
|
| 160 |
```
|
| 161 |
|
| 162 |
+
### 6. Ingest (index) your documents
|
| 163 |
|
| 164 |
```bash
|
| 165 |
python ingest.py
|
|
|
|
| 182 |
Ingestion complete: 89 chunks from 5 files.
|
| 183 |
```
|
| 184 |
|
| 185 |
+
### 7. Start the chatbot
|
| 186 |
|
| 187 |
**Terminal interface** (recommended for getting started):
|
| 188 |
|