routes.go 31.8 KB
Newer Older
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1
2
3
package server

import (
4
	"context"
Michael Yang's avatar
Michael Yang committed
5
	"encoding/json"
6
	"errors"
7
	"fmt"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
8
	"io"
9
	"io/fs"
10
	"log/slog"
11
	"math"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
12
13
	"net"
	"net/http"
14
	"net/netip"
15
	"os"
16
	"os/signal"
Michael Yang's avatar
Michael Yang committed
17
	"path/filepath"
18
	"strconv"
Michael Yang's avatar
Michael Yang committed
19
	"strings"
20
	"syscall"
21
	"time"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
22

Michael Yang's avatar
Michael Yang committed
23
	"github.com/gin-contrib/cors"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
24
	"github.com/gin-gonic/gin"
25
	"golang.org/x/exp/slices"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
26

27
28
29
30
31
32
	"github.com/ollama/ollama/api"
	"github.com/ollama/ollama/gpu"
	"github.com/ollama/ollama/llm"
	"github.com/ollama/ollama/openai"
	"github.com/ollama/ollama/parser"
	"github.com/ollama/ollama/version"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
33
34
)

Michael Yang's avatar
Michael Yang committed
35
36
var mode string = gin.DebugMode

37
type Server struct {
Daniel Hiltgen's avatar
Daniel Hiltgen committed
38
39
	addr  net.Addr
	sched *Scheduler
40
41
}

Michael Yang's avatar
Michael Yang committed
42
43
44
45
46
47
48
49
50
51
52
53
func init() {
	switch mode {
	case gin.DebugMode:
	case gin.ReleaseMode:
	case gin.TestMode:
	default:
		mode = gin.DebugMode
	}

	gin.SetMode(mode)
}

54
55
var defaultSessionDuration = 5 * time.Minute

56
57
58
59
60
61
62
63
64
65
66
func modelOptions(model *Model, requestOpts map[string]interface{}) (api.Options, error) {
	opts := api.DefaultOptions()
	if err := opts.FromMap(model.Options); err != nil {
		return api.Options{}, err
	}

	if err := opts.FromMap(requestOpts); err != nil {
		return api.Options{}, err
	}

	return opts, nil
Bruce MacDonald's avatar
Bruce MacDonald committed
67
68
}

69
70
71
72
73
74
func isSupportedImageType(image []byte) bool {
	contentType := http.DetectContentType(image)
	allowedTypes := []string{"image/jpeg", "image/jpg", "image/png"}
	return slices.Contains(allowedTypes, contentType)
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
75
func (s *Server) GenerateHandler(c *gin.Context) {
Bruce MacDonald's avatar
Bruce MacDonald committed
76
77
78

	checkpointStart := time.Now()
	var req api.GenerateRequest
Michael Yang's avatar
Michael Yang committed
79
	err := c.ShouldBindJSON(&req)
Patrick Devine's avatar
Patrick Devine committed
80

Michael Yang's avatar
Michael Yang committed
81
82
83
84
85
86
	switch {
	case errors.Is(err, io.EOF):
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
	case err != nil:
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Bruce MacDonald's avatar
Bruce MacDonald committed
87
88
89
		return
	}

90
91
92
	// validate the request
	switch {
	case req.Model == "":
93
94
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
		return
95
96
97
	case len(req.Format) > 0 && req.Format != "json":
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "format must be json"})
		return
98
99
100
	case req.Raw && (req.Template != "" || req.System != "" || len(req.Context) > 0):
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "raw mode does not support template, system, or context"})
		return
101
102
	}

103
104
105
106
107
108
109
	for _, img := range req.Images {
		if !isSupportedImageType(img) {
			c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "unsupported image format"})
			return
		}
	}

110
	model, err := GetModel(req.Model)
Bruce MacDonald's avatar
Bruce MacDonald committed
111
	if err != nil {
112
		var pErr *fs.PathError
113
		if errors.As(err, &pErr) {
114
			c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found, try pulling it first", req.Model)})
115
116
117
118
119
120
			return
		}
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

121
	if model.IsEmbedding() {
122
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "embedding models do not support generate"})
123
124
125
		return
	}

126
127
128
	opts, err := modelOptions(model, req.Options)
	if err != nil {
		if errors.Is(err, api.ErrInvalidOpts) {
Bruce MacDonald's avatar
Bruce MacDonald committed
129
			c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
130
			return
131
		}
132
133
134
135
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

136
137
	var sessionDuration time.Duration
	if req.KeepAlive == nil {
138
		sessionDuration = getDefaultSessionDuration()
139
140
141
142
	} else {
		sessionDuration = req.KeepAlive.Duration
	}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
143
144
145
146
147
	rCh, eCh := s.sched.GetRunner(c.Request.Context(), model, opts, sessionDuration)
	var runner *runnerRef
	select {
	case runner = <-rCh:
	case err = <-eCh:
148
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
Bruce MacDonald's avatar
Bruce MacDonald committed
149
150
151
		return
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
152
	// an empty request loads the model
153
154
	// note: for a short while template was used in lieu
	// of `raw` mode so we need to check for it too
Bruce MacDonald's avatar
Bruce MacDonald committed
155
	if req.Prompt == "" && req.Template == "" && req.System == "" {
156
		c.JSON(http.StatusOK, api.GenerateResponse{
157
158
			CreatedAt: time.Now().UTC(),
			Model:     req.Model,
Michael Yang's avatar
Michael Yang committed
159
160
			Done:      true,
		})
Bruce MacDonald's avatar
Bruce MacDonald committed
161
162
163
164
165
		return
	}

	checkpointLoaded := time.Now()

Bruce MacDonald's avatar
Bruce MacDonald committed
166
167
168
169
170
	var prompt string
	switch {
	case req.Raw:
		prompt = req.Prompt
	case req.Prompt != "":
171
172
		if req.Template == "" {
			req.Template = model.Template
Bruce MacDonald's avatar
Bruce MacDonald committed
173
174
		}

175
176
177
178
179
180
181
182
183
		if req.System == "" {
			req.System = model.System
		}

		slog.Debug("generate handler", "prompt", req.Prompt)
		slog.Debug("generate handler", "template", req.Template)
		slog.Debug("generate handler", "system", req.System)

		var sb strings.Builder
Michael Yang's avatar
Michael Yang committed
184
185
186
187
188
189
190
191
192
193
194
195
196
		for i := range req.Images {
			fmt.Fprintf(&sb, "[img-%d] ", i)
		}

		sb.WriteString(req.Prompt)

		p, err := Prompt(req.Template, req.System, sb.String(), "", true)
		if err != nil {
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
			return
		}

		sb.Reset()
Bruce MacDonald's avatar
Bruce MacDonald committed
197
		if req.Context != nil {
Daniel Hiltgen's avatar
Daniel Hiltgen committed
198
			prev, err := runner.llama.Detokenize(c.Request.Context(), req.Context)
Bruce MacDonald's avatar
Bruce MacDonald committed
199
200
201
202
203
			if err != nil {
				c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
				return
			}

204
			sb.WriteString(prev)
205
206
		}

207
208
209
		sb.WriteString(p)

		prompt = sb.String()
Bruce MacDonald's avatar
Bruce MacDonald committed
210
211
	}

Michael Yang's avatar
Michael Yang committed
212
	slog.Debug("generate handler", "prompt", prompt)
213

Bruce MacDonald's avatar
Bruce MacDonald committed
214
	ch := make(chan any)
Bruce MacDonald's avatar
Bruce MacDonald committed
215
	var generated strings.Builder
Bruce MacDonald's avatar
Bruce MacDonald committed
216
217
218
	go func() {
		defer close(ch)

219
		fn := func(r llm.CompletionResponse) {
Bruce MacDonald's avatar
Bruce MacDonald committed
220
221
222
223
			// Build up the full response
			if _, err := generated.WriteString(r.Content); err != nil {
				ch <- gin.H{"error": err.Error()}
				return
Bruce MacDonald's avatar
Bruce MacDonald committed
224
225
			}

Bruce MacDonald's avatar
Bruce MacDonald committed
226
			resp := api.GenerateResponse{
227
				Model:     req.Model,
228
				CreatedAt: time.Now().UTC(),
229
230
				Done:      r.Done,
				Response:  r.Content,
Bruce MacDonald's avatar
Bruce MacDonald committed
231
232
233
234
235
236
				Metrics: api.Metrics{
					PromptEvalCount:    r.PromptEvalCount,
					PromptEvalDuration: r.PromptEvalDuration,
					EvalCount:          r.EvalCount,
					EvalDuration:       r.EvalDuration,
				},
Bruce MacDonald's avatar
Bruce MacDonald committed
237
238
			}

239
240
241
242
243
			if r.Done {
				resp.TotalDuration = time.Since(checkpointStart)
				resp.LoadDuration = checkpointLoaded.Sub(checkpointStart)

				if !req.Raw {
244
					p, err := Prompt(req.Template, req.System, req.Prompt, generated.String(), false)
245
					if err != nil {
246
						c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
247
248
						return
					}
249
250

					// TODO (jmorganca): encode() should not strip special tokens
Daniel Hiltgen's avatar
Daniel Hiltgen committed
251
					tokens, err := runner.llama.Tokenize(c.Request.Context(), p)
252
253
254
255
					if err != nil {
						ch <- gin.H{"error": err.Error()}
						return
					}
256
257

					resp.Context = append(req.Context, tokens...)
Bruce MacDonald's avatar
Bruce MacDonald committed
258
259
260
261
				}
			}

			ch <- resp
Bruce MacDonald's avatar
Bruce MacDonald committed
262
263
		}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
264
		var images []llm.ImageData
Michael Yang's avatar
Michael Yang committed
265
		for i := range req.Images {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
266
267
268
269
			images = append(images, llm.ImageData{
				ID:   i,
				Data: req.Images[i],
			})
Michael Yang's avatar
Michael Yang committed
270
271
		}

Bruce MacDonald's avatar
Bruce MacDonald committed
272
		// Start prediction
273
		req := llm.CompletionRequest{
274
275
			Prompt:  prompt,
			Format:  req.Format,
Michael Yang's avatar
Michael Yang committed
276
			Images:  images,
277
			Options: opts,
Bruce MacDonald's avatar
Bruce MacDonald committed
278
		}
Daniel Hiltgen's avatar
Daniel Hiltgen committed
279
		if err := runner.llama.Completion(c.Request.Context(), req, fn); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
280
281
282
283
284
			ch <- gin.H{"error": err.Error()}
		}
	}()

	if req.Stream != nil && !*req.Stream {
285
286
		// Accumulate responses into the final response
		var final api.GenerateResponse
Bruce MacDonald's avatar
Bruce MacDonald committed
287
		var sb strings.Builder
Bruce MacDonald's avatar
Bruce MacDonald committed
288
		for resp := range ch {
289
290
291
292
293
294
295
296
297
298
299
300
301
302
			switch r := resp.(type) {
			case api.GenerateResponse:
				sb.WriteString(r.Response)
				final = r
			case gin.H:
				if errorMsg, ok := r["error"].(string); ok {
					c.JSON(http.StatusInternalServerError, gin.H{"error": errorMsg})
					return
				} else {
					c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected error format in response"})
					return
				}
			default:
				c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected error"})
Bruce MacDonald's avatar
Bruce MacDonald committed
303
304
305
				return
			}
		}
306
307
308

		final.Response = sb.String()
		c.JSON(http.StatusOK, final)
Bruce MacDonald's avatar
Bruce MacDonald committed
309
310
311
312
313
314
		return
	}

	streamResponse(c, ch)
}

315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
func getDefaultSessionDuration() time.Duration {
	if t, exists := os.LookupEnv("OLLAMA_KEEP_ALIVE"); exists {
		v, err := strconv.Atoi(t)
		if err != nil {
			d, err := time.ParseDuration(t)
			if err != nil {
				return defaultSessionDuration
			}

			if d < 0 {
				return time.Duration(math.MaxInt64)
			}

			return d
		}

		d := time.Duration(v) * time.Second
		if d < 0 {
			return time.Duration(math.MaxInt64)
		}
		return d
	}

	return defaultSessionDuration
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
341
func (s *Server) EmbeddingsHandler(c *gin.Context) {
Bruce MacDonald's avatar
Bruce MacDonald committed
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
	var req api.EmbeddingRequest
	err := c.ShouldBindJSON(&req)
	switch {
	case errors.Is(err, io.EOF):
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
	case err != nil:
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

	if req.Model == "" {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
		return
	}

358
	model, err := GetModel(req.Model)
Bruce MacDonald's avatar
Bruce MacDonald committed
359
	if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
360
		var pErr *fs.PathError
361
		if errors.As(err, &pErr) {
Bruce MacDonald's avatar
Bruce MacDonald committed
362
			c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found, try pulling it first", req.Model)})
363
364
365
366
367
368
369
370
371
			return
		}
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

	opts, err := modelOptions(model, req.Options)
	if err != nil {
		if errors.Is(err, api.ErrInvalidOpts) {
Bruce MacDonald's avatar
Bruce MacDonald committed
372
			c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
373
			return
Bruce MacDonald's avatar
Bruce MacDonald committed
374
		}
375
376
377
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}
378
379
380

	var sessionDuration time.Duration
	if req.KeepAlive == nil {
381
		sessionDuration = getDefaultSessionDuration()
382
383
384
385
	} else {
		sessionDuration = req.KeepAlive.Duration
	}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
386
387
388
389
390
	rCh, eCh := s.sched.GetRunner(c.Request.Context(), model, opts, sessionDuration)
	var runner *runnerRef
	select {
	case runner = <-rCh:
	case err = <-eCh:
391
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
Bruce MacDonald's avatar
Bruce MacDonald committed
392
393
394
		return
	}

395
396
397
	// an empty request loads the model
	if req.Prompt == "" {
		c.JSON(http.StatusOK, api.EmbeddingResponse{Embedding: []float64{}})
Bruce MacDonald's avatar
Bruce MacDonald committed
398
399
400
		return
	}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
401
	embedding, err := runner.llama.Embedding(c.Request.Context(), req.Prompt)
Bruce MacDonald's avatar
Bruce MacDonald committed
402
	if err != nil {
403
		slog.Info(fmt.Sprintf("embedding generation failed: %v", err))
Bruce MacDonald's avatar
Bruce MacDonald committed
404
405
406
407
408
409
410
411
412
413
		c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to generate embedding"})
		return
	}

	resp := api.EmbeddingResponse{
		Embedding: embedding,
	}
	c.JSON(http.StatusOK, resp)
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
414
func (s *Server) PullModelHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
415
	var req api.PullRequest
Michael Yang's avatar
Michael Yang committed
416
417
418
419
420
421
422
	err := c.ShouldBindJSON(&req)
	switch {
	case errors.Is(err, io.EOF):
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
	case err != nil:
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Michael Yang's avatar
Michael Yang committed
423
424
425
		return
	}

Michael Yang's avatar
Michael Yang committed
426
427
428
429
430
431
432
	var model string
	if req.Model != "" {
		model = req.Model
	} else if req.Name != "" {
		model = req.Name
	} else {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
433
434
435
		return
	}

436
437
438
	ch := make(chan any)
	go func() {
		defer close(ch)
439
440
		fn := func(r api.ProgressResponse) {
			ch <- r
441
		}
442

Michael Yang's avatar
Michael Yang committed
443
		regOpts := &registryOptions{
444
445
446
			Insecure: req.Insecure,
		}

447
448
449
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

Michael Yang's avatar
Michael Yang committed
450
		if err := PullModel(ctx, model, regOpts, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
451
			ch <- gin.H{"error": err.Error()}
452
453
454
		}
	}()

455
456
457
458
459
	if req.Stream != nil && !*req.Stream {
		waitForStream(c, ch)
		return
	}

460
461
462
	streamResponse(c, ch)
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
463
func (s *Server) PushModelHandler(c *gin.Context) {
464
	var req api.PushRequest
Michael Yang's avatar
Michael Yang committed
465
466
467
468
469
470
471
	err := c.ShouldBindJSON(&req)
	switch {
	case errors.Is(err, io.EOF):
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
	case err != nil:
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Michael Yang's avatar
Michael Yang committed
472
473
		return
	}
Michael Yang's avatar
Michael Yang committed
474

Michael Yang's avatar
Michael Yang committed
475
476
477
478
479
480
481
	var model string
	if req.Model != "" {
		model = req.Model
	} else if req.Name != "" {
		model = req.Name
	} else {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
482
483
484
		return
	}

485
486
487
	ch := make(chan any)
	go func() {
		defer close(ch)
488
489
		fn := func(r api.ProgressResponse) {
			ch <- r
490
		}
491

Michael Yang's avatar
Michael Yang committed
492
		regOpts := &registryOptions{
493
494
495
			Insecure: req.Insecure,
		}

Michael Yang's avatar
Michael Yang committed
496
497
498
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

Michael Yang's avatar
Michael Yang committed
499
		if err := PushModel(ctx, model, regOpts, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
500
			ch <- gin.H{"error": err.Error()}
501
502
503
		}
	}()

504
505
506
507
508
	if req.Stream != nil && !*req.Stream {
		waitForStream(c, ch)
		return
	}

509
510
511
	streamResponse(c, ch)
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
512
func (s *Server) CreateModelHandler(c *gin.Context) {
513
	var req api.CreateRequest
Michael Yang's avatar
Michael Yang committed
514
515
516
517
518
519
520
	err := c.ShouldBindJSON(&req)
	switch {
	case errors.Is(err, io.EOF):
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
	case err != nil:
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Michael Yang's avatar
Michael Yang committed
521
		return
522
523
	}

Michael Yang's avatar
Michael Yang committed
524
525
526
527
528
529
530
	var model string
	if req.Model != "" {
		model = req.Model
	} else if req.Name != "" {
		model = req.Name
	} else {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
531
532
533
		return
	}

Michael Yang's avatar
Michael Yang committed
534
	if err := ParseModelPath(model).Validate(); err != nil {
535
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
536
537
538
		return
	}

Michael Yang's avatar
Michael Yang committed
539
540
	if req.Path == "" && req.Modelfile == "" {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "path or modelfile are required"})
Michael Yang's avatar
Michael Yang committed
541
542
		return
	}
Michael Yang's avatar
Michael Yang committed
543
544
545

	var modelfile io.Reader = strings.NewReader(req.Modelfile)
	if req.Path != "" && req.Modelfile == "" {
546
		mf, err := os.Open(req.Path)
Michael Yang's avatar
Michael Yang committed
547
548
549
550
		if err != nil {
			c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("error reading modelfile: %s", err)})
			return
		}
551
		defer mf.Close()
Michael Yang's avatar
Michael Yang committed
552

553
		modelfile = mf
Michael Yang's avatar
Michael Yang committed
554
	}
Michael Yang's avatar
Michael Yang committed
555
556
557
558
559
560
561

	commands, err := parser.Parse(modelfile)
	if err != nil {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

Michael Yang's avatar
Michael Yang committed
562
	ch := make(chan any)
Michael Yang's avatar
Michael Yang committed
563
564
	go func() {
		defer close(ch)
565
566
		fn := func(resp api.ProgressResponse) {
			ch <- resp
567
568
		}

569
570
571
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

Michael Yang's avatar
Michael Yang committed
572
		if err := CreateModel(ctx, model, filepath.Dir(req.Path), req.Quantization, commands, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
573
			ch <- gin.H{"error": err.Error()}
574
		}
Michael Yang's avatar
Michael Yang committed
575
	}()
Michael Yang's avatar
Michael Yang committed
576

577
578
579
580
581
	if req.Stream != nil && !*req.Stream {
		waitForStream(c, ch)
		return
	}

Michael Yang's avatar
Michael Yang committed
582
	streamResponse(c, ch)
Bruce MacDonald's avatar
Bruce MacDonald committed
583
584
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
585
func (s *Server) DeleteModelHandler(c *gin.Context) {
586
	var req api.DeleteRequest
Michael Yang's avatar
Michael Yang committed
587
588
589
590
591
592
593
	err := c.ShouldBindJSON(&req)
	switch {
	case errors.Is(err, io.EOF):
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
	case err != nil:
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
594
595
596
		return
	}

Michael Yang's avatar
Michael Yang committed
597
598
599
600
601
602
603
	var model string
	if req.Model != "" {
		model = req.Model
	} else if req.Name != "" {
		model = req.Name
	} else {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
604
605
606
		return
	}

Michael Yang's avatar
Michael Yang committed
607
	if err := DeleteModel(model); err != nil {
608
		if os.IsNotExist(err) {
Michael Yang's avatar
Michael Yang committed
609
			c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found", model)})
610
		} else {
611
612
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		}
613
614
		return
	}
Michael Yang's avatar
Michael Yang committed
615
616
617
618
619
620
621
622
623
624
625
626

	manifestsPath, err := GetManifestPath()
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

	if err := PruneDirectory(manifestsPath); err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

627
	c.JSON(http.StatusOK, nil)
628
629
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
630
func (s *Server) ShowModelHandler(c *gin.Context) {
Patrick Devine's avatar
Patrick Devine committed
631
	var req api.ShowRequest
Michael Yang's avatar
Michael Yang committed
632
633
634
635
636
637
638
	err := c.ShouldBindJSON(&req)
	switch {
	case errors.Is(err, io.EOF):
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
	case err != nil:
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Patrick Devine's avatar
Patrick Devine committed
639
640
641
		return
	}

Michael Yang's avatar
Michael Yang committed
642
	if req.Model != "" {
Michael Yang's avatar
Michael Yang committed
643
		// noop
Michael Yang's avatar
Michael Yang committed
644
	} else if req.Name != "" {
Michael Yang's avatar
Michael Yang committed
645
		req.Model = req.Name
Michael Yang's avatar
Michael Yang committed
646
	} else {
647
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
648
649
650
		return
	}

651
	resp, err := GetModelInfo(req)
Patrick Devine's avatar
Patrick Devine committed
652
653
	if err != nil {
		if os.IsNotExist(err) {
Michael Yang's avatar
Michael Yang committed
654
			c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found", req.Model)})
Patrick Devine's avatar
Patrick Devine committed
655
656
657
658
659
660
661
662
663
		} else {
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		}
		return
	}

	c.JSON(http.StatusOK, resp)
}

664
665
func GetModelInfo(req api.ShowRequest) (*api.ShowResponse, error) {
	model, err := GetModel(req.Model)
Patrick Devine's avatar
Patrick Devine committed
666
667
668
669
	if err != nil {
		return nil, err
	}

Patrick Devine's avatar
Patrick Devine committed
670
	modelDetails := api.ModelDetails{
671
		ParentModel:       model.ParentModel,
Patrick Devine's avatar
Patrick Devine committed
672
673
674
675
676
677
678
		Format:            model.Config.ModelFormat,
		Family:            model.Config.ModelFamily,
		Families:          model.Config.ModelFamilies,
		ParameterSize:     model.Config.ModelType,
		QuantizationLevel: model.Config.FileType,
	}

679
680
681
682
683
684
685
686
	if req.System != "" {
		model.System = req.System
	}

	if req.Template != "" {
		model.Template = req.Template
	}

687
688
689
690
691
	msgs := make([]api.Message, 0)
	for _, msg := range model.Messages {
		msgs = append(msgs, api.Message{Role: msg.Role, Content: msg.Content})
	}

Patrick Devine's avatar
Patrick Devine committed
692
693
694
695
	resp := &api.ShowResponse{
		License:  strings.Join(model.License, "\n"),
		System:   model.System,
		Template: model.Template,
Patrick Devine's avatar
Patrick Devine committed
696
		Details:  modelDetails,
697
		Messages: msgs,
Patrick Devine's avatar
Patrick Devine committed
698
699
700
701
702
703
704
705
	}

	var params []string
	cs := 30
	for k, v := range model.Options {
		switch val := v.(type) {
		case []interface{}:
			for _, nv := range val {
Patrick Devine's avatar
Patrick Devine committed
706
				params = append(params, fmt.Sprintf("%-*s %#v", cs, k, nv))
Patrick Devine's avatar
Patrick Devine committed
707
			}
Patrick Devine's avatar
Patrick Devine committed
708
709
		default:
			params = append(params, fmt.Sprintf("%-*s %#v", cs, k, v))
Patrick Devine's avatar
Patrick Devine committed
710
711
712
713
		}
	}
	resp.Parameters = strings.Join(params, "\n")

714
715
716
717
718
719
720
721
722
723
724
725
726
	for k, v := range req.Options {
		if _, ok := req.Options[k]; ok {
			model.Options[k] = v
		}
	}

	mf, err := ShowModelfile(model)
	if err != nil {
		return nil, err
	}

	resp.Modelfile = mf

Patrick Devine's avatar
Patrick Devine committed
727
728
729
	return resp, nil
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
730
func (s *Server) ListModelsHandler(c *gin.Context) {
731
	models := make([]api.ModelResponse, 0)
732
	manifestsPath, err := GetManifestPath()
Patrick Devine's avatar
Patrick Devine committed
733
734
735
736
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}
Michael Yang's avatar
Michael Yang committed
737

Patrick Devine's avatar
Patrick Devine committed
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
	modelResponse := func(modelName string) (api.ModelResponse, error) {
		model, err := GetModel(modelName)
		if err != nil {
			return api.ModelResponse{}, err
		}

		modelDetails := api.ModelDetails{
			Format:            model.Config.ModelFormat,
			Family:            model.Config.ModelFamily,
			Families:          model.Config.ModelFamilies,
			ParameterSize:     model.Config.ModelType,
			QuantizationLevel: model.Config.FileType,
		}

		return api.ModelResponse{
Michael Yang's avatar
Michael Yang committed
753
			Model:   model.ShortName,
Patrick Devine's avatar
Patrick Devine committed
754
755
756
757
758
759
760
			Name:    model.ShortName,
			Size:    model.Size,
			Digest:  model.Digest,
			Details: modelDetails,
		}, nil
	}

Michael Yang's avatar
Michael Yang committed
761
	walkFunc := func(path string, info os.FileInfo, _ error) error {
Patrick Devine's avatar
Patrick Devine committed
762
		if !info.IsDir() {
763
764
765
766
			path, tag := filepath.Split(path)
			model := strings.Trim(strings.TrimPrefix(path, manifestsPath), string(os.PathSeparator))
			modelPath := strings.Join([]string{model, tag}, ":")
			canonicalModelPath := strings.ReplaceAll(modelPath, string(os.PathSeparator), "/")
767

768
			resp, err := modelResponse(canonicalModelPath)
Patrick Devine's avatar
Patrick Devine committed
769
			if err != nil {
770
				slog.Info(fmt.Sprintf("skipping file: %s", canonicalModelPath))
Michael Yang's avatar
Michael Yang committed
771
				// nolint: nilerr
772
				return nil
Patrick Devine's avatar
Patrick Devine committed
773
			}
Michael Yang's avatar
Michael Yang committed
774

Patrick Devine's avatar
Patrick Devine committed
775
776
			resp.ModifiedAt = info.ModTime()
			models = append(models, resp)
Patrick Devine's avatar
Patrick Devine committed
777
		}
Michael Yang's avatar
Michael Yang committed
778

Patrick Devine's avatar
Patrick Devine committed
779
		return nil
Michael Yang's avatar
Michael Yang committed
780
781
	}

782
	if err := filepath.Walk(manifestsPath, walkFunc); err != nil {
Patrick Devine's avatar
Patrick Devine committed
783
784
785
786
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

Michael Yang's avatar
Michael Yang committed
787
	c.JSON(http.StatusOK, api.ListResponse{Models: models})
Patrick Devine's avatar
Patrick Devine committed
788
789
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
790
func (s *Server) CopyModelHandler(c *gin.Context) {
Patrick Devine's avatar
Patrick Devine committed
791
	var req api.CopyRequest
Michael Yang's avatar
Michael Yang committed
792
793
794
795
796
797
798
	err := c.ShouldBindJSON(&req)
	switch {
	case errors.Is(err, io.EOF):
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
	case err != nil:
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Patrick Devine's avatar
Patrick Devine committed
799
800
801
		return
	}

802
803
804
805
806
	if req.Source == "" || req.Destination == "" {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "source add destination are required"})
		return
	}

807
808
809
810
811
	if err := ParseModelPath(req.Destination).Validate(); err != nil {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

Patrick Devine's avatar
Patrick Devine committed
812
813
814
815
816
817
818
819
820
821
	if err := CopyModel(req.Source, req.Destination); err != nil {
		if os.IsNotExist(err) {
			c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found", req.Source)})
		} else {
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		}
		return
	}
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
822
func (s *Server) HeadBlobHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
823
824
825
826
827
828
829
830
831
832
833
	path, err := GetBlobsPath(c.Param("digest"))
	if err != nil {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

	if _, err := os.Stat(path); err != nil {
		c.AbortWithStatusJSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("blob %q not found", c.Param("digest"))})
		return
	}

Michael Yang's avatar
Michael Yang committed
834
	c.Status(http.StatusOK)
Michael Yang's avatar
Michael Yang committed
835
836
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
837
func (s *Server) CreateBlobHandler(c *gin.Context) {
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
	path, err := GetBlobsPath(c.Param("digest"))
	if err != nil {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

	_, err = os.Stat(path)
	switch {
	case errors.Is(err, os.ErrNotExist):
		// noop
	case err != nil:
		c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	default:
		c.Status(http.StatusOK)
		return
	}

856
	layer, err := NewLayer(c.Request.Body, "")
Michael Yang's avatar
Michael Yang committed
857
858
859
860
861
	if err != nil {
		c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

862
863
	if layer.Digest != c.Param("digest") {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("digest mismatch, expected %q, got %q", c.Param("digest"), layer.Digest)})
Michael Yang's avatar
Michael Yang committed
864
865
866
		return
	}

867
	if _, err := layer.Commit(); err != nil {
Michael Yang's avatar
Michael Yang committed
868
869
870
871
		c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

Michael Yang's avatar
Michael Yang committed
872
	c.Status(http.StatusCreated)
Michael Yang's avatar
Michael Yang committed
873
874
}

Michael Yang's avatar
Michael Yang committed
875
876
877
878
879
880
var defaultAllowOrigins = []string{
	"localhost",
	"127.0.0.1",
	"0.0.0.0",
}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
func isLocalIP(ip netip.Addr) bool {
	if interfaces, err := net.Interfaces(); err == nil {
		for _, iface := range interfaces {
			addrs, err := iface.Addrs()
			if err != nil {
				continue
			}

			for _, a := range addrs {
				if parsed, _, err := net.ParseCIDR(a.String()); err == nil {
					if parsed.String() == ip.String() {
						return true
					}
				}
			}
		}
	}

	return false
}

902
func allowedHost(host string) bool {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
903
	if host == "" || host == "localhost" {
904
905
906
907
908
909
910
911
		return true
	}

	if hostname, err := os.Hostname(); err == nil && host == hostname {
		return true
	}

	var tlds = []string{
Jeffrey Morgan's avatar
Jeffrey Morgan committed
912
913
914
		"localhost",
		"local",
		"internal",
915
	}
916

Jeffrey Morgan's avatar
Jeffrey Morgan committed
917
	// check if the host is a local TLD
918
919
920
921
922
923
	for _, tld := range tlds {
		if strings.HasSuffix(host, "."+tld) {
			return true
		}
	}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
924
	return false
Jeffrey Morgan's avatar
Jeffrey Morgan committed
925
}
926

Jeffrey Morgan's avatar
Jeffrey Morgan committed
927
928
929
func allowedHostsMiddleware(addr net.Addr) gin.HandlerFunc {
	return func(c *gin.Context) {
		if addr == nil {
930
931
932
933
			c.Next()
			return
		}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
934
		if addr, err := netip.ParseAddrPort(addr.String()); err == nil && !addr.Addr().IsLoopback() {
935
936
937
938
939
940
941
942
943
			c.Next()
			return
		}

		host, _, err := net.SplitHostPort(c.Request.Host)
		if err != nil {
			host = c.Request.Host
		}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
944
		if addr, err := netip.ParseAddr(host); err == nil {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
945
			if addr.IsLoopback() || addr.IsPrivate() || addr.IsUnspecified() || isLocalIP(addr) {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
946
947
948
949
950
				c.Next()
				return
			}
		}

951
952
953
954
955
956
957
		if allowedHost(host) {
			c.Next()
			return
		}

		c.AbortWithStatus(http.StatusForbidden)
	}
958
}
959

960
func (s *Server) GenerateRoutes() http.Handler {
Michael Yang's avatar
Michael Yang committed
961
962
	config := cors.DefaultConfig()
	config.AllowWildcard = true
963
	config.AllowBrowserExtensions = true
Michael Yang's avatar
Michael Yang committed
964

965
966
967
968
	if allowedOrigins := strings.Trim(os.Getenv("OLLAMA_ORIGINS"), "\"'"); allowedOrigins != "" {
		config.AllowOrigins = strings.Split(allowedOrigins, ",")
	}

Michael Yang's avatar
Michael Yang committed
969
970
971
972
973
974
975
976
	for _, allowOrigin := range defaultAllowOrigins {
		config.AllowOrigins = append(config.AllowOrigins,
			fmt.Sprintf("http://%s", allowOrigin),
			fmt.Sprintf("https://%s", allowOrigin),
			fmt.Sprintf("http://%s:*", allowOrigin),
			fmt.Sprintf("https://%s:*", allowOrigin),
		)
	}
Michael Yang's avatar
Michael Yang committed
977

Bruce MacDonald's avatar
Bruce MacDonald committed
978
	r := gin.Default()
979
980
	r.Use(
		cors.New(config),
981
		allowedHostsMiddleware(s.addr),
982
	)
Bruce MacDonald's avatar
Bruce MacDonald committed
983

Daniel Hiltgen's avatar
Daniel Hiltgen committed
984
985
986
987
988
989
990
991
992
993
994
	r.POST("/api/pull", s.PullModelHandler)
	r.POST("/api/generate", s.GenerateHandler)
	r.POST("/api/chat", s.ChatHandler)
	r.POST("/api/embeddings", s.EmbeddingsHandler)
	r.POST("/api/create", s.CreateModelHandler)
	r.POST("/api/push", s.PushModelHandler)
	r.POST("/api/copy", s.CopyModelHandler)
	r.DELETE("/api/delete", s.DeleteModelHandler)
	r.POST("/api/show", s.ShowModelHandler)
	r.POST("/api/blobs/:digest", s.CreateBlobHandler)
	r.HEAD("/api/blobs/:digest", s.HeadBlobHandler)
Jeffrey Morgan's avatar
Jeffrey Morgan committed
995

996
	// Compatibility endpoints
Daniel Hiltgen's avatar
Daniel Hiltgen committed
997
	r.POST("/v1/chat/completions", openai.Middleware(), s.ChatHandler)
998

Michael Yang's avatar
Michael Yang committed
999
1000
1001
1002
1003
	for _, method := range []string{http.MethodGet, http.MethodHead} {
		r.Handle(method, "/", func(c *gin.Context) {
			c.String(http.StatusOK, "Ollama is running")
		})

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1004
		r.Handle(method, "/api/tags", s.ListModelsHandler)
Michael Yang's avatar
Michael Yang committed
1005
1006
1007
		r.Handle(method, "/api/version", func(c *gin.Context) {
			c.JSON(http.StatusOK, gin.H{"version": version.Version})
		})
Michael Yang's avatar
Michael Yang committed
1008
1009
	}

1010
1011
1012
1013
	return r
}

func Serve(ln net.Listener) error {
Michael Yang's avatar
Michael Yang committed
1014
	level := slog.LevelInfo
1015
	if debug := os.Getenv("OLLAMA_DEBUG"); debug != "" {
Michael Yang's avatar
Michael Yang committed
1016
		level = slog.LevelDebug
1017
	}
Michael Yang's avatar
Michael Yang committed
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033

	handler := slog.NewTextHandler(os.Stderr, &slog.HandlerOptions{
		Level:     level,
		AddSource: true,
		ReplaceAttr: func(_ []string, attr slog.Attr) slog.Attr {
			if attr.Key == slog.SourceKey {
				source := attr.Value.Any().(*slog.Source)
				source.File = filepath.Base(source.File)
			}

			return attr
		},
	})

	slog.SetDefault(slog.New(handler))

1034
1035
1036
1037
1038
1039
1040
1041
	blobsDir, err := GetBlobsPath("")
	if err != nil {
		return err
	}
	if err := fixBlobs(blobsDir); err != nil {
		return err
	}

1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
	if noprune := os.Getenv("OLLAMA_NOPRUNE"); noprune == "" {
		// clean up unused layers and manifests
		if err := PruneLayers(); err != nil {
			return err
		}

		manifestsPath, err := GetManifestPath()
		if err != nil {
			return err
		}

		if err := PruneDirectory(manifestsPath); err != nil {
			return err
		}
	}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1058
1059
1060
	ctx, done := context.WithCancel(context.Background())
	sched := InitScheduler(ctx)
	s := &Server{addr: ln.Addr(), sched: sched}
1061
1062
	r := s.GenerateRoutes()

1063
	slog.Info(fmt.Sprintf("Listening on %s (version %s)", ln.Addr(), version.Version))
1064
	srvr := &http.Server{
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1065
1066
1067
		Handler: r,
	}

1068
1069
	// listen for a ctrl+c and stop any loaded llm
	signals := make(chan os.Signal, 1)
1070
	signal.Notify(signals, syscall.SIGINT, syscall.SIGTERM)
1071
1072
	go func() {
		<-signals
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1073
1074
		done()
		sched.unloadAllRunners()
1075
		gpu.Cleanup()
1076
1077
1078
		os.Exit(0)
	}()

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1079
	if err := llm.Init(); err != nil {
1080
1081
		return fmt.Errorf("unable to initialize llm library %w", err)
	}
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1082
1083
1084
1085
1086
1087

	s.sched.Run(ctx)

	// At startup we retrieve GPU information so we can get log messages before loading a model
	// This will log warnings to the log in case we have problems with detected GPUs
	_ = gpu.GetGPUInfo()
1088

1089
	return srvr.Serve(ln)
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1090
}
Michael Yang's avatar
Michael Yang committed
1091

1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
func waitForStream(c *gin.Context, ch chan interface{}) {
	c.Header("Content-Type", "application/json")
	for resp := range ch {
		switch r := resp.(type) {
		case api.ProgressResponse:
			if r.Status == "success" {
				c.JSON(http.StatusOK, r)
				return
			}
		case gin.H:
			if errorMsg, ok := r["error"].(string); ok {
				c.JSON(http.StatusInternalServerError, gin.H{"error": errorMsg})
				return
			} else {
				c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected error format in progress response"})
				return
			}
		default:
			c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected progress response"})
			return
		}
	}
	c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected end of progress response"})
}

Michael Yang's avatar
Michael Yang committed
1117
func streamResponse(c *gin.Context, ch chan any) {
1118
	c.Header("Content-Type", "application/x-ndjson")
Michael Yang's avatar
Michael Yang committed
1119
1120
1121
1122
1123
1124
1125
1126
	c.Stream(func(w io.Writer) bool {
		val, ok := <-ch
		if !ok {
			return false
		}

		bts, err := json.Marshal(val)
		if err != nil {
1127
			slog.Info(fmt.Sprintf("streamResponse: json.Marshal failed with %s", err))
Michael Yang's avatar
Michael Yang committed
1128
1129
1130
			return false
		}

1131
		// Delineate chunks with new-line delimiter
Michael Yang's avatar
Michael Yang committed
1132
1133
		bts = append(bts, '\n')
		if _, err := w.Write(bts); err != nil {
1134
			slog.Info(fmt.Sprintf("streamResponse: w.Write failed with %s", err))
Michael Yang's avatar
Michael Yang committed
1135
1136
1137
1138
1139
1140
			return false
		}

		return true
	})
}
Bruce MacDonald's avatar
Bruce MacDonald committed
1141

1142
// ChatPrompt builds up a prompt from a series of messages for the currently `loaded` model
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1143
func chatPrompt(ctx context.Context, runner *runnerRef, template string, messages []api.Message, numCtx int) (string, error) {
1144
	encode := func(s string) ([]int, error) {
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1145
		return runner.llama.Tokenize(ctx, s)
1146
1147
	}

1148
	prompt, err := ChatPrompt(template, messages, numCtx, encode)
1149
1150
1151
1152
1153
1154
1155
	if err != nil {
		return "", err
	}

	return prompt, nil
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1156
func (s *Server) ChatHandler(c *gin.Context) {
Bruce MacDonald's avatar
Bruce MacDonald committed
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
	checkpointStart := time.Now()

	var req api.ChatRequest
	err := c.ShouldBindJSON(&req)
	switch {
	case errors.Is(err, io.EOF):
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
	case err != nil:
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

	// validate the request
	switch {
	case req.Model == "":
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
		return
	case len(req.Format) > 0 && req.Format != "json":
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "format must be json"})
		return
	}

1180
	model, err := GetModel(req.Model)
Bruce MacDonald's avatar
Bruce MacDonald committed
1181
1182
	if err != nil {
		var pErr *fs.PathError
1183
		if errors.As(err, &pErr) {
Bruce MacDonald's avatar
Bruce MacDonald committed
1184
			c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found, try pulling it first", req.Model)})
1185
1186
1187
1188
1189
1190
			return
		}
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

1191
	if model.IsEmbedding() {
1192
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "embedding models do not support chat"})
1193
1194
1195
		return
	}

1196
1197
1198
	opts, err := modelOptions(model, req.Options)
	if err != nil {
		if errors.Is(err, api.ErrInvalidOpts) {
Bruce MacDonald's avatar
Bruce MacDonald committed
1199
			c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
1200
			return
Bruce MacDonald's avatar
Bruce MacDonald committed
1201
		}
1202
1203
1204
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}
1205
1206
1207

	var sessionDuration time.Duration
	if req.KeepAlive == nil {
1208
		sessionDuration = getDefaultSessionDuration()
1209
1210
1211
1212
	} else {
		sessionDuration = req.KeepAlive.Duration
	}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1213
1214
1215
1216
1217
	rCh, eCh := s.sched.GetRunner(c.Request.Context(), model, opts, sessionDuration)
	var runner *runnerRef
	select {
	case runner = <-rCh:
	case err = <-eCh:
1218
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
Bruce MacDonald's avatar
Bruce MacDonald committed
1219
1220
1221
1222
1223
		return
	}

	checkpointLoaded := time.Now()

1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
	// if the first message is not a system message, then add the model's default system message
	if len(req.Messages) > 0 && req.Messages[0].Role != "system" {
		req.Messages = append([]api.Message{
			{
				Role:    "system",
				Content: model.System,
			},
		}, req.Messages...)
	}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1234
	prompt, err := chatPrompt(c.Request.Context(), runner, model.Template, req.Messages, opts.NumCtx)
Bruce MacDonald's avatar
Bruce MacDonald committed
1235
1236
1237
1238
	if err != nil {
		c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}
Michael Yang's avatar
Michael Yang committed
1239

1240
	// an empty request loads the model
1241
	if len(req.Messages) == 0 || prompt == "" {
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
		resp := api.ChatResponse{
			CreatedAt: time.Now().UTC(),
			Model:     req.Model,
			Done:      true,
			Message:   api.Message{Role: "assistant"},
		}
		c.JSON(http.StatusOK, resp)
		return
	}

1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
	// only send images that are in the prompt
	var i int
	var images []llm.ImageData
	for _, m := range req.Messages {
		for _, img := range m.Images {
			if !isSupportedImageType(img) {
				c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "unsupported image format"})
				return
			}

			if strings.Contains(prompt, fmt.Sprintf("[img-%d]", i)) {
				images = append(images, llm.ImageData{Data: img, ID: i})
			}
			i += 1
		}
	}

	slog.Debug("chat handler", "prompt", prompt, "images", len(images))
1270

Bruce MacDonald's avatar
Bruce MacDonald committed
1271
1272
1273
1274
1275
	ch := make(chan any)

	go func() {
		defer close(ch)

1276
		fn := func(r llm.CompletionResponse) {
Bruce MacDonald's avatar
Bruce MacDonald committed
1277
1278

			resp := api.ChatResponse{
1279
				Model:     req.Model,
1280
				CreatedAt: time.Now().UTC(),
1281
				Message:   api.Message{Role: "assistant", Content: r.Content},
Bruce MacDonald's avatar
Bruce MacDonald committed
1282
1283
1284
1285
1286
1287
1288
1289
1290
				Done:      r.Done,
				Metrics: api.Metrics{
					PromptEvalCount:    r.PromptEvalCount,
					PromptEvalDuration: r.PromptEvalDuration,
					EvalCount:          r.EvalCount,
					EvalDuration:       r.EvalDuration,
				},
			}

1291
1292
1293
			if r.Done {
				resp.TotalDuration = time.Since(checkpointStart)
				resp.LoadDuration = checkpointLoaded.Sub(checkpointStart)
Bruce MacDonald's avatar
Bruce MacDonald committed
1294
1295
1296
1297
1298
			}

			ch <- resp
		}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1299
		if err := runner.llama.Completion(c.Request.Context(), llm.CompletionRequest{
1300
1301
			Prompt:  prompt,
			Format:  req.Format,
Michael Yang's avatar
Michael Yang committed
1302
			Images:  images,
1303
			Options: opts,
1304
		}, fn); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1305
1306
1307
1308
1309
			ch <- gin.H{"error": err.Error()}
		}
	}()

	if req.Stream != nil && !*req.Stream {
1310
1311
		// Accumulate responses into the final response
		var final api.ChatResponse
Bruce MacDonald's avatar
Bruce MacDonald committed
1312
1313
		var sb strings.Builder
		for resp := range ch {
1314
1315
			switch r := resp.(type) {
			case api.ChatResponse:
1316
				sb.WriteString(r.Message.Content)
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
				final = r
			case gin.H:
				if errorMsg, ok := r["error"].(string); ok {
					c.JSON(http.StatusInternalServerError, gin.H{"error": errorMsg})
					return
				} else {
					c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected error format in response"})
					return
				}
			default:
				c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected error"})
				return
Bruce MacDonald's avatar
Bruce MacDonald committed
1329
1330
			}
		}
1331

1332
		final.Message = api.Message{Role: "assistant", Content: sb.String()}
1333
		c.JSON(http.StatusOK, final)
Bruce MacDonald's avatar
Bruce MacDonald committed
1334
1335
1336
1337
1338
		return
	}

	streamResponse(c, ch)
}