routes.go 41.3 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"
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"
Michael Yang's avatar
Michael Yang committed
20
	"path/filepath"
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/sync/errgroup"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
29

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

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

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

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

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

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

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

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

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

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

Michael Yang's avatar
Michael Yang committed
117
	return runner.llama, model, &opts, nil
Michael Yang's avatar
Michael Yang committed
118
119
120
}

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

131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
	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
	}

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

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

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

179
	caps := []model.Capability{model.CapabilityCompletion}
180
	if req.Suffix != "" {
181
		caps = append(caps, model.CapabilityInsert)
182
183
	}

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

193
194
	checkpointLoaded := time.Now()

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

206
	isMllama := checkMllamaModelFamily(m)
207
208
209
210
211
	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
212
213
	images := make([]llm.ImageData, len(req.Images))
	for i := range req.Images {
214
		if isMllama && len(m.ProjectorPaths) > 0 {
215
			data, opts, err := mllama.Preprocess(bytes.NewReader(req.Images[i]))
216
217
218
219
220
			if err != nil {
				c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": "error processing image"})
				return
			}

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

227
228
229
230
231
232
233
			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
			}

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

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

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

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

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

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

		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
295
296
	}

297
	slog.Debug("generate request", "images", len(images), "prompt", prompt)
298

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

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

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

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

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

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

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

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

	streamResponse(c, ch)
}

378
func (s *Server) EmbedHandler(c *gin.Context) {
379
	checkpointStart := time.Now()
380
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
	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:
413
414
415
416
		if req.Input != nil {
			c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "invalid input type"})
			return
		}
417
418
	}

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

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

431
432
	checkpointLoaded := time.Now()

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

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

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

467
468
		count += len(tokens)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

610
611
612
	streamResponse(c, ch)
}

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

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

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

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

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

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

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

665
666
667
	streamResponse(c, ch)
}

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

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

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

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

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

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

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

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

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

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

	c.JSON(http.StatusOK, resp)
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1177
1178
1179
1180
1181
1182
	// 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}) })

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

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

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

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

1211
1212
1213
1214
1215
1216
	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,
1217

1218
1219
1220
			Prune: PruneLayers,
		}
		return rs, nil
1221
1222
	}

1223
	return r, nil
1224
1225
1226
}

func Serve(ln net.Listener) error {
Michael Yang's avatar
Michael Yang committed
1227
	level := slog.LevelInfo
Michael Yang's avatar
Michael Yang committed
1228
	if envconfig.Debug() {
Michael Yang's avatar
Michael Yang committed
1229
		level = slog.LevelDebug
1230
	}
Michael Yang's avatar
Michael Yang committed
1231

1232
	slog.Info("server config", "env", envconfig.Values())
Michael Yang's avatar
Michael Yang committed
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
	handler := slog.NewTextHandler(os.Stderr, &slog.HandlerOptions{
		Level:     level,
		AddSource: true,
		ReplaceAttr: func(_ []string, attr slog.Attr) slog.Attr {
			if attr.Key == slog.SourceKey {
				source := attr.Value.Any().(*slog.Source)
				source.File = filepath.Base(source.File)
			}

			return attr
		},
	})

	slog.SetDefault(slog.New(handler))

1248
1249
1250
1251
1252
1253
1254
1255
	blobsDir, err := GetBlobsPath("")
	if err != nil {
		return err
	}
	if err := fixBlobs(blobsDir); err != nil {
		return err
	}

Michael Yang's avatar
bool  
Michael Yang committed
1256
	if !envconfig.NoPrune() {
1257
1258
1259
1260
1261
1262
1263
		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
			}
1264

1265
1266
1267
1268
			manifestsPath, err := GetManifestPath()
			if err != nil {
				return err
			}
1269

1270
1271
1272
			if err := PruneDirectory(manifestsPath); err != nil {
				return err
			}
1273
1274
1275
		}
	}

1276
1277
	s := &Server{addr: ln.Addr()}

1278
1279
1280
1281
1282
1283
1284
	var rc *ollama.Registry
	if useClient2 {
		var err error
		rc, err = ollama.DefaultRegistry()
		if err != nil {
			return err
		}
1285
1286
	}

1287
	h, err := s.GenerateRoutes(rc)
1288
1289
1290
	if err != nil {
		return err
	}
1291

1292
1293
	http.Handle("/", h)

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1294
	ctx, done := context.WithCancel(context.Background())
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1295
1296
	schedCtx, schedDone := context.WithCancel(ctx)
	sched := InitScheduler(schedCtx)
1297
	s.sched = sched
1298

1299
	slog.Info(fmt.Sprintf("Listening on %s (version %s)", ln.Addr(), version.Version))
1300
	srvr := &http.Server{
1301
1302
1303
1304
1305
1306
1307
1308
1309
		// 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
1310
1311
	}

1312
1313
	// listen for a ctrl+c and stop any loaded llm
	signals := make(chan os.Signal, 1)
1314
	signal.Notify(signals, syscall.SIGINT, syscall.SIGTERM)
1315
1316
	go func() {
		<-signals
1317
		srvr.Close()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1318
		schedDone()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1319
		sched.unloadAllRunners()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1320
		done()
1321
1322
	}()

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1323
	s.sched.Run(schedCtx)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1324
1325
1326

	// 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
1327
	gpus := discover.GetGPUInfo()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1328
	gpus.LogDetails()
1329

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1330
1331
1332
1333
1334
1335
1336
	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()
1337
	return nil
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1338
}
Michael Yang's avatar
Michael Yang committed
1339

1340
func waitForStream(c *gin.Context, ch chan any) {
1341
1342
1343
1344
1345
1346
1347
1348
1349
	c.Header("Content-Type", "application/json")
	for resp := range ch {
		switch r := resp.(type) {
		case api.ProgressResponse:
			if r.Status == "success" {
				c.JSON(http.StatusOK, r)
				return
			}
		case gin.H:
Josh's avatar
Josh committed
1350
1351
1352
1353
			status, ok := r["status"].(int)
			if !ok {
				status = http.StatusInternalServerError
			}
1354
			if errorMsg, ok := r["error"].(string); ok {
Josh's avatar
Josh committed
1355
				c.JSON(status, gin.H{"error": errorMsg})
1356
1357
				return
			} else {
Josh's avatar
Josh committed
1358
				c.JSON(status, gin.H{"error": "unexpected error format in progress response"})
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
				return
			}
		default:
			c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected progress response"})
			return
		}
	}
	c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected end of progress response"})
}

Michael Yang's avatar
Michael Yang committed
1369
func streamResponse(c *gin.Context, ch chan any) {
1370
	c.Header("Content-Type", "application/x-ndjson")
Michael Yang's avatar
Michael Yang committed
1371
1372
1373
1374
1375
1376
1377
1378
	c.Stream(func(w io.Writer) bool {
		val, ok := <-ch
		if !ok {
			return false
		}

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

1383
		// Delineate chunks with new-line delimiter
Michael Yang's avatar
Michael Yang committed
1384
1385
		bts = append(bts, '\n')
		if _, err := w.Write(bts); err != nil {
1386
			slog.Info(fmt.Sprintf("streamResponse: w.Write failed with %s", err))
Michael Yang's avatar
Michael Yang committed
1387
1388
1389
1390
1391
1392
			return false
		}

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

1394
func (s *Server) PsHandler(c *gin.Context) {
1395
	models := []api.ProcessModelResponse{}
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406

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

1407
		mr := api.ProcessModelResponse{
1408
1409
1410
1411
1412
1413
1414
1415
			Model:     model.ShortName,
			Name:      model.ShortName,
			Size:      int64(v.estimatedTotal),
			SizeVRAM:  int64(v.estimatedVRAM),
			Digest:    model.Digest,
			Details:   modelDetails,
			ExpiresAt: v.expiresAt,
		}
1416
1417
1418
1419
1420
1421
1422
1423
		// 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)
		}

1424
1425
1426
		models = append(models, mr)
	}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1427
1428
1429
1430
1431
	slices.SortStableFunc(models, func(i, j api.ProcessModelResponse) int {
		// longest duration remaining listed first
		return cmp.Compare(j.ExpiresAt.Unix(), i.ExpiresAt.Unix())
	})

1432
	c.JSON(http.StatusOK, api.ProcessResponse{Models: models})
1433
1434
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1435
func (s *Server) ChatHandler(c *gin.Context) {
1436
1437
	checkpointStart := time.Now()

Bruce MacDonald's avatar
Bruce MacDonald committed
1438
	var req api.ChatRequest
Michael Yang's avatar
Michael Yang committed
1439
	if err := c.ShouldBindJSON(&req); errors.Is(err, io.EOF) {
Bruce MacDonald's avatar
Bruce MacDonald committed
1440
1441
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
1442
	} else if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1443
1444
1445
1446
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

Patrick Devine's avatar
Patrick Devine committed
1447
1448
1449
1450
1451
1452
1453
	// 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)})
1454
			case err.Error() == errtypes.InvalidModelNameErrMsg:
Patrick Devine's avatar
Patrick Devine committed
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
				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
	}

1473
	caps := []model.Capability{model.CapabilityCompletion}
1474
	if len(req.Tools) > 0 {
1475
		caps = append(caps, model.CapabilityTools)
Michael Yang's avatar
tools  
Michael Yang committed
1476
1477
	}

1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
	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
1490
1491
	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
1492
		return
Michael Yang's avatar
Michael Yang committed
1493
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
1494
		handleScheduleError(c, req.Model, err)
Bruce MacDonald's avatar
Bruce MacDonald committed
1495
1496
		return
	}
Michael Yang's avatar
Michael Yang committed
1497

1498
1499
	checkpointLoaded := time.Now()

Michael Yang's avatar
Michael Yang committed
1500
1501
	if len(req.Messages) == 0 {
		c.JSON(http.StatusOK, api.ChatResponse{
1502
			Model:      req.Model,
Michael Yang's avatar
Michael Yang committed
1503
1504
			CreatedAt:  time.Now().UTC(),
			Message:    api.Message{Role: "assistant"},
1505
1506
			Done:       true,
			DoneReason: "load",
Michael Yang's avatar
Michael Yang committed
1507
		})
1508
1509
1510
		return
	}

Michael Yang's avatar
Michael Yang committed
1511
	msgs := append(m.Messages, req.Messages...)
1512
	if req.Messages[0].Role != "system" && m.System != "" {
Michael Yang's avatar
Michael Yang committed
1513
		msgs = append([]api.Message{{Role: "system", Content: m.System}}, msgs...)
1514
1515
	}

Michael Yang's avatar
Michael Yang committed
1516
	prompt, images, err := chatPrompt(c.Request.Context(), m, r.Tokenize, opts, msgs, req.Tools)
Michael Yang's avatar
Michael Yang committed
1517
	if err != nil {
1518
		slog.Error("chat prompt error", "error", err)
Michael Yang's avatar
Michael Yang committed
1519
1520
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
1521
1522
	}

Michael Yang's avatar
Michael Yang committed
1523
	slog.Debug("chat request", "images", len(images), "prompt", prompt)
1524

Bruce MacDonald's avatar
Bruce MacDonald committed
1525
1526
1527
	ch := make(chan any)
	go func() {
		defer close(ch)
1528
		var sb strings.Builder
1529
		var toolCallIndex int = 0
Michael Yang's avatar
Michael Yang committed
1530
		if err := r.Completion(c.Request.Context(), llm.CompletionRequest{
Michael Yang's avatar
Michael Yang committed
1531
1532
1533
			Prompt:  prompt,
			Images:  images,
			Format:  req.Format,
Michael Yang's avatar
Michael Yang committed
1534
			Options: opts,
Michael Yang's avatar
Michael Yang committed
1535
		}, func(r llm.CompletionResponse) {
1536
			res := api.ChatResponse{
1537
1538
1539
1540
				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
1541
1542
1543
1544
1545
1546
1547
				Metrics: api.Metrics{
					PromptEvalCount:    r.PromptEvalCount,
					PromptEvalDuration: r.PromptEvalDuration,
					EvalCount:          r.EvalCount,
					EvalDuration:       r.EvalDuration,
				},
			}
1548
1549

			if r.Done {
1550
				res.DoneReason = r.DoneReason.String()
1551
1552
1553
1554
				res.TotalDuration = time.Since(checkpointStart)
				res.LoadDuration = checkpointLoaded.Sub(checkpointStart)
			}

1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
			// 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
1569
1570
1571
1572
				for i := range toolCalls {
					toolCalls[i].Function.Index = toolCallIndex
					toolCallIndex++
				}
1573
1574
1575
1576
1577
1578
1579
1580
				res.Message.Content = ""
				sb.Reset()
				ch <- res
				return
			}

			if r.Done {
				// Send any remaining content if no tool calls were detected
1581
				if toolCallIndex == 0 {
1582
1583
1584
1585
					res.Message.Content = sb.String()
				}
				ch <- res
			}
Michael Yang's avatar
Michael Yang committed
1586
		}); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1587
1588
1589
1590
1591
			ch <- gin.H{"error": err.Error()}
		}
	}()

	if req.Stream != nil && !*req.Stream {
Michael Yang's avatar
tools  
Michael Yang committed
1592
		var resp api.ChatResponse
Bruce MacDonald's avatar
Bruce MacDonald committed
1593
		var sb strings.Builder
Michael Yang's avatar
Michael Yang committed
1594
1595
		for rr := range ch {
			switch t := rr.(type) {
1596
			case api.ChatResponse:
Michael Yang's avatar
Michael Yang committed
1597
				sb.WriteString(t.Message.Content)
Michael Yang's avatar
tools  
Michael Yang committed
1598
				resp = t
1599
			case gin.H:
Michael Yang's avatar
Michael Yang committed
1600
1601
1602
				msg, ok := t["error"].(string)
				if !ok {
					msg = "unexpected error format in response"
1603
				}
Michael Yang's avatar
Michael Yang committed
1604
1605
1606

				c.JSON(http.StatusInternalServerError, gin.H{"error": msg})
				return
1607
			default:
Michael Yang's avatar
Michael Yang committed
1608
				c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected response"})
1609
				return
Bruce MacDonald's avatar
Bruce MacDonald committed
1610
1611
			}
		}
1612

Michael Yang's avatar
tools  
Michael Yang committed
1613
		resp.Message.Content = sb.String()
1614
1615
1616
1617
1618
1619

		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
1620
1621
1622
		}

		c.JSON(http.StatusOK, resp)
Bruce MacDonald's avatar
Bruce MacDonald committed
1623
1624
1625
1626
1627
		return
	}

	streamResponse(c, ch)
}
1628

Michael Yang's avatar
Michael Yang committed
1629
func handleScheduleError(c *gin.Context, name string, err error) {
Michael Yang's avatar
Michael Yang committed
1630
	switch {
1631
	case errors.Is(err, errCapabilities), errors.Is(err, errRequired):
Michael Yang's avatar
Michael Yang committed
1632
		c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Michael Yang's avatar
Michael Yang committed
1633
	case errors.Is(err, context.Canceled):
1634
		c.JSON(499, gin.H{"error": "request canceled"})
Michael Yang's avatar
Michael Yang committed
1635
	case errors.Is(err, ErrMaxQueue):
1636
		c.JSON(http.StatusServiceUnavailable, gin.H{"error": err.Error()})
Michael Yang's avatar
Michael Yang committed
1637
1638
	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
1639
1640
	default:
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
1641
1642
	}
}