Skip to content

Document

llmfy.vector_store.document

Document

Bases: BaseModel

Container for text document with dynamic metadata

Example usage: 

metadata = {
    "source": "llmfy",
}
meta = {
    "header_level": 1,
    "header_text": "Hello",
    **(metadata or {}),
}
doc = Document(
    id="doc_1",
    text="Sample",
    **meta,
)
print(doc)
print(doc.source)
print(doc.not_exist)

Source code in llmfy/vector_store/document.py 
 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
class Document(BaseModel):
    """Container for text document with dynamic metadata

    Example usage:
    ```python
    metadata = {
        "source": "llmfy",
    }
    meta = {
        "header_level": 1,
        "header_text": "Hello",
        **(metadata or {}),
    }
    doc = Document(
        id="doc_1",
        text="Sample",
        **meta,
    )
    print(doc)
    print(doc.source)
    print(doc.not_exist)
    ```
    """

    id: str
    text: str

    model_config = {
        "extra": "allow"  # Allow extra fields to be set dynamically (for metadata needs)
    }

    def __getattr__(self, name: str) -> Any:
        # Check normal attributes first
        try:
            return super().__getattribute__(name)
        except AttributeError:
            pass

        # Check Pydantic v2 dynamic fields
        extra = getattr(self, "model_extra", {})
        if name in extra:
            return extra[name]

        # Not found
        return None

id instance-attribute

text instance-attribute

model_config = {'extra': 'allow'} class-attribute instance-attribute

__getattr__(name)

Source code in llmfy/vector_store/document.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
50
def __getattr__(self, name: str) -> Any:
    # Check normal attributes first
    try:
        return super().__getattribute__(name)
    except AttributeError:
        pass

    # Check Pydantic v2 dynamic fields
    extra = getattr(self, "model_extra", {})
    if name in extra:
        return extra[name]

    # Not found
    return None