Spaces:
Running
Running
Ayona commited on
Commit ·
4e70645
1
Parent(s): 4c6d96a
docs: reorganize markdown files into docs/; add docs index
Browse files- HELP.md +1 -1
- README.md +6 -7
- docs/README.md +39 -0
- BATCH_TESTING_README.md → docs/batch/BATCH_TESTING_README.md +0 -0
- CHANGES.md → docs/changelog/CHANGES.md +0 -0
- dataset_README.md → docs/data/dataset_README.md +0 -0
- DEPLOYMENT_HF.md → docs/deployment/hf/DEPLOYMENT_HF.md +0 -0
- HF_DEPLOYMENT_CHECKLIST.md → docs/deployment/hf/HF_DEPLOYMENT_CHECKLIST.md +0 -0
- HF_DEPLOYMENT_SUMMARY.md → docs/deployment/hf/HF_DEPLOYMENT_SUMMARY.md +0 -0
- HF_SPACE_SETUP.md → docs/deployment/hf/HF_SPACE_SETUP.md +0 -0
- README_HF.md → docs/deployment/hf/README_HF.md +0 -0
- IMPLEMENTATION_SUMMARY.md → docs/legacy/IMPLEMENTATION_SUMMARY.md +2 -2
- GEMINI_EMBEDDINGS.md → docs/models/gemini/GEMINI_EMBEDDINGS.md +0 -0
- CHANGELOG_GPT5_2.md → docs/models/openai/CHANGELOG_GPT5_2.md +0 -0
- GPT5_2_INTEGRATION.md → docs/models/openai/GPT5_2_INTEGRATION.md +0 -0
- GPT5_2_QUICKSTART.md → docs/models/openai/GPT5_2_QUICKSTART.md +0 -0
- GPT5_2_SUMMARY.md → docs/models/openai/GPT5_2_SUMMARY.md +0 -0
- API_KEYS_OPTIONAL.md → docs/ops/API_KEYS_OPTIONAL.md +1 -1
- CONFIGURATION_CLEANUP.md → docs/ops/CONFIGURATION_CLEANUP.md +0 -0
- TODO.md → docs/ops/TODO.md +1 -1
HELP.md
CHANGED
|
@@ -536,5 +536,5 @@ A: Поки що ні - дочекайтеся завершення або он
|
|
| 536 |
|
| 537 |
Для додаткової інформації дивіться:
|
| 538 |
- [README.md](README.md) - технічна документація
|
| 539 |
-
- [BATCH_TESTING_README.md](BATCH_TESTING_README.md) - детально про пакетне тестування
|
| 540 |
- [PROMPT_EDITING.md](docs/PROMPT_EDITING.md) - глибоке занурення у промпти
|
|
|
|
| 536 |
|
| 537 |
Для додаткової інформації дивіться:
|
| 538 |
- [README.md](README.md) - технічна документація
|
| 539 |
+
- [docs/batch/BATCH_TESTING_README.md](docs/batch/BATCH_TESTING_README.md) - детально про пакетне тестування
|
| 540 |
- [PROMPT_EDITING.md](docs/PROMPT_EDITING.md) - глибоке занурення у промпти
|
README.md
CHANGED
|
@@ -79,7 +79,7 @@ python_version: "3.11"
|
|
| 79 |
- Налаштування деталізації відповідей
|
| 80 |
- Конфіденційність: опція не зберігати запити
|
| 81 |
|
| 82 |
-
📖 [Детальна документація GPT-5.2](GPT5_2_INTEGRATION.md) | [Швидкий старт](GPT5_2_QUICKSTART.md)
|
| 83 |
|
| 84 |
## 📋 Структура проекту
|
| 85 |
|
|
@@ -111,9 +111,8 @@ Legal_Position_2/
|
|
| 111 |
│
|
| 112 |
├── test_results/ # Результати пакетного тестування
|
| 113 |
│
|
| 114 |
-
├──
|
| 115 |
-
|
| 116 |
-
└── CHANGES.md # Детальний changelog
|
| 117 |
```
|
| 118 |
|
| 119 |
## 🛠️ Встановлення
|
|
@@ -208,7 +207,7 @@ python main.py
|
|
| 208 |
|
| 209 |
**Формат результатів:** Повний JSON об'єкт з полями `title`, `text`, `proceeding`, `category`
|
| 210 |
|
| 211 |
-
Детальна інструкція: [BATCH_TESTING_README.md](BATCH_TESTING_README.md)
|
| 212 |
|
| 213 |
### 📖 Допомога
|
| 214 |
|
|
@@ -370,10 +369,10 @@ gunicorn main:app --workers 4 --bind 0.0.0.0:7860
|
|
| 370 |
## 📚 Документація
|
| 371 |
|
| 372 |
- **[HELP.md](HELP.md)** - Загальна допомога для користувачів (доступна в додатку)
|
| 373 |
-
- **[BATCH_TESTING_README.md](BATCH_TESTING_README.md)** - Документація пакетного тестування
|
| 374 |
- **[PROMPT_EDITING.md](docs/PROMPT_EDITING.md)** - Повна технічна документація з редагування промптів
|
| 375 |
- **[QUICK_START_PROMPTS.md](docs/QUICK_START_PROMPTS.md)** - Швидкий старт для користувачів
|
| 376 |
-
- **[CHANGES.md](CHANGES.md)** - Детальний changelog
|
| 377 |
|
| 378 |
## 🔧 Troubleshooting
|
| 379 |
|
|
|
|
| 79 |
- Налаштування деталізації відповідей
|
| 80 |
- Конфіденційність: опція не зберігати запити
|
| 81 |
|
| 82 |
+
📖 [Детальна документація GPT-5.2](docs/models/openai/GPT5_2_INTEGRATION.md) | [Швидкий старт](docs/models/openai/GPT5_2_QUICKSTART.md)
|
| 83 |
|
| 84 |
## 📋 Структура проекту
|
| 85 |
|
|
|
|
| 111 |
│
|
| 112 |
├── test_results/ # Результати пакетного тестування
|
| 113 |
│
|
| 114 |
+
├── HELP.md # Загальна допомога для користувачів (використовується інтерфейсом)
|
| 115 |
+
└── docs/ # Документація (див. docs/README.md)
|
|
|
|
| 116 |
```
|
| 117 |
|
| 118 |
## 🛠️ Встановлення
|
|
|
|
| 207 |
|
| 208 |
**Формат результатів:** Повний JSON об'єкт з полями `title`, `text`, `proceeding`, `category`
|
| 209 |
|
| 210 |
+
Детальна інструкція: [docs/batch/BATCH_TESTING_README.md](docs/batch/BATCH_TESTING_README.md)
|
| 211 |
|
| 212 |
### 📖 Допомога
|
| 213 |
|
|
|
|
| 369 |
## 📚 Документація
|
| 370 |
|
| 371 |
- **[HELP.md](HELP.md)** - Загальна допомога для користувачів (доступна в додатку)
|
| 372 |
+
- **[docs/batch/BATCH_TESTING_README.md](docs/batch/BATCH_TESTING_README.md)** - Документація пакетного тестування
|
| 373 |
- **[PROMPT_EDITING.md](docs/PROMPT_EDITING.md)** - Повна технічна документація з редагування промптів
|
| 374 |
- **[QUICK_START_PROMPTS.md](docs/QUICK_START_PROMPTS.md)** - Швидкий старт для користувачів
|
| 375 |
+
- **[docs/changelog/CHANGES.md](docs/changelog/CHANGES.md)** - Детальний changelog
|
| 376 |
|
| 377 |
## 🔧 Troubleshooting
|
| 378 |
|
docs/README.md
ADDED
|
@@ -0,0 +1,39 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Документація проєкту Legal Position AI Analyzer
|
| 2 |
+
|
| 3 |
+
## Швидкі посилання
|
| 4 |
+
|
| 5 |
+
### MVP / Scope
|
| 6 |
+
- **Scope + актуальність даних (важливо для замовника):** `SCOPE_AND_DATA_FRESHNESS.md`
|
| 7 |
+
|
| 8 |
+
### Генерація (основний фокус)
|
| 9 |
+
- **Prompt editing:** `PROMPT_EDITING.md`
|
| 10 |
+
- **Quick start prompts:** `QUICK_START_PROMPTS.md`
|
| 11 |
+
|
| 12 |
+
### Моделі
|
| 13 |
+
- OpenAI GPT‑5.2: `models/openai/GPT5_2_INTEGRATION.md` · `models/openai/GPT5_2_QUICKSTART.md` · `models/openai/GPT5_2_SUMMARY.md` · `models/openai/CHANGELOG_GPT5_2.md`
|
| 14 |
+
- Gemini embeddings: `models/gemini/GEMINI_EMBEDDINGS.md`
|
| 15 |
+
|
| 16 |
+
### Деплой / HF
|
| 17 |
+
- `deployment/hf/DEPLOYMENT_HF.md`
|
| 18 |
+
- `deployment/hf/HF_SPACE_SETUP.md`
|
| 19 |
+
- `deployment/hf/HF_DEPLOYMENT_CHECKLIST.md`
|
| 20 |
+
- `deployment/hf/HF_DEPLOYMENT_SUMMARY.md`
|
| 21 |
+
- `deployment/hf/README_HF.md`
|
| 22 |
+
|
| 23 |
+
### Дані / індекси (опціонально, якщо search увімкнений)
|
| 24 |
+
- `HF_DATASET_SETUP.md`
|
| 25 |
+
- `INDEX_STORAGE_OPTIONS.md`
|
| 26 |
+
- `data/dataset_README.md`
|
| 27 |
+
|
| 28 |
+
### Ops
|
| 29 |
+
- `ops/API_KEYS_OPTIONAL.md`
|
| 30 |
+
- `ops/CONFIGURATION_CLEANUP.md`
|
| 31 |
+
- `ops/TODO.md`
|
| 32 |
+
|
| 33 |
+
### Batch
|
| 34 |
+
- `batch/BATCH_TESTING_README.md`
|
| 35 |
+
|
| 36 |
+
### Історія змін / технічні нотатки
|
| 37 |
+
- `changelog/CHANGES.md`
|
| 38 |
+
- `legacy/IMPLEMENTATION_SUMMARY.md`
|
| 39 |
+
|
BATCH_TESTING_README.md → docs/batch/BATCH_TESTING_README.md
RENAMED
|
File without changes
|
CHANGES.md → docs/changelog/CHANGES.md
RENAMED
|
File without changes
|
dataset_README.md → docs/data/dataset_README.md
RENAMED
|
File without changes
|
DEPLOYMENT_HF.md → docs/deployment/hf/DEPLOYMENT_HF.md
RENAMED
|
File without changes
|
HF_DEPLOYMENT_CHECKLIST.md → docs/deployment/hf/HF_DEPLOYMENT_CHECKLIST.md
RENAMED
|
File without changes
|
HF_DEPLOYMENT_SUMMARY.md → docs/deployment/hf/HF_DEPLOYMENT_SUMMARY.md
RENAMED
|
File without changes
|
HF_SPACE_SETUP.md → docs/deployment/hf/HF_SPACE_SETUP.md
RENAMED
|
File without changes
|
README_HF.md → docs/deployment/hf/README_HF.md
RENAMED
|
File without changes
|
IMPLEMENTATION_SUMMARY.md → docs/legacy/IMPLEMENTATION_SUMMARY.md
RENAMED
|
@@ -148,7 +148,7 @@ async def process_input(..., session_id: str) -> Tuple[str, Dict, str]:
|
|
| 148 |
- Життєвий цикл сесії
|
| 149 |
- Порівняння до/після
|
| 150 |
|
| 151 |
-
4. **[CHANGES.md](CHANGES.md)** (500+ рядків)
|
| 152 |
- Детальний changelog
|
| 153 |
- Список всіх змінених файлів
|
| 154 |
- Технічні деталі
|
|
@@ -453,7 +453,7 @@ python main.py
|
|
| 453 |
|
| 454 |
1. **[docs/PROMPT_EDITING.md](docs/PROMPT_EDITING.md)** - Технічна документація
|
| 455 |
2. **[docs/ARCHITECTURE.md](docs/ARCHITECTURE.md)** - Архітектурні схеми
|
| 456 |
-
3. **[CHANGES.md](CHANGES.md)** - Детальний changelog
|
| 457 |
|
| 458 |
### Для DevOps
|
| 459 |
|
|
|
|
| 148 |
- Життєвий цикл сесії
|
| 149 |
- Порівняння до/після
|
| 150 |
|
| 151 |
+
4. **[CHANGES.md](../changelog/CHANGES.md)** (500+ рядків)
|
| 152 |
- Детальний changelog
|
| 153 |
- Список всіх змінених файлів
|
| 154 |
- Технічні деталі
|
|
|
|
| 453 |
|
| 454 |
1. **[docs/PROMPT_EDITING.md](docs/PROMPT_EDITING.md)** - Технічна документація
|
| 455 |
2. **[docs/ARCHITECTURE.md](docs/ARCHITECTURE.md)** - Архітектурні схеми
|
| 456 |
+
3. **[CHANGES.md](../changelog/CHANGES.md)** - Детальний changelog
|
| 457 |
|
| 458 |
### Для DevOps
|
| 459 |
|
GEMINI_EMBEDDINGS.md → docs/models/gemini/GEMINI_EMBEDDINGS.md
RENAMED
|
File without changes
|
CHANGELOG_GPT5_2.md → docs/models/openai/CHANGELOG_GPT5_2.md
RENAMED
|
File without changes
|
GPT5_2_INTEGRATION.md → docs/models/openai/GPT5_2_INTEGRATION.md
RENAMED
|
File without changes
|
GPT5_2_QUICKSTART.md → docs/models/openai/GPT5_2_QUICKSTART.md
RENAMED
|
File without changes
|
GPT5_2_SUMMARY.md → docs/models/openai/GPT5_2_SUMMARY.md
RENAMED
|
File without changes
|
API_KEYS_OPTIONAL.md → docs/ops/API_KEYS_OPTIONAL.md
RENAMED
|
@@ -277,7 +277,7 @@ else:
|
|
| 277 |
print("Warning: No embedding API key found (OpenAI or Gemini). Search functionality will be disabled.")
|
| 278 |
```
|
| 279 |
|
| 280 |
-
Детальна документація: [GEMINI_EMBEDDINGS.md](GEMINI_EMBEDDINGS.md)
|
| 281 |
|
| 282 |
---
|
| 283 |
|
|
|
|
| 277 |
print("Warning: No embedding API key found (OpenAI or Gemini). Search functionality will be disabled.")
|
| 278 |
```
|
| 279 |
|
| 280 |
+
Детальна документація: [GEMINI_EMBEDDINGS.md](../models/gemini/GEMINI_EMBEDDINGS.md)
|
| 281 |
|
| 282 |
---
|
| 283 |
|
CONFIGURATION_CLEANUP.md → docs/ops/CONFIGURATION_CLEANUP.md
RENAMED
|
File without changes
|
TODO.md → docs/ops/TODO.md
RENAMED
|
@@ -24,7 +24,7 @@
|
|
| 24 |
- [x] Написано швидкий старт (QUICK_START_PROMPTS.md)
|
| 25 |
- [x] Створено архітектурну схему (ARCHITECTURE.md)
|
| 26 |
- [x] Оновлено README.md з детальною інформацією
|
| 27 |
-
- [x] Створено CHANGES.md з повним changelog
|
| 28 |
|
| 29 |
### Можливі покращення в майбутньому:
|
| 30 |
|
|
|
|
| 24 |
- [x] Написано швидкий старт (QUICK_START_PROMPTS.md)
|
| 25 |
- [x] Створено архітектурну схему (ARCHITECTURE.md)
|
| 26 |
- [x] Оновлено README.md з детальною інформацією
|
| 27 |
+
- [x] Створено docs/changelog/CHANGES.md з повним changelog
|
| 28 |
|
| 29 |
### Можливі покращення в майбутньому:
|
| 30 |
|