Ayona commited on
Commit
4c6d96a
·
1 Parent(s): eaccccc

docs: clarify scope (generation-first) and index snapshot freshness

Browse files
Files changed (3) hide show
  1. HELP.md +11 -3
  2. README.md +10 -0
  3. docs/SCOPE_AND_DATA_FRESHNESS.md +58 -0
HELP.md CHANGED
@@ -21,10 +21,14 @@
21
  ### Основні можливості:
22
 
23
  - ✅ **Генерація** правових позицій з текстів судових рішень
24
- - ✅ **Пошук** схожих позицій у базі даних Верховного Суду
25
- - ✅ **Аналіз** релевантності знайдених позицій
26
- - ✅ **Налаштування** промптів для персоналізації роботи AI
27
  - ✅ **Пакетне тестування** для масової обробки даних
 
 
 
 
 
28
 
29
  ---
30
 
@@ -101,6 +105,10 @@
101
  ### Призначення
102
  Знайти схожі правові позиції Верховного Суду у базі даних.
103
 
 
 
 
 
104
  ### Два типи пошуку:
105
 
106
  #### 1. Пошук на основі правової позиції
 
21
  ### Основні можливості:
22
 
23
  - ✅ **Генерація** правових позицій з текстів судових рішень
24
+ - ✅ **Налаштування моделей** ибір провайдера/моделі + режими «роздумів») і **поле коментаря** для уточнення генерації
25
+ - ✅ **Налаштування промптів** для персоналізації роботи AI
 
26
  - ✅ **Пакетне тестування** для масової обробки даних
27
+ - 🟡 **Пошук / Аналіз** (опціонально): може бути вимкнено у поставці, якщо це не входить у ТЗ
28
+
29
+ ⚠️ **Примітка про дані для пошуку:** якщо пошук увімкнений, індекси можуть завантажуватися з відкритого датасету `DocSA/legal-position-indexes`. Це тестовий snapshot приблизно **1.5 роки давності** і він може бути неактуальним.
30
+
31
+ Докладніше: `docs/SCOPE_AND_DATA_FRESHNESS.md`
32
 
33
  ---
34
 
 
105
  ### Призначення
106
  Знайти схожі правові позиції Верховного Суду у базі даних.
107
 
108
+ ⚠️ **Статус функції:** пошук може бути **опціональним** у поставці (якщо він не входить у ТЗ). Якщо пошук вимкнено — це не впливає на роботу розділу «Генерація».
109
+
110
+ ⚠️ **Актуальність бази:** якщо пошук увімкнений і використовує індекси з `DocSA/legal-position-indexes`, врахуйте що це тестовий snapshot приблизно **1.5 роки давності** і він може не містити нових/оновлених позицій після дати snapshot.
111
+
112
  ### Два типи пошуку:
113
 
114
  #### 1. Пошук на основі правової позиції
README.md CHANGED
@@ -15,6 +15,16 @@ python_version: "3.11"
15
 
16
  Інтелектуальний інструмент для аналізу судових рішень та формування правових позицій Верховного Суду України з використанням AI.
17
 
 
 
 
 
 
 
 
 
 
 
18
  ## 🚀 Основні можливості
19
 
20
  ### 💡 Генерація правових позицій
 
15
 
16
  Інтелектуальний інструмент для аналізу судових рішень та формування правових позицій Верховного Суду України з використанням AI.
17
 
18
+ ## 🎯 Scope для поставки (LPD / Верховний Суд)
19
+
20
+ Поточний фокус замовника — **модернізація функціонала генерації правових позицій** (розділ «Генерація» + налаштування моделей/«роздумів» + поле коментаря).
21
+
22
+ - **In-scope (MVP):** генерація правових позицій + узгоджені налаштування моделей/Thinking/Comment.
23
+ - **Out-of-scope (якщо не прописано в ТЗ):** пошук і порівняльний аналіз можуть розглядатися як *опціональні* (і за потреби вимикаються у customer build).
24
+ - **Важливо про пошук:** якщо search/analysis увімкнено, індекси можуть завантажуватися з `DocSA/legal-position-indexes`, але це тестовий snapshot приблизно **1.5 роки давності** (може бути неактуальним).
25
+
26
+ Докладніше: [`docs/SCOPE_AND_DATA_FRESHNESS.md`](docs/SCOPE_AND_DATA_FRESHNESS.md)
27
+
28
  ## 🚀 Основні можливості
29
 
30
  ### 💡 Генерація правових позицій
docs/SCOPE_AND_DATA_FRESHNESS.md ADDED
@@ -0,0 +1,58 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Scope, data freshness & expectations (LPD / Верховний Суд)
2
+
3
+ Цей документ фіксує **межі поставки (scope)** та **очікування щодо даних**, щоб уникнути непорозумінь при передачі коду замовнику.
4
+
5
+ ## 1) In-scope (обов’язково для MVP)
6
+
7
+ ### 1.1 Генерація правових позицій
8
+ - Вкладка/розділ: **«Генерація правових позицій»**.
9
+ - Вхід: текст / URL / файл.
10
+ - Вихід: **структурований JSON** з полями: `title`, `text`, `proceeding`, `category`.
11
+
12
+ ### 1.2 Налаштування моделей і режимів «роздумів»
13
+ Для розділу генерації мають бути узгоджені (з порталом) параметри:
14
+ - `provider` (openai | anthropic | gemini | deepseek)
15
+ - `model`
16
+ - `thinking_enabled` (true/false)
17
+ - `thinking_level` (low | medium | high) — **уніфікований** рівень; деталізація/мапінг до провайдерів робиться в backend.
18
+ - (опційно) `openai_verbosity` (low | medium | high) — якщо замовник хоче це в UI.
19
+
20
+ ### 1.3 Додаткове поле «Коментар» (опціонально)
21
+ - UI: textarea **«Коментар до генерації (опціонально)»**.
22
+ - Backend payload: `comment`.
23
+ - Призначення: дати моделі коротку інструкцію/акцент (що підкреслити, який аспект важливий тощо).
24
+
25
+ ## 2) Out-of-scope (не є критерієм приймання MVP, якщо не зазначено в ТЗ)
26
+
27
+ ### 2.1 Пошук схожих позицій
28
+ Функціонал пошуку (vector+BM25) може бути:
29
+ - залишений у коді як **опціональний**, або
30
+ - **вимкнений у customer build**, якщо замовнику зараз не потрібен.
31
+
32
+ ### 2.2 Порівняльний аналіз / прецедентний аналіз
33
+ Аналіз результатів пошуку також вважається **опціональним**, якщо він не прописаний у ТЗ.
34
+
35
+ ## 3) Джерело індексів (search KB) та актуальність даних
36
+
37
+ Якщо пошук увімкнений, застосунок може завантажувати індекси з HuggingFace Dataset:
38
+ - `https://huggingface.co/datasets/DocSA/legal-position-indexes`
39
+
40
+ ### Важливий нюанс
41
+ - Ця база індексів була отримана **приблизно 1.5 роки тому** як тестовий snapshot від ВС.
42
+ - З того часу вона **не оновлювалася**.
43
+
44
+ ### Наслідки
45
+ - Пошук/аналіз може **не знаходити** нові/оновлені позиції після дати snapshot.
46
+ - Це **не дефект генерації**; це обмеження актуальності корпусу для retrieval-компоненти.
47
+
48
+ ### Як комунікуємо замовнику
49
+ - У документації та Help UI має бути явна примітка: **search/analysis optional + data snapshot may be outdated**.
50
+ - За потреби — показувати користувачу `Index snapshot: …` (якщо буде додано manifest/version).
51
+
52
+ ## 4) Якщо замовнику колись знадобиться актуалізація
53
+ Це окремий потік робіт (не обов’язково для MVP):
54
+ - хто надає нові дані (ВС / відповідальна сторона)
55
+ - хто будує індекси
56
+ - де вони зберігаються
57
+ - частота оновлень (разово / періодично)
58
+