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

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

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

28
29
30
31
	"github.com/ollama/ollama/api"
	"github.com/ollama/ollama/gpu"
	"github.com/ollama/ollama/llm"
	"github.com/ollama/ollama/openai"
32
	"github.com/ollama/ollama/server/envconfig"
33
	"github.com/ollama/ollama/types/errtypes"
Michael Yang's avatar
Michael Yang committed
34
	"github.com/ollama/ollama/types/model"
35
	"github.com/ollama/ollama/version"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
36
37
)

Michael Yang's avatar
Michael Yang committed
38
39
var mode string = gin.DebugMode

40
type Server struct {
Daniel Hiltgen's avatar
Daniel Hiltgen committed
41
42
	addr  net.Addr
	sched *Scheduler
43
44
}

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

	gin.SetMode(mode)
}

57
58
var defaultSessionDuration = 5 * time.Minute

59
60
61
62
63
64
65
66
67
68
69
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
70
71
}

72
73
74
75
76
77
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
78
func (s *Server) GenerateHandler(c *gin.Context) {
Bruce MacDonald's avatar
Bruce MacDonald committed
79
80
81

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

Michael Yang's avatar
Michael Yang committed
84
85
86
87
88
89
	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
90
91
92
		return
	}

93
94
95
	// validate the request
	switch {
	case req.Model == "":
96
97
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
		return
98
99
100
	case len(req.Format) > 0 && req.Format != "json":
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "format must be json"})
		return
101
102
103
	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
104
105
	}

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

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

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

129
130
131
132
133
134
	opts, err := modelOptions(model, req.Options)
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

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

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

Bruce MacDonald's avatar
Bruce MacDonald committed
151
	// an empty request loads the model
152
153
	// 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
154
	if req.Prompt == "" && req.Template == "" && req.System == "" {
155
		c.JSON(http.StatusOK, api.GenerateResponse{
156
157
158
159
			CreatedAt:  time.Now().UTC(),
			Model:      req.Model,
			Done:       true,
			DoneReason: "load",
Michael Yang's avatar
Michael Yang committed
160
		})
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
228
229
230
231
				Model:      req.Model,
				CreatedAt:  time.Now().UTC(),
				Done:       r.Done,
				Response:   r.Content,
				DoneReason: r.DoneReason,
Bruce MacDonald's avatar
Bruce MacDonald committed
232
233
234
235
236
237
				Metrics: api.Metrics{
					PromptEvalCount:    r.PromptEvalCount,
					PromptEvalDuration: r.PromptEvalDuration,
					EvalCount:          r.EvalCount,
					EvalDuration:       r.EvalDuration,
				},
Bruce MacDonald's avatar
Bruce MacDonald committed
238
239
			}

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

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

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

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

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

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

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

	if req.Stream != nil && !*req.Stream {
286
287
		// Accumulate responses into the final response
		var final api.GenerateResponse
Bruce MacDonald's avatar
Bruce MacDonald committed
288
		var sb strings.Builder
Bruce MacDonald's avatar
Bruce MacDonald committed
289
		for resp := range ch {
290
291
292
293
294
295
296
297
298
299
300
301
302
303
			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
304
305
306
				return
			}
		}
307
308
309

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

	streamResponse(c, ch)
}

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
341
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
342
func (s *Server) EmbeddingsHandler(c *gin.Context) {
Bruce MacDonald's avatar
Bruce MacDonald committed
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
	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
	}

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

	opts, err := modelOptions(model, req.Options)
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}
375
376
377

	var sessionDuration time.Duration
	if req.KeepAlive == nil {
378
		sessionDuration = getDefaultSessionDuration()
379
380
381
382
	} else {
		sessionDuration = req.KeepAlive.Duration
	}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
383
384
385
386
387
	rCh, eCh := s.sched.GetRunner(c.Request.Context(), model, opts, sessionDuration)
	var runner *runnerRef
	select {
	case runner = <-rCh:
	case err = <-eCh:
388
		handleErrorResponse(c, err)
Bruce MacDonald's avatar
Bruce MacDonald committed
389
390
391
		return
	}

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

Daniel Hiltgen's avatar
Daniel Hiltgen committed
398
	embedding, err := runner.llama.Embedding(c.Request.Context(), req.Prompt)
Bruce MacDonald's avatar
Bruce MacDonald committed
399
	if err != nil {
400
		slog.Info(fmt.Sprintf("embedding generation failed: %v", err))
Bruce MacDonald's avatar
Bruce MacDonald committed
401
402
403
404
405
406
407
408
409
410
		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
411
func (s *Server) PullModelHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
412
	var req api.PullRequest
Michael Yang's avatar
Michael Yang committed
413
414
415
416
417
418
419
	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
420
421
422
		return
	}

Michael Yang's avatar
Michael Yang committed
423
424
425
426
427
428
429
	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"})
430
431
432
		return
	}

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

Michael Yang's avatar
Michael Yang committed
440
		regOpts := &registryOptions{
441
442
443
			Insecure: req.Insecure,
		}

444
445
446
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

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

452
453
454
455
456
	if req.Stream != nil && !*req.Stream {
		waitForStream(c, ch)
		return
	}

457
458
459
	streamResponse(c, ch)
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
460
func (s *Server) PushModelHandler(c *gin.Context) {
461
	var req api.PushRequest
Michael Yang's avatar
Michael Yang committed
462
463
464
465
466
467
468
	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
469
470
		return
	}
Michael Yang's avatar
Michael Yang committed
471

Michael Yang's avatar
Michael Yang committed
472
473
474
475
476
477
478
	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"})
479
480
481
		return
	}

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

Michael Yang's avatar
Michael Yang committed
489
		regOpts := &registryOptions{
490
491
492
			Insecure: req.Insecure,
		}

Michael Yang's avatar
Michael Yang committed
493
494
495
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

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

501
502
503
504
505
	if req.Stream != nil && !*req.Stream {
		waitForStream(c, ch)
		return
	}

506
507
508
	streamResponse(c, ch)
}

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

Michael Yang's avatar
Michael Yang committed
519
520
	name := model.ParseName(cmp.Or(req.Model, req.Name))
	if !name.IsValid() {
521
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": errtypes.InvalidModelNameErrMsg})
522
523
524
		return
	}

Michael Yang's avatar
Michael Yang committed
525
526
	if req.Path == "" && req.Modelfile == "" {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "path or modelfile are required"})
Michael Yang's avatar
Michael Yang committed
527
528
		return
	}
Michael Yang's avatar
Michael Yang committed
529

Michael Yang's avatar
Michael Yang committed
530
	var r io.Reader = strings.NewReader(req.Modelfile)
Michael Yang's avatar
Michael Yang committed
531
	if req.Path != "" && req.Modelfile == "" {
Michael Yang's avatar
Michael Yang committed
532
		f, err := os.Open(req.Path)
Michael Yang's avatar
Michael Yang committed
533
534
535
536
		if err != nil {
			c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("error reading modelfile: %s", err)})
			return
		}
Michael Yang's avatar
Michael Yang committed
537
		defer f.Close()
Michael Yang's avatar
Michael Yang committed
538

Michael Yang's avatar
Michael Yang committed
539
		r = f
Michael Yang's avatar
Michael Yang committed
540
	}
Michael Yang's avatar
Michael Yang committed
541

Michael Yang's avatar
Michael Yang committed
542
	modelfile, err := model.ParseFile(r)
Michael Yang's avatar
Michael Yang committed
543
544
545
546
547
	if err != nil {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

Michael Yang's avatar
Michael Yang committed
548
	ch := make(chan any)
Michael Yang's avatar
Michael Yang committed
549
550
	go func() {
		defer close(ch)
551
552
		fn := func(resp api.ProgressResponse) {
			ch <- resp
553
554
		}

555
556
557
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

558
559
560
561
562
563
		quantization := req.Quantization
		if req.Quantize != "" {
			quantization = req.Quantize
		}

		if err := CreateModel(ctx, name.String(), filepath.Dir(req.Path), strings.ToUpper(quantization), modelfile, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
564
			ch <- gin.H{"error": err.Error()}
565
		}
Michael Yang's avatar
Michael Yang committed
566
	}()
Michael Yang's avatar
Michael Yang committed
567

568
569
570
571
572
	if req.Stream != nil && !*req.Stream {
		waitForStream(c, ch)
		return
	}

Michael Yang's avatar
Michael Yang committed
573
	streamResponse(c, ch)
Bruce MacDonald's avatar
Bruce MacDonald committed
574
575
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
576
func (s *Server) DeleteModelHandler(c *gin.Context) {
577
578
	var r api.DeleteRequest
	if err := c.ShouldBindJSON(&r); errors.Is(err, io.EOF) {
Michael Yang's avatar
Michael Yang committed
579
580
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
581
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
582
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
583
584
585
		return
	}

586
587
588
	n := model.ParseName(cmp.Or(r.Model, r.Name))
	if !n.IsValid() {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("name %q is invalid", cmp.Or(r.Model, r.Name))})
589
590
		return
	}
Michael Yang's avatar
Michael Yang committed
591

592
	m, err := ParseNamedManifest(n)
Michael Yang's avatar
Michael Yang committed
593
594
595
596
597
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

598
	if err := m.Remove(); err != nil {
Michael Yang's avatar
Michael Yang committed
599
600
601
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}
602
603
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
604
func (s *Server) ShowModelHandler(c *gin.Context) {
Patrick Devine's avatar
Patrick Devine committed
605
	var req api.ShowRequest
Michael Yang's avatar
Michael Yang committed
606
607
608
609
610
611
612
	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
613
614
615
		return
	}

Michael Yang's avatar
Michael Yang committed
616
	if req.Model != "" {
Michael Yang's avatar
Michael Yang committed
617
		// noop
Michael Yang's avatar
Michael Yang committed
618
	} else if req.Name != "" {
Michael Yang's avatar
Michael Yang committed
619
		req.Model = req.Name
Michael Yang's avatar
Michael Yang committed
620
	} else {
621
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
622
623
624
		return
	}

625
	resp, err := GetModelInfo(req)
Patrick Devine's avatar
Patrick Devine committed
626
627
	if err != nil {
		if os.IsNotExist(err) {
Michael Yang's avatar
Michael Yang committed
628
			c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found", req.Model)})
Patrick Devine's avatar
Patrick Devine committed
629
630
631
632
633
634
635
636
637
		} else {
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		}
		return
	}

	c.JSON(http.StatusOK, resp)
}

638
639
func GetModelInfo(req api.ShowRequest) (*api.ShowResponse, error) {
	model, err := GetModel(req.Model)
Patrick Devine's avatar
Patrick Devine committed
640
641
642
643
	if err != nil {
		return nil, err
	}

Patrick Devine's avatar
Patrick Devine committed
644
	modelDetails := api.ModelDetails{
645
		ParentModel:       model.ParentModel,
Patrick Devine's avatar
Patrick Devine committed
646
647
648
649
650
651
652
		Format:            model.Config.ModelFormat,
		Family:            model.Config.ModelFamily,
		Families:          model.Config.ModelFamilies,
		ParameterSize:     model.Config.ModelType,
		QuantizationLevel: model.Config.FileType,
	}

653
654
655
656
657
658
659
660
	if req.System != "" {
		model.System = req.System
	}

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

661
662
663
664
665
	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
666
667
668
669
	resp := &api.ShowResponse{
		License:  strings.Join(model.License, "\n"),
		System:   model.System,
		Template: model.Template,
Patrick Devine's avatar
Patrick Devine committed
670
		Details:  modelDetails,
671
		Messages: msgs,
Patrick Devine's avatar
Patrick Devine committed
672
673
674
675
676
677
678
679
	}

	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
680
				params = append(params, fmt.Sprintf("%-*s %#v", cs, k, nv))
Patrick Devine's avatar
Patrick Devine committed
681
			}
Patrick Devine's avatar
Patrick Devine committed
682
683
		default:
			params = append(params, fmt.Sprintf("%-*s %#v", cs, k, v))
Patrick Devine's avatar
Patrick Devine committed
684
685
686
687
		}
	}
	resp.Parameters = strings.Join(params, "\n")

688
689
690
691
692
693
	for k, v := range req.Options {
		if _, ok := req.Options[k]; ok {
			model.Options[k] = v
		}
	}

694
695
696
697
	var sb strings.Builder
	fmt.Fprintln(&sb, "# Modelfile generate by \"ollama show\"")
	fmt.Fprintln(&sb, "# To build a new Modelfile based on this, replace FROM with:")
	fmt.Fprintf(&sb, "# FROM %s\n\n", model.ShortName)
Michael Yang's avatar
Michael Yang committed
698
	fmt.Fprint(&sb, model.String())
699
	resp.Modelfile = sb.String()
700

Patrick Devine's avatar
Patrick Devine committed
701
702
703
	return resp, nil
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
704
func (s *Server) ListModelsHandler(c *gin.Context) {
705
	ms, err := Manifests()
Patrick Devine's avatar
Patrick Devine committed
706
707
708
709
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}
Michael Yang's avatar
Michael Yang committed
710

711
	models := []api.ModelResponse{}
712
713
714
715
716
717
718
	for n, m := range ms {
		f, err := m.Config.Open()
		if err != nil {
			slog.Warn("bad manifest filepath", "name", n, "error", err)
			continue
		}
		defer f.Close()
719

720
721
722
723
		var cf ConfigV2
		if err := json.NewDecoder(f).Decode(&cf); err != nil {
			slog.Warn("bad manifest config", "name", n, "error", err)
			continue
Patrick Devine's avatar
Patrick Devine committed
724
		}
Michael Yang's avatar
Michael Yang committed
725

726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
		// tag should never be masked
		models = append(models, api.ModelResponse{
			Model:      n.DisplayShortest(),
			Name:       n.DisplayShortest(),
			Size:       m.Size(),
			Digest:     m.digest,
			ModifiedAt: m.fi.ModTime(),
			Details: api.ModelDetails{
				Format:            cf.ModelFormat,
				Family:            cf.ModelFamily,
				Families:          cf.ModelFamilies,
				ParameterSize:     cf.ModelType,
				QuantizationLevel: cf.FileType,
			},
		})
Patrick Devine's avatar
Patrick Devine committed
741
742
	}

743
744
745
746
747
	slices.SortStableFunc(models, func(i, j api.ModelResponse) int {
		// most recently modified first
		return cmp.Compare(j.ModifiedAt.Unix(), i.ModifiedAt.Unix())
	})

Michael Yang's avatar
Michael Yang committed
748
	c.JSON(http.StatusOK, api.ListResponse{Models: models})
Patrick Devine's avatar
Patrick Devine committed
749
750
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
751
func (s *Server) CopyModelHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
752
753
	var r api.CopyRequest
	if err := c.ShouldBindJSON(&r); errors.Is(err, io.EOF) {
Michael Yang's avatar
Michael Yang committed
754
755
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
756
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
757
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Patrick Devine's avatar
Patrick Devine committed
758
759
760
		return
	}

Michael Yang's avatar
Michael Yang committed
761
762
	src := model.ParseName(r.Source)
	if !src.IsValid() {
Michael Yang's avatar
Michael Yang committed
763
764
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("source %q is invalid", r.Source)})
		return
765
766
	}

Michael Yang's avatar
Michael Yang committed
767
768
	dst := model.ParseName(r.Destination)
	if !dst.IsValid() {
769
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("destination %q is invalid", r.Destination)})
Patrick Devine's avatar
Patrick Devine committed
770
771
		return
	}
Michael Yang's avatar
Michael Yang committed
772
773
774
775
776
777

	if err := CopyModel(src, dst); errors.Is(err, os.ErrNotExist) {
		c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model %q not found", r.Source)})
	} else if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
	}
Patrick Devine's avatar
Patrick Devine committed
778
779
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
780
func (s *Server) HeadBlobHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
781
782
783
784
785
786
787
788
789
790
791
	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
792
	c.Status(http.StatusOK)
Michael Yang's avatar
Michael Yang committed
793
794
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
795
func (s *Server) CreateBlobHandler(c *gin.Context) {
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
	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
	}

814
	layer, err := NewLayer(c.Request.Body, "")
Michael Yang's avatar
Michael Yang committed
815
816
817
818
819
	if err != nil {
		c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

820
821
	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
822
823
824
		return
	}

Michael Yang's avatar
Michael Yang committed
825
	c.Status(http.StatusCreated)
Michael Yang's avatar
Michael Yang committed
826
827
}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
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
}

849
func allowedHost(host string) bool {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
850
	if host == "" || host == "localhost" {
851
852
853
854
855
856
857
858
		return true
	}

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

	var tlds = []string{
Jeffrey Morgan's avatar
Jeffrey Morgan committed
859
860
861
		"localhost",
		"local",
		"internal",
862
	}
863

Jeffrey Morgan's avatar
Jeffrey Morgan committed
864
	// check if the host is a local TLD
865
866
867
868
869
870
	for _, tld := range tlds {
		if strings.HasSuffix(host, "."+tld) {
			return true
		}
	}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
871
	return false
Jeffrey Morgan's avatar
Jeffrey Morgan committed
872
}
873

Jeffrey Morgan's avatar
Jeffrey Morgan committed
874
875
876
func allowedHostsMiddleware(addr net.Addr) gin.HandlerFunc {
	return func(c *gin.Context) {
		if addr == nil {
877
878
879
880
			c.Next()
			return
		}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
881
		if addr, err := netip.ParseAddrPort(addr.String()); err == nil && !addr.Addr().IsLoopback() {
882
883
884
885
886
887
888
889
890
			c.Next()
			return
		}

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

Jeffrey Morgan's avatar
Jeffrey Morgan committed
891
		if addr, err := netip.ParseAddr(host); err == nil {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
892
			if addr.IsLoopback() || addr.IsPrivate() || addr.IsUnspecified() || isLocalIP(addr) {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
893
894
895
896
897
				c.Next()
				return
			}
		}

898
		if allowedHost(host) {
899
900
901
902
903
			if c.Request.Method == "OPTIONS" {
				c.AbortWithStatus(http.StatusNoContent)
				return
			}

904
905
906
907
908
909
			c.Next()
			return
		}

		c.AbortWithStatus(http.StatusForbidden)
	}
910
}
911

912
func (s *Server) GenerateRoutes() http.Handler {
Michael Yang's avatar
Michael Yang committed
913
914
	config := cors.DefaultConfig()
	config.AllowWildcard = true
915
	config.AllowBrowserExtensions = true
916
	config.AllowHeaders = []string{"Authorization", "Content-Type", "User-Agent", "Accept", "X-Requested-With"}
917
	config.AllowOrigins = envconfig.AllowOrigins
Michael Yang's avatar
Michael Yang committed
918

Bruce MacDonald's avatar
Bruce MacDonald committed
919
	r := gin.Default()
920
921
	r.Use(
		cors.New(config),
922
		allowedHostsMiddleware(s.addr),
923
	)
Bruce MacDonald's avatar
Bruce MacDonald committed
924

Daniel Hiltgen's avatar
Daniel Hiltgen committed
925
926
927
928
929
930
931
932
933
934
935
	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)
936
	r.GET("/api/ps", s.ProcessHandler)
Jeffrey Morgan's avatar
Jeffrey Morgan committed
937

938
	// Compatibility endpoints
Daniel Hiltgen's avatar
Daniel Hiltgen committed
939
	r.POST("/v1/chat/completions", openai.Middleware(), s.ChatHandler)
940

Michael Yang's avatar
Michael Yang committed
941
942
943
944
945
	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
946
		r.Handle(method, "/api/tags", s.ListModelsHandler)
Michael Yang's avatar
Michael Yang committed
947
948
949
		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
950
951
	}

952
953
954
955
	return r
}

func Serve(ln net.Listener) error {
Michael Yang's avatar
Michael Yang committed
956
	level := slog.LevelInfo
957
	if envconfig.Debug {
Michael Yang's avatar
Michael Yang committed
958
		level = slog.LevelDebug
959
	}
Michael Yang's avatar
Michael Yang committed
960

961
	slog.Info("server config", "env", envconfig.AsMap())
Michael Yang's avatar
Michael Yang committed
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
	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))

977
978
979
980
981
982
983
984
	blobsDir, err := GetBlobsPath("")
	if err != nil {
		return err
	}
	if err := fixBlobs(blobsDir); err != nil {
		return err
	}

985
	if !envconfig.NoPrune {
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
		// 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
1001
	ctx, done := context.WithCancel(context.Background())
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1002
1003
	schedCtx, schedDone := context.WithCancel(ctx)
	sched := InitScheduler(schedCtx)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1004
	s := &Server{addr: ln.Addr(), sched: sched}
1005
1006
	r := s.GenerateRoutes()

1007
	slog.Info(fmt.Sprintf("Listening on %s (version %s)", ln.Addr(), version.Version))
1008
	srvr := &http.Server{
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1009
1010
1011
		Handler: r,
	}

1012
1013
	// listen for a ctrl+c and stop any loaded llm
	signals := make(chan os.Signal, 1)
1014
	signal.Notify(signals, syscall.SIGINT, syscall.SIGTERM)
1015
1016
	go func() {
		<-signals
1017
		srvr.Close()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1018
		schedDone()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1019
		sched.unloadAllRunners()
1020
		gpu.Cleanup()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1021
		done()
1022
1023
	}()

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1024
	if err := llm.Init(); err != nil {
1025
1026
		return fmt.Errorf("unable to initialize llm library %w", err)
	}
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1027

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1028
	s.sched.Run(schedCtx)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1029
1030
1031

	// 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
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1032
1033
	gpus := gpu.GetGPUInfo()
	gpus.LogDetails()
1034

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1035
1036
1037
1038
1039
1040
1041
1042
	err = srvr.Serve(ln)
	// If server is closed from the signal handler, wait for the ctx to be done
	// otherwise error out quickly
	if !errors.Is(err, http.ErrServerClosed) {
		return err
	}
	<-ctx.Done()
	return err
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1043
}
Michael Yang's avatar
Michael Yang committed
1044

1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
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
1070
func streamResponse(c *gin.Context, ch chan any) {
1071
	c.Header("Content-Type", "application/x-ndjson")
Michael Yang's avatar
Michael Yang committed
1072
1073
1074
1075
1076
1077
1078
1079
	c.Stream(func(w io.Writer) bool {
		val, ok := <-ch
		if !ok {
			return false
		}

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

1084
		// Delineate chunks with new-line delimiter
Michael Yang's avatar
Michael Yang committed
1085
1086
		bts = append(bts, '\n')
		if _, err := w.Write(bts); err != nil {
1087
			slog.Info(fmt.Sprintf("streamResponse: w.Write failed with %s", err))
Michael Yang's avatar
Michael Yang committed
1088
1089
1090
1091
1092
1093
			return false
		}

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

1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
func (s *Server) ProcessHandler(c *gin.Context) {
	models := []api.ModelResponse{}

	for _, v := range s.sched.loaded {
		model := v.model
		modelDetails := api.ModelDetails{
			Format:            model.Config.ModelFormat,
			Family:            model.Config.ModelFamily,
			Families:          model.Config.ModelFamilies,
			ParameterSize:     model.Config.ModelType,
			QuantizationLevel: model.Config.FileType,
		}

		mr := api.ModelResponse{
			Model:     model.ShortName,
			Name:      model.ShortName,
			Size:      int64(v.estimatedTotal),
			SizeVRAM:  int64(v.estimatedVRAM),
			Digest:    model.Digest,
			Details:   modelDetails,
			ExpiresAt: v.expiresAt,
		}
		models = append(models, mr)
	}

	c.JSON(http.StatusOK, api.ListResponse{Models: models})
}

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

1129
	prompt, err := ChatPrompt(template, messages, numCtx, encode)
1130
1131
1132
1133
1134
1135
1136
	if err != nil {
		return "", err
	}

	return prompt, nil
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1137
func (s *Server) ChatHandler(c *gin.Context) {
Bruce MacDonald's avatar
Bruce MacDonald committed
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
	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
	}

1161
	model, err := GetModel(req.Model)
Bruce MacDonald's avatar
Bruce MacDonald committed
1162
1163
	if err != nil {
		var pErr *fs.PathError
1164
		if errors.As(err, &pErr) {
Bruce MacDonald's avatar
Bruce MacDonald committed
1165
			c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found, try pulling it first", req.Model)})
1166
1167
1168
1169
1170
1171
			return
		}
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

1172
	if model.IsEmbedding() {
1173
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "embedding models do not support chat"})
1174
1175
1176
		return
	}

1177
1178
1179
1180
1181
	opts, err := modelOptions(model, req.Options)
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}
1182
1183
1184

	var sessionDuration time.Duration
	if req.KeepAlive == nil {
1185
		sessionDuration = getDefaultSessionDuration()
1186
1187
1188
1189
	} else {
		sessionDuration = req.KeepAlive.Duration
	}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1190
1191
1192
1193
1194
	rCh, eCh := s.sched.GetRunner(c.Request.Context(), model, opts, sessionDuration)
	var runner *runnerRef
	select {
	case runner = <-rCh:
	case err = <-eCh:
1195
		handleErrorResponse(c, err)
Bruce MacDonald's avatar
Bruce MacDonald committed
1196
1197
1198
1199
1200
		return
	}

	checkpointLoaded := time.Now()

1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
	// 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
1211
	prompt, err := chatPrompt(c.Request.Context(), runner, model.Template, req.Messages, opts.NumCtx)
Bruce MacDonald's avatar
Bruce MacDonald committed
1212
1213
1214
1215
	if err != nil {
		c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}
Michael Yang's avatar
Michael Yang committed
1216

1217
	// an empty request loads the model
1218
	if len(req.Messages) == 0 || prompt == "" {
1219
		resp := api.ChatResponse{
1220
1221
1222
1223
1224
			CreatedAt:  time.Now().UTC(),
			Model:      req.Model,
			Done:       true,
			DoneReason: "load",
			Message:    api.Message{Role: "assistant"},
1225
1226
1227
1228
1229
		}
		c.JSON(http.StatusOK, resp)
		return
	}

1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
	// 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))
1248

Bruce MacDonald's avatar
Bruce MacDonald committed
1249
1250
1251
1252
1253
	ch := make(chan any)

	go func() {
		defer close(ch)

1254
		fn := func(r llm.CompletionResponse) {
Bruce MacDonald's avatar
Bruce MacDonald committed
1255
1256

			resp := api.ChatResponse{
1257
1258
1259
1260
1261
				Model:      req.Model,
				CreatedAt:  time.Now().UTC(),
				Message:    api.Message{Role: "assistant", Content: r.Content},
				Done:       r.Done,
				DoneReason: r.DoneReason,
Bruce MacDonald's avatar
Bruce MacDonald committed
1262
1263
1264
1265
1266
1267
1268
1269
				Metrics: api.Metrics{
					PromptEvalCount:    r.PromptEvalCount,
					PromptEvalDuration: r.PromptEvalDuration,
					EvalCount:          r.EvalCount,
					EvalDuration:       r.EvalDuration,
				},
			}

1270
1271
1272
			if r.Done {
				resp.TotalDuration = time.Since(checkpointStart)
				resp.LoadDuration = checkpointLoaded.Sub(checkpointStart)
Bruce MacDonald's avatar
Bruce MacDonald committed
1273
1274
1275
1276
1277
			}

			ch <- resp
		}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1278
		if err := runner.llama.Completion(c.Request.Context(), llm.CompletionRequest{
1279
1280
			Prompt:  prompt,
			Format:  req.Format,
Michael Yang's avatar
Michael Yang committed
1281
			Images:  images,
1282
			Options: opts,
1283
		}, fn); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1284
1285
1286
1287
1288
			ch <- gin.H{"error": err.Error()}
		}
	}()

	if req.Stream != nil && !*req.Stream {
1289
1290
		// Accumulate responses into the final response
		var final api.ChatResponse
Bruce MacDonald's avatar
Bruce MacDonald committed
1291
1292
		var sb strings.Builder
		for resp := range ch {
1293
1294
			switch r := resp.(type) {
			case api.ChatResponse:
1295
				sb.WriteString(r.Message.Content)
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
				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
1308
1309
			}
		}
1310

1311
		final.Message = api.Message{Role: "assistant", Content: sb.String()}
1312
		c.JSON(http.StatusOK, final)
Bruce MacDonald's avatar
Bruce MacDonald committed
1313
1314
1315
1316
1317
		return
	}

	streamResponse(c, ch)
}
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329

func handleErrorResponse(c *gin.Context, err error) {
	if errors.Is(err, context.Canceled) {
		c.JSON(499, gin.H{"error": "request canceled"})
		return
	}
	if errors.Is(err, ErrMaxQueue) {
		c.JSON(http.StatusServiceUnavailable, gin.H{"error": err.Error()})
		return
	}
	c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
}