routes.go 40.5 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
	"regexp"
21
	"slices"
Michael Yang's avatar
Michael Yang committed
22
	"strings"
23
	"syscall"
24
	"time"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
25

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

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

47
48
49
50
51
52
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
53
54
var mode string = gin.DebugMode

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

Michael Yang's avatar
Michael Yang committed
60
61
62
63
64
65
66
67
68
69
70
71
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
72
73
74
75
var (
	errRequired    = errors.New("is required")
	errBadTemplate = errors.New("template error")
)
Michael Yang's avatar
Michael Yang committed
76

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

Michael Yang's avatar
Michael Yang committed
90
91
// 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.
92
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
93
	if name == "" {
Michael Yang's avatar
Michael Yang committed
94
		return nil, nil, nil, fmt.Errorf("model %w", errRequired)
Bruce MacDonald's avatar
Bruce MacDonald committed
95
96
	}

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

102
103
104
105
	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
106
	if err := model.CheckCapabilities(caps...); err != nil {
Michael Yang's avatar
Michael Yang committed
107
		return nil, nil, nil, fmt.Errorf("%s %w", name, err)
108
109
	}

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

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

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

func (s *Server) GenerateHandler(c *gin.Context) {
127
	checkpointStart := time.Now()
Michael Yang's avatar
Michael Yang committed
128
129
130
131
132
133
	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
134
135
136
		return
	}

137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
	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
	}

153
	m, err := GetModel(name.String())
154
155
	if err != nil {
		switch {
156
		case errors.Is(err, fs.ErrNotExist):
157
			c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found", req.Model)})
158
		case err.Error() == errtypes.InvalidModelNameErrMsg:
159
160
161
162
163
164
165
			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
166
167
	// expire the runner
	if req.Prompt == "" && req.KeepAlive != nil && int(req.KeepAlive.Seconds()) == 0 {
168
		s.sched.expireRunner(m)
Patrick Devine's avatar
Patrick Devine committed
169
170
171
172
173
174
175
176
177
178
179

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

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

185
	caps := []model.Capability{model.CapabilityCompletion}
186
	if req.Suffix != "" {
187
		caps = append(caps, model.CapabilityInsert)
188
189
	}

190
	r, m, opts, err := s.scheduleRunner(c.Request.Context(), name.String(), caps, req.Options, req.KeepAlive)
Michael Yang's avatar
Michael Yang committed
191
192
193
194
	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
195
196
197
198
		handleScheduleError(c, req.Model, err)
		return
	}

199
200
	checkpointLoaded := time.Now()

201
	// load the model
Michael Yang's avatar
Michael Yang committed
202
203
204
205
206
207
208
	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
209
210
		return
	}
Bruce MacDonald's avatar
Bruce MacDonald committed
211

212
213
	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"})
214
215
216
		return
	}

Michael Yang's avatar
Michael Yang committed
217
218
	images := make([]llm.ImageData, len(req.Images))
	for i := range req.Images {
219
		images[i] = llm.ImageData{ID: i, Data: req.Images[i]}
Michael Yang's avatar
Michael Yang committed
220
	}
Bruce MacDonald's avatar
Bruce MacDonald committed
221

Michael Yang's avatar
Michael Yang committed
222
223
	prompt := req.Prompt
	if !req.Raw {
Michael Yang's avatar
Michael Yang committed
224
		tmpl := m.Template
Michael Yang's avatar
Michael Yang committed
225
226
227
228
229
230
231
232
		if req.Template != "" {
			tmpl, err = template.Parse(req.Template)
			if err != nil {
				c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
				return
			}
		}

233
234
235
236
237
238
239
240
241
242
243
244
		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
245
246
247
248
			if req.Context == nil {
				msgs = append(msgs, m.Messages...)
			}

249
			for _, i := range images {
250
251
				imgPrompt := ""
				msgs = append(msgs, api.Message{Role: "user", Content: fmt.Sprintf("[img-%d]"+imgPrompt, i.ID)})
252
253
254
255
256
			}

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

Michael Yang's avatar
Michael Yang committed
257
258
		var b bytes.Buffer
		if req.Context != nil {
259
			slog.Warn("the context field is deprecated and will be removed in a future version of Ollama")
260
			s, err := r.Detokenize(c.Request.Context(), req.Context)
Michael Yang's avatar
Michael Yang committed
261
262
263
264
			if err != nil {
				c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
				return
			}
265
			b.WriteString(s)
Michael Yang's avatar
Michael Yang committed
266
		}
267
268
269
270
271
272
273

		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
274
275
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
276
277
	ch := make(chan any)
	go func() {
278
279
		// TODO (jmorganca): avoid building the response twice both here and below
		var sb strings.Builder
Bruce MacDonald's avatar
Bruce MacDonald committed
280
		defer close(ch)
Michael Yang's avatar
Michael Yang committed
281
		if err := r.Completion(c.Request.Context(), llm.CompletionRequest{
Michael Yang's avatar
Michael Yang committed
282
283
			Prompt:  prompt,
			Images:  images,
284
			Format:  req.Format,
Michael Yang's avatar
Michael Yang committed
285
			Options: opts,
286
287
		}, func(cr llm.CompletionResponse) {
			res := api.GenerateResponse{
288
289
290
291
				Model:     req.Model,
				CreatedAt: time.Now().UTC(),
				Response:  cr.Content,
				Done:      cr.Done,
Bruce MacDonald's avatar
Bruce MacDonald committed
292
				Metrics: api.Metrics{
293
294
295
296
					PromptEvalCount:    cr.PromptEvalCount,
					PromptEvalDuration: cr.PromptEvalDuration,
					EvalCount:          cr.EvalCount,
					EvalDuration:       cr.EvalDuration,
Bruce MacDonald's avatar
Bruce MacDonald committed
297
				},
Bruce MacDonald's avatar
Bruce MacDonald committed
298
			}
299
300
301
302
303
304

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

			if cr.Done {
305
				res.DoneReason = cr.DoneReason.String()
306
307
308
309
				res.TotalDuration = time.Since(checkpointStart)
				res.LoadDuration = checkpointLoaded.Sub(checkpointStart)

				if !req.Raw {
310
					tokens, err := r.Tokenize(c.Request.Context(), prompt+sb.String())
311
312
313
314
					if err != nil {
						ch <- gin.H{"error": err.Error()}
						return
					}
315
					res.Context = tokens
316
317
318
319
				}
			}

			ch <- res
Michael Yang's avatar
Michael Yang committed
320
		}); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
321
322
323
324
325
			ch <- gin.H{"error": err.Error()}
		}
	}()

	if req.Stream != nil && !*req.Stream {
Michael Yang's avatar
Michael Yang committed
326
		var r api.GenerateResponse
Bruce MacDonald's avatar
Bruce MacDonald committed
327
		var sb strings.Builder
Michael Yang's avatar
Michael Yang committed
328
329
		for rr := range ch {
			switch t := rr.(type) {
330
			case api.GenerateResponse:
Michael Yang's avatar
Michael Yang committed
331
332
				sb.WriteString(t.Response)
				r = t
333
			case gin.H:
Michael Yang's avatar
Michael Yang committed
334
335
336
				msg, ok := t["error"].(string)
				if !ok {
					msg = "unexpected error format in response"
337
				}
Michael Yang's avatar
Michael Yang committed
338
339
340

				c.JSON(http.StatusInternalServerError, gin.H{"error": msg})
				return
341
			default:
Michael Yang's avatar
Michael Yang committed
342
				c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected response"})
Bruce MacDonald's avatar
Bruce MacDonald committed
343
344
345
				return
			}
		}
346

Michael Yang's avatar
Michael Yang committed
347
348
		r.Response = sb.String()
		c.JSON(http.StatusOK, r)
Bruce MacDonald's avatar
Bruce MacDonald committed
349
350
351
352
353
354
		return
	}

	streamResponse(c, ch)
}

355
func (s *Server) EmbedHandler(c *gin.Context) {
356
	checkpointStart := time.Now()
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
	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:
390
391
392
393
		if req.Input != nil {
			c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "invalid input type"})
			return
		}
394
395
	}

396
397
398
399
400
401
	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
	}

402
	r, m, opts, err := s.scheduleRunner(c.Request.Context(), name.String(), []model.Capability{}, req.Options, req.KeepAlive)
403
404
405
406
407
	if err != nil {
		handleScheduleError(c, req.Model, err)
		return
	}

408
409
	checkpointLoaded := time.Now()

410
411
412
413
414
	if len(input) == 0 {
		c.JSON(http.StatusOK, api.EmbedResponse{Model: req.Model, Embeddings: [][]float32{}})
		return
	}

415
	kvData, _, err := getModelData(m.ModelPath, false)
416
417
418
419
420
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

421
	var count int
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
	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
			}
		}

444
445
		count += len(tokens)

446
447
		input[i] = s
	}
448
449
450
451
452
453
454
455
456
457
458
459

	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
		})
460
461
	}

462
	if err := g.Wait(); err != nil {
463
		c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": strings.TrimSpace(err.Error())})
464
		return
465
466
467
	}

	resp := api.EmbedResponse{
468
		Model:           req.Model,
469
		Embeddings:      embeddings,
470
471
		TotalDuration:   time.Since(checkpointStart),
		LoadDuration:    checkpointLoaded.Sub(checkpointStart),
472
		PromptEvalCount: count,
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
	}
	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
494
func (s *Server) EmbeddingsHandler(c *gin.Context) {
Bruce MacDonald's avatar
Bruce MacDonald committed
495
	var req api.EmbeddingRequest
Michael Yang's avatar
Michael Yang committed
496
	if err := c.ShouldBindJSON(&req); errors.Is(err, io.EOF) {
Bruce MacDonald's avatar
Bruce MacDonald committed
497
498
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
499
	} else if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
500
501
502
503
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

504
505
506
507
508
509
	name := model.ParseName(req.Model)
	if !name.IsValid() {
		c.JSON(http.StatusBadRequest, gin.H{"error": "model is required"})
		return
	}

510
	r, _, _, err := s.scheduleRunner(c.Request.Context(), name.String(), []model.Capability{}, req.Options, req.KeepAlive)
Bruce MacDonald's avatar
Bruce MacDonald committed
511
	if err != nil {
Michael Yang's avatar
Michael Yang committed
512
		handleScheduleError(c, req.Model, err)
Bruce MacDonald's avatar
Bruce MacDonald committed
513
514
515
		return
	}

516
517
518
	// an empty request loads the model
	if req.Prompt == "" {
		c.JSON(http.StatusOK, api.EmbeddingResponse{Embedding: []float64{}})
Bruce MacDonald's avatar
Bruce MacDonald committed
519
520
521
		return
	}

522
	embedding, err := r.Embedding(c.Request.Context(), req.Prompt)
Bruce MacDonald's avatar
Bruce MacDonald committed
523
	if err != nil {
524
		c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": strings.TrimSpace(err.Error())})
Bruce MacDonald's avatar
Bruce MacDonald committed
525
526
527
		return
	}

528
529
530
	var e []float64
	for _, v := range embedding {
		e = append(e, float64(v))
531
532
533
	}

	resp := api.EmbeddingResponse{
534
		Embedding: e,
535
536
	}
	c.JSON(http.StatusOK, resp)
Bruce MacDonald's avatar
Bruce MacDonald committed
537
538
}

539
func (s *Server) PullHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
540
	var req api.PullRequest
Michael Yang's avatar
Michael Yang committed
541
542
543
544
545
546
547
	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
548
549
550
		return
	}

551
552
	name := model.ParseName(cmp.Or(req.Model, req.Name))
	if !name.IsValid() {
553
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": errtypes.InvalidModelNameErrMsg})
554
555
556
		return
	}

557
558
	name, err = getExistingName(name)
	if err != nil {
559
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
560
561
562
		return
	}

563
564
565
	ch := make(chan any)
	go func() {
		defer close(ch)
566
567
		fn := func(r api.ProgressResponse) {
			ch <- r
568
		}
569

Michael Yang's avatar
Michael Yang committed
570
		regOpts := &registryOptions{
571
572
573
			Insecure: req.Insecure,
		}

574
575
576
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

577
		if err := PullModel(ctx, name.DisplayShortest(), regOpts, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
578
			ch <- gin.H{"error": err.Error()}
579
580
581
		}
	}()

582
583
584
585
586
	if req.Stream != nil && !*req.Stream {
		waitForStream(c, ch)
		return
	}

587
588
589
	streamResponse(c, ch)
}

590
func (s *Server) PushHandler(c *gin.Context) {
591
	var req api.PushRequest
Michael Yang's avatar
Michael Yang committed
592
593
594
595
596
597
598
	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
599
600
		return
	}
Michael Yang's avatar
Michael Yang committed
601

602
	var mname string
Michael Yang's avatar
Michael Yang committed
603
	if req.Model != "" {
604
		mname = req.Model
Michael Yang's avatar
Michael Yang committed
605
	} else if req.Name != "" {
606
		mname = req.Name
Michael Yang's avatar
Michael Yang committed
607
608
	} else {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
609
610
611
		return
	}

612
613
614
	ch := make(chan any)
	go func() {
		defer close(ch)
615
616
		fn := func(r api.ProgressResponse) {
			ch <- r
617
		}
618

Michael Yang's avatar
Michael Yang committed
619
		regOpts := &registryOptions{
620
621
622
			Insecure: req.Insecure,
		}

Michael Yang's avatar
Michael Yang committed
623
624
625
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

626
627
628
629
630
631
632
		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
633
			ch <- gin.H{"error": err.Error()}
634
635
636
		}
	}()

637
638
639
640
641
	if req.Stream != nil && !*req.Stream {
		waitForStream(c, ch)
		return
	}

642
643
644
	streamResponse(c, ch)
}

645
646
647
648
// 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.
649
650
651
func getExistingName(n model.Name) (model.Name, error) {
	var zero model.Name
	existing, err := Manifests(true)
652
	if err != nil {
653
		return zero, err
654
	}
655
	var set model.Name // tracks parts already canonicalized
656
	for e := range existing {
657
658
659
660
661
662
663
664
665
666
667
		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
668
669
		}
	}
670
	return n, nil
671
672
}

673
func (s *Server) DeleteHandler(c *gin.Context) {
674
675
	var r api.DeleteRequest
	if err := c.ShouldBindJSON(&r); errors.Is(err, io.EOF) {
Michael Yang's avatar
Michael Yang committed
676
677
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
678
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
679
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
680
681
682
		return
	}

683
684
685
	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))})
686
687
		return
	}
Michael Yang's avatar
Michael Yang committed
688

689
690
691
692
693
694
	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
	}

695
	m, err := ParseNamedManifest(n)
Michael Yang's avatar
Michael Yang committed
696
	if err != nil {
697
698
699
700
701
702
		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
703
704
705
		return
	}

706
	if err := m.Remove(); err != nil {
Michael Yang's avatar
Michael Yang committed
707
708
709
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}
710
711
712
713
714

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

717
func (s *Server) ShowHandler(c *gin.Context) {
Patrick Devine's avatar
Patrick Devine committed
718
	var req api.ShowRequest
Michael Yang's avatar
Michael Yang committed
719
720
721
722
723
724
725
	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
726
727
728
		return
	}

Michael Yang's avatar
Michael Yang committed
729
	if req.Model != "" {
Michael Yang's avatar
Michael Yang committed
730
		// noop
Michael Yang's avatar
Michael Yang committed
731
	} else if req.Name != "" {
Michael Yang's avatar
Michael Yang committed
732
		req.Model = req.Name
Michael Yang's avatar
Michael Yang committed
733
	} else {
734
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
735
736
737
		return
	}

738
	resp, err := GetModelInfo(req)
Patrick Devine's avatar
Patrick Devine committed
739
	if err != nil {
740
741
		switch {
		case os.IsNotExist(err):
Michael Yang's avatar
Michael Yang committed
742
			c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found", req.Model)})
743
		case err.Error() == errtypes.InvalidModelNameErrMsg:
744
745
			c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		default:
Patrick Devine's avatar
Patrick Devine committed
746
747
748
749
750
751
752
753
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		}
		return
	}

	c.JSON(http.StatusOK, resp)
}

754
func GetModelInfo(req api.ShowRequest) (*api.ShowResponse, error) {
755
756
	name := model.ParseName(req.Model)
	if !name.IsValid() {
CYJiang's avatar
CYJiang committed
757
		return nil, ErrModelPathInvalid
758
759
760
761
762
763
764
	}
	name, err := getExistingName(name)
	if err != nil {
		return nil, err
	}

	m, err := GetModel(name.String())
Patrick Devine's avatar
Patrick Devine committed
765
766
767
768
	if err != nil {
		return nil, err
	}

Patrick Devine's avatar
Patrick Devine committed
769
	modelDetails := api.ModelDetails{
770
771
772
773
774
775
		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
776
777
	}

778
	if req.System != "" {
779
		m.System = req.System
780
781
	}

Michael Yang's avatar
Michael Yang committed
782
783
784
	msgs := make([]api.Message, len(m.Messages))
	for i, msg := range m.Messages {
		msgs[i] = api.Message{Role: msg.Role, Content: msg.Content}
785
786
	}

787
	manifest, err := ParseNamedManifest(name)
788
789
790
791
	if err != nil {
		return nil, err
	}

Patrick Devine's avatar
Patrick Devine committed
792
	resp := &api.ShowResponse{
793
794
795
796
797
798
799
		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
800
801
802
803
	}

	var params []string
	cs := 30
804
	for k, v := range m.Options {
Patrick Devine's avatar
Patrick Devine committed
805
		switch val := v.(type) {
806
		case []any:
Patrick Devine's avatar
Patrick Devine committed
807
			for _, nv := range val {
Patrick Devine's avatar
Patrick Devine committed
808
				params = append(params, fmt.Sprintf("%-*s %#v", cs, k, nv))
Patrick Devine's avatar
Patrick Devine committed
809
			}
Patrick Devine's avatar
Patrick Devine committed
810
811
		default:
			params = append(params, fmt.Sprintf("%-*s %#v", cs, k, v))
Patrick Devine's avatar
Patrick Devine committed
812
813
814
815
		}
	}
	resp.Parameters = strings.Join(params, "\n")

816
817
	for k, v := range req.Options {
		if _, ok := req.Options[k]; ok {
818
			m.Options[k] = v
819
820
821
		}
	}

822
	var sb strings.Builder
823
	fmt.Fprintln(&sb, "# Modelfile generated by \"ollama show\"")
824
	fmt.Fprintln(&sb, "# To build a new Modelfile based on this, replace FROM with:")
825
826
	fmt.Fprintf(&sb, "# FROM %s\n\n", m.ShortName)
	fmt.Fprint(&sb, m.String())
827
	resp.Modelfile = sb.String()
828

829
	kvData, tensors, err := getModelData(m.ModelPath, req.Verbose)
830
831
832
	if err != nil {
		return nil, err
	}
833

834
835
836
837
	delete(kvData, "general.name")
	delete(kvData, "tokenizer.chat_template")
	resp.ModelInfo = kvData

838
839
840
841
842
843
	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

844
	if len(m.ProjectorPaths) > 0 {
845
		projectorData, _, err := getModelData(m.ProjectorPaths[0], req.Verbose)
846
847
848
849
850
851
		if err != nil {
			return nil, err
		}
		resp.ProjectorInfo = projectorData
	}

Patrick Devine's avatar
Patrick Devine committed
852
853
854
	return resp, nil
}

855
func getModelData(digest string, verbose bool) (ggml.KV, ggml.Tensors, error) {
856
857
858
859
	maxArraySize := 0
	if verbose {
		maxArraySize = -1
	}
860
	data, err := llm.LoadModel(digest, maxArraySize)
861
	if err != nil {
862
		return nil, ggml.Tensors{}, err
863
864
	}

865
	kv := data.KV()
866
867
868
869
870
871
872
873
874

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

875
	return kv, data.Tensors(), nil
876
877
}

878
func (s *Server) ListHandler(c *gin.Context) {
879
	ms, err := Manifests(true)
Patrick Devine's avatar
Patrick Devine committed
880
881
882
883
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}
Michael Yang's avatar
Michael Yang committed
884

885
	models := []api.ListModelResponse{}
886
887
	for n, m := range ms {
		var cf ConfigV2
888
889
890
891
892
893
894
895
896
897
898
899
900

		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
901
		}
Michael Yang's avatar
Michael Yang committed
902

903
		// tag should never be masked
904
		models = append(models, api.ListModelResponse{
905
906
907
908
909
910
911
912
913
914
915
916
917
			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
918
919
	}

920
	slices.SortStableFunc(models, func(i, j api.ListModelResponse) int {
921
922
923
924
		// most recently modified first
		return cmp.Compare(j.ModifiedAt.Unix(), i.ModifiedAt.Unix())
	})

Michael Yang's avatar
Michael Yang committed
925
	c.JSON(http.StatusOK, api.ListResponse{Models: models})
Patrick Devine's avatar
Patrick Devine committed
926
927
}

928
func (s *Server) CopyHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
929
930
	var r api.CopyRequest
	if err := c.ShouldBindJSON(&r); errors.Is(err, io.EOF) {
Michael Yang's avatar
Michael Yang committed
931
932
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
933
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
934
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Patrick Devine's avatar
Patrick Devine committed
935
936
937
		return
	}

Michael Yang's avatar
Michael Yang committed
938
939
	src := model.ParseName(r.Source)
	if !src.IsValid() {
Michael Yang's avatar
Michael Yang committed
940
941
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("source %q is invalid", r.Source)})
		return
942
	}
943
944
945
946
947
	src, err := getExistingName(src)
	if err != nil {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}
948

Michael Yang's avatar
Michael Yang committed
949
950
	dst := model.ParseName(r.Destination)
	if !dst.IsValid() {
951
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("destination %q is invalid", r.Destination)})
Patrick Devine's avatar
Patrick Devine committed
952
953
		return
	}
954
955
	dst, err = getExistingName(dst)
	if err != nil {
956
957
958
959
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

Michael Yang's avatar
Michael Yang committed
960
961
962
963
964
	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
965
966
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
967
func (s *Server) HeadBlobHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
968
969
970
971
972
973
974
975
976
977
978
	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
979
	c.Status(http.StatusOK)
Michael Yang's avatar
Michael Yang committed
980
981
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
982
func (s *Server) CreateBlobHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
983
984
	if ib, ok := intermediateBlobs[c.Param("digest")]; ok {
		p, err := GetBlobsPath(ib)
985
986
987
988
989
990
		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
991
992
			slog.Info("evicting intermediate blob which no longer exists", "digest", ib)
			delete(intermediateBlobs, c.Param("digest"))
993
994
995
996
997
998
999
1000
1001
		} else if err != nil {
			c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
			return
		} else {
			c.Status(http.StatusOK)
			return
		}
	}

1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
	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
	}

1020
	layer, err := NewLayer(c.Request.Body, "")
Michael Yang's avatar
Michael Yang committed
1021
1022
1023
1024
1025
	if err != nil {
		c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

1026
1027
	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
1028
1029
1030
		return
	}

Michael Yang's avatar
Michael Yang committed
1031
	c.Status(http.StatusCreated)
Michael Yang's avatar
Michael Yang committed
1032
1033
}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
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
}

1055
func allowedHost(host string) bool {
1056
1057
	host = strings.ToLower(host)

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1058
	if host == "" || host == "localhost" {
1059
1060
1061
		return true
	}

1062
	if hostname, err := os.Hostname(); err == nil && host == strings.ToLower(hostname) {
1063
1064
1065
		return true
	}

Michael Yang's avatar
lint  
Michael Yang committed
1066
	tlds := []string{
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1067
1068
1069
		"localhost",
		"local",
		"internal",
1070
	}
1071

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1072
	// check if the host is a local TLD
1073
1074
1075
1076
1077
1078
	for _, tld := range tlds {
		if strings.HasSuffix(host, "."+tld) {
			return true
		}
	}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1079
	return false
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1080
}
1081

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1082
1083
1084
func allowedHostsMiddleware(addr net.Addr) gin.HandlerFunc {
	return func(c *gin.Context) {
		if addr == nil {
1085
1086
1087
1088
			c.Next()
			return
		}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1089
		if addr, err := netip.ParseAddrPort(addr.String()); err == nil && !addr.Addr().IsLoopback() {
1090
1091
1092
1093
1094
1095
1096
1097
1098
			c.Next()
			return
		}

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

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1099
		if addr, err := netip.ParseAddr(host); err == nil {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1100
			if addr.IsLoopback() || addr.IsPrivate() || addr.IsUnspecified() || isLocalIP(addr) {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1101
1102
1103
1104
1105
				c.Next()
				return
			}
		}

1106
		if allowedHost(host) {
Michael Yang's avatar
lint  
Michael Yang committed
1107
			if c.Request.Method == http.MethodOptions {
1108
1109
1110
1111
				c.AbortWithStatus(http.StatusNoContent)
				return
			}

1112
1113
1114
1115
1116
1117
			c.Next()
			return
		}

		c.AbortWithStatus(http.StatusForbidden)
	}
1118
}
1119

1120
func (s *Server) GenerateRoutes(rc *ollama.Registry) (http.Handler, error) {
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
	corsConfig := cors.DefaultConfig()
	corsConfig.AllowWildcard = true
	corsConfig.AllowBrowserExtensions = true
	corsConfig.AllowHeaders = []string{
		"Authorization",
		"Content-Type",
		"User-Agent",
		"Accept",
		"X-Requested-With",

		// OpenAI compatibility headers
1132
1133
1134
1135
1136
		"OpenAI-Beta",
		"x-stainless-arch",
		"x-stainless-async",
		"x-stainless-custom-poll-interval",
		"x-stainless-helper-method",
1137
1138
		"x-stainless-lang",
		"x-stainless-os",
1139
1140
		"x-stainless-package-version",
		"x-stainless-poll-helper",
1141
1142
1143
1144
1145
1146
		"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
1147

Bruce MacDonald's avatar
Bruce MacDonald committed
1148
	r := gin.Default()
1149
	r.HandleMethodNotAllowed = true
1150
	r.Use(
1151
		cors.New(corsConfig),
1152
		allowedHostsMiddleware(s.addr),
1153
	)
Bruce MacDonald's avatar
Bruce MacDonald committed
1154

1155
1156
1157
1158
1159
1160
	// 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}) })

1161
	// Local model cache management (new implementation is at end of function)
1162
1163
	r.POST("/api/pull", s.PullHandler)
	r.POST("/api/push", s.PushHandler)
1164
1165
	r.HEAD("/api/tags", s.ListHandler)
	r.GET("/api/tags", s.ListHandler)
1166
	r.POST("/api/show", s.ShowHandler)
1167
	r.DELETE("/api/delete", s.DeleteHandler)
1168
1169
1170

	// Create
	r.POST("/api/create", s.CreateHandler)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1171
1172
	r.POST("/api/blobs/:digest", s.CreateBlobHandler)
	r.HEAD("/api/blobs/:digest", s.HeadBlobHandler)
1173
1174
1175
	r.POST("/api/copy", s.CopyHandler)

	// Inference
1176
	r.GET("/api/ps", s.PsHandler)
1177
1178
1179
1180
	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
1181

1182
	// Inference (OpenAI compatibility)
1183
	r.POST("/v1/chat/completions", openai.ChatMiddleware(), s.ChatHandler)
1184
	r.POST("/v1/completions", openai.CompletionsMiddleware(), s.GenerateHandler)
1185
	r.POST("/v1/embeddings", openai.EmbeddingsMiddleware(), s.EmbedHandler)
1186
1187
	r.GET("/v1/models", openai.ListMiddleware(), s.ListHandler)
	r.GET("/v1/models/:model", openai.RetrieveMiddleware(), s.ShowHandler)
1188

1189
1190
1191
1192
1193
1194
	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,
1195

1196
1197
1198
			Prune: PruneLayers,
		}
		return rs, nil
1199
1200
	}

1201
	return r, nil
1202
1203
1204
}

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

1208
1209
1210
1211
1212
1213
1214
1215
	blobsDir, err := GetBlobsPath("")
	if err != nil {
		return err
	}
	if err := fixBlobs(blobsDir); err != nil {
		return err
	}

Michael Yang's avatar
bool  
Michael Yang committed
1216
	if !envconfig.NoPrune() {
1217
1218
1219
1220
1221
1222
1223
		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
			}
1224

1225
1226
1227
1228
			manifestsPath, err := GetManifestPath()
			if err != nil {
				return err
			}
1229

1230
1231
1232
			if err := PruneDirectory(manifestsPath); err != nil {
				return err
			}
1233
1234
1235
		}
	}

1236
1237
	s := &Server{addr: ln.Addr()}

1238
1239
1240
1241
1242
1243
1244
	var rc *ollama.Registry
	if useClient2 {
		var err error
		rc, err = ollama.DefaultRegistry()
		if err != nil {
			return err
		}
1245
1246
	}

1247
	h, err := s.GenerateRoutes(rc)
1248
1249
1250
	if err != nil {
		return err
	}
1251

1252
1253
	http.Handle("/", h)

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1254
	ctx, done := context.WithCancel(context.Background())
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1255
1256
	schedCtx, schedDone := context.WithCancel(ctx)
	sched := InitScheduler(schedCtx)
1257
	s.sched = sched
1258

1259
	slog.Info(fmt.Sprintf("Listening on %s (version %s)", ln.Addr(), version.Version))
1260
	srvr := &http.Server{
1261
1262
1263
1264
1265
1266
1267
1268
1269
		// 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
1270
1271
	}

1272
1273
	// listen for a ctrl+c and stop any loaded llm
	signals := make(chan os.Signal, 1)
1274
	signal.Notify(signals, syscall.SIGINT, syscall.SIGTERM)
1275
1276
	go func() {
		<-signals
1277
		srvr.Close()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1278
		schedDone()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1279
		sched.unloadAllRunners()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1280
		done()
1281
1282
	}()

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1283
	s.sched.Run(schedCtx)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1284

1285
1286
1287
1288
	// 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
1289
1290
	// 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
1291
	gpus := discover.GetGPUInfo()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1292
	gpus.LogDetails()
1293

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1294
1295
1296
1297
1298
1299
1300
	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()
1301
	return nil
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1302
}
Michael Yang's avatar
Michael Yang committed
1303

1304
func waitForStream(c *gin.Context, ch chan any) {
1305
	c.Header("Content-Type", "application/json")
1306
	var latest api.ProgressResponse
1307
1308
1309
	for resp := range ch {
		switch r := resp.(type) {
		case api.ProgressResponse:
1310
			latest = r
1311
		case gin.H:
Josh's avatar
Josh committed
1312
1313
1314
1315
			status, ok := r["status"].(int)
			if !ok {
				status = http.StatusInternalServerError
			}
1316
1317
1318
			errorMsg, ok := r["error"].(string)
			if !ok {
				errorMsg = "unknown error"
1319
			}
1320
1321
			c.JSON(status, gin.H{"error": errorMsg})
			return
1322
		default:
1323
			c.JSON(http.StatusInternalServerError, gin.H{"error": "unknown message type"})
1324
1325
1326
			return
		}
	}
1327
1328

	c.JSON(http.StatusOK, latest)
1329
1330
}

Michael Yang's avatar
Michael Yang committed
1331
func streamResponse(c *gin.Context, ch chan any) {
1332
	c.Header("Content-Type", "application/x-ndjson")
Michael Yang's avatar
Michael Yang committed
1333
1334
1335
1336
1337
1338
1339
1340
	c.Stream(func(w io.Writer) bool {
		val, ok := <-ch
		if !ok {
			return false
		}

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

1345
		// Delineate chunks with new-line delimiter
Michael Yang's avatar
Michael Yang committed
1346
1347
		bts = append(bts, '\n')
		if _, err := w.Write(bts); err != nil {
1348
			slog.Info(fmt.Sprintf("streamResponse: w.Write failed with %s", err))
Michael Yang's avatar
Michael Yang committed
1349
1350
1351
1352
1353
1354
			return false
		}

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

1356
func (s *Server) PsHandler(c *gin.Context) {
1357
	models := []api.ProcessModelResponse{}
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368

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

1369
		mr := api.ProcessModelResponse{
1370
1371
1372
1373
1374
1375
1376
1377
			Model:     model.ShortName,
			Name:      model.ShortName,
			Size:      int64(v.estimatedTotal),
			SizeVRAM:  int64(v.estimatedVRAM),
			Digest:    model.Digest,
			Details:   modelDetails,
			ExpiresAt: v.expiresAt,
		}
1378
1379
1380
1381
1382
1383
1384
1385
		// 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)
		}

1386
1387
1388
		models = append(models, mr)
	}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1389
1390
1391
1392
1393
	slices.SortStableFunc(models, func(i, j api.ProcessModelResponse) int {
		// longest duration remaining listed first
		return cmp.Compare(j.ExpiresAt.Unix(), i.ExpiresAt.Unix())
	})

1394
	c.JSON(http.StatusOK, api.ProcessResponse{Models: models})
1395
1396
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1397
func (s *Server) ChatHandler(c *gin.Context) {
1398
1399
	checkpointStart := time.Now()

Bruce MacDonald's avatar
Bruce MacDonald committed
1400
	var req api.ChatRequest
Michael Yang's avatar
Michael Yang committed
1401
	if err := c.ShouldBindJSON(&req); errors.Is(err, io.EOF) {
Bruce MacDonald's avatar
Bruce MacDonald committed
1402
1403
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
1404
	} else if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1405
1406
1407
1408
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

Patrick Devine's avatar
Patrick Devine committed
1409
1410
1411
1412
1413
1414
1415
	// 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)})
1416
			case err.Error() == errtypes.InvalidModelNameErrMsg:
Patrick Devine's avatar
Patrick Devine committed
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
				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
	}

1435
	caps := []model.Capability{model.CapabilityCompletion}
1436
	if len(req.Tools) > 0 {
1437
		caps = append(caps, model.CapabilityTools)
Michael Yang's avatar
tools  
Michael Yang committed
1438
1439
	}

1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
	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
1452
1453
	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
1454
		return
Michael Yang's avatar
Michael Yang committed
1455
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
1456
		handleScheduleError(c, req.Model, err)
Bruce MacDonald's avatar
Bruce MacDonald committed
1457
1458
		return
	}
Michael Yang's avatar
Michael Yang committed
1459

1460
1461
	checkpointLoaded := time.Now()

Michael Yang's avatar
Michael Yang committed
1462
1463
	if len(req.Messages) == 0 {
		c.JSON(http.StatusOK, api.ChatResponse{
1464
			Model:      req.Model,
Michael Yang's avatar
Michael Yang committed
1465
1466
			CreatedAt:  time.Now().UTC(),
			Message:    api.Message{Role: "assistant"},
1467
1468
			Done:       true,
			DoneReason: "load",
Michael Yang's avatar
Michael Yang committed
1469
		})
1470
1471
1472
		return
	}

Michael Yang's avatar
Michael Yang committed
1473
	msgs := append(m.Messages, req.Messages...)
1474
	if req.Messages[0].Role != "system" && m.System != "" {
Michael Yang's avatar
Michael Yang committed
1475
		msgs = append([]api.Message{{Role: "system", Content: m.System}}, msgs...)
1476
	}
1477
	msgs = filterThinkTags(msgs, m)
1478

Michael Yang's avatar
Michael Yang committed
1479
	prompt, images, err := chatPrompt(c.Request.Context(), m, r.Tokenize, opts, msgs, req.Tools)
Michael Yang's avatar
Michael Yang committed
1480
	if err != nil {
1481
		slog.Error("chat prompt error", "error", err)
Michael Yang's avatar
Michael Yang committed
1482
1483
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
1484
1485
	}

1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
	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
1496
1497
1498
	ch := make(chan any)
	go func() {
		defer close(ch)
1499

Michael Yang's avatar
Michael Yang committed
1500
		if err := r.Completion(c.Request.Context(), llm.CompletionRequest{
Michael Yang's avatar
Michael Yang committed
1501
1502
1503
			Prompt:  prompt,
			Images:  images,
			Format:  req.Format,
Michael Yang's avatar
Michael Yang committed
1504
			Options: opts,
Michael Yang's avatar
Michael Yang committed
1505
		}, func(r llm.CompletionResponse) {
1506
			res := api.ChatResponse{
1507
1508
1509
1510
				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
1511
1512
1513
1514
1515
1516
1517
				Metrics: api.Metrics{
					PromptEvalCount:    r.PromptEvalCount,
					PromptEvalDuration: r.PromptEvalDuration,
					EvalCount:          r.EvalCount,
					EvalDuration:       r.EvalDuration,
				},
			}
1518
1519

			if r.Done {
1520
				res.DoneReason = r.DoneReason.String()
1521
1522
1523
1524
				res.TotalDuration = time.Since(checkpointStart)
				res.LoadDuration = checkpointLoaded.Sub(checkpointStart)
			}

1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
			if len(req.Tools) > 0 {
				toolCalls, content := toolParser.Add(r.Content)
				if len(content) > 0 {
					res.Message.Content = content
				} else if len(toolCalls) > 0 {
					res.Message.ToolCalls = toolCalls
					res.Message.Content = ""
				} else {
					if r.Done {
						ch <- res
					}
					return
1537
1538
				}
			}
1539
			ch <- res
Michael Yang's avatar
Michael Yang committed
1540
		}); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1541
1542
1543
1544
1545
			ch <- gin.H{"error": err.Error()}
		}
	}()

	if req.Stream != nil && !*req.Stream {
Michael Yang's avatar
tools  
Michael Yang committed
1546
		var resp api.ChatResponse
Bruce MacDonald's avatar
Bruce MacDonald committed
1547
		var sb strings.Builder
1548
		var toolCalls []api.ToolCall
Michael Yang's avatar
Michael Yang committed
1549
1550
		for rr := range ch {
			switch t := rr.(type) {
1551
			case api.ChatResponse:
Michael Yang's avatar
Michael Yang committed
1552
				sb.WriteString(t.Message.Content)
Michael Yang's avatar
tools  
Michael Yang committed
1553
				resp = t
1554
1555
1556
				if len(req.Tools) > 0 {
					toolCalls = append(toolCalls, t.Message.ToolCalls...)
				}
1557
			case gin.H:
Michael Yang's avatar
Michael Yang committed
1558
1559
1560
				msg, ok := t["error"].(string)
				if !ok {
					msg = "unexpected error format in response"
1561
				}
Michael Yang's avatar
Michael Yang committed
1562
1563
1564

				c.JSON(http.StatusInternalServerError, gin.H{"error": msg})
				return
1565
			default:
Michael Yang's avatar
Michael Yang committed
1566
				c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected response"})
1567
				return
Bruce MacDonald's avatar
Bruce MacDonald committed
1568
1569
			}
		}
1570

Michael Yang's avatar
tools  
Michael Yang committed
1571
		resp.Message.Content = sb.String()
1572
1573
		if len(toolCalls) > 0 {
			resp.Message.ToolCalls = toolCalls
Michael Yang's avatar
tools  
Michael Yang committed
1574
1575
1576
		}

		c.JSON(http.StatusOK, resp)
Bruce MacDonald's avatar
Bruce MacDonald committed
1577
1578
1579
1580
1581
		return
	}

	streamResponse(c, ch)
}
1582

Michael Yang's avatar
Michael Yang committed
1583
func handleScheduleError(c *gin.Context, name string, err error) {
Michael Yang's avatar
Michael Yang committed
1584
	switch {
1585
	case errors.Is(err, errCapabilities), errors.Is(err, errRequired):
Michael Yang's avatar
Michael Yang committed
1586
		c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Michael Yang's avatar
Michael Yang committed
1587
	case errors.Is(err, context.Canceled):
1588
		c.JSON(499, gin.H{"error": "request canceled"})
Michael Yang's avatar
Michael Yang committed
1589
	case errors.Is(err, ErrMaxQueue):
1590
		c.JSON(http.StatusServiceUnavailable, gin.H{"error": err.Error()})
Michael Yang's avatar
Michael Yang committed
1591
1592
	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
1593
1594
	default:
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
1595
1596
	}
}
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616

var thinkTagRegexp = regexp.MustCompile(`<think>(?s).*?</think>(\n)*`)

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 {
				msgs[i].Content = thinkTagRegexp.ReplaceAllString(msg.Content, "")
			}
		}
	}
	return msgs
}