XQ commited on
Commit
d686bcf
Β·
1 Parent(s): d1fb6b4

Track .env.example by exempting it from .env.* ignore rule

Browse files
Files changed (2) hide show
  1. .env.example +115 -0
  2. .gitignore +1 -0
.env.example ADDED
@@ -0,0 +1,115 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # =============================================================================
2
+ # KU Doc Assistant β€” Environment Variables
3
+ # Copy this file to .env and adjust as needed.
4
+ # =============================================================================
5
+ #
6
+ # Two Docker usage modes β€” pick ONE and uncomment the matching block below.
7
+ #
8
+ # 1) LOCAL MODE β€” docker compose --profile local up --build
9
+ # Uses Ollama (in Docker) + local HuggingFace embeddings. No API keys.
10
+ #
11
+ # 2) CLOUD MODE β€” docker compose up --build
12
+ # Uses a cloud LLM (OpenAI / Azure / Anthropic / Google) + cloud or local
13
+ # embeddings. Requires the relevant API key(s) set below.
14
+ #
15
+ # Container-internal addresses (QDRANT_URL, OLLAMA_BASE_URL, API_BASE_URL)
16
+ # are overridden by docker-compose.yml `environment:`. Do NOT change them here
17
+ # for Docker β€” the localhost defaults below are for bare-metal development.
18
+ # =============================================================================
19
+
20
+
21
+ # *****************************************************************************
22
+ # EXAMPLE 1 β€” LOCAL MODE (Ollama + HuggingFace, no API keys)
23
+ # *****************************************************************************
24
+ LLM_PROVIDER=ollama
25
+ EMBEDDING_PROVIDER=local
26
+
27
+ OLLAMA_BASE_URL=http://localhost:11434
28
+ OLLAMA_MODEL=gemma4:e4b
29
+ LOCAL_EMBEDDING_MODEL=paraphrase-multilingual-MiniLM-L12-v2
30
+
31
+ # *****************************************************************************
32
+ # EXAMPLE 2 β€” CLOUD MODE (OpenAI) β€” uncomment & comment out Example 1 above
33
+ # *****************************************************************************
34
+ # LLM_PROVIDER=openai
35
+ # EMBEDDING_PROVIDER=openai
36
+ # OPENAI_API_KEY=sk-...
37
+ # OPENAI_BASE_URL= # Optional: custom endpoint for OpenAI-compatible APIs
38
+ # OPENAI_MODEL=gpt-4o-mini
39
+ # OPENAI_EMBEDDING_MODEL=text-embedding-3-small
40
+
41
+ # *****************************************************************************
42
+ # EXAMPLE 2a β€” CLOUD MODE (SiliconFlow, OpenAI-compatible)
43
+ # *****************************************************************************
44
+ # LLM_PROVIDER=openai
45
+ # EMBEDDING_PROVIDER=local
46
+ # OPENAI_API_KEY=your-siliconflow-api-key
47
+ # OPENAI_BASE_URL=https://api.siliconflow.cn/v1
48
+ # OPENAI_MODEL=Qwen/Qwen2.5-72B-Instruct
49
+ # LOCAL_EMBEDDING_MODEL=paraphrase-multilingual-MiniLM-L12-v2
50
+
51
+ # *****************************************************************************
52
+ # EXAMPLE 2b β€” CLOUD MODE (Azure OpenAI) β€” uncomment & comment out above
53
+ # *****************************************************************************
54
+ # LLM_PROVIDER=azure_openai
55
+ # EMBEDDING_PROVIDER=azure_openai
56
+ # AZURE_OPENAI_API_KEY=...
57
+ # AZURE_OPENAI_ENDPOINT=https://<resource>.openai.azure.com/
58
+ # AZURE_OPENAI_API_VERSION=2024-02-01
59
+ # AZURE_OPENAI_DEPLOYMENT=<deployment-name>
60
+ # AZURE_OPENAI_EMBEDDING_DEPLOYMENT=<embedding-deployment>
61
+
62
+ # *****************************************************************************
63
+ # EXAMPLE 2c β€” CLOUD MODE (Groq LLM + local embeddings, FREE)
64
+ # *****************************************************************************
65
+ # LLM_PROVIDER=groq
66
+ # EMBEDDING_PROVIDER=local
67
+ # GROQ_API_KEY=gsk_...
68
+ # GROQ_MODEL=qwen/qwen3-32b
69
+ # LOCAL_EMBEDDING_MODEL=paraphrase-multilingual-MiniLM-L12-v2
70
+
71
+ # *****************************************************************************
72
+ # EXAMPLE 2e β€” CLOUD MODE (Anthropic LLM + local embeddings)
73
+ # *****************************************************************************
74
+ # LLM_PROVIDER=anthropic
75
+ # EMBEDDING_PROVIDER=local
76
+ # ANTHROPIC_API_KEY=sk-ant-...
77
+ # ANTHROPIC_MODEL=claude-sonnet-4-20250514
78
+ # LOCAL_EMBEDDING_MODEL=paraphrase-multilingual-MiniLM-L12-v2
79
+
80
+ # *****************************************************************************
81
+ # EXAMPLE 2f β€” CLOUD MODE (Google GenAI)
82
+ # *****************************************************************************
83
+ # LLM_PROVIDER=google_genai
84
+ # EMBEDDING_PROVIDER=google_genai
85
+ # GOOGLE_API_KEY=...
86
+ # GOOGLE_LLM_MODEL=gemini-2.5-flash
87
+ # GOOGLE_EMBEDDING_MODEL=models/embedding-001
88
+
89
+
90
+ # =============================================================================
91
+ # Shared settings (apply to all modes)
92
+ # =============================================================================
93
+
94
+ # --- Vector Store / Search ---------------------------------------------------
95
+ QDRANT_PATH=./qdrant_data
96
+ QDRANT_URL= # Empty = local file mode; Docker overrides to http://qdrant:6333
97
+ COLLECTION_NAME=ku_documents
98
+ EMBEDDING_MODEL=paraphrase-multilingual-MiniLM-L12-v2
99
+ EMBEDDING_DIMENSION=384
100
+ GENERATION_MODEL=gemma4:e4b
101
+ RERANKER_MODEL=cross-encoder/mmarco-mMiniLMv2-L12-H384-v1
102
+ CHUNK_SIZE=512
103
+ CHUNK_OVERLAP=64
104
+ TOP_K=5
105
+ BM25_WEIGHT=0.3
106
+ DENSE_WEIGHT=0.7
107
+ LOG_LEVEL=INFO
108
+
109
+ # --- Query Translation -------------------------------------------------------
110
+ # Translate non-Danish queries to Danish before retrieval (BM25 + vector search).
111
+ # Default: true when LLM_PROVIDER=ollama, false for cloud providers.
112
+ # TRANSLATE_QUERY=true
113
+
114
+ # --- Inter-service Communication (bare-metal defaults) -----------------------
115
+ API_BASE_URL=http://localhost:8000 # Docker overrides to http://api:8000
.gitignore CHANGED
@@ -23,6 +23,7 @@ CLAUDE.md
23
  # Environment variables
24
  .env
25
  .env.*
 
26
 
27
  # Qdrant local storage
28
  qdrant_data/
 
23
  # Environment variables
24
  .env
25
  .env.*
26
+ !.env.example
27
 
28
  # Qdrant local storage
29
  qdrant_data/