File size: 11,954 Bytes
d520909
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
"""
Document Retriever with Grounding

Provides:
- Semantic search over document chunks
- Metadata filtering (chunk_type, page range, etc.)
- Evidence grounding with bbox and page references
"""

from typing import List, Optional, Dict, Any, Tuple
from pydantic import BaseModel, Field
from loguru import logger

from .store import VectorStore, VectorSearchResult, get_vector_store, VectorStoreConfig
from .embeddings import EmbeddingAdapter, get_embedding_adapter, EmbeddingConfig

# Import evidence types from document module
import sys
if "src.document" in sys.modules or True:
    try:
        from ..document.schemas.core import EvidenceRef, BoundingBox, DocumentChunk
        DOCUMENT_TYPES_AVAILABLE = True
    except ImportError:
        DOCUMENT_TYPES_AVAILABLE = False
else:
    DOCUMENT_TYPES_AVAILABLE = False


class RetrieverConfig(BaseModel):
    """Configuration for document retriever."""
    # Search parameters
    default_top_k: int = Field(default=5, ge=1, description="Default number of results")
    similarity_threshold: float = Field(
        default=0.7,
        ge=0.0,
        le=1.0,
        description="Minimum similarity score"
    )
    max_results: int = Field(default=20, ge=1, description="Maximum results to return")

    # Reranking
    enable_reranking: bool = Field(default=False, description="Enable result reranking")
    rerank_top_k: int = Field(default=10, ge=1, description="Number to rerank")

    # Evidence settings
    include_evidence: bool = Field(default=True, description="Include evidence references")
    evidence_snippet_length: int = Field(
        default=200,
        ge=50,
        description="Maximum snippet length in evidence"
    )


class RetrievedChunk(BaseModel):
    """A retrieved chunk with evidence."""
    chunk_id: str
    document_id: str
    text: str
    similarity: float

    # Location
    page: Optional[int] = None
    chunk_type: Optional[str] = None

    # Bounding box
    bbox_x_min: Optional[float] = None
    bbox_y_min: Optional[float] = None
    bbox_x_max: Optional[float] = None
    bbox_y_max: Optional[float] = None

    # Source
    source_path: Optional[str] = None
    sequence_index: Optional[int] = None
    confidence: Optional[float] = None

    def to_evidence_ref(self) -> Optional[Any]:
        """Convert to EvidenceRef if document types available."""
        if not DOCUMENT_TYPES_AVAILABLE:
            return None

        bbox = None
        if all(v is not None for v in [self.bbox_x_min, self.bbox_y_min,
                                        self.bbox_x_max, self.bbox_y_max]):
            bbox = BoundingBox(
                x_min=self.bbox_x_min,
                y_min=self.bbox_y_min,
                x_max=self.bbox_x_max,
                y_max=self.bbox_y_max,
            )

        return EvidenceRef(
            chunk_id=self.chunk_id,
            page=self.page or 0,
            bbox=bbox or BoundingBox(x_min=0, y_min=0, x_max=0, y_max=0),
            source_type=self.chunk_type or "text",
            snippet=self.text[:200] + ("..." if len(self.text) > 200 else ""),
            confidence=self.confidence or self.similarity,
        )


class DocumentRetriever:
    """
    Document retriever with grounding support.

    Features:
    - Semantic search over indexed chunks
    - Metadata filtering
    - Evidence grounding
    - Optional reranking
    """

    def __init__(
        self,
        config: Optional[RetrieverConfig] = None,
        vector_store: Optional[VectorStore] = None,
        embedding_adapter: Optional[EmbeddingAdapter] = None,
    ):
        """
        Initialize retriever.

        Args:
            config: Retriever configuration
            vector_store: Vector store instance (or uses global)
            embedding_adapter: Embedding adapter (or uses global)
        """
        self.config = config or RetrieverConfig()
        self._store = vector_store
        self._embedder = embedding_adapter

    @property
    def store(self) -> VectorStore:
        """Get vector store (lazy initialization)."""
        if self._store is None:
            self._store = get_vector_store()
        return self._store

    @property
    def embedder(self) -> EmbeddingAdapter:
        """Get embedding adapter (lazy initialization)."""
        if self._embedder is None:
            self._embedder = get_embedding_adapter()
        return self._embedder

    def retrieve(
        self,
        query: str,
        top_k: Optional[int] = None,
        filters: Optional[Dict[str, Any]] = None,
    ) -> List[RetrievedChunk]:
        """
        Retrieve relevant chunks for a query.

        Args:
            query: Search query
            top_k: Number of results (default from config)
            filters: Metadata filters (document_id, chunk_type, page, etc.)

        Returns:
            List of retrieved chunks with evidence
        """
        top_k = top_k or self.config.default_top_k

        # Embed query
        query_embedding = self.embedder.embed_text(query)

        # Search
        results = self.store.search(
            query_embedding=query_embedding,
            top_k=min(top_k, self.config.max_results),
            filters=filters,
        )

        # Convert to RetrievedChunk
        chunks = []
        for result in results:
            # Extract bbox from metadata
            bbox = result.bbox or {}

            chunk = RetrievedChunk(
                chunk_id=result.chunk_id,
                document_id=result.document_id,
                text=result.text,
                similarity=result.similarity,
                page=result.page,
                chunk_type=result.chunk_type,
                bbox_x_min=bbox.get("x_min"),
                bbox_y_min=bbox.get("y_min"),
                bbox_x_max=bbox.get("x_max"),
                bbox_y_max=bbox.get("y_max"),
                source_path=result.metadata.get("source_path"),
                sequence_index=result.metadata.get("sequence_index"),
                confidence=result.metadata.get("confidence"),
            )
            chunks.append(chunk)

        logger.debug(f"Retrieved {len(chunks)} chunks for query: {query[:50]}...")
        return chunks

    def retrieve_with_evidence(
        self,
        query: str,
        top_k: Optional[int] = None,
        filters: Optional[Dict[str, Any]] = None,
    ) -> Tuple[List[RetrievedChunk], List[Any]]:
        """
        Retrieve chunks with evidence references.

        Args:
            query: Search query
            top_k: Number of results
            filters: Metadata filters

        Returns:
            Tuple of (chunks, evidence_refs)
        """
        chunks = self.retrieve(query, top_k, filters)

        evidence_refs = []
        if self.config.include_evidence and DOCUMENT_TYPES_AVAILABLE:
            for chunk in chunks:
                evidence = chunk.to_evidence_ref()
                if evidence:
                    evidence_refs.append(evidence)

        return chunks, evidence_refs

    def retrieve_by_document(
        self,
        document_id: str,
        query: Optional[str] = None,
        top_k: Optional[int] = None,
    ) -> List[RetrievedChunk]:
        """
        Retrieve chunks from a specific document.

        Args:
            document_id: Document to search in
            query: Optional query (returns all if not provided)
            top_k: Number of results

        Returns:
            List of chunks from document
        """
        filters = {"document_id": document_id}

        if query:
            return self.retrieve(query, top_k, filters)

        # Without query, return all chunks for document
        # Use a generic query to trigger search
        return self.retrieve("document content", top_k or 100, filters)

    def retrieve_by_page(
        self,
        query: str,
        page_range: Tuple[int, int],
        document_id: Optional[str] = None,
        top_k: Optional[int] = None,
    ) -> List[RetrievedChunk]:
        """
        Retrieve chunks from specific page range.

        Args:
            query: Search query
            page_range: (start_page, end_page) tuple
            document_id: Optional document filter
            top_k: Number of results

        Returns:
            List of chunks from page range
        """
        filters = {
            "page": {"min": page_range[0], "max": page_range[1]},
        }

        if document_id:
            filters["document_id"] = document_id

        return self.retrieve(query, top_k, filters)

    def retrieve_tables(
        self,
        query: str,
        document_id: Optional[str] = None,
        top_k: Optional[int] = None,
    ) -> List[RetrievedChunk]:
        """
        Retrieve table chunks.

        Args:
            query: Search query
            document_id: Optional document filter
            top_k: Number of results

        Returns:
            List of table chunks
        """
        filters = {"chunk_type": "table"}

        if document_id:
            filters["document_id"] = document_id

        return self.retrieve(query, top_k, filters)

    def retrieve_figures(
        self,
        query: str,
        document_id: Optional[str] = None,
        top_k: Optional[int] = None,
    ) -> List[RetrievedChunk]:
        """
        Retrieve figure/chart chunks.

        Args:
            query: Search query
            document_id: Optional document filter
            top_k: Number of results

        Returns:
            List of figure chunks
        """
        filters = {"chunk_type": ["figure", "chart"]}

        if document_id:
            filters["document_id"] = document_id

        return self.retrieve(query, top_k, filters)

    def build_context(
        self,
        chunks: List[RetrievedChunk],
        max_length: Optional[int] = None,
        include_metadata: bool = True,
    ) -> str:
        """
        Build context string from retrieved chunks.

        Args:
            chunks: Retrieved chunks
            max_length: Maximum context length
            include_metadata: Include chunk metadata

        Returns:
            Formatted context string
        """
        if not chunks:
            return ""

        context_parts = []

        for i, chunk in enumerate(chunks, 1):
            if include_metadata:
                header = f"[{i}] "
                if chunk.page is not None:
                    header += f"Page {chunk.page + 1}"
                if chunk.chunk_type:
                    header += f" ({chunk.chunk_type})"
                header += f" - Similarity: {chunk.similarity:.2f}"
                context_parts.append(header)

            context_parts.append(chunk.text)
            context_parts.append("")  # Empty line separator

        context = "\n".join(context_parts)

        if max_length and len(context) > max_length:
            context = context[:max_length] + "\n...[truncated]"

        return context


# Global instance and factory
_document_retriever: Optional[DocumentRetriever] = None


def get_document_retriever(
    config: Optional[RetrieverConfig] = None,
    vector_store: Optional[VectorStore] = None,
    embedding_adapter: Optional[EmbeddingAdapter] = None,
) -> DocumentRetriever:
    """
    Get or create singleton document retriever.

    Args:
        config: Retriever configuration
        vector_store: Optional vector store instance
        embedding_adapter: Optional embedding adapter

    Returns:
        DocumentRetriever instance
    """
    global _document_retriever

    if _document_retriever is None:
        _document_retriever = DocumentRetriever(
            config=config,
            vector_store=vector_store,
            embedding_adapter=embedding_adapter,
        )

    return _document_retriever


def reset_document_retriever():
    """Reset the global retriever instance."""
    global _document_retriever
    _document_retriever = None