galbendavids commited on
Commit
bf7bcb9
·
1 Parent(s): 5c6f353

עדכון README: הערה על re-encoding ומודל embedding החדש

Browse files
Files changed (1) hide show
  1. README.md +13 -1
README.md CHANGED
@@ -30,6 +30,18 @@ requirements.txt
30
  Dockerfile
31
  ```
32
 
 
 
 
 
 
 
 
 
 
 
 
 
33
  ### Quick start (Local Development)
34
 
35
  **📖 למדריך מפורט:** ראה [LOCAL_SETUP_GUIDE.md](LOCAL_SETUP_GUIDE.md)
@@ -81,7 +93,7 @@ python -m app.rag_service --query "שיפור טופס" --top_k 5
81
  Environment variables:
82
  - GEMINI_API_KEY: If set, RAG uses Gemini (preferred) for summaries
83
  - OPENAI_API_KEY: If set, RAG can use OpenAI as a fallback
84
- - EMBEDDING_MODEL: Sentence-Transformers model name (default: sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2)
85
  - VECTOR_INDEX_PATH: Path to persist FAISS index (default: ./.vector_index/faiss.index)
86
  - VECTOR_METADATA_PATH: Path to persist FAISS index metadata (default: ./.vector_index/meta.parquet)
87
  - CSV_PATH: Optional path to your CSV (if not `Feedback.csv` in repo root)
 
30
  Dockerfile
31
  ```
32
 
33
+ ### ⚠️ חשוב: Re-encoding נדרש
34
+
35
+ אם שינית את מודל ה-embedding (למשל, שיפור מ-MiniLM ל-mpnet), **חובה** להריץ re-encoding של כל הנתונים:
36
+
37
+ ```bash
38
+ uv run -m scripts.precompute_index
39
+ # או
40
+ python scripts/precompute_index.py
41
+ ```
42
+
43
+ זה יבנה מחדש את האינדקס הווקטורי עם המודל החדש.
44
+
45
  ### Quick start (Local Development)
46
 
47
  **📖 למדריך מפורט:** ראה [LOCAL_SETUP_GUIDE.md](LOCAL_SETUP_GUIDE.md)
 
93
  Environment variables:
94
  - GEMINI_API_KEY: If set, RAG uses Gemini (preferred) for summaries
95
  - OPENAI_API_KEY: If set, RAG can use OpenAI as a fallback
96
+ - EMBEDDING_MODEL: Sentence-Transformers model name (default: sentence-transformers/paraphrase-multilingual-mpnet-base-v2)
97
  - VECTOR_INDEX_PATH: Path to persist FAISS index (default: ./.vector_index/faiss.index)
98
  - VECTOR_METADATA_PATH: Path to persist FAISS index metadata (default: ./.vector_index/meta.parquet)
99
  - CSV_PATH: Optional path to your CSV (if not `Feedback.csv` in repo root)