Skip to content

prompt

dandy.llm.prompt.prompt

Prompt dataclass

input = (None,) class-attribute instance-attribute

tag = (None,) class-attribute instance-attribute

estimated_token_count property

__post_init__

Source code in dandy/llm/prompt/prompt.py 
17
18
19
20
21
22
23
24
25
26
def __post_init__(
        self,
):
    self.snippets: list[snippet.BaseSnippet] = []

    if isinstance(self.input, Prompt):
        self.text(text=self.input.to_str())

    if isinstance(self.input, str):
        self.text(text=self.input)

__str__

Source code in dandy/llm/prompt/prompt.py 
28
29
def __str__(self) -> str:
    return self.to_str()

to_str

Source code in dandy/llm/prompt/prompt.py 
31
32
33
34
35
36
37
def to_str(self) -> str:
    prompt_string = ''.join([snippet_.to_str() for snippet_ in self.snippets])

    if isinstance(self.tag, str):
        return f'<{self.tag}>\n{prompt_string}\n</{self.tag}>\n'

    return prompt_string

dict

Source code in dandy/llm/prompt/prompt.py 
39
40
41
42
43
44
def dict(self, dictionary: dict, triple_backtick: bool = False) -> Self:
    self.snippets.append(
        snippet.DictionarySnippet(dictionary=dictionary, triple_backtick=triple_backtick)
    )

    return self

directory_list

Source code in dandy/llm/prompt/prompt.py 
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
def directory_list(
        self,
        directory_path: str | Path,
        max_depth: int | None = None,
        file_extensions: Sequence[str] | None = None,
        triple_backtick: bool = False,
) -> Self:
    self.snippets.append(
        snippet.DirectoryListSnippet(
            directory_path=directory_path,
            triple_backtick=triple_backtick,
            max_depth=max_depth,
            file_extensions=file_extensions,
        )
    )

    return self

divider

Source code in dandy/llm/prompt/prompt.py 
64
65
66
67
def divider(self) -> Self:
    self.snippets.append(snippet.DividerSnippet())

    return self

array

Source code in dandy/llm/prompt/prompt.py 
69
70
71
72
def array(self, items: list[str]) -> Self:
    self.snippets.append(snippet.ArraySnippet(items=items))

    return self

array_random_order

Source code in dandy/llm/prompt/prompt.py 
74
75
76
77
def array_random_order(self, items: list[str]) -> Self:
    self.snippets.append(snippet.ArrayRandomOrderSnippet(items=items))

    return self

file

Source code in dandy/llm/prompt/prompt.py 
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
def file(
        self, file_path: str | Path,
        encoding: str = 'utf-8',
        triple_backtick: bool = False,
        triple_backtick_label: str | None = None
) -> Self:
    self.snippets.append(
        snippet.FileSnippet(
            file_path=file_path,
            encoding=encoding,
            triple_backtick=triple_backtick,
            triple_backtick_label=triple_backtick_label
        )
    )

    return self

heading

Source code in dandy/llm/prompt/prompt.py 
100
101
102
103
104
105
106
107
108
109
110
def heading(
        self,
        heading: str,
) -> Self:
    self.snippets.append(
        snippet.HeadingSnippet(
            heading=heading,
        )
    )

    return self

lb

Source code in dandy/llm/prompt/prompt.py 
112
113
def lb(self) -> Self:
    return self.line_break()

line_break

Source code in dandy/llm/prompt/prompt.py 
115
116
117
118
def line_break(self) -> Self:
    self.snippets.append(snippet.LineBreakSnippet())

    return self

list

Source code in dandy/llm/prompt/prompt.py 
120
121
122
123
def list(self, items: list[str], triple_backtick: bool = False) -> Self:
    self.unordered_list(items=items, triple_backtick=triple_backtick)

    return self

intel

Source code in dandy/llm/prompt/prompt.py 
125
126
127
128
129
130
def intel(self, intel: BaseIntel, triple_backtick: bool = False) -> Self:
    self.snippets.append(
        snippet.IntelSnippet(intel=intel, triple_backtick=triple_backtick)
    )

    return self

intel_schema

Source code in dandy/llm/prompt/prompt.py 
132
133
134
135
136
137
138
139
140
141
def intel_schema(
        self, intel_class: type[BaseIntel], triple_backtick: bool = False
) -> Self:
    self.snippets.append(
        snippet.IntelSchemaSnippet(
            intel_class=intel_class, triple_backtick=triple_backtick
        )
    )

    return self

module_source

Source code in dandy/llm/prompt/prompt.py 
143
144
145
146
147
148
149
150
151
152
def module_source(self, module_name: str, triple_backtick: bool = True) -> Self:
    self.snippets.append(
        snippet.ModuleSourceSnippet(
            module_name=module_name,
            triple_backtick=triple_backtick,
            triple_backtick_label=module_name,
        )
    )

    return self

object_source

Source code in dandy/llm/prompt/prompt.py 
154
155
156
157
158
159
160
161
162
163
def object_source(self, object_module_name: str, triple_backtick: bool = True) -> Self:
    self.snippets.append(
        snippet.ObjectSourceSnippet(
            object_module_name=object_module_name,
            triple_backtick=triple_backtick,
            triple_backtick_label=object_module_name,
        )
    )

    return self

ordered_list

Source code in dandy/llm/prompt/prompt.py 
165
166
167
168
169
170
171
172
def ordered_list(
        self, items: builtins.list[str], triple_backtick: bool = False
) -> Self:
    self.snippets.append(
        snippet.OrderedListSnippet(items=items, triple_backtick=triple_backtick)
    )

    return self

prompt

Source code in dandy/llm/prompt/prompt.py 
174
175
176
177
178
179
def prompt(self, prompt: Self | str, triple_backtick: bool = False) -> Self:
    self.snippets.append(
        snippet.PromptSnippet(prompt=prompt, triple_backtick=triple_backtick)
    )

    return self

random_choice

Source code in dandy/llm/prompt/prompt.py 
181
182
183
184
185
186
187
188
189
190
191
def random_choice(
        self, choices: builtins.list[str], triple_backtick: bool = False
) -> Self:
    self.snippets.append(
        snippet.RandomChoiceSnippet(
            choices=choices,
            triple_backtick=triple_backtick,
        )
    )

    return self

sub_heading

Source code in dandy/llm/prompt/prompt.py 
193
194
195
196
197
198
199
200
201
202
203
def sub_heading(
        self,
        sub_heading: str,
) -> Self:
    self.snippets.append(
        snippet.SubHeadingSnippet(
            sub_heading=sub_heading,
        )
    )

    return self

text

Source code in dandy/llm/prompt/prompt.py 
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
def text(
        self,
        text: str = '',
        label: str = '',
        triple_backtick: bool = False,
        triple_backtick_label: str | None = None,
) -> Self:
    self.snippets.append(
        snippet.TextSnippet(
            text=text,
            label=label,
            triple_backtick=triple_backtick,
            triple_backtick_label=triple_backtick_label,
        )
    )

    return self

title

Source code in dandy/llm/prompt/prompt.py 
223
224
225
226
227
228
229
230
231
232
233
def title(
        self,
        title: str,
) -> Self:
    self.snippets.append(
        snippet.TitleSnippet(
            title=title,
        )
    )

    return self

unordered_list

Source code in dandy/llm/prompt/prompt.py 
235
236
237
238
239
240
241
242
def unordered_list(
        self, items: builtins.list[str], triple_backtick: bool = False
) -> Self:
    self.snippets.append(
        snippet.UnorderedListSnippet(items=items, triple_backtick=triple_backtick)
    )

    return self

unordered_random_list

Source code in dandy/llm/prompt/prompt.py 
244
245
246
247
248
249
250
251
252
253
254
255
def unordered_random_list(
        self, items: builtins.list[str], triple_backtick: bool = False
) -> Self:

    self.snippets.append(
        snippet.UnorderedRandomListSnippet(
            items=items,
            triple_backtick=triple_backtick
        )
    )

    return self