File size: 51,289 Bytes
167596f | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 | """
This module contains all query-related routes for the LightRAG API.
"""
import json
import logging
from typing import Any, Dict, List, Literal, Optional
from fastapi import APIRouter, Depends, HTTPException
from lightrag.base import QueryParam
from lightrag.api.utils_api import get_combined_auth_dependency
from pydantic import BaseModel, Field, field_validator
from ascii_colors import trace_exception
router = APIRouter(tags=["query"])
class QueryRequest(BaseModel):
query: str = Field(
min_length=3,
description="The query text",
)
mode: Literal["local", "global", "hybrid", "naive", "mix", "bypass"] = Field(
default="mix",
description="Query mode",
)
only_need_context: Optional[bool] = Field(
default=None,
description="If True, only returns the retrieved context without generating a response.",
)
only_need_prompt: Optional[bool] = Field(
default=None,
description="If True, only returns the generated prompt without producing a response.",
)
response_type: Optional[str] = Field(
min_length=1,
default=None,
description="Defines the response format. Examples: 'Multiple Paragraphs', 'Single Paragraph', 'Bullet Points'.",
)
top_k: Optional[int] = Field(
ge=1,
default=None,
description="Number of top items to retrieve. Represents entities in 'local' mode and relationships in 'global' mode.",
)
chunk_top_k: Optional[int] = Field(
ge=1,
default=None,
description="Number of text chunks to retrieve initially from vector search and keep after reranking.",
)
max_entity_tokens: Optional[int] = Field(
default=None,
description="Maximum number of tokens allocated for entity context in unified token control system.",
ge=1,
)
max_relation_tokens: Optional[int] = Field(
default=None,
description="Maximum number of tokens allocated for relationship context in unified token control system.",
ge=1,
)
max_total_tokens: Optional[int] = Field(
default=None,
description="Maximum total tokens budget for the entire query context (entities + relations + chunks + system prompt).",
ge=1,
)
conversation_history: Optional[List[Dict[str, Any]]] = Field(
default=None,
description="Stores past conversation history to maintain context. Format: [{'role': 'user/assistant', 'content': 'message'}].",
)
user_prompt: Optional[str] = Field(
default=None,
description="User-provided prompt for the query. If provided, this will be used instead of the default value from prompt template.",
)
enable_rerank: Optional[bool] = Field(
default=None,
description="Enable reranking for retrieved text chunks. If True but no rerank model is configured, a warning will be issued. Default is True.",
)
include_references: Optional[bool] = Field(
default=True,
description="If True, includes reference list in responses. Affects /query and /query/stream endpoints. /query/data always includes references.",
)
stream: Optional[bool] = Field(
default=True,
description="If True, enables streaming output for real-time responses. Only affects /query/stream endpoint.",
)
@field_validator("query", mode="after")
@classmethod
def query_strip_after(cls, query: str) -> str:
return query.strip()
@field_validator("conversation_history", mode="after")
@classmethod
def conversation_history_role_check(
cls, conversation_history: List[Dict[str, Any]] | None
) -> List[Dict[str, Any]] | None:
if conversation_history is None:
return None
for msg in conversation_history:
if "role" not in msg:
raise ValueError("Each message must have a 'role' key.")
if not isinstance(msg["role"], str) or not msg["role"].strip():
raise ValueError("Each message 'role' must be a non-empty string.")
return conversation_history
def to_query_params(self, is_stream: bool) -> "QueryParam":
"""Converts a QueryRequest instance into a QueryParam instance."""
# Use Pydantic's `.model_dump(exclude_none=True)` to remove None values automatically
request_data = self.model_dump(exclude_none=True, exclude={"query"})
# Ensure `mode` and `stream` are set explicitly
param = QueryParam(**request_data)
param.stream = is_stream
return param
class QueryResponse(BaseModel):
response: str = Field(
description="The generated response",
)
references: Optional[List[Dict[str, str]]] = Field(
default=None,
description="Reference list (Disabled when include_references=False, /query/data always includes references.)",
)
class QueryDataResponse(BaseModel):
status: str = Field(description="Query execution status")
message: str = Field(description="Status message")
data: Dict[str, Any] = Field(
description="Query result data containing entities, relationships, chunks, and references"
)
metadata: Dict[str, Any] = Field(
description="Query metadata including mode, keywords, and processing information"
)
class StreamChunkResponse(BaseModel):
"""Response model for streaming chunks in NDJSON format"""
references: Optional[List[Dict[str, str]]] = Field(
default=None,
description="Reference list (only in first chunk when include_references=True)",
)
response: Optional[str] = Field(
default=None, description="Response content chunk or complete response"
)
error: Optional[str] = Field(
default=None, description="Error message if processing fails"
)
def create_query_routes(rag, api_key: Optional[str] = None, top_k: int = 60):
combined_auth = get_combined_auth_dependency(api_key)
@router.post(
"/query",
response_model=QueryResponse,
dependencies=[Depends(combined_auth)],
responses={
200: {
"description": "Successful RAG query response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "string",
"description": "The generated response from the RAG system",
},
"references": {
"type": "array",
"items": {
"type": "object",
"properties": {
"reference_id": {"type": "string"},
"file_path": {"type": "string"},
},
},
"description": "Reference list (only included when include_references=True)",
},
},
"required": ["response"],
},
"examples": {
"with_references": {
"summary": "Response with references",
"description": "Example response when include_references=True",
"value": {
"response": "Artificial Intelligence (AI) is a branch of computer science that aims to create intelligent machines capable of performing tasks that typically require human intelligence, such as learning, reasoning, and problem-solving.",
"references": [
{
"reference_id": "1",
"file_path": "/documents/ai_overview.pdf",
},
{
"reference_id": "2",
"file_path": "/documents/machine_learning.txt",
},
],
},
},
"without_references": {
"summary": "Response without references",
"description": "Example response when include_references=False",
"value": {
"response": "Artificial Intelligence (AI) is a branch of computer science that aims to create intelligent machines capable of performing tasks that typically require human intelligence, such as learning, reasoning, and problem-solving."
},
},
"different_modes": {
"summary": "Different query modes",
"description": "Examples of responses from different query modes",
"value": {
"local_mode": "Focuses on specific entities and their relationships",
"global_mode": "Provides broader context from relationship patterns",
"hybrid_mode": "Combines local and global approaches",
"naive_mode": "Simple vector similarity search",
"mix_mode": "Integrates knowledge graph and vector retrieval",
},
},
},
}
},
},
400: {
"description": "Bad Request - Invalid input parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {"detail": {"type": "string"}},
},
"example": {
"detail": "Query text must be at least 3 characters long"
},
}
},
},
500: {
"description": "Internal Server Error - Query processing failed",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {"detail": {"type": "string"}},
},
"example": {
"detail": "Failed to process query: LLM service unavailable"
},
}
},
},
},
)
async def query_text(request: QueryRequest):
"""
Comprehensive RAG query endpoint with non-streaming response. Parameter "stream" is ignored.
This endpoint performs Retrieval-Augmented Generation (RAG) queries using various modes
to provide intelligent responses based on your knowledge base.
**Query Modes:**
- **local**: Focuses on specific entities and their direct relationships
- **global**: Analyzes broader patterns and relationships across the knowledge graph
- **hybrid**: Combines local and global approaches for comprehensive results
- **naive**: Simple vector similarity search without knowledge graph
- **mix**: Integrates knowledge graph retrieval with vector search (recommended)
- **bypass**: Direct LLM query without knowledge retrieval
conversation_history parameteris sent to LLM only, does not affect retrieval results.
**Usage Examples:**
Basic query:
```json
{
"query": "What is machine learning?",
"mode": "mix"
}
```
Advanced query with references:
```json
{
"query": "Explain neural networks",
"mode": "hybrid",
"include_references": true,
"response_type": "Multiple Paragraphs",
"top_k": 10
}
```
Conversation with history:
```json
{
"query": "Can you give me more details?",
"conversation_history": [
{"role": "user", "content": "What is AI?"},
{"role": "assistant", "content": "AI is artificial intelligence..."}
]
}
```
Args:
request (QueryRequest): The request object containing query parameters:
- **query**: The question or prompt to process (min 3 characters)
- **mode**: Query strategy - "mix" recommended for best results
- **include_references**: Whether to include source citations
- **response_type**: Format preference (e.g., "Multiple Paragraphs")
- **top_k**: Number of top entities/relations to retrieve
- **conversation_history**: Previous dialogue context
- **max_total_tokens**: Token budget for the entire response
Returns:
QueryResponse: JSON response containing:
- **response**: The generated answer to your query
- **references**: Source citations (if include_references=True)
Raises:
HTTPException:
- 400: Invalid input parameters (e.g., query too short)
- 500: Internal processing error (e.g., LLM service unavailable)
"""
try:
param = request.to_query_params(
False
) # Ensure stream=False for non-streaming endpoint
# Force stream=False for /query endpoint regardless of include_references setting
param.stream = False
# Unified approach: always use aquery_llm for both cases
result = await rag.aquery_llm(request.query, param=param)
# Extract LLM response and references from unified result
llm_response = result.get("llm_response", {})
references = result.get("data", {}).get("references", [])
# Get the non-streaming response content
response_content = llm_response.get("content", "")
if not response_content:
response_content = "No relevant context found for the query."
# Return response with or without references based on request
if request.include_references:
return QueryResponse(response=response_content, references=references)
else:
return QueryResponse(response=response_content, references=None)
except Exception as e:
trace_exception(e)
raise HTTPException(status_code=500, detail=str(e))
@router.post(
"/query/stream",
dependencies=[Depends(combined_auth)],
responses={
200: {
"description": "Flexible RAG query response - format depends on stream parameter",
"content": {
"application/x-ndjson": {
"schema": {
"type": "string",
"format": "ndjson",
"description": "Newline-delimited JSON (NDJSON) format used for both streaming and non-streaming responses. For streaming: multiple lines with separate JSON objects. For non-streaming: single line with complete JSON object.",
"example": '{"references": [{"reference_id": "1", "file_path": "/documents/ai.pdf"}]}\n{"response": "Artificial Intelligence is"}\n{"response": " a field of computer science"}\n{"response": " that focuses on creating intelligent machines."}',
},
"examples": {
"streaming_with_references": {
"summary": "Streaming mode with references (stream=true)",
"description": "Multiple NDJSON lines when stream=True and include_references=True. First line contains references, subsequent lines contain response chunks.",
"value": '{"references": [{"reference_id": "1", "file_path": "/documents/ai_overview.pdf"}, {"reference_id": "2", "file_path": "/documents/ml_basics.txt"}]}\n{"response": "Artificial Intelligence (AI) is a branch of computer science"}\n{"response": " that aims to create intelligent machines capable of performing"}\n{"response": " tasks that typically require human intelligence, such as learning,"}\n{"response": " reasoning, and problem-solving."}',
},
"streaming_without_references": {
"summary": "Streaming mode without references (stream=true)",
"description": "Multiple NDJSON lines when stream=True and include_references=False. Only response chunks are sent.",
"value": '{"response": "Machine learning is a subset of artificial intelligence"}\n{"response": " that enables computers to learn and improve from experience"}\n{"response": " without being explicitly programmed for every task."}',
},
"non_streaming_with_references": {
"summary": "Non-streaming mode with references (stream=false)",
"description": "Single NDJSON line when stream=False and include_references=True. Complete response with references in one message.",
"value": '{"references": [{"reference_id": "1", "file_path": "/documents/neural_networks.pdf"}], "response": "Neural networks are computational models inspired by biological neural networks that consist of interconnected nodes (neurons) organized in layers. They are fundamental to deep learning and can learn complex patterns from data through training processes."}',
},
"non_streaming_without_references": {
"summary": "Non-streaming mode without references (stream=false)",
"description": "Single NDJSON line when stream=False and include_references=False. Complete response only.",
"value": '{"response": "Deep learning is a subset of machine learning that uses neural networks with multiple layers (hence deep) to model and understand complex patterns in data. It has revolutionized fields like computer vision, natural language processing, and speech recognition."}',
},
"error_response": {
"summary": "Error during streaming",
"description": "Error handling in NDJSON format when an error occurs during processing.",
"value": '{"references": [{"reference_id": "1", "file_path": "/documents/ai.pdf"}]}\n{"response": "Artificial Intelligence is"}\n{"error": "LLM service temporarily unavailable"}',
},
},
}
},
},
400: {
"description": "Bad Request - Invalid input parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {"detail": {"type": "string"}},
},
"example": {
"detail": "Query text must be at least 3 characters long"
},
}
},
},
500: {
"description": "Internal Server Error - Query processing failed",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {"detail": {"type": "string"}},
},
"example": {
"detail": "Failed to process streaming query: Knowledge graph unavailable"
},
}
},
},
},
)
async def query_text_stream(request: QueryRequest):
"""
Advanced RAG query endpoint with flexible streaming response.
This endpoint provides the most flexible querying experience, supporting both real-time streaming
and complete response delivery based on your integration needs.
**Response Modes:**
- Real-time response delivery as content is generated
- NDJSON format: each line is a separate JSON object
- First line: `{"references": [...]}` (if include_references=True)
- Subsequent lines: `{"response": "content chunk"}`
- Error handling: `{"error": "error message"}`
> If stream parameter is False, or the query hit LLM cache, complete response delivered in a single streaming message.
**Response Format Details**
- **Content-Type**: `application/x-ndjson` (Newline-Delimited JSON)
- **Structure**: Each line is an independent, valid JSON object
- **Parsing**: Process line-by-line, each line is self-contained
- **Headers**: Includes cache control and connection management
**Query Modes (same as /query endpoint)**
- **local**: Entity-focused retrieval with direct relationships
- **global**: Pattern analysis across the knowledge graph
- **hybrid**: Combined local and global strategies
- **naive**: Vector similarity search only
- **mix**: Integrated knowledge graph + vector retrieval (recommended)
- **bypass**: Direct LLM query without knowledge retrieval
conversation_history parameteris sent to LLM only, does not affect retrieval results.
**Usage Examples**
Real-time streaming query:
```json
{
"query": "Explain machine learning algorithms",
"mode": "mix",
"stream": true,
"include_references": true
}
```
Complete response query:
```json
{
"query": "What is deep learning?",
"mode": "hybrid",
"stream": false,
"response_type": "Multiple Paragraphs"
}
```
Conversation with context:
```json
{
"query": "Can you elaborate on that?",
"stream": true,
"conversation_history": [
{"role": "user", "content": "What is neural network?"},
{"role": "assistant", "content": "A neural network is..."}
]
}
```
**Response Processing:**
```python
async for line in response.iter_lines():
data = json.loads(line)
if "references" in data:
# Handle references (first message)
references = data["references"]
if "response" in data:
# Handle content chunk
content_chunk = data["response"]
if "error" in data:
# Handle error
error_message = data["error"]
```
**Error Handling:**
- Streaming errors are delivered as `{"error": "message"}` lines
- Non-streaming errors raise HTTP exceptions
- Partial responses may be delivered before errors in streaming mode
- Always check for error objects when processing streaming responses
Args:
request (QueryRequest): The request object containing query parameters:
- **query**: The question or prompt to process (min 3 characters)
- **mode**: Query strategy - "mix" recommended for best results
- **stream**: Enable streaming (True) or complete response (False)
- **include_references**: Whether to include source citations
- **response_type**: Format preference (e.g., "Multiple Paragraphs")
- **top_k**: Number of top entities/relations to retrieve
- **conversation_history**: Previous dialogue context for multi-turn conversations
- **max_total_tokens**: Token budget for the entire response
Returns:
StreamingResponse: NDJSON streaming response containing:
- **Streaming mode**: Multiple JSON objects, one per line
- References object (if requested): `{"references": [...]}`
- Content chunks: `{"response": "chunk content"}`
- Error objects: `{"error": "error message"}`
- **Non-streaming mode**: Single JSON object
- Complete response: `{"references": [...], "response": "complete content"}`
Raises:
HTTPException:
- 400: Invalid input parameters (e.g., query too short, invalid mode)
- 500: Internal processing error (e.g., LLM service unavailable)
Note:
This endpoint is ideal for applications requiring flexible response delivery.
Use streaming mode for real-time interfaces and non-streaming for batch processing.
"""
try:
# Use the stream parameter from the request, defaulting to True if not specified
stream_mode = request.stream if request.stream is not None else True
param = request.to_query_params(stream_mode)
from fastapi.responses import StreamingResponse
# Unified approach: always use aquery_llm for all cases
result = await rag.aquery_llm(request.query, param=param)
async def stream_generator():
# Extract references and LLM response from unified result
references = result.get("data", {}).get("references", [])
llm_response = result.get("llm_response", {})
if llm_response.get("is_streaming"):
# Streaming mode: send references first, then stream response chunks
if request.include_references:
yield f"{json.dumps({'references': references})}\n"
response_stream = llm_response.get("response_iterator")
if response_stream:
try:
async for chunk in response_stream:
if chunk: # Only send non-empty content
yield f"{json.dumps({'response': chunk})}\n"
except Exception as e:
logging.error(f"Streaming error: {str(e)}")
yield f"{json.dumps({'error': str(e)})}\n"
else:
# Non-streaming mode: send complete response in one message
response_content = llm_response.get("content", "")
if not response_content:
response_content = "No relevant context found for the query."
# Create complete response object
complete_response = {"response": response_content}
if request.include_references:
complete_response["references"] = references
yield f"{json.dumps(complete_response)}\n"
return StreamingResponse(
stream_generator(),
media_type="application/x-ndjson",
headers={
"Cache-Control": "no-cache",
"Connection": "keep-alive",
"Content-Type": "application/x-ndjson",
"X-Accel-Buffering": "no", # Ensure proper handling of streaming response when proxied by Nginx
},
)
except Exception as e:
trace_exception(e)
raise HTTPException(status_code=500, detail=str(e))
@router.post(
"/query/data",
response_model=QueryDataResponse,
dependencies=[Depends(combined_auth)],
responses={
200: {
"description": "Successful data retrieval response with structured RAG data",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": ["success", "failure"],
"description": "Query execution status",
},
"message": {
"type": "string",
"description": "Status message describing the result",
},
"data": {
"type": "object",
"properties": {
"entities": {
"type": "array",
"items": {
"type": "object",
"properties": {
"entity_name": {"type": "string"},
"entity_type": {"type": "string"},
"description": {"type": "string"},
"source_id": {"type": "string"},
"file_path": {"type": "string"},
"reference_id": {"type": "string"},
},
},
"description": "Retrieved entities from knowledge graph",
},
"relationships": {
"type": "array",
"items": {
"type": "object",
"properties": {
"src_id": {"type": "string"},
"tgt_id": {"type": "string"},
"description": {"type": "string"},
"keywords": {"type": "string"},
"weight": {"type": "number"},
"source_id": {"type": "string"},
"file_path": {"type": "string"},
"reference_id": {"type": "string"},
},
},
"description": "Retrieved relationships from knowledge graph",
},
"chunks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"content": {"type": "string"},
"file_path": {"type": "string"},
"chunk_id": {"type": "string"},
"reference_id": {"type": "string"},
},
},
"description": "Retrieved text chunks from vector database",
},
"references": {
"type": "array",
"items": {
"type": "object",
"properties": {
"reference_id": {"type": "string"},
"file_path": {"type": "string"},
},
},
"description": "Reference list for citation purposes",
},
},
"description": "Structured retrieval data containing entities, relationships, chunks, and references",
},
"metadata": {
"type": "object",
"properties": {
"query_mode": {"type": "string"},
"keywords": {
"type": "object",
"properties": {
"high_level": {
"type": "array",
"items": {"type": "string"},
},
"low_level": {
"type": "array",
"items": {"type": "string"},
},
},
},
"processing_info": {
"type": "object",
"properties": {
"total_entities_found": {
"type": "integer"
},
"total_relations_found": {
"type": "integer"
},
"entities_after_truncation": {
"type": "integer"
},
"relations_after_truncation": {
"type": "integer"
},
"final_chunks_count": {
"type": "integer"
},
},
},
},
"description": "Query metadata including mode, keywords, and processing information",
},
},
"required": ["status", "message", "data", "metadata"],
},
"examples": {
"successful_local_mode": {
"summary": "Local mode data retrieval",
"description": "Example of structured data from local mode query focusing on specific entities",
"value": {
"status": "success",
"message": "Query executed successfully",
"data": {
"entities": [
{
"entity_name": "Neural Networks",
"entity_type": "CONCEPT",
"description": "Computational models inspired by biological neural networks",
"source_id": "chunk-123",
"file_path": "/documents/ai_basics.pdf",
"reference_id": "1",
}
],
"relationships": [
{
"src_id": "Neural Networks",
"tgt_id": "Machine Learning",
"description": "Neural networks are a subset of machine learning algorithms",
"keywords": "subset, algorithm, learning",
"weight": 0.85,
"source_id": "chunk-123",
"file_path": "/documents/ai_basics.pdf",
"reference_id": "1",
}
],
"chunks": [
{
"content": "Neural networks are computational models that mimic the way biological neural networks work...",
"file_path": "/documents/ai_basics.pdf",
"chunk_id": "chunk-123",
"reference_id": "1",
}
],
"references": [
{
"reference_id": "1",
"file_path": "/documents/ai_basics.pdf",
}
],
},
"metadata": {
"query_mode": "local",
"keywords": {
"high_level": ["neural", "networks"],
"low_level": [
"computation",
"model",
"algorithm",
],
},
"processing_info": {
"total_entities_found": 5,
"total_relations_found": 3,
"entities_after_truncation": 1,
"relations_after_truncation": 1,
"final_chunks_count": 1,
},
},
},
},
"global_mode": {
"summary": "Global mode data retrieval",
"description": "Example of structured data from global mode query analyzing broader patterns",
"value": {
"status": "success",
"message": "Query executed successfully",
"data": {
"entities": [],
"relationships": [
{
"src_id": "Artificial Intelligence",
"tgt_id": "Machine Learning",
"description": "AI encompasses machine learning as a core component",
"keywords": "encompasses, component, field",
"weight": 0.92,
"source_id": "chunk-456",
"file_path": "/documents/ai_overview.pdf",
"reference_id": "2",
}
],
"chunks": [],
"references": [
{
"reference_id": "2",
"file_path": "/documents/ai_overview.pdf",
}
],
},
"metadata": {
"query_mode": "global",
"keywords": {
"high_level": [
"artificial",
"intelligence",
"overview",
],
"low_level": [],
},
},
},
},
"naive_mode": {
"summary": "Naive mode data retrieval",
"description": "Example of structured data from naive mode using only vector search",
"value": {
"status": "success",
"message": "Query executed successfully",
"data": {
"entities": [],
"relationships": [],
"chunks": [
{
"content": "Deep learning is a subset of machine learning that uses neural networks with multiple layers...",
"file_path": "/documents/deep_learning.pdf",
"chunk_id": "chunk-789",
"reference_id": "3",
}
],
"references": [
{
"reference_id": "3",
"file_path": "/documents/deep_learning.pdf",
}
],
},
"metadata": {
"query_mode": "naive",
"keywords": {"high_level": [], "low_level": []},
},
},
},
},
}
},
},
400: {
"description": "Bad Request - Invalid input parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {"detail": {"type": "string"}},
},
"example": {
"detail": "Query text must be at least 3 characters long"
},
}
},
},
500: {
"description": "Internal Server Error - Data retrieval failed",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {"detail": {"type": "string"}},
},
"example": {
"detail": "Failed to retrieve data: Knowledge graph unavailable"
},
}
},
},
},
)
async def query_data(request: QueryRequest):
"""
Advanced data retrieval endpoint for structured RAG analysis.
This endpoint provides raw retrieval results without LLM generation, perfect for:
- **Data Analysis**: Examine what information would be used for RAG
- **System Integration**: Get structured data for custom processing
- **Debugging**: Understand retrieval behavior and quality
- **Research**: Analyze knowledge graph structure and relationships
**Key Features:**
- No LLM generation - pure data retrieval
- Complete structured output with entities, relationships, and chunks
- Always includes references for citation
- Detailed metadata about processing and keywords
- Compatible with all query modes and parameters
**Query Mode Behaviors:**
- **local**: Returns entities and their direct relationships + related chunks
- **global**: Returns relationship patterns across the knowledge graph
- **hybrid**: Combines local and global retrieval strategies
- **naive**: Returns only vector-retrieved text chunks (no knowledge graph)
- **mix**: Integrates knowledge graph data with vector-retrieved chunks
- **bypass**: Returns empty data arrays (used for direct LLM queries)
**Data Structure:**
- **entities**: Knowledge graph entities with descriptions and metadata
- **relationships**: Connections between entities with weights and descriptions
- **chunks**: Text segments from documents with source information
- **references**: Citation information mapping reference IDs to file paths
- **metadata**: Processing information, keywords, and query statistics
**Usage Examples:**
Analyze entity relationships:
```json
{
"query": "machine learning algorithms",
"mode": "local",
"top_k": 10
}
```
Explore global patterns:
```json
{
"query": "artificial intelligence trends",
"mode": "global",
"max_relation_tokens": 2000
}
```
Vector similarity search:
```json
{
"query": "neural network architectures",
"mode": "naive",
"chunk_top_k": 5
}
```
**Response Analysis:**
- **Empty arrays**: Normal for certain modes (e.g., naive mode has no entities/relationships)
- **Processing info**: Shows retrieval statistics and token usage
- **Keywords**: High-level and low-level keywords extracted from query
- **Reference mapping**: Links all data back to source documents
Args:
request (QueryRequest): The request object containing query parameters:
- **query**: The search query to analyze (min 3 characters)
- **mode**: Retrieval strategy affecting data types returned
- **top_k**: Number of top entities/relationships to retrieve
- **chunk_top_k**: Number of text chunks to retrieve
- **max_entity_tokens**: Token limit for entity context
- **max_relation_tokens**: Token limit for relationship context
- **max_total_tokens**: Overall token budget for retrieval
Returns:
QueryDataResponse: Structured JSON response containing:
- **status**: "success" or "failure"
- **message**: Human-readable status description
- **data**: Complete retrieval results with entities, relationships, chunks, references
- **metadata**: Query processing information and statistics
Raises:
HTTPException:
- 400: Invalid input parameters (e.g., query too short, invalid mode)
- 500: Internal processing error (e.g., knowledge graph unavailable)
Note:
This endpoint always includes references regardless of the include_references parameter,
as structured data analysis typically requires source attribution.
"""
try:
param = request.to_query_params(False) # No streaming for data endpoint
response = await rag.aquery_data(request.query, param=param)
# aquery_data returns the new format with status, message, data, and metadata
if isinstance(response, dict):
return QueryDataResponse(**response)
else:
# Handle unexpected response format
return QueryDataResponse(
status="failure",
message="Invalid response type",
data={},
)
except Exception as e:
trace_exception(e)
raise HTTPException(status_code=500, detail=str(e))
return router
|