routes.go 41.4 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"
7
	"encoding/binary"
Michael Yang's avatar
Michael Yang committed
8
	"encoding/json"
9
	"errors"
10
	"fmt"
11
	"image"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
12
	"io"
13
	"io/fs"
14
	"log/slog"
15
	"math"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
16
17
	"net"
	"net/http"
18
	"net/netip"
19
	"os"
20
	"os/signal"
21
	"regexp"
22
	"slices"
Michael Yang's avatar
Michael Yang committed
23
	"strings"
24
	"syscall"
25
	"time"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
26

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

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

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

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

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

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

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

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

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

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

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

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

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

134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
	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
	}

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

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

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

182
	caps := []model.Capability{model.CapabilityCompletion}
183
	if req.Suffix != "" {
184
		caps = append(caps, model.CapabilityInsert)
185
186
	}

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

196
197
	checkpointLoaded := time.Now()

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

209
	isMllama := checkMllamaModelFamily(m)
210
211
212
213
214
	if isMllama && len(req.Images) > 1 {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "this model only supports one image: more than one image sent"})
		return
	}

Michael Yang's avatar
Michael Yang committed
215
216
	images := make([]llm.ImageData, len(req.Images))
	for i := range req.Images {
217
		if isMllama && len(m.ProjectorPaths) > 0 {
218
			data, opts, err := mllama.Preprocess(bytes.NewReader(req.Images[i]))
219
220
221
222
223
			if err != nil {
				c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": "error processing image"})
				return
			}

224
225
226
227
228
229
			ar, ok := opts["aspectRatioIndex"].(int)
			if !ok {
				c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": "error processing image"})
				return
			}

230
231
232
233
234
235
236
			buf := new(bytes.Buffer)
			err = binary.Write(buf, binary.LittleEndian, data)
			if err != nil {
				c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": "error processing image"})
				return
			}

237
			images[i] = llm.ImageData{ID: i, Data: buf.Bytes(), AspectRatioID: ar}
238
239
240
		} else {
			images[i] = llm.ImageData{ID: i, Data: req.Images[i]}
		}
Michael Yang's avatar
Michael Yang committed
241
	}
Bruce MacDonald's avatar
Bruce MacDonald committed
242

Michael Yang's avatar
Michael Yang committed
243
244
	prompt := req.Prompt
	if !req.Raw {
Michael Yang's avatar
Michael Yang committed
245
		tmpl := m.Template
Michael Yang's avatar
Michael Yang committed
246
247
248
249
250
251
252
253
		if req.Template != "" {
			tmpl, err = template.Parse(req.Template)
			if err != nil {
				c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
				return
			}
		}

254
255
256
257
258
259
260
261
262
263
264
265
		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
266
267
268
269
			if req.Context == nil {
				msgs = append(msgs, m.Messages...)
			}

270
			for _, i := range images {
271
				imgPrompt := ""
272
				if isMllama {
273
					imgPrompt = "<|image|>"
274
				}
275
				msgs = append(msgs, api.Message{Role: "user", Content: fmt.Sprintf("[img-%d]"+imgPrompt, i.ID)})
276
277
278
279
280
			}

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

Michael Yang's avatar
Michael Yang committed
281
282
		var b bytes.Buffer
		if req.Context != nil {
283
			slog.Warn("the context field is deprecated and will be removed in a future version of Ollama")
284
			s, err := r.Detokenize(c.Request.Context(), req.Context)
Michael Yang's avatar
Michael Yang committed
285
286
287
288
			if err != nil {
				c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
				return
			}
289
			b.WriteString(s)
Michael Yang's avatar
Michael Yang committed
290
		}
291
292
293
294
295
296
297

		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
298
299
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
300
301
	ch := make(chan any)
	go func() {
302
303
		// TODO (jmorganca): avoid building the response twice both here and below
		var sb strings.Builder
Bruce MacDonald's avatar
Bruce MacDonald committed
304
		defer close(ch)
Michael Yang's avatar
Michael Yang committed
305
		if err := r.Completion(c.Request.Context(), llm.CompletionRequest{
Michael Yang's avatar
Michael Yang committed
306
307
			Prompt:  prompt,
			Images:  images,
308
			Format:  req.Format,
Michael Yang's avatar
Michael Yang committed
309
			Options: opts,
310
311
		}, func(cr llm.CompletionResponse) {
			res := api.GenerateResponse{
312
313
314
315
				Model:     req.Model,
				CreatedAt: time.Now().UTC(),
				Response:  cr.Content,
				Done:      cr.Done,
Bruce MacDonald's avatar
Bruce MacDonald committed
316
				Metrics: api.Metrics{
317
318
319
320
					PromptEvalCount:    cr.PromptEvalCount,
					PromptEvalDuration: cr.PromptEvalDuration,
					EvalCount:          cr.EvalCount,
					EvalDuration:       cr.EvalDuration,
Bruce MacDonald's avatar
Bruce MacDonald committed
321
				},
Bruce MacDonald's avatar
Bruce MacDonald committed
322
			}
323
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
Bruce MacDonald's avatar
Bruce MacDonald committed
351
		var sb strings.Builder
Michael Yang's avatar
Michael Yang committed
352
353
		for rr := range ch {
			switch t := rr.(type) {
354
			case api.GenerateResponse:
Michael Yang's avatar
Michael Yang committed
355
356
				sb.WriteString(t.Response)
				r = t
357
			case gin.H:
Michael Yang's avatar
Michael Yang committed
358
359
360
				msg, ok := t["error"].(string)
				if !ok {
					msg = "unexpected error format in response"
361
				}
Michael Yang's avatar
Michael Yang committed
362
363
364

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

Michael Yang's avatar
Michael Yang committed
371
372
		r.Response = sb.String()
		c.JSON(http.StatusOK, r)
Bruce MacDonald's avatar
Bruce MacDonald committed
373
374
375
376
377
378
		return
	}

	streamResponse(c, ch)
}

379
func (s *Server) EmbedHandler(c *gin.Context) {
380
	checkpointStart := time.Now()
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
	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:
414
415
416
417
		if req.Input != nil {
			c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "invalid input type"})
			return
		}
418
419
	}

420
421
422
423
424
425
	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
	}

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

432
433
	checkpointLoaded := time.Now()

434
435
436
437
438
	if len(input) == 0 {
		c.JSON(http.StatusOK, api.EmbedResponse{Model: req.Model, Embeddings: [][]float32{}})
		return
	}

439
	kvData, _, err := getModelData(m.ModelPath, false)
440
441
442
443
444
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

445
	var count int
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
	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
			}
		}

468
469
		count += len(tokens)

470
471
		input[i] = s
	}
472
473
474
475
476
477
478
479
480
481
482
483

	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
		})
484
485
	}

486
	if err := g.Wait(); err != nil {
487
		c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": strings.TrimSpace(err.Error())})
488
		return
489
490
491
	}

	resp := api.EmbedResponse{
492
		Model:           req.Model,
493
		Embeddings:      embeddings,
494
495
		TotalDuration:   time.Since(checkpointStart),
		LoadDuration:    checkpointLoaded.Sub(checkpointStart),
496
		PromptEvalCount: count,
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
	}
	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
518
func (s *Server) EmbeddingsHandler(c *gin.Context) {
Bruce MacDonald's avatar
Bruce MacDonald committed
519
	var req api.EmbeddingRequest
Michael Yang's avatar
Michael Yang committed
520
	if err := c.ShouldBindJSON(&req); errors.Is(err, io.EOF) {
Bruce MacDonald's avatar
Bruce MacDonald committed
521
522
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
523
	} else if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
524
525
526
527
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

528
529
530
531
532
533
	name := model.ParseName(req.Model)
	if !name.IsValid() {
		c.JSON(http.StatusBadRequest, gin.H{"error": "model is required"})
		return
	}

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

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

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

552
553
554
	var e []float64
	for _, v := range embedding {
		e = append(e, float64(v))
555
556
557
	}

	resp := api.EmbeddingResponse{
558
		Embedding: e,
559
560
	}
	c.JSON(http.StatusOK, resp)
Bruce MacDonald's avatar
Bruce MacDonald committed
561
562
}

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

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

581
582
	name, err = getExistingName(name)
	if err != nil {
583
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
584
585
586
		return
	}

587
588
589
	ch := make(chan any)
	go func() {
		defer close(ch)
590
591
		fn := func(r api.ProgressResponse) {
			ch <- r
592
		}
593

Michael Yang's avatar
Michael Yang committed
594
		regOpts := &registryOptions{
595
596
597
			Insecure: req.Insecure,
		}

598
599
600
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

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

606
607
608
609
610
	if req.Stream != nil && !*req.Stream {
		waitForStream(c, ch)
		return
	}

611
612
613
	streamResponse(c, ch)
}

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

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

636
637
638
	ch := make(chan any)
	go func() {
		defer close(ch)
639
640
		fn := func(r api.ProgressResponse) {
			ch <- r
641
		}
642

Michael Yang's avatar
Michael Yang committed
643
		regOpts := &registryOptions{
644
645
646
			Insecure: req.Insecure,
		}

Michael Yang's avatar
Michael Yang committed
647
648
649
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

650
651
652
653
654
655
656
		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
657
			ch <- gin.H{"error": err.Error()}
658
659
660
		}
	}()

661
662
663
664
665
	if req.Stream != nil && !*req.Stream {
		waitForStream(c, ch)
		return
	}

666
667
668
	streamResponse(c, ch)
}

669
670
671
672
// 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.
673
674
675
func getExistingName(n model.Name) (model.Name, error) {
	var zero model.Name
	existing, err := Manifests(true)
676
	if err != nil {
677
		return zero, err
678
	}
679
	var set model.Name // tracks parts already canonicalized
680
	for e := range existing {
681
682
683
684
685
686
687
688
689
690
691
		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
692
693
		}
	}
694
	return n, nil
695
696
}

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

707
708
709
	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))})
710
711
		return
	}
Michael Yang's avatar
Michael Yang committed
712

713
714
715
716
717
718
	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
	}

719
	m, err := ParseNamedManifest(n)
Michael Yang's avatar
Michael Yang committed
720
	if err != nil {
721
722
723
724
725
726
		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
727
728
729
		return
	}

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

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

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

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

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

	c.JSON(http.StatusOK, resp)
}

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

	m, err := GetModel(name.String())
Patrick Devine's avatar
Patrick Devine committed
789
790
791
792
	if err != nil {
		return nil, err
	}

Patrick Devine's avatar
Patrick Devine committed
793
	modelDetails := api.ModelDetails{
794
795
796
797
798
799
		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
800
801
	}

802
	if req.System != "" {
803
		m.System = req.System
804
805
	}

Michael Yang's avatar
Michael Yang committed
806
807
808
	msgs := make([]api.Message, len(m.Messages))
	for i, msg := range m.Messages {
		msgs[i] = api.Message{Role: msg.Role, Content: msg.Content}
809
810
	}

811
	manifest, err := ParseNamedManifest(name)
812
813
814
815
	if err != nil {
		return nil, err
	}

Patrick Devine's avatar
Patrick Devine committed
816
	resp := &api.ShowResponse{
817
818
819
820
821
822
823
		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
824
825
826
827
	}

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

840
841
	for k, v := range req.Options {
		if _, ok := req.Options[k]; ok {
842
			m.Options[k] = v
843
844
845
		}
	}

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

853
	kvData, tensors, err := getModelData(m.ModelPath, req.Verbose)
854
855
856
	if err != nil {
		return nil, err
	}
857

858
859
860
861
	delete(kvData, "general.name")
	delete(kvData, "tokenizer.chat_template")
	resp.ModelInfo = kvData

862
863
864
865
866
867
	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

868
	if len(m.ProjectorPaths) > 0 {
869
		projectorData, _, err := getModelData(m.ProjectorPaths[0], req.Verbose)
870
871
872
873
874
875
		if err != nil {
			return nil, err
		}
		resp.ProjectorInfo = projectorData
	}

Patrick Devine's avatar
Patrick Devine committed
876
877
878
	return resp, nil
}

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

889
	kv := data.KV()
890
891
892
893
894
895
896
897
898

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

899
	return kv, data.Tensors(), nil
900
901
}

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

909
	models := []api.ListModelResponse{}
910
911
	for n, m := range ms {
		var cf ConfigV2
912
913
914
915
916
917
918
919
920
921
922
923
924

		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
925
		}
Michael Yang's avatar
Michael Yang committed
926

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

944
	slices.SortStableFunc(models, func(i, j api.ListModelResponse) int {
945
946
947
948
		// most recently modified first
		return cmp.Compare(j.ModifiedAt.Unix(), i.ModifiedAt.Unix())
	})

Michael Yang's avatar
Michael Yang committed
949
	c.JSON(http.StatusOK, api.ListResponse{Models: models})
Patrick Devine's avatar
Patrick Devine committed
950
951
}

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

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

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

Michael Yang's avatar
Michael Yang committed
984
985
986
987
988
	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
989
990
}

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

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1006
func (s *Server) CreateBlobHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
1007
1008
	if ib, ok := intermediateBlobs[c.Param("digest")]; ok {
		p, err := GetBlobsPath(ib)
1009
1010
1011
1012
1013
1014
		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
1015
1016
			slog.Info("evicting intermediate blob which no longer exists", "digest", ib)
			delete(intermediateBlobs, c.Param("digest"))
1017
1018
1019
1020
1021
1022
1023
1024
1025
		} else if err != nil {
			c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
			return
		} else {
			c.Status(http.StatusOK)
			return
		}
	}

1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
	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
	}

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

1050
1051
	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
1052
1053
1054
		return
	}

Michael Yang's avatar
Michael Yang committed
1055
	c.Status(http.StatusCreated)
Michael Yang's avatar
Michael Yang committed
1056
1057
}

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

1079
func allowedHost(host string) bool {
1080
1081
	host = strings.ToLower(host)

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1082
	if host == "" || host == "localhost" {
1083
1084
1085
		return true
	}

1086
	if hostname, err := os.Hostname(); err == nil && host == strings.ToLower(hostname) {
1087
1088
1089
		return true
	}

Michael Yang's avatar
lint  
Michael Yang committed
1090
	tlds := []string{
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1091
1092
1093
		"localhost",
		"local",
		"internal",
1094
	}
1095

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

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1103
	return false
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1104
}
1105

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1106
1107
1108
func allowedHostsMiddleware(addr net.Addr) gin.HandlerFunc {
	return func(c *gin.Context) {
		if addr == nil {
1109
1110
1111
1112
			c.Next()
			return
		}

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

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

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

1130
		if allowedHost(host) {
Michael Yang's avatar
lint  
Michael Yang committed
1131
			if c.Request.Method == http.MethodOptions {
1132
1133
1134
1135
				c.AbortWithStatus(http.StatusNoContent)
				return
			}

1136
1137
1138
1139
1140
1141
			c.Next()
			return
		}

		c.AbortWithStatus(http.StatusForbidden)
	}
1142
}
1143

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

		// OpenAI compatibility headers
1156
1157
1158
1159
1160
		"OpenAI-Beta",
		"x-stainless-arch",
		"x-stainless-async",
		"x-stainless-custom-poll-interval",
		"x-stainless-helper-method",
1161
1162
		"x-stainless-lang",
		"x-stainless-os",
1163
1164
		"x-stainless-package-version",
		"x-stainless-poll-helper",
1165
1166
1167
1168
1169
1170
		"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
1171

Bruce MacDonald's avatar
Bruce MacDonald committed
1172
	r := gin.Default()
1173
	r.HandleMethodNotAllowed = true
1174
	r.Use(
1175
		cors.New(corsConfig),
1176
		allowedHostsMiddleware(s.addr),
1177
	)
Bruce MacDonald's avatar
Bruce MacDonald committed
1178

1179
1180
1181
1182
1183
1184
	// 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}) })

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

	// Create
	r.POST("/api/create", s.CreateHandler)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1195
1196
	r.POST("/api/blobs/:digest", s.CreateBlobHandler)
	r.HEAD("/api/blobs/:digest", s.HeadBlobHandler)
1197
1198
1199
	r.POST("/api/copy", s.CopyHandler)

	// Inference
1200
	r.GET("/api/ps", s.PsHandler)
1201
1202
1203
1204
	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
1205

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

1213
1214
1215
1216
1217
1218
	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,
1219

1220
1221
1222
			Prune: PruneLayers,
		}
		return rs, nil
1223
1224
	}

1225
	return r, nil
1226
1227
1228
}

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

1232
1233
1234
1235
1236
1237
1238
1239
	blobsDir, err := GetBlobsPath("")
	if err != nil {
		return err
	}
	if err := fixBlobs(blobsDir); err != nil {
		return err
	}

Michael Yang's avatar
bool  
Michael Yang committed
1240
	if !envconfig.NoPrune() {
1241
1242
1243
1244
1245
1246
1247
		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
			}
1248

1249
1250
1251
1252
			manifestsPath, err := GetManifestPath()
			if err != nil {
				return err
			}
1253

1254
1255
1256
			if err := PruneDirectory(manifestsPath); err != nil {
				return err
			}
1257
1258
1259
		}
	}

1260
1261
	s := &Server{addr: ln.Addr()}

1262
1263
1264
1265
1266
1267
1268
	var rc *ollama.Registry
	if useClient2 {
		var err error
		rc, err = ollama.DefaultRegistry()
		if err != nil {
			return err
		}
1269
1270
	}

1271
	h, err := s.GenerateRoutes(rc)
1272
1273
1274
	if err != nil {
		return err
	}
1275

1276
1277
	http.Handle("/", h)

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1278
	ctx, done := context.WithCancel(context.Background())
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1279
1280
	schedCtx, schedDone := context.WithCancel(ctx)
	sched := InitScheduler(schedCtx)
1281
	s.sched = sched
1282

1283
	slog.Info(fmt.Sprintf("Listening on %s (version %s)", ln.Addr(), version.Version))
1284
	srvr := &http.Server{
1285
1286
1287
1288
1289
1290
1291
1292
1293
		// 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
1294
1295
	}

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

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1307
	s.sched.Run(schedCtx)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1308

1309
1310
1311
1312
	// 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
1313
1314
	// 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
1315
	gpus := discover.GetGPUInfo()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1316
	gpus.LogDetails()
1317

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1318
1319
1320
1321
1322
1323
1324
	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()
1325
	return nil
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1326
}
Michael Yang's avatar
Michael Yang committed
1327

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

	c.JSON(http.StatusOK, latest)
1353
1354
}

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

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

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

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

1380
func (s *Server) PsHandler(c *gin.Context) {
1381
	models := []api.ProcessModelResponse{}
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392

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

1393
		mr := api.ProcessModelResponse{
1394
1395
1396
1397
1398
1399
1400
1401
			Model:     model.ShortName,
			Name:      model.ShortName,
			Size:      int64(v.estimatedTotal),
			SizeVRAM:  int64(v.estimatedVRAM),
			Digest:    model.Digest,
			Details:   modelDetails,
			ExpiresAt: v.expiresAt,
		}
1402
1403
1404
1405
1406
1407
1408
1409
		// 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)
		}

1410
1411
1412
		models = append(models, mr)
	}

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

1418
	c.JSON(http.StatusOK, api.ProcessResponse{Models: models})
1419
1420
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1421
func (s *Server) ChatHandler(c *gin.Context) {
1422
1423
	checkpointStart := time.Now()

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

Patrick Devine's avatar
Patrick Devine committed
1433
1434
1435
1436
1437
1438
1439
	// 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)})
1440
			case err.Error() == errtypes.InvalidModelNameErrMsg:
Patrick Devine's avatar
Patrick Devine committed
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
				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
	}

1459
	caps := []model.Capability{model.CapabilityCompletion}
1460
	if len(req.Tools) > 0 {
1461
		caps = append(caps, model.CapabilityTools)
Michael Yang's avatar
tools  
Michael Yang committed
1462
1463
	}

1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
	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
1476
1477
	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
1478
		return
Michael Yang's avatar
Michael Yang committed
1479
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
1480
		handleScheduleError(c, req.Model, err)
Bruce MacDonald's avatar
Bruce MacDonald committed
1481
1482
		return
	}
Michael Yang's avatar
Michael Yang committed
1483

1484
1485
	checkpointLoaded := time.Now()

Michael Yang's avatar
Michael Yang committed
1486
1487
	if len(req.Messages) == 0 {
		c.JSON(http.StatusOK, api.ChatResponse{
1488
			Model:      req.Model,
Michael Yang's avatar
Michael Yang committed
1489
1490
			CreatedAt:  time.Now().UTC(),
			Message:    api.Message{Role: "assistant"},
1491
1492
			Done:       true,
			DoneReason: "load",
Michael Yang's avatar
Michael Yang committed
1493
		})
1494
1495
1496
		return
	}

Michael Yang's avatar
Michael Yang committed
1497
	msgs := append(m.Messages, req.Messages...)
1498
	if req.Messages[0].Role != "system" && m.System != "" {
Michael Yang's avatar
Michael Yang committed
1499
		msgs = append([]api.Message{{Role: "system", Content: m.System}}, msgs...)
1500
	}
1501
	msgs = filterThinkTags(msgs, m)
1502

Michael Yang's avatar
Michael Yang committed
1503
	prompt, images, err := chatPrompt(c.Request.Context(), m, r.Tokenize, opts, msgs, req.Tools)
Michael Yang's avatar
Michael Yang committed
1504
	if err != nil {
1505
		slog.Error("chat prompt error", "error", err)
Michael Yang's avatar
Michael Yang committed
1506
1507
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
1508
1509
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
1510
1511
1512
	ch := make(chan any)
	go func() {
		defer close(ch)
1513
		var sb strings.Builder
1514
		var toolCallIndex int = 0
Michael Yang's avatar
Michael Yang committed
1515
		if err := r.Completion(c.Request.Context(), llm.CompletionRequest{
Michael Yang's avatar
Michael Yang committed
1516
1517
1518
			Prompt:  prompt,
			Images:  images,
			Format:  req.Format,
Michael Yang's avatar
Michael Yang committed
1519
			Options: opts,
Michael Yang's avatar
Michael Yang committed
1520
		}, func(r llm.CompletionResponse) {
1521
			res := api.ChatResponse{
1522
1523
1524
1525
				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
1526
1527
1528
1529
1530
1531
1532
				Metrics: api.Metrics{
					PromptEvalCount:    r.PromptEvalCount,
					PromptEvalDuration: r.PromptEvalDuration,
					EvalCount:          r.EvalCount,
					EvalDuration:       r.EvalDuration,
				},
			}
1533
1534

			if r.Done {
1535
				res.DoneReason = r.DoneReason.String()
1536
1537
1538
1539
				res.TotalDuration = time.Since(checkpointStart)
				res.LoadDuration = checkpointLoaded.Sub(checkpointStart)
			}

1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
			// TODO: tool call checking and filtering should be moved outside of this callback once streaming
			// however this was a simple change for now without reworking streaming logic of this (and other)
			// handlers
			if req.Stream != nil && !*req.Stream || len(req.Tools) == 0 {
				ch <- res
				return
			}

			// Streaming tool calls:
			// If tools are recognized, use a flag to track the sending of a tool downstream
			// This ensures that content is cleared from the message on the last chunk sent
			sb.WriteString(r.Content)
			if toolCalls, ok := m.parseToolCalls(sb.String()); ok {
				res.Message.ToolCalls = toolCalls
1554
1555
1556
1557
				for i := range toolCalls {
					toolCalls[i].Function.Index = toolCallIndex
					toolCallIndex++
				}
1558
1559
1560
1561
1562
1563
1564
1565
				res.Message.Content = ""
				sb.Reset()
				ch <- res
				return
			}

			if r.Done {
				// Send any remaining content if no tool calls were detected
1566
				if toolCallIndex == 0 {
1567
1568
1569
1570
					res.Message.Content = sb.String()
				}
				ch <- res
			}
Michael Yang's avatar
Michael Yang committed
1571
		}); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1572
1573
1574
1575
1576
			ch <- gin.H{"error": err.Error()}
		}
	}()

	if req.Stream != nil && !*req.Stream {
Michael Yang's avatar
tools  
Michael Yang committed
1577
		var resp api.ChatResponse
Bruce MacDonald's avatar
Bruce MacDonald committed
1578
		var sb strings.Builder
Michael Yang's avatar
Michael Yang committed
1579
1580
		for rr := range ch {
			switch t := rr.(type) {
1581
			case api.ChatResponse:
Michael Yang's avatar
Michael Yang committed
1582
				sb.WriteString(t.Message.Content)
Michael Yang's avatar
tools  
Michael Yang committed
1583
				resp = t
1584
			case gin.H:
Michael Yang's avatar
Michael Yang committed
1585
1586
1587
				msg, ok := t["error"].(string)
				if !ok {
					msg = "unexpected error format in response"
1588
				}
Michael Yang's avatar
Michael Yang committed
1589
1590
1591

				c.JSON(http.StatusInternalServerError, gin.H{"error": msg})
				return
1592
			default:
Michael Yang's avatar
Michael Yang committed
1593
				c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected response"})
1594
				return
Bruce MacDonald's avatar
Bruce MacDonald committed
1595
1596
			}
		}
1597

Michael Yang's avatar
tools  
Michael Yang committed
1598
		resp.Message.Content = sb.String()
1599
1600
1601
1602
1603
1604

		if len(req.Tools) > 0 {
			if toolCalls, ok := m.parseToolCalls(sb.String()); ok {
				resp.Message.ToolCalls = toolCalls
				resp.Message.Content = ""
			}
Michael Yang's avatar
tools  
Michael Yang committed
1605
1606
1607
		}

		c.JSON(http.StatusOK, resp)
Bruce MacDonald's avatar
Bruce MacDonald committed
1608
1609
1610
1611
1612
		return
	}

	streamResponse(c, ch)
}
1613

Michael Yang's avatar
Michael Yang committed
1614
func handleScheduleError(c *gin.Context, name string, err error) {
Michael Yang's avatar
Michael Yang committed
1615
	switch {
1616
	case errors.Is(err, errCapabilities), errors.Is(err, errRequired):
Michael Yang's avatar
Michael Yang committed
1617
		c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Michael Yang's avatar
Michael Yang committed
1618
	case errors.Is(err, context.Canceled):
1619
		c.JSON(499, gin.H{"error": "request canceled"})
Michael Yang's avatar
Michael Yang committed
1620
	case errors.Is(err, ErrMaxQueue):
1621
		c.JSON(http.StatusServiceUnavailable, gin.H{"error": err.Error()})
Michael Yang's avatar
Michael Yang committed
1622
1623
	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
1624
1625
	default:
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
1626
1627
	}
}
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647

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
}