template.go 9.13 KB
Newer Older
Michael Yang's avatar
Michael Yang committed
1
2
3
4
5
6
7
package template

import (
	"bytes"
	"embed"
	"encoding/json"
	"errors"
Michael Yang's avatar
Michael Yang committed
8
	"fmt"
Michael Yang's avatar
Michael Yang committed
9
10
11
12
13
14
15
16
17
18
	"io"
	"math"
	"slices"
	"strings"
	"sync"
	"text/template"
	"text/template/parse"

	"github.com/agnivade/levenshtein"
	"golang.org/x/exp/maps"
Michael Yang's avatar
lint  
Michael Yang committed
19
20

	"github.com/ollama/ollama/api"
Michael Yang's avatar
Michael Yang committed
21
22
23
24
25
26
)

//go:embed index.json
var indexBytes []byte

//go:embed *.gotmpl
27
//go:embed *.json
Michael Yang's avatar
Michael Yang committed
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
var templatesFS embed.FS

var templatesOnce = sync.OnceValues(func() ([]*named, error) {
	var templates []*named
	if err := json.Unmarshal(indexBytes, &templates); err != nil {
		return nil, err
	}

	for _, t := range templates {
		bts, err := templatesFS.ReadFile(t.Name + ".gotmpl")
		if err != nil {
			return nil, err
		}

		// normalize line endings
		t.Bytes = bytes.ReplaceAll(bts, []byte("\r\n"), []byte("\n"))
44
45
46
47
48
49
50
51
52

		params, err := templatesFS.ReadFile(t.Name + ".json")
		if err != nil {
			continue
		}

		if err := json.Unmarshal(params, &t.Parameters); err != nil {
			return nil, err
		}
Michael Yang's avatar
Michael Yang committed
53
54
55
56
57
58
59
60
61
	}

	return templates, nil
})

type named struct {
	Name     string `json:"name"`
	Template string `json:"template"`
	Bytes    []byte
62
63
64
65

	Parameters *struct {
		Stop []string `json:"stop"`
	}
Michael Yang's avatar
Michael Yang committed
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
}

func (t named) Reader() io.Reader {
	return bytes.NewReader(t.Bytes)
}

func Named(s string) (*named, error) {
	templates, err := templatesOnce()
	if err != nil {
		return nil, err
	}

	var template *named
	score := math.MaxInt
	for _, t := range templates {
		if s := levenshtein.ComputeDistance(s, t.Template); s < score {
			score = s
			template = t
		}
	}

	if score < 100 {
		return template, nil
	}

	return nil, errors.New("no matching template found")
}

Michael Yang's avatar
Michael Yang committed
94
95
var DefaultTemplate, _ = Parse("{{ .Prompt }}")

Michael Yang's avatar
Michael Yang committed
96
97
98
99
100
type Template struct {
	*template.Template
	raw string
}

Michael Yang's avatar
Michael Yang committed
101
// response is a template node that can be added to templates that don't already have one
Michael Yang's avatar
Michael Yang committed
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
var response = parse.ActionNode{
	NodeType: parse.NodeAction,
	Pipe: &parse.PipeNode{
		NodeType: parse.NodePipe,
		Cmds: []*parse.CommandNode{
			{
				NodeType: parse.NodeCommand,
				Args: []parse.Node{
					&parse.FieldNode{
						NodeType: parse.NodeField,
						Ident:    []string{"Response"},
					},
				},
			},
		},
	},
Michael Yang's avatar
Michael Yang committed
118
119
}

Michael Yang's avatar
tools  
Michael Yang committed
120
121
122
123
124
125
126
var funcs = template.FuncMap{
	"json": func(v any) string {
		b, _ := json.Marshal(v)
		return string(b)
	},
}

Michael Yang's avatar
Michael Yang committed
127
func Parse(s string) (*Template, error) {
Michael Yang's avatar
tools  
Michael Yang committed
128
	tmpl := template.New("").Option("missingkey=zero").Funcs(funcs)
Michael Yang's avatar
Michael Yang committed
129
130

	tmpl, err := tmpl.Parse(s)
Michael Yang's avatar
Michael Yang committed
131
132
133
134
	if err != nil {
		return nil, err
	}

Michael Yang's avatar
Michael Yang committed
135
136
137
138
139
140
141
142
143
144
145
	t := Template{Template: tmpl, raw: s}
	if vars := t.Vars(); !slices.Contains(vars, "messages") && !slices.Contains(vars, "response") {
		// touch up the template and append {{ .Response }}
		tmpl.Tree.Root.Nodes = append(tmpl.Tree.Root.Nodes, &response)
	}

	return &t, nil
}

func (t *Template) String() string {
	return t.raw
Michael Yang's avatar
Michael Yang committed
146
147
148
149
}

func (t *Template) Vars() []string {
	var vars []string
Michael Yang's avatar
Michael Yang committed
150
151
	for _, tt := range t.Templates() {
		for _, n := range tt.Root.Nodes {
Michael Yang's avatar
tools  
Michael Yang committed
152
			vars = append(vars, Identifiers(n)...)
Michael Yang's avatar
Michael Yang committed
153
		}
Michael Yang's avatar
Michael Yang committed
154
155
156
157
158
159
160
161
162
163
164
165
	}

	set := make(map[string]struct{})
	for _, n := range vars {
		set[strings.ToLower(n)] = struct{}{}
	}

	vars = maps.Keys(set)
	slices.Sort(vars)
	return vars
}

Michael Yang's avatar
Michael Yang committed
166
167
type Values struct {
	Messages []api.Message
168
169
170
	api.Tools
	Prompt string
	Suffix string
171
172
173

	// forceLegacy is a flag used to test compatibility with legacy templates
	forceLegacy bool
Michael Yang's avatar
Michael Yang committed
174
175
}

Michael Yang's avatar
tools  
Michael Yang committed
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
func (t *Template) Subtree(fn func(parse.Node) bool) *template.Template {
	var walk func(parse.Node) parse.Node
	walk = func(n parse.Node) parse.Node {
		if fn(n) {
			return n
		}

		switch t := n.(type) {
		case *parse.ListNode:
			for _, c := range t.Nodes {
				if n := walk(c); n != nil {
					return n
				}
			}
		case *parse.BranchNode:
			for _, n := range []*parse.ListNode{t.List, t.ElseList} {
				if n != nil {
					if n := walk(n); n != nil {
						return n
					}
				}
			}
		case *parse.IfNode:
			return walk(&t.BranchNode)
		case *parse.WithNode:
			return walk(&t.BranchNode)
		case *parse.RangeNode:
			return walk(&t.BranchNode)
		}

		return nil
	}

	if n := walk(t.Tree.Root); n != nil {
		return (&template.Template{
			Tree: &parse.Tree{
				Root: &parse.ListNode{
					Nodes: []parse.Node{n},
				},
			},
		}).Funcs(funcs)
	}

	return nil
}

Michael Yang's avatar
Michael Yang committed
222
func (t *Template) Execute(w io.Writer, v Values) error {
Michael Yang's avatar
Michael Yang committed
223
	system, messages := collate(v.Messages)
224
225
226
227
228
229
230
	if v.Prompt != "" && v.Suffix != "" {
		return t.Template.Execute(w, map[string]any{
			"Prompt":   v.Prompt,
			"Suffix":   v.Suffix,
			"Response": "",
		})
	} else if !v.forceLegacy && slices.Contains(t.Vars(), "messages") {
Michael Yang's avatar
Michael Yang committed
231
		return t.Template.Execute(w, map[string]any{
232
			"System":   system,
Michael Yang's avatar
Michael Yang committed
233
			"Messages": messages,
Michael Yang's avatar
tools  
Michael Yang committed
234
			"Tools":    v.Tools,
Michael Yang's avatar
Michael Yang committed
235
			"Response": "",
Michael Yang's avatar
Michael Yang committed
236
237
238
		})
	}

Michael Yang's avatar
Michael Yang committed
239
	system = ""
Michael Yang's avatar
Michael Yang committed
240
	var b bytes.Buffer
241
	var prompt, response string
Michael Yang's avatar
Michael Yang committed
242
	for _, m := range messages {
Michael Yang's avatar
tools  
Michael Yang committed
243
		execute := func() error {
Michael Yang's avatar
Michael Yang committed
244
			if err := t.Template.Execute(&b, map[string]any{
245
				"System":   system,
Michael Yang's avatar
Michael Yang committed
246
247
248
249
250
251
				"Prompt":   prompt,
				"Response": response,
			}); err != nil {
				return err
			}

252
			system = ""
Michael Yang's avatar
Michael Yang committed
253
254
			prompt = ""
			response = ""
Michael Yang's avatar
Michael Yang committed
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
			return nil
		}

		switch m.Role {
		case "system":
			if prompt != "" || response != "" {
				if err := execute(); err != nil {
					return err
				}
			}
			system = m.Content
		case "user":
			if response != "" {
				if err := execute(); err != nil {
					return err
				}
			}
			prompt = m.Content
		case "assistant":
			response = m.Content
Michael Yang's avatar
Michael Yang committed
275
276
277
278
		}
	}

	var cut bool
279
	nodes := deleteNode(t.Template.Root.Copy(), func(n parse.Node) bool {
Michael Yang's avatar
tools  
Michael Yang committed
280
281
		if field, ok := n.(*parse.FieldNode); ok && slices.Contains(field.Ident, "Response") {
			cut = true
282
			return false
Michael Yang's avatar
Michael Yang committed
283
284
285
286
287
		}

		return cut
	})

288
289
	tree := parse.Tree{Root: nodes.(*parse.ListNode)}
	if err := template.Must(template.New("").AddParseTree("", &tree)).Execute(&b, map[string]any{
Michael Yang's avatar
Michael Yang committed
290
291
		"System":   system,
		"Prompt":   prompt,
292
		"Response": response,
Michael Yang's avatar
Michael Yang committed
293
294
295
296
297
298
299
300
	}); err != nil {
		return err
	}

	_, err := io.Copy(w, &b)
	return err
}

Michael Yang's avatar
Michael Yang committed
301
// collate messages based on role. consecutive messages of the same role are merged
302
303
304
// into a single message. collate also collects and returns all system messages.
// collate mutates message content adding image tags ([img-%d]) as needed
func collate(msgs []api.Message) (string, []*api.Message) {
Michael Yang's avatar
Michael Yang committed
305
	var n int
306
307
308

	var system []string
	var collated []*api.Message
Michael Yang's avatar
Michael Yang committed
309
310
311
312
313
314
315
316
317
318
319
320
	for i := range msgs {
		msg := msgs[i]
		for range msg.Images {
			imageTag := fmt.Sprintf("[img-%d]", n)
			if !strings.Contains(msg.Content, "[img]") {
				msg.Content = strings.TrimSpace("[img] " + msg.Content)
			}

			msg.Content = strings.Replace(msg.Content, "[img]", imageTag, 1)
			n++
		}

321
322
323
324
		if msg.Role == "system" {
			system = append(system, msg.Content)
		}

Michael Yang's avatar
Michael Yang committed
325
326
327
328
329
330
331
		if len(collated) > 0 && collated[len(collated)-1].Role == msg.Role {
			collated[len(collated)-1].Content += "\n\n" + msg.Content
		} else {
			collated = append(collated, &msg)
		}
	}

332
	return strings.Join(system, "\n\n"), collated
Michael Yang's avatar
Michael Yang committed
333
334
}

Michael Yang's avatar
tools  
Michael Yang committed
335
336
// Identifiers walks the node tree returning any identifiers it finds along the way
func Identifiers(n parse.Node) []string {
Michael Yang's avatar
Michael Yang committed
337
	switch n := n.(type) {
Michael Yang's avatar
tools  
Michael Yang committed
338
339
340
341
	case *parse.ListNode:
		var names []string
		for _, n := range n.Nodes {
			names = append(names, Identifiers(n)...)
Michael Yang's avatar
Michael Yang committed
342
		}
Michael Yang's avatar
tools  
Michael Yang committed
343

Michael Yang's avatar
Michael Yang committed
344
		return names
Michael Yang's avatar
tools  
Michael Yang committed
345
346
347
348
349
350
351
352
353
354
	case *parse.TemplateNode:
		return Identifiers(n.Pipe)
	case *parse.ActionNode:
		return Identifiers(n.Pipe)
	case *parse.BranchNode:
		names := Identifiers(n.Pipe)
		for _, n := range []*parse.ListNode{n.List, n.ElseList} {
			if n != nil {
				names = append(names, Identifiers(n)...)
			}
Michael Yang's avatar
Michael Yang committed
355
356
		}
		return names
Michael Yang's avatar
tools  
Michael Yang committed
357
358
359
360
	case *parse.IfNode:
		return Identifiers(&n.BranchNode)
	case *parse.RangeNode:
		return Identifiers(&n.BranchNode)
Michael Yang's avatar
Michael Yang committed
361
	case *parse.WithNode:
Michael Yang's avatar
tools  
Michael Yang committed
362
		return Identifiers(&n.BranchNode)
Michael Yang's avatar
Michael Yang committed
363
364
365
366
	case *parse.PipeNode:
		var names []string
		for _, c := range n.Cmds {
			for _, a := range c.Args {
Michael Yang's avatar
tools  
Michael Yang committed
367
				names = append(names, Identifiers(a)...)
Michael Yang's avatar
Michael Yang committed
368
369
370
371
372
			}
		}
		return names
	case *parse.FieldNode:
		return n.Ident
Michael Yang's avatar
tools  
Michael Yang committed
373
374
	case *parse.VariableNode:
		return n.Ident
Michael Yang's avatar
Michael Yang committed
375
376
377
378
	}

	return nil
}
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
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447

// deleteNode walks the node list and deletes nodes that match the predicate
// this is currently to remove the {{ .Response }} node from templates
func deleteNode(n parse.Node, fn func(parse.Node) bool) parse.Node {
	var walk func(n parse.Node) parse.Node
	walk = func(n parse.Node) parse.Node {
		if fn(n) {
			return nil
		}

		switch t := n.(type) {
		case *parse.ListNode:
			var nodes []parse.Node
			for _, c := range t.Nodes {
				if n := walk(c); n != nil {
					nodes = append(nodes, n)
				}
			}

			t.Nodes = nodes
			return t
		case *parse.IfNode:
			t.BranchNode = *(walk(&t.BranchNode).(*parse.BranchNode))
		case *parse.WithNode:
			t.BranchNode = *(walk(&t.BranchNode).(*parse.BranchNode))
		case *parse.RangeNode:
			t.BranchNode = *(walk(&t.BranchNode).(*parse.BranchNode))
		case *parse.BranchNode:
			t.List = walk(t.List).(*parse.ListNode)
			if t.ElseList != nil {
				t.ElseList = walk(t.ElseList).(*parse.ListNode)
			}
		case *parse.ActionNode:
			n := walk(t.Pipe)
			if n == nil {
				return nil
			}

			t.Pipe = n.(*parse.PipeNode)
		case *parse.PipeNode:
			var commands []*parse.CommandNode
			for _, c := range t.Cmds {
				var args []parse.Node
				for _, a := range c.Args {
					if n := walk(a); n != nil {
						args = append(args, n)
					}
				}

				if len(args) == 0 {
					return nil
				}

				c.Args = args
				commands = append(commands, c)
			}

			if len(commands) == 0 {
				return nil
			}

			t.Cmds = commands
		}

		return n
	}

	return walk(n)
}