Skip to content

dspy.Example

dspy.Example(base=None, **kwargs)

Source code in dspy/primitives/example.py 
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
def __init__(self, base=None, **kwargs):
    # Internal storage and other attributes
    self._store = {}
    self._demos = []
    self._input_keys = None

    # Initialize from a base Example if provided
    if base and isinstance(base, type(self)):
        self._store = base._store.copy()

    # Initialize from a dict if provided
    elif base and isinstance(base, dict):
        self._store = base.copy()

    # Update with provided kwargs
    self._store.update(kwargs)

Functions

copy(**kwargs)

Source code in dspy/primitives/example.py 
98
99
def copy(self, **kwargs):
    return type(self)(base=self, **kwargs)

get(key, default=None)

Source code in dspy/primitives/example.py 
70
71
def get(self, key, default=None):
    return self._store.get(key, default)

inputs()

Source code in dspy/primitives/example.py 
78
79
80
81
82
83
84
85
86
87
def inputs(self):
    if self._input_keys is None:
        raise ValueError("Inputs have not been set for this example. Use `example.with_inputs()` to set them.")

    # return items that are in input_keys
    d = {key: self._store[key] for key in self._store if key in self._input_keys}
    # return type(self)(d)
    new_instance = type(self)(base=d)
    new_instance._input_keys = self._input_keys  # Preserve input_keys in new instance
    return new_instance

items(include_dspy=False)

Source code in dspy/primitives/example.py 
67
68
def items(self, include_dspy=False):
    return [(k, v) for k, v in self._store.items() if not k.startswith("dspy_") or include_dspy]

keys(include_dspy=False)

Source code in dspy/primitives/example.py 
61
62
def keys(self, include_dspy=False):
    return [k for k in self._store.keys() if not k.startswith("dspy_") or include_dspy]

labels()

Source code in dspy/primitives/example.py 
89
90
91
92
93
def labels(self):
    # return items that are NOT in input_keys
    input_keys = self.inputs().keys()
    d = {key: self._store[key] for key in self._store if key not in input_keys}
    return type(self)(d)

toDict()

Source code in dspy/primitives/example.py 
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
def toDict(self):  # noqa: N802
    def convert_to_serializable(value):
        if hasattr(value, "toDict"):
            return value.toDict()
        elif isinstance(value, list):
            return [convert_to_serializable(item) for item in value]
        elif isinstance(value, dict):
            return {k: convert_to_serializable(v) for k, v in value.items()}
        else:
            return value

    serializable_store = {}
    for k, v in self._store.items():
        serializable_store[k] = convert_to_serializable(v)

    return serializable_store

values(include_dspy=False)

Source code in dspy/primitives/example.py 
64
65
def values(self, include_dspy=False):
    return [v for k, v in self._store.items() if not k.startswith("dspy_") or include_dspy]

with_inputs(*keys)

Source code in dspy/primitives/example.py 
73
74
75
76
def with_inputs(self, *keys):
    copied = self.copy()
    copied._input_keys = set(keys)
    return copied

without(*keys)

Source code in dspy/primitives/example.py 
101
102
103
104
105
def without(self, *keys):
    copied = self.copy()
    for key in keys:
        del copied[key]
    return copied

:::