Coverage for lib/import_util/lib_import_retrieval/models/models.py: 100%

44 statements  

« prev     ^ index     » next       coverage.py v7.9.1, created at 2026-01-26 23:58 +0100

1from pydantic import BaseModel 

2from typing import List, Optional 

3from enum import Enum 

4 

5 

6class Source(str, Enum): 

7 email = "email" 

8 file = "file" 

9 chat = "chat" 

10 

11 

12class DocumentMetadata(BaseModel): 

13 source: Optional[Source] = None 

14 source_id: Optional[str] = None 

15 url: Optional[str] = None 

16 created_at: Optional[str] = None 

17 author: Optional[str] = None 

18 

19 

20class DocumentChunkMetadata(DocumentMetadata): 

21 document_id: Optional[str] = None 

22 

23 

24class DocumentChunk(BaseModel): 

25 id: Optional[str] = None 

26 text: str 

27 metadata: DocumentChunkMetadata 

28 embedding: Optional[List[float]] = None 

29 

30 

31class DocumentChunkWithScore(DocumentChunk): 

32 score: float 

33 

34 

35class Document(BaseModel): 

36 id: Optional[str] = None 

37 text: str 

38 metadata: Optional[DocumentMetadata] = None 

39 

40 

41class DocumentWithChunks(Document): 

42 chunks: List[DocumentChunk] 

43 

44 

45class DocumentMetadataFilter(BaseModel): 

46 document_id: Optional[str] = None 

47 source: Optional[Source] = None 

48 source_id: Optional[str] = None 

49 author: Optional[str] = None 

50 start_date: Optional[str] = None # any date string format 

51 end_date: Optional[str] = None # any date string format 

52 

53 

54class Query(BaseModel): 

55 query: str 

56 filter: Optional[DocumentMetadataFilter] = None 

57 top_k: Optional[int] = 3 

58 

59 

60class QueryWithEmbedding(Query): 

61 embedding: List[float] 

62 

63 

64class QueryResult(BaseModel): 

65 query: str 

66 results: List[DocumentChunkWithScore]