tarzanagh commited on
Commit
620ac43
·
verified ·
1 Parent(s): 1a2226a

Remove Python API section

Browse files
Files changed (1) hide show
  1. README.md +0 -34
README.md CHANGED
@@ -284,40 +284,6 @@ Local embeddings (`jina-v3`, `gritlm`, `nvidia-nv-embed-v2`) run on your GPU and
284
 
285
  `gpt-4o-mini` (default), `gpt-4o`, `gpt-5-nano`, `gpt-5-mini`, `gpt-5`, `gpt-oss-120b` (free, local)
286
 
287
- ## Python API
288
-
289
- ```python
290
- from src import QAFD_RAG, QueryParam
291
-
292
- # Initialize
293
- rag = QAFD_RAG(
294
- working_dir="./my_kg",
295
- llm_model_name="gpt-4o-mini",
296
- embedding_model_key="jina-v3",
297
- )
298
-
299
- # Index documents
300
- rag.insert(["Document text 1...", "Document text 2..."])
301
-
302
- # Query
303
- answer = rag.query(
304
- "What is X?",
305
- param=QueryParam(mode="hybrid"),
306
- )
307
- print(answer)
308
- ```
309
-
310
- ### QueryParam Options
311
-
312
- | Parameter | Default | Description |
313
- |-----------|---------|-------------|
314
- | `mode` | `"hybrid"` | Retrieval mode: `local`, `global`, `hybrid` |
315
- | `top_k` | 40 | Number of entities to retrieve |
316
- | `max_source_nodes` | 40 | Max source nodes for flow diffusion |
317
- | `min_flow_threshold` | 0.1 | Minimum flow value to include a node |
318
- | `enable_query_aware_flow_diffusion` | `True` | Use query-aware edge weighting |
319
- | `alpha` | 50.0 | Flow diffusion initialization factor |
320
- | `response_type` | `"Multiple Paragraphs"` | Output format |
321
 
322
  ## How It Works
323
 
 
284
 
285
  `gpt-4o-mini` (default), `gpt-4o`, `gpt-5-nano`, `gpt-5-mini`, `gpt-5`, `gpt-oss-120b` (free, local)
286
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
287
 
288
  ## How It Works
289