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

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

Michael Yang's avatar
Michael Yang committed
25
	"github.com/gin-contrib/cors"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
26
	"github.com/gin-gonic/gin"
27
	"golang.org/x/image/webp"
28
	"golang.org/x/sync/errgroup"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
29

30
	"github.com/ollama/ollama/api"
31
	"github.com/ollama/ollama/discover"
32
	"github.com/ollama/ollama/envconfig"
Michael Yang's avatar
Michael Yang committed
33
	"github.com/ollama/ollama/fs/ggml"
34
	"github.com/ollama/ollama/llm"
35
	"github.com/ollama/ollama/logutil"
36
	"github.com/ollama/ollama/openai"
37
38
	"github.com/ollama/ollama/server/internal/client/ollama"
	"github.com/ollama/ollama/server/internal/registry"
Michael Yang's avatar
Michael Yang committed
39
	"github.com/ollama/ollama/template"
40
	"github.com/ollama/ollama/tools"
41
	"github.com/ollama/ollama/types/errtypes"
Michael Yang's avatar
Michael Yang committed
42
	"github.com/ollama/ollama/types/model"
43
	"github.com/ollama/ollama/version"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
44
45
)

46
47
48
49
50
51
func experimentEnabled(name string) bool {
	return slices.Contains(strings.Split(os.Getenv("OLLAMA_EXPERIMENT"), ","), name)
}

var useClient2 = experimentEnabled("client2")

Michael Yang's avatar
Michael Yang committed
52
53
var mode string = gin.DebugMode

54
type Server struct {
Daniel Hiltgen's avatar
Daniel Hiltgen committed
55
56
	addr  net.Addr
	sched *Scheduler
57
58
}

Michael Yang's avatar
Michael Yang committed
59
60
61
62
63
64
65
66
67
68
69
70
func init() {
	switch mode {
	case gin.DebugMode:
	case gin.ReleaseMode:
	case gin.TestMode:
	default:
		mode = gin.DebugMode
	}

	gin.SetMode(mode)
}

Michael Yang's avatar
lint  
Michael Yang committed
71
72
73
74
var (
	errRequired    = errors.New("is required")
	errBadTemplate = errors.New("template error")
)
Michael Yang's avatar
Michael Yang committed
75

76
func modelOptions(model *Model, requestOpts map[string]any) (api.Options, error) {
77
78
79
80
81
82
83
84
85
86
	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
87
88
}

Michael Yang's avatar
Michael Yang committed
89
90
// scheduleRunner schedules a runner after validating inputs such as capabilities and model options.
// It returns the allocated runner, model instance, and consolidated options if successful and error otherwise.
91
func (s *Server) scheduleRunner(ctx context.Context, name string, caps []model.Capability, requestOpts map[string]any, keepAlive *api.Duration) (llm.LlamaServer, *Model, *api.Options, error) {
Michael Yang's avatar
Michael Yang committed
92
	if name == "" {
Michael Yang's avatar
Michael Yang committed
93
		return nil, nil, nil, fmt.Errorf("model %w", errRequired)
Bruce MacDonald's avatar
Bruce MacDonald committed
94
95
	}

Michael Yang's avatar
Michael Yang committed
96
	model, err := GetModel(name)
Bruce MacDonald's avatar
Bruce MacDonald committed
97
	if err != nil {
Michael Yang's avatar
Michael Yang committed
98
		return nil, nil, nil, err
99
100
	}

101
102
103
104
	if slices.Contains(model.Config.ModelFamilies, "mllama") && len(model.ProjectorPaths) > 0 {
		return nil, nil, nil, fmt.Errorf("'llama3.2-vision' is no longer compatible with your version of Ollama and has been replaced by a newer version. To re-download, run 'ollama pull llama3.2-vision'")
	}

Michael Yang's avatar
Michael Yang committed
105
	if err := model.CheckCapabilities(caps...); err != nil {
Michael Yang's avatar
Michael Yang committed
106
		return nil, nil, nil, fmt.Errorf("%s %w", name, err)
107
108
	}

Michael Yang's avatar
Michael Yang committed
109
	opts, err := modelOptions(model, requestOpts)
110
	if err != nil {
Michael Yang's avatar
Michael Yang committed
111
		return nil, nil, nil, err
112
113
	}

Michael Yang's avatar
Michael Yang committed
114
	runnerCh, errCh := s.sched.GetRunner(ctx, model, opts, keepAlive)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
115
116
	var runner *runnerRef
	select {
Michael Yang's avatar
Michael Yang committed
117
118
	case runner = <-runnerCh:
	case err = <-errCh:
Michael Yang's avatar
Michael Yang committed
119
		return nil, nil, nil, err
Bruce MacDonald's avatar
Bruce MacDonald committed
120
121
	}

Michael Yang's avatar
Michael Yang committed
122
	return runner.llama, model, &opts, nil
Michael Yang's avatar
Michael Yang committed
123
124
125
}

func (s *Server) GenerateHandler(c *gin.Context) {
126
	checkpointStart := time.Now()
Michael Yang's avatar
Michael Yang committed
127
128
129
130
131
132
	var req api.GenerateRequest
	if err := c.ShouldBindJSON(&req); errors.Is(err, io.EOF) {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
	} else if err != nil {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Bruce MacDonald's avatar
Bruce MacDonald committed
133
134
135
		return
	}

136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
	name := model.ParseName(req.Model)
	if !name.IsValid() {
		// Ideally this is "invalid model name" but we're keeping with
		// what the API currently returns until we can change it.
		c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found", req.Model)})
		return
	}

	// We cannot currently consolidate this into GetModel because all we'll
	// induce infinite recursion given the current code structure.
	name, err := getExistingName(name)
	if err != nil {
		c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found", req.Model)})
		return
	}

152
	m, err := GetModel(name.String())
153
154
	if err != nil {
		switch {
155
		case errors.Is(err, fs.ErrNotExist):
156
			c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found", req.Model)})
157
		case err.Error() == errtypes.InvalidModelNameErrMsg:
158
159
160
161
162
163
164
			c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		default:
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		}
		return
	}

Patrick Devine's avatar
Patrick Devine committed
165
166
	// expire the runner
	if req.Prompt == "" && req.KeepAlive != nil && int(req.KeepAlive.Seconds()) == 0 {
167
		s.sched.expireRunner(m)
Patrick Devine's avatar
Patrick Devine committed
168
169
170
171
172
173
174
175
176
177
178

		c.JSON(http.StatusOK, api.GenerateResponse{
			Model:      req.Model,
			CreatedAt:  time.Now().UTC(),
			Response:   "",
			Done:       true,
			DoneReason: "unload",
		})
		return
	}

179
	if req.Raw && (req.Template != "" || req.System != "" || len(req.Context) > 0) {
Michael Yang's avatar
Michael Yang committed
180
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "raw mode does not support template, system, or context"})
Michael Yang's avatar
Michael Yang committed
181
182
183
		return
	}

184
	caps := []model.Capability{model.CapabilityCompletion}
185
	if req.Suffix != "" {
186
		caps = append(caps, model.CapabilityInsert)
187
	}
188
189
190
191
192
193
194
	if req.Think != nil && *req.Think {
		caps = append(caps, model.CapabilityThinking)
		// TODO(drifkin): consider adding a warning if it's false and the model
		// doesn't support thinking. It's not strictly required, but it can be a
		// hint that the user is on an older qwen3/r1 model that doesn't have an
		// updated template supporting thinking
	}
195

196
	r, m, opts, err := s.scheduleRunner(c.Request.Context(), name.String(), caps, req.Options, req.KeepAlive)
Michael Yang's avatar
Michael Yang committed
197
198
199
200
	if errors.Is(err, errCapabilityCompletion) {
		c.JSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("%q does not support generate", req.Model)})
		return
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
201
202
203
204
		handleScheduleError(c, req.Model, err)
		return
	}

205
206
	checkpointLoaded := time.Now()

207
	// load the model
Michael Yang's avatar
Michael Yang committed
208
209
210
211
212
213
214
	if req.Prompt == "" {
		c.JSON(http.StatusOK, api.GenerateResponse{
			Model:      req.Model,
			CreatedAt:  time.Now().UTC(),
			Done:       true,
			DoneReason: "load",
		})
Michael Yang's avatar
Michael Yang committed
215
216
		return
	}
Bruce MacDonald's avatar
Bruce MacDonald committed
217

218
219
	if slices.Contains(m.Config.ModelFamilies, "mllama") && len(req.Images) > 1 {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "this model only supports one image while more than one image requested"})
220
221
222
		return
	}

Michael Yang's avatar
Michael Yang committed
223
224
	images := make([]llm.ImageData, len(req.Images))
	for i := range req.Images {
225
		images[i] = llm.ImageData{ID: i, Data: req.Images[i]}
Michael Yang's avatar
Michael Yang committed
226
	}
Bruce MacDonald's avatar
Bruce MacDonald committed
227

Michael Yang's avatar
Michael Yang committed
228
229
	prompt := req.Prompt
	if !req.Raw {
Michael Yang's avatar
Michael Yang committed
230
		tmpl := m.Template
Michael Yang's avatar
Michael Yang committed
231
232
233
234
235
236
237
238
		if req.Template != "" {
			tmpl, err = template.Parse(req.Template)
			if err != nil {
				c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
				return
			}
		}

239
240
241
242
243
244
245
246
247
248
249
250
		var values template.Values
		if req.Suffix != "" {
			values.Prompt = prompt
			values.Suffix = req.Suffix
		} else {
			var msgs []api.Message
			if req.System != "" {
				msgs = append(msgs, api.Message{Role: "system", Content: req.System})
			} else if m.System != "" {
				msgs = append(msgs, api.Message{Role: "system", Content: m.System})
			}

Michael Yang's avatar
Michael Yang committed
251
252
253
254
			if req.Context == nil {
				msgs = append(msgs, m.Messages...)
			}

255
			for _, i := range images {
256
257
				imgPrompt := ""
				msgs = append(msgs, api.Message{Role: "user", Content: fmt.Sprintf("[img-%d]"+imgPrompt, i.ID)})
258
259
260
261
262
			}

			values.Messages = append(msgs, api.Message{Role: "user", Content: req.Prompt})
		}

263
264
265
		values.Think = req.Think != nil && *req.Think
		values.IsThinkSet = req.Think != nil

Michael Yang's avatar
Michael Yang committed
266
267
		var b bytes.Buffer
		if req.Context != nil {
268
			slog.Warn("the context field is deprecated and will be removed in a future version of Ollama")
269
			s, err := r.Detokenize(c.Request.Context(), req.Context)
Michael Yang's avatar
Michael Yang committed
270
271
272
273
			if err != nil {
				c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
				return
			}
274
			b.WriteString(s)
Michael Yang's avatar
Michael Yang committed
275
		}
276
277
278
279
280
281
282

		if err := tmpl.Execute(&b, values); err != nil {
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
			return
		}

		prompt = b.String()
Bruce MacDonald's avatar
Bruce MacDonald committed
283
284
	}

285
286
287
288
289
290
291
292
293
	var thinkingState *thinkingParser
	openingTag, closingTag := inferThinkingTags(m.Template.Template)
	if req.Think != nil && *req.Think && openingTag != "" && closingTag != "" {
		thinkingState = &thinkingParser{
			openingTag: openingTag,
			closingTag: closingTag,
		}
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
294
295
	ch := make(chan any)
	go func() {
296
297
		// TODO (jmorganca): avoid building the response twice both here and below
		var sb strings.Builder
Bruce MacDonald's avatar
Bruce MacDonald committed
298
		defer close(ch)
Michael Yang's avatar
Michael Yang committed
299
		if err := r.Completion(c.Request.Context(), llm.CompletionRequest{
Michael Yang's avatar
Michael Yang committed
300
301
			Prompt:  prompt,
			Images:  images,
302
			Format:  req.Format,
Michael Yang's avatar
Michael Yang committed
303
			Options: opts,
304
305
		}, func(cr llm.CompletionResponse) {
			res := api.GenerateResponse{
306
307
308
309
				Model:     req.Model,
				CreatedAt: time.Now().UTC(),
				Response:  cr.Content,
				Done:      cr.Done,
Bruce MacDonald's avatar
Bruce MacDonald committed
310
				Metrics: api.Metrics{
311
312
313
314
					PromptEvalCount:    cr.PromptEvalCount,
					PromptEvalDuration: cr.PromptEvalDuration,
					EvalCount:          cr.EvalCount,
					EvalDuration:       cr.EvalDuration,
Bruce MacDonald's avatar
Bruce MacDonald committed
315
				},
Bruce MacDonald's avatar
Bruce MacDonald committed
316
			}
317

318
319
320
321
322
323
			if thinkingState != nil {
				thinking, content := thinkingState.addContent(cr.Content)
				res.Thinking = thinking
				res.Response = content
			}

324
325
326
327
328
			if _, err := sb.WriteString(cr.Content); err != nil {
				ch <- gin.H{"error": err.Error()}
			}

			if cr.Done {
329
				res.DoneReason = cr.DoneReason.String()
330
331
332
333
				res.TotalDuration = time.Since(checkpointStart)
				res.LoadDuration = checkpointLoaded.Sub(checkpointStart)

				if !req.Raw {
334
					tokens, err := r.Tokenize(c.Request.Context(), prompt+sb.String())
335
336
337
338
					if err != nil {
						ch <- gin.H{"error": err.Error()}
						return
					}
339
					res.Context = tokens
340
341
342
343
				}
			}

			ch <- res
Michael Yang's avatar
Michael Yang committed
344
		}); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
345
346
347
348
349
			ch <- gin.H{"error": err.Error()}
		}
	}()

	if req.Stream != nil && !*req.Stream {
Michael Yang's avatar
Michael Yang committed
350
		var r api.GenerateResponse
351
352
		var sbThinking strings.Builder
		var sbContent strings.Builder
Michael Yang's avatar
Michael Yang committed
353
354
		for rr := range ch {
			switch t := rr.(type) {
355
			case api.GenerateResponse:
356
357
				sbThinking.WriteString(t.Thinking)
				sbContent.WriteString(t.Response)
Michael Yang's avatar
Michael Yang committed
358
				r = t
359
			case gin.H:
Michael Yang's avatar
Michael Yang committed
360
361
362
				msg, ok := t["error"].(string)
				if !ok {
					msg = "unexpected error format in response"
363
				}
Michael Yang's avatar
Michael Yang committed
364
365
366

				c.JSON(http.StatusInternalServerError, gin.H{"error": msg})
				return
367
			default:
Michael Yang's avatar
Michael Yang committed
368
				c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected response"})
Bruce MacDonald's avatar
Bruce MacDonald committed
369
370
371
				return
			}
		}
372

373
374
375
		r.Thinking = sbThinking.String()
		r.Response = sbContent.String()

Michael Yang's avatar
Michael Yang committed
376
		c.JSON(http.StatusOK, r)
Bruce MacDonald's avatar
Bruce MacDonald committed
377
378
379
380
381
382
		return
	}

	streamResponse(c, ch)
}

383
func (s *Server) EmbedHandler(c *gin.Context) {
384
	checkpointStart := time.Now()
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
	var req api.EmbedRequest
	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
	}

	truncate := true

	if req.Truncate != nil && !*req.Truncate {
		truncate = false
	}

	var input []string

	switch i := req.Input.(type) {
	case string:
		if len(i) > 0 {
			input = append(input, i)
		}
	case []any:
		for _, v := range i {
			if _, ok := v.(string); !ok {
				c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "invalid input type"})
				return
			}
			input = append(input, v.(string))
		}
	default:
418
419
420
421
		if req.Input != nil {
			c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "invalid input type"})
			return
		}
422
423
	}

424
425
426
427
428
429
	name, err := getExistingName(model.ParseName(req.Model))
	if err != nil {
		c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found", req.Model)})
		return
	}

430
	r, m, opts, err := s.scheduleRunner(c.Request.Context(), name.String(), []model.Capability{}, req.Options, req.KeepAlive)
431
432
433
434
435
	if err != nil {
		handleScheduleError(c, req.Model, err)
		return
	}

436
437
	checkpointLoaded := time.Now()

438
439
440
441
442
	if len(input) == 0 {
		c.JSON(http.StatusOK, api.EmbedResponse{Model: req.Model, Embeddings: [][]float32{}})
		return
	}

443
	kvData, _, err := getModelData(m.ModelPath, false)
444
445
446
447
448
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

449
	var count int
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
	for i, s := range input {
		tokens, err := r.Tokenize(c.Request.Context(), s)
		if err != nil {
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
			return
		}

		ctxLen := min(opts.NumCtx, int(kvData.ContextLength()))
		if len(tokens) > ctxLen {
			if !truncate {
				c.JSON(http.StatusBadRequest, gin.H{"error": "input length exceeds maximum context length"})
				return
			}

			tokens = tokens[:ctxLen]
			s, err = r.Detokenize(c.Request.Context(), tokens)
			if err != nil {
				c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
				return
			}
		}

472
473
		count += len(tokens)

474
475
		input[i] = s
	}
476
477
478
479
480
481
482
483
484
485
486
487

	var g errgroup.Group
	embeddings := make([][]float32, len(input))
	for i, text := range input {
		g.Go(func() error {
			embedding, err := r.Embedding(c.Request.Context(), text)
			if err != nil {
				return err
			}
			embeddings[i] = normalize(embedding)
			return nil
		})
488
489
	}

490
	if err := g.Wait(); err != nil {
491
		c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": strings.TrimSpace(err.Error())})
492
		return
493
494
495
	}

	resp := api.EmbedResponse{
496
		Model:           req.Model,
497
		Embeddings:      embeddings,
498
499
		TotalDuration:   time.Since(checkpointStart),
		LoadDuration:    checkpointLoaded.Sub(checkpointStart),
500
		PromptEvalCount: count,
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
	}
	c.JSON(http.StatusOK, resp)
}

func normalize(vec []float32) []float32 {
	var sum float32
	for _, v := range vec {
		sum += v * v
	}

	norm := float32(0.0)
	if sum > 0 {
		norm = float32(1.0 / math.Sqrt(float64(sum)))
	}

	for i := range vec {
		vec[i] *= norm
	}
	return vec
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
522
func (s *Server) EmbeddingsHandler(c *gin.Context) {
Bruce MacDonald's avatar
Bruce MacDonald committed
523
	var req api.EmbeddingRequest
Michael Yang's avatar
Michael Yang committed
524
	if err := c.ShouldBindJSON(&req); errors.Is(err, io.EOF) {
Bruce MacDonald's avatar
Bruce MacDonald committed
525
526
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
527
	} else if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
528
529
530
531
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

532
533
534
535
536
537
	name := model.ParseName(req.Model)
	if !name.IsValid() {
		c.JSON(http.StatusBadRequest, gin.H{"error": "model is required"})
		return
	}

538
	r, _, _, err := s.scheduleRunner(c.Request.Context(), name.String(), []model.Capability{}, req.Options, req.KeepAlive)
Bruce MacDonald's avatar
Bruce MacDonald committed
539
	if err != nil {
Michael Yang's avatar
Michael Yang committed
540
		handleScheduleError(c, req.Model, err)
Bruce MacDonald's avatar
Bruce MacDonald committed
541
542
543
		return
	}

544
545
546
	// an empty request loads the model
	if req.Prompt == "" {
		c.JSON(http.StatusOK, api.EmbeddingResponse{Embedding: []float64{}})
Bruce MacDonald's avatar
Bruce MacDonald committed
547
548
549
		return
	}

550
	embedding, err := r.Embedding(c.Request.Context(), req.Prompt)
Bruce MacDonald's avatar
Bruce MacDonald committed
551
	if err != nil {
552
		c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": strings.TrimSpace(err.Error())})
Bruce MacDonald's avatar
Bruce MacDonald committed
553
554
555
		return
	}

556
557
558
	var e []float64
	for _, v := range embedding {
		e = append(e, float64(v))
559
560
561
	}

	resp := api.EmbeddingResponse{
562
		Embedding: e,
563
564
	}
	c.JSON(http.StatusOK, resp)
Bruce MacDonald's avatar
Bruce MacDonald committed
565
566
}

567
func (s *Server) PullHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
568
	var req api.PullRequest
Michael Yang's avatar
Michael Yang committed
569
570
571
572
573
574
575
	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
576
577
578
		return
	}

579
580
	name := model.ParseName(cmp.Or(req.Model, req.Name))
	if !name.IsValid() {
581
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": errtypes.InvalidModelNameErrMsg})
582
583
584
		return
	}

585
586
	name, err = getExistingName(name)
	if err != nil {
587
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
588
589
590
		return
	}

591
592
593
	ch := make(chan any)
	go func() {
		defer close(ch)
594
595
		fn := func(r api.ProgressResponse) {
			ch <- r
596
		}
597

Michael Yang's avatar
Michael Yang committed
598
		regOpts := &registryOptions{
599
600
601
			Insecure: req.Insecure,
		}

602
603
604
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

605
		if err := PullModel(ctx, name.DisplayShortest(), regOpts, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
606
			ch <- gin.H{"error": err.Error()}
607
608
609
		}
	}()

610
611
612
613
614
	if req.Stream != nil && !*req.Stream {
		waitForStream(c, ch)
		return
	}

615
616
617
	streamResponse(c, ch)
}

618
func (s *Server) PushHandler(c *gin.Context) {
619
	var req api.PushRequest
Michael Yang's avatar
Michael Yang committed
620
621
622
623
624
625
626
	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
627
628
		return
	}
Michael Yang's avatar
Michael Yang committed
629

630
	var mname string
Michael Yang's avatar
Michael Yang committed
631
	if req.Model != "" {
632
		mname = req.Model
Michael Yang's avatar
Michael Yang committed
633
	} else if req.Name != "" {
634
		mname = req.Name
Michael Yang's avatar
Michael Yang committed
635
636
	} else {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
637
638
639
		return
	}

640
641
642
	ch := make(chan any)
	go func() {
		defer close(ch)
643
644
		fn := func(r api.ProgressResponse) {
			ch <- r
645
		}
646

Michael Yang's avatar
Michael Yang committed
647
		regOpts := &registryOptions{
648
649
650
			Insecure: req.Insecure,
		}

Michael Yang's avatar
Michael Yang committed
651
652
653
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

654
655
656
657
658
659
660
		name, err := getExistingName(model.ParseName(mname))
		if err != nil {
			ch <- gin.H{"error": err.Error()}
			return
		}

		if err := PushModel(ctx, name.DisplayShortest(), regOpts, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
661
			ch <- gin.H{"error": err.Error()}
662
663
664
		}
	}()

665
666
667
668
669
	if req.Stream != nil && !*req.Stream {
		waitForStream(c, ch)
		return
	}

670
671
672
	streamResponse(c, ch)
}

673
674
675
676
// getExistingName searches the models directory for the longest prefix match of
// the input name and returns the input name with all existing parts replaced
// with each part found. If no parts are found, the input name is returned as
// is.
677
678
679
func getExistingName(n model.Name) (model.Name, error) {
	var zero model.Name
	existing, err := Manifests(true)
680
	if err != nil {
681
		return zero, err
682
	}
683
	var set model.Name // tracks parts already canonicalized
684
	for e := range existing {
685
686
687
688
689
690
691
692
693
694
695
		if set.Host == "" && strings.EqualFold(e.Host, n.Host) {
			n.Host = e.Host
		}
		if set.Namespace == "" && strings.EqualFold(e.Namespace, n.Namespace) {
			n.Namespace = e.Namespace
		}
		if set.Model == "" && strings.EqualFold(e.Model, n.Model) {
			n.Model = e.Model
		}
		if set.Tag == "" && strings.EqualFold(e.Tag, n.Tag) {
			n.Tag = e.Tag
696
697
		}
	}
698
	return n, nil
699
700
}

701
func (s *Server) DeleteHandler(c *gin.Context) {
702
703
	var r api.DeleteRequest
	if err := c.ShouldBindJSON(&r); errors.Is(err, io.EOF) {
Michael Yang's avatar
Michael Yang committed
704
705
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
706
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
707
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
708
709
710
		return
	}

711
712
713
	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))})
714
715
		return
	}
Michael Yang's avatar
Michael Yang committed
716

717
718
719
720
721
722
	n, err := getExistingName(n)
	if err != nil {
		c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found", cmp.Or(r.Model, r.Name))})
		return
	}

723
	m, err := ParseNamedManifest(n)
Michael Yang's avatar
Michael Yang committed
724
	if err != nil {
725
726
727
728
729
730
		switch {
		case os.IsNotExist(err):
			c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found", cmp.Or(r.Model, r.Name))})
		default:
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		}
Michael Yang's avatar
Michael Yang committed
731
732
733
		return
	}

734
	if err := m.Remove(); err != nil {
Michael Yang's avatar
Michael Yang committed
735
736
737
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}
738
739
740
741
742

	if err := m.RemoveLayers(); err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}
743
744
}

745
func (s *Server) ShowHandler(c *gin.Context) {
Patrick Devine's avatar
Patrick Devine committed
746
	var req api.ShowRequest
Michael Yang's avatar
Michael Yang committed
747
748
749
750
751
752
753
	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
754
755
756
		return
	}

Michael Yang's avatar
Michael Yang committed
757
	if req.Model != "" {
Michael Yang's avatar
Michael Yang committed
758
		// noop
Michael Yang's avatar
Michael Yang committed
759
	} else if req.Name != "" {
Michael Yang's avatar
Michael Yang committed
760
		req.Model = req.Name
Michael Yang's avatar
Michael Yang committed
761
	} else {
762
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
763
764
765
		return
	}

766
	resp, err := GetModelInfo(req)
Patrick Devine's avatar
Patrick Devine committed
767
	if err != nil {
768
769
		switch {
		case os.IsNotExist(err):
Michael Yang's avatar
Michael Yang committed
770
			c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found", req.Model)})
771
		case err.Error() == errtypes.InvalidModelNameErrMsg:
772
773
			c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		default:
Patrick Devine's avatar
Patrick Devine committed
774
775
776
777
778
779
780
781
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		}
		return
	}

	c.JSON(http.StatusOK, resp)
}

782
func GetModelInfo(req api.ShowRequest) (*api.ShowResponse, error) {
783
784
	name := model.ParseName(req.Model)
	if !name.IsValid() {
CYJiang's avatar
CYJiang committed
785
		return nil, ErrModelPathInvalid
786
787
788
789
790
791
792
	}
	name, err := getExistingName(name)
	if err != nil {
		return nil, err
	}

	m, err := GetModel(name.String())
Patrick Devine's avatar
Patrick Devine committed
793
794
795
796
	if err != nil {
		return nil, err
	}

Patrick Devine's avatar
Patrick Devine committed
797
	modelDetails := api.ModelDetails{
798
799
800
801
802
803
		ParentModel:       m.ParentModel,
		Format:            m.Config.ModelFormat,
		Family:            m.Config.ModelFamily,
		Families:          m.Config.ModelFamilies,
		ParameterSize:     m.Config.ModelType,
		QuantizationLevel: m.Config.FileType,
Patrick Devine's avatar
Patrick Devine committed
804
805
	}

806
	if req.System != "" {
807
		m.System = req.System
808
809
	}

Michael Yang's avatar
Michael Yang committed
810
811
812
	msgs := make([]api.Message, len(m.Messages))
	for i, msg := range m.Messages {
		msgs[i] = api.Message{Role: msg.Role, Content: msg.Content}
813
814
	}

815
	manifest, err := ParseNamedManifest(name)
816
817
818
819
	if err != nil {
		return nil, err
	}

Patrick Devine's avatar
Patrick Devine committed
820
	resp := &api.ShowResponse{
821
822
823
824
825
826
827
		License:      strings.Join(m.License, "\n"),
		System:       m.System,
		Template:     m.Template.String(),
		Details:      modelDetails,
		Messages:     msgs,
		Capabilities: m.Capabilities(),
		ModifiedAt:   manifest.fi.ModTime(),
Patrick Devine's avatar
Patrick Devine committed
828
829
830
831
	}

	var params []string
	cs := 30
832
	for k, v := range m.Options {
Patrick Devine's avatar
Patrick Devine committed
833
		switch val := v.(type) {
834
		case []any:
Patrick Devine's avatar
Patrick Devine committed
835
			for _, nv := range val {
Patrick Devine's avatar
Patrick Devine committed
836
				params = append(params, fmt.Sprintf("%-*s %#v", cs, k, nv))
Patrick Devine's avatar
Patrick Devine committed
837
			}
Patrick Devine's avatar
Patrick Devine committed
838
839
		default:
			params = append(params, fmt.Sprintf("%-*s %#v", cs, k, v))
Patrick Devine's avatar
Patrick Devine committed
840
841
842
843
		}
	}
	resp.Parameters = strings.Join(params, "\n")

844
845
	for k, v := range req.Options {
		if _, ok := req.Options[k]; ok {
846
			m.Options[k] = v
847
848
849
		}
	}

850
	var sb strings.Builder
851
	fmt.Fprintln(&sb, "# Modelfile generated by \"ollama show\"")
852
	fmt.Fprintln(&sb, "# To build a new Modelfile based on this, replace FROM with:")
853
854
	fmt.Fprintf(&sb, "# FROM %s\n\n", m.ShortName)
	fmt.Fprint(&sb, m.String())
855
	resp.Modelfile = sb.String()
856

857
	kvData, tensors, err := getModelData(m.ModelPath, req.Verbose)
858
859
860
	if err != nil {
		return nil, err
	}
861

862
863
864
865
	delete(kvData, "general.name")
	delete(kvData, "tokenizer.chat_template")
	resp.ModelInfo = kvData

866
867
868
869
870
871
	tensorData := make([]api.Tensor, len(tensors.Items()))
	for cnt, t := range tensors.Items() {
		tensorData[cnt] = api.Tensor{Name: t.Name, Type: t.Type(), Shape: t.Shape}
	}
	resp.Tensors = tensorData

872
	if len(m.ProjectorPaths) > 0 {
873
		projectorData, _, err := getModelData(m.ProjectorPaths[0], req.Verbose)
874
875
876
877
878
879
		if err != nil {
			return nil, err
		}
		resp.ProjectorInfo = projectorData
	}

Patrick Devine's avatar
Patrick Devine committed
880
881
882
	return resp, nil
}

883
func getModelData(digest string, verbose bool) (ggml.KV, ggml.Tensors, error) {
884
885
886
887
	maxArraySize := 0
	if verbose {
		maxArraySize = -1
	}
888
	data, err := llm.LoadModel(digest, maxArraySize)
889
	if err != nil {
890
		return nil, ggml.Tensors{}, err
891
892
	}

893
	kv := data.KV()
894
895
896
897
898
899
900
901
902

	if !verbose {
		for k := range kv {
			if t, ok := kv[k].([]any); len(t) > 5 && ok {
				kv[k] = []any{}
			}
		}
	}

903
	return kv, data.Tensors(), nil
904
905
}

906
func (s *Server) ListHandler(c *gin.Context) {
907
	ms, err := Manifests(true)
Patrick Devine's avatar
Patrick Devine committed
908
909
910
911
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}
Michael Yang's avatar
Michael Yang committed
912

913
	models := []api.ListModelResponse{}
914
915
	for n, m := range ms {
		var cf ConfigV2
916
917
918
919
920
921
922
923
924
925
926
927
928

		if m.Config.Digest != "" {
			f, err := m.Config.Open()
			if err != nil {
				slog.Warn("bad manifest filepath", "name", n, "error", err)
				continue
			}
			defer f.Close()

			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
929
		}
Michael Yang's avatar
Michael Yang committed
930

931
		// tag should never be masked
932
		models = append(models, api.ListModelResponse{
933
934
935
936
937
938
939
940
941
942
943
944
945
			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
946
947
	}

948
	slices.SortStableFunc(models, func(i, j api.ListModelResponse) int {
949
950
951
952
		// most recently modified first
		return cmp.Compare(j.ModifiedAt.Unix(), i.ModifiedAt.Unix())
	})

Michael Yang's avatar
Michael Yang committed
953
	c.JSON(http.StatusOK, api.ListResponse{Models: models})
Patrick Devine's avatar
Patrick Devine committed
954
955
}

956
func (s *Server) CopyHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
957
958
	var r api.CopyRequest
	if err := c.ShouldBindJSON(&r); errors.Is(err, io.EOF) {
Michael Yang's avatar
Michael Yang committed
959
960
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
961
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
962
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Patrick Devine's avatar
Patrick Devine committed
963
964
965
		return
	}

Michael Yang's avatar
Michael Yang committed
966
967
	src := model.ParseName(r.Source)
	if !src.IsValid() {
Michael Yang's avatar
Michael Yang committed
968
969
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("source %q is invalid", r.Source)})
		return
970
	}
971
972
973
974
975
	src, err := getExistingName(src)
	if err != nil {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}
976

Michael Yang's avatar
Michael Yang committed
977
978
	dst := model.ParseName(r.Destination)
	if !dst.IsValid() {
979
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("destination %q is invalid", r.Destination)})
Patrick Devine's avatar
Patrick Devine committed
980
981
		return
	}
982
983
	dst, err = getExistingName(dst)
	if err != nil {
984
985
986
987
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

Michael Yang's avatar
Michael Yang committed
988
989
990
991
992
	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
993
994
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
995
func (s *Server) HeadBlobHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
	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
1007
	c.Status(http.StatusOK)
Michael Yang's avatar
Michael Yang committed
1008
1009
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1010
func (s *Server) CreateBlobHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
1011
1012
	if ib, ok := intermediateBlobs[c.Param("digest")]; ok {
		p, err := GetBlobsPath(ib)
1013
1014
1015
1016
1017
1018
		if err != nil {
			c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
			return
		}

		if _, err := os.Stat(p); errors.Is(err, os.ErrNotExist) {
Michael Yang's avatar
Michael Yang committed
1019
1020
			slog.Info("evicting intermediate blob which no longer exists", "digest", ib)
			delete(intermediateBlobs, c.Param("digest"))
1021
1022
1023
1024
1025
1026
1027
1028
1029
		} else if err != nil {
			c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
			return
		} else {
			c.Status(http.StatusOK)
			return
		}
	}

1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
	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
	}

1048
	layer, err := NewLayer(c.Request.Body, "")
Michael Yang's avatar
Michael Yang committed
1049
1050
1051
1052
1053
	if err != nil {
		c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

1054
1055
	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
1056
1057
1058
		return
	}

Michael Yang's avatar
Michael Yang committed
1059
	c.Status(http.StatusCreated)
Michael Yang's avatar
Michael Yang committed
1060
1061
}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
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
}

1083
func allowedHost(host string) bool {
1084
1085
	host = strings.ToLower(host)

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1086
	if host == "" || host == "localhost" {
1087
1088
1089
		return true
	}

1090
	if hostname, err := os.Hostname(); err == nil && host == strings.ToLower(hostname) {
1091
1092
1093
		return true
	}

Michael Yang's avatar
lint  
Michael Yang committed
1094
	tlds := []string{
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1095
1096
1097
		"localhost",
		"local",
		"internal",
1098
	}
1099

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1100
	// check if the host is a local TLD
1101
1102
1103
1104
1105
1106
	for _, tld := range tlds {
		if strings.HasSuffix(host, "."+tld) {
			return true
		}
	}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1107
	return false
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1108
}
1109

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1110
1111
1112
func allowedHostsMiddleware(addr net.Addr) gin.HandlerFunc {
	return func(c *gin.Context) {
		if addr == nil {
1113
1114
1115
1116
			c.Next()
			return
		}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1117
		if addr, err := netip.ParseAddrPort(addr.String()); err == nil && !addr.Addr().IsLoopback() {
1118
1119
1120
1121
1122
1123
1124
1125
1126
			c.Next()
			return
		}

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

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1127
		if addr, err := netip.ParseAddr(host); err == nil {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1128
			if addr.IsLoopback() || addr.IsPrivate() || addr.IsUnspecified() || isLocalIP(addr) {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1129
1130
1131
1132
1133
				c.Next()
				return
			}
		}

1134
		if allowedHost(host) {
Michael Yang's avatar
lint  
Michael Yang committed
1135
			if c.Request.Method == http.MethodOptions {
1136
1137
1138
1139
				c.AbortWithStatus(http.StatusNoContent)
				return
			}

1140
1141
1142
1143
1144
1145
			c.Next()
			return
		}

		c.AbortWithStatus(http.StatusForbidden)
	}
1146
}
1147

1148
func (s *Server) GenerateRoutes(rc *ollama.Registry) (http.Handler, error) {
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
	corsConfig := cors.DefaultConfig()
	corsConfig.AllowWildcard = true
	corsConfig.AllowBrowserExtensions = true
	corsConfig.AllowHeaders = []string{
		"Authorization",
		"Content-Type",
		"User-Agent",
		"Accept",
		"X-Requested-With",

		// OpenAI compatibility headers
1160
1161
1162
1163
1164
		"OpenAI-Beta",
		"x-stainless-arch",
		"x-stainless-async",
		"x-stainless-custom-poll-interval",
		"x-stainless-helper-method",
1165
1166
		"x-stainless-lang",
		"x-stainless-os",
1167
1168
		"x-stainless-package-version",
		"x-stainless-poll-helper",
1169
1170
1171
1172
1173
1174
		"x-stainless-retry-count",
		"x-stainless-runtime",
		"x-stainless-runtime-version",
		"x-stainless-timeout",
	}
	corsConfig.AllowOrigins = envconfig.AllowedOrigins()
Michael Yang's avatar
Michael Yang committed
1175

Bruce MacDonald's avatar
Bruce MacDonald committed
1176
	r := gin.Default()
1177
	r.HandleMethodNotAllowed = true
1178
	r.Use(
1179
		cors.New(corsConfig),
1180
		allowedHostsMiddleware(s.addr),
1181
	)
Bruce MacDonald's avatar
Bruce MacDonald committed
1182

1183
1184
1185
1186
1187
1188
	// General
	r.HEAD("/", func(c *gin.Context) { c.String(http.StatusOK, "Ollama is running") })
	r.GET("/", func(c *gin.Context) { c.String(http.StatusOK, "Ollama is running") })
	r.HEAD("/api/version", func(c *gin.Context) { c.JSON(http.StatusOK, gin.H{"version": version.Version}) })
	r.GET("/api/version", func(c *gin.Context) { c.JSON(http.StatusOK, gin.H{"version": version.Version}) })

1189
	// Local model cache management (new implementation is at end of function)
1190
1191
	r.POST("/api/pull", s.PullHandler)
	r.POST("/api/push", s.PushHandler)
1192
1193
	r.HEAD("/api/tags", s.ListHandler)
	r.GET("/api/tags", s.ListHandler)
1194
	r.POST("/api/show", s.ShowHandler)
1195
	r.DELETE("/api/delete", s.DeleteHandler)
1196
1197
1198

	// Create
	r.POST("/api/create", s.CreateHandler)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1199
1200
	r.POST("/api/blobs/:digest", s.CreateBlobHandler)
	r.HEAD("/api/blobs/:digest", s.HeadBlobHandler)
1201
1202
1203
	r.POST("/api/copy", s.CopyHandler)

	// Inference
1204
	r.GET("/api/ps", s.PsHandler)
1205
1206
1207
1208
	r.POST("/api/generate", s.GenerateHandler)
	r.POST("/api/chat", s.ChatHandler)
	r.POST("/api/embed", s.EmbedHandler)
	r.POST("/api/embeddings", s.EmbeddingsHandler)
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1209

1210
	// Inference (OpenAI compatibility)
1211
	r.POST("/v1/chat/completions", openai.ChatMiddleware(), s.ChatHandler)
1212
	r.POST("/v1/completions", openai.CompletionsMiddleware(), s.GenerateHandler)
1213
	r.POST("/v1/embeddings", openai.EmbeddingsMiddleware(), s.EmbedHandler)
1214
1215
	r.GET("/v1/models", openai.ListMiddleware(), s.ListHandler)
	r.GET("/v1/models/:model", openai.RetrieveMiddleware(), s.ShowHandler)
1216

1217
1218
1219
1220
1221
1222
	if rc != nil {
		// wrap old with new
		rs := &registry.Local{
			Client:   rc,
			Logger:   slog.Default(), // TODO(bmizerany): Take a logger, do not use slog.Default()
			Fallback: r,
1223

1224
1225
1226
			Prune: PruneLayers,
		}
		return rs, nil
1227
1228
	}

1229
	return r, nil
1230
1231
1232
}

func Serve(ln net.Listener) error {
1233
	slog.SetDefault(logutil.NewLogger(os.Stderr, envconfig.LogLevel()))
1234
	slog.Info("server config", "env", envconfig.Values())
Michael Yang's avatar
Michael Yang committed
1235

1236
1237
1238
1239
1240
1241
1242
1243
	blobsDir, err := GetBlobsPath("")
	if err != nil {
		return err
	}
	if err := fixBlobs(blobsDir); err != nil {
		return err
	}

Michael Yang's avatar
bool  
Michael Yang committed
1244
	if !envconfig.NoPrune() {
1245
1246
1247
1248
1249
1250
1251
		if _, err := Manifests(false); err != nil {
			slog.Warn("corrupt manifests detected, skipping prune operation.  Re-pull or delete to clear", "error", err)
		} else {
			// clean up unused layers and manifests
			if err := PruneLayers(); err != nil {
				return err
			}
1252

1253
1254
1255
1256
			manifestsPath, err := GetManifestPath()
			if err != nil {
				return err
			}
1257

1258
1259
1260
			if err := PruneDirectory(manifestsPath); err != nil {
				return err
			}
1261
1262
1263
		}
	}

1264
1265
	s := &Server{addr: ln.Addr()}

1266
1267
1268
1269
1270
1271
1272
	var rc *ollama.Registry
	if useClient2 {
		var err error
		rc, err = ollama.DefaultRegistry()
		if err != nil {
			return err
		}
1273
1274
	}

1275
	h, err := s.GenerateRoutes(rc)
1276
1277
1278
	if err != nil {
		return err
	}
1279

1280
1281
	http.Handle("/", h)

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1282
	ctx, done := context.WithCancel(context.Background())
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1283
1284
	schedCtx, schedDone := context.WithCancel(ctx)
	sched := InitScheduler(schedCtx)
1285
	s.sched = sched
1286

1287
	slog.Info(fmt.Sprintf("Listening on %s (version %s)", ln.Addr(), version.Version))
1288
	srvr := &http.Server{
1289
1290
1291
1292
1293
1294
1295
1296
1297
		// Use http.DefaultServeMux so we get net/http/pprof for
		// free.
		//
		// TODO(bmizerany): Decide if we want to make this
		// configurable so it is not exposed by default, or allow
		// users to bind it to a different port. This was a quick
		// and easy way to get pprof, but it may not be the best
		// way.
		Handler: nil,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1298
1299
	}

1300
1301
	// listen for a ctrl+c and stop any loaded llm
	signals := make(chan os.Signal, 1)
1302
	signal.Notify(signals, syscall.SIGINT, syscall.SIGTERM)
1303
1304
	go func() {
		<-signals
1305
		srvr.Close()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1306
		schedDone()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1307
		sched.unloadAllRunners()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1308
		done()
1309
1310
	}()

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1311
	s.sched.Run(schedCtx)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1312

1313
1314
1315
1316
	// register the experimental webp decoder
	// so webp images can be used in multimodal inputs
	image.RegisterFormat("webp", "RIFF????WEBP", webp.Decode, webp.DecodeConfig)

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1317
1318
	// 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
1319
	gpus := discover.GetGPUInfo()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1320
	gpus.LogDetails()
1321

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1322
1323
1324
1325
1326
1327
1328
	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()
1329
	return nil
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1330
}
Michael Yang's avatar
Michael Yang committed
1331

1332
func waitForStream(c *gin.Context, ch chan any) {
1333
	c.Header("Content-Type", "application/json")
1334
	var latest api.ProgressResponse
1335
1336
1337
	for resp := range ch {
		switch r := resp.(type) {
		case api.ProgressResponse:
1338
			latest = r
1339
		case gin.H:
Josh's avatar
Josh committed
1340
1341
1342
1343
			status, ok := r["status"].(int)
			if !ok {
				status = http.StatusInternalServerError
			}
1344
1345
1346
			errorMsg, ok := r["error"].(string)
			if !ok {
				errorMsg = "unknown error"
1347
			}
1348
1349
			c.JSON(status, gin.H{"error": errorMsg})
			return
1350
		default:
1351
			c.JSON(http.StatusInternalServerError, gin.H{"error": "unknown message type"})
1352
1353
1354
			return
		}
	}
1355
1356

	c.JSON(http.StatusOK, latest)
1357
1358
}

Michael Yang's avatar
Michael Yang committed
1359
func streamResponse(c *gin.Context, ch chan any) {
1360
	c.Header("Content-Type", "application/x-ndjson")
Michael Yang's avatar
Michael Yang committed
1361
1362
1363
1364
1365
1366
1367
1368
	c.Stream(func(w io.Writer) bool {
		val, ok := <-ch
		if !ok {
			return false
		}

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

1373
		// Delineate chunks with new-line delimiter
Michael Yang's avatar
Michael Yang committed
1374
1375
		bts = append(bts, '\n')
		if _, err := w.Write(bts); err != nil {
1376
			slog.Info(fmt.Sprintf("streamResponse: w.Write failed with %s", err))
Michael Yang's avatar
Michael Yang committed
1377
1378
1379
1380
1381
1382
			return false
		}

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

1384
func (s *Server) PsHandler(c *gin.Context) {
1385
	models := []api.ProcessModelResponse{}
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396

	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,
		}

1397
		mr := api.ProcessModelResponse{
1398
1399
1400
1401
1402
1403
1404
1405
			Model:     model.ShortName,
			Name:      model.ShortName,
			Size:      int64(v.estimatedTotal),
			SizeVRAM:  int64(v.estimatedVRAM),
			Digest:    model.Digest,
			Details:   modelDetails,
			ExpiresAt: v.expiresAt,
		}
1406
1407
1408
1409
1410
1411
1412
1413
		// The scheduler waits to set expiresAt, so if a model is loading it's
		// possible that it will be set to the unix epoch. For those cases, just
		// calculate the time w/ the sessionDuration instead.
		var epoch time.Time
		if v.expiresAt == epoch {
			mr.ExpiresAt = time.Now().Add(v.sessionDuration)
		}

1414
1415
1416
		models = append(models, mr)
	}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1417
1418
1419
1420
1421
	slices.SortStableFunc(models, func(i, j api.ProcessModelResponse) int {
		// longest duration remaining listed first
		return cmp.Compare(j.ExpiresAt.Unix(), i.ExpiresAt.Unix())
	})

1422
	c.JSON(http.StatusOK, api.ProcessResponse{Models: models})
1423
1424
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1425
func (s *Server) ChatHandler(c *gin.Context) {
1426
1427
	checkpointStart := time.Now()

Bruce MacDonald's avatar
Bruce MacDonald committed
1428
	var req api.ChatRequest
Michael Yang's avatar
Michael Yang committed
1429
	if err := c.ShouldBindJSON(&req); errors.Is(err, io.EOF) {
Bruce MacDonald's avatar
Bruce MacDonald committed
1430
1431
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
1432
	} else if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1433
1434
1435
1436
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

Patrick Devine's avatar
Patrick Devine committed
1437
1438
1439
1440
1441
1442
1443
	// expire the runner
	if len(req.Messages) == 0 && req.KeepAlive != nil && int(req.KeepAlive.Seconds()) == 0 {
		model, err := GetModel(req.Model)
		if err != nil {
			switch {
			case os.IsNotExist(err):
				c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found", req.Model)})
1444
			case err.Error() == errtypes.InvalidModelNameErrMsg:
Patrick Devine's avatar
Patrick Devine committed
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
				c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
			default:
				c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
			}
			return
		}
		s.sched.expireRunner(model)

		c.JSON(http.StatusOK, api.ChatResponse{
			Model:      req.Model,
			CreatedAt:  time.Now().UTC(),
			Message:    api.Message{Role: "assistant"},
			Done:       true,
			DoneReason: "unload",
		})
		return
	}

1463
	caps := []model.Capability{model.CapabilityCompletion}
1464
	if len(req.Tools) > 0 {
1465
		caps = append(caps, model.CapabilityTools)
Michael Yang's avatar
tools  
Michael Yang committed
1466
	}
1467
1468
1469
	if req.Think != nil && *req.Think {
		caps = append(caps, model.CapabilityThinking)
	}
Michael Yang's avatar
tools  
Michael Yang committed
1470

1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
	name := model.ParseName(req.Model)
	if !name.IsValid() {
		c.JSON(http.StatusBadRequest, gin.H{"error": "model is required"})
		return
	}
	name, err := getExistingName(name)
	if err != nil {
		c.JSON(http.StatusBadRequest, gin.H{"error": "model is required"})
		return
	}

	r, m, opts, err := s.scheduleRunner(c.Request.Context(), name.String(), caps, req.Options, req.KeepAlive)
Michael Yang's avatar
Michael Yang committed
1483
1484
	if errors.Is(err, errCapabilityCompletion) {
		c.JSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("%q does not support chat", req.Model)})
Bruce MacDonald's avatar
Bruce MacDonald committed
1485
		return
Michael Yang's avatar
Michael Yang committed
1486
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
1487
		handleScheduleError(c, req.Model, err)
Bruce MacDonald's avatar
Bruce MacDonald committed
1488
1489
		return
	}
Michael Yang's avatar
Michael Yang committed
1490

1491
1492
	checkpointLoaded := time.Now()

Michael Yang's avatar
Michael Yang committed
1493
1494
	if len(req.Messages) == 0 {
		c.JSON(http.StatusOK, api.ChatResponse{
1495
			Model:      req.Model,
Michael Yang's avatar
Michael Yang committed
1496
1497
			CreatedAt:  time.Now().UTC(),
			Message:    api.Message{Role: "assistant"},
1498
1499
			Done:       true,
			DoneReason: "load",
Michael Yang's avatar
Michael Yang committed
1500
		})
1501
1502
1503
		return
	}

Michael Yang's avatar
Michael Yang committed
1504
	msgs := append(m.Messages, req.Messages...)
1505
	if req.Messages[0].Role != "system" && m.System != "" {
Michael Yang's avatar
Michael Yang committed
1506
		msgs = append([]api.Message{{Role: "system", Content: m.System}}, msgs...)
1507
	}
1508
	msgs = filterThinkTags(msgs, m)
1509

1510
	prompt, images, err := chatPrompt(c.Request.Context(), m, r.Tokenize, opts, msgs, req.Tools, req.Think)
Michael Yang's avatar
Michael Yang committed
1511
	if err != nil {
1512
		slog.Error("chat prompt error", "error", err)
Michael Yang's avatar
Michael Yang committed
1513
1514
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
1515
1516
	}

1517
1518
1519
1520
1521
1522
1523
1524
1525
	var thinkingState *thinkingParser
	openingTag, closingTag := inferThinkingTags(m.Template.Template)
	if req.Think != nil && *req.Think && openingTag != "" && closingTag != "" {
		thinkingState = &thinkingParser{
			openingTag: openingTag,
			closingTag: closingTag,
		}
	}

1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
	var toolParser *tools.Parser
	if len(req.Tools) > 0 {
		toolParser, err = tools.NewParser(m.Template.Template)
		if err != nil {
			slog.Error("failed to create tool parser", "error", err)
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
			return
		}
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
1536
1537
1538
	ch := make(chan any)
	go func() {
		defer close(ch)
1539

Michael Yang's avatar
Michael Yang committed
1540
		if err := r.Completion(c.Request.Context(), llm.CompletionRequest{
Michael Yang's avatar
Michael Yang committed
1541
1542
1543
			Prompt:  prompt,
			Images:  images,
			Format:  req.Format,
Michael Yang's avatar
Michael Yang committed
1544
			Options: opts,
Michael Yang's avatar
Michael Yang committed
1545
		}, func(r llm.CompletionResponse) {
1546
			res := api.ChatResponse{
1547
1548
1549
1550
				Model:     req.Model,
				CreatedAt: time.Now().UTC(),
				Message:   api.Message{Role: "assistant", Content: r.Content},
				Done:      r.Done,
Bruce MacDonald's avatar
Bruce MacDonald committed
1551
1552
1553
1554
1555
1556
1557
				Metrics: api.Metrics{
					PromptEvalCount:    r.PromptEvalCount,
					PromptEvalDuration: r.PromptEvalDuration,
					EvalCount:          r.EvalCount,
					EvalDuration:       r.EvalDuration,
				},
			}
1558

1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
			if thinkingState != nil {
				thinkingContent, remainingContent := thinkingState.addContent(res.Message.Content)
				if thinkingContent == "" && remainingContent == "" && !r.Done {
					// need to accumulate more to decide what to send
					return
				}
				res.Message.Content = remainingContent
				res.Message.Thinking = thinkingContent
			}

1569
			if r.Done {
1570
				res.DoneReason = r.DoneReason.String()
1571
1572
1573
1574
				res.TotalDuration = time.Since(checkpointStart)
				res.LoadDuration = checkpointLoaded.Sub(checkpointStart)
			}

1575
			if len(req.Tools) > 0 {
1576
				toolCalls, content := toolParser.Add(res.Message.Content)
1577
1578
1579
1580
1581
				if len(content) > 0 {
					res.Message.Content = content
				} else if len(toolCalls) > 0 {
					res.Message.ToolCalls = toolCalls
					res.Message.Content = ""
1582
1583
				} else if res.Message.Thinking != "" {
					// don't return
1584
1585
1586
1587
1588
				} else {
					if r.Done {
						ch <- res
					}
					return
1589
1590
				}
			}
1591

1592
			ch <- res
Michael Yang's avatar
Michael Yang committed
1593
		}); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1594
1595
1596
1597
1598
			ch <- gin.H{"error": err.Error()}
		}
	}()

	if req.Stream != nil && !*req.Stream {
Michael Yang's avatar
tools  
Michael Yang committed
1599
		var resp api.ChatResponse
1600
		var toolCalls []api.ToolCall
1601
1602
		var sbThinking strings.Builder
		var sbContent strings.Builder
Michael Yang's avatar
Michael Yang committed
1603
1604
		for rr := range ch {
			switch t := rr.(type) {
1605
			case api.ChatResponse:
1606
1607
				sbThinking.WriteString(t.Message.Thinking)
				sbContent.WriteString(t.Message.Content)
Michael Yang's avatar
tools  
Michael Yang committed
1608
				resp = t
1609
1610
1611
				if len(req.Tools) > 0 {
					toolCalls = append(toolCalls, t.Message.ToolCalls...)
				}
1612
			case gin.H:
Michael Yang's avatar
Michael Yang committed
1613
1614
1615
				msg, ok := t["error"].(string)
				if !ok {
					msg = "unexpected error format in response"
1616
				}
Michael Yang's avatar
Michael Yang committed
1617
1618
1619

				c.JSON(http.StatusInternalServerError, gin.H{"error": msg})
				return
1620
			default:
Michael Yang's avatar
Michael Yang committed
1621
				c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected response"})
1622
				return
Bruce MacDonald's avatar
Bruce MacDonald committed
1623
1624
			}
		}
1625

1626
1627
1628
		resp.Message.Content = sbContent.String()
		resp.Message.Thinking = sbThinking.String()

1629
1630
		if len(toolCalls) > 0 {
			resp.Message.ToolCalls = toolCalls
Michael Yang's avatar
tools  
Michael Yang committed
1631
1632
1633
		}

		c.JSON(http.StatusOK, resp)
Bruce MacDonald's avatar
Bruce MacDonald committed
1634
1635
1636
1637
1638
		return
	}

	streamResponse(c, ch)
}
1639

Michael Yang's avatar
Michael Yang committed
1640
func handleScheduleError(c *gin.Context, name string, err error) {
Michael Yang's avatar
Michael Yang committed
1641
	switch {
1642
	case errors.Is(err, errCapabilities), errors.Is(err, errRequired):
Michael Yang's avatar
Michael Yang committed
1643
		c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Michael Yang's avatar
Michael Yang committed
1644
	case errors.Is(err, context.Canceled):
1645
		c.JSON(499, gin.H{"error": "request canceled"})
Michael Yang's avatar
Michael Yang committed
1646
	case errors.Is(err, ErrMaxQueue):
1647
		c.JSON(http.StatusServiceUnavailable, gin.H{"error": err.Error()})
Michael Yang's avatar
Michael Yang committed
1648
1649
	case errors.Is(err, os.ErrNotExist):
		c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model %q not found, try pulling it first", name)})
Michael Yang's avatar
Michael Yang committed
1650
1651
	default:
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
1652
1653
	}
}
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665

func filterThinkTags(msgs []api.Message, m *Model) []api.Message {
	if m.Config.ModelFamily == "qwen3" || model.ParseName(m.Name).Model == "deepseek-r1" {
		finalUserIndex := -1
		for i, msg := range msgs {
			if msg.Role == "user" {
				finalUserIndex = i
			}
		}

		for i, msg := range msgs {
			if msg.Role == "assistant" && i < finalUserIndex {
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
				// TODO(drifkin): this is from before we added proper thinking support.
				// However, even if thinking is not enabled (and therefore we shouldn't
				// change the user output), we should probably perform this filtering
				// for all thinking models (not just qwen3 & deepseek-r1) since it tends
				// to save tokens and improve quality.
				thinkingState := &thinkingParser{
					openingTag: "<think>",
					closingTag: "</think>",
				}
				_, content := thinkingState.addContent(msg.Content)
				msgs[i].Content = content
1677
1678
1679
1680
1681
			}
		}
	}
	return msgs
}