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

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

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

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

Michael Yang's avatar
Michael Yang committed
40
41
var mode string = gin.DebugMode

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

Michael Yang's avatar
Michael Yang committed
47
48
49
50
51
52
53
54
55
56
57
58
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
59
60
61
62
var (
	errRequired    = errors.New("is required")
	errBadTemplate = errors.New("template error")
)
Michael Yang's avatar
Michael Yang committed
63

64
65
66
67
68
69
70
71
72
73
74
func modelOptions(model *Model, requestOpts map[string]interface{}) (api.Options, error) {
	opts := api.DefaultOptions()
	if err := opts.FromMap(model.Options); err != nil {
		return api.Options{}, err
	}

	if err := opts.FromMap(requestOpts); err != nil {
		return api.Options{}, err
	}

	return opts, nil
Bruce MacDonald's avatar
Bruce MacDonald committed
75
76
}

Michael Yang's avatar
Michael Yang committed
77
78
79
// 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.
func (s *Server) scheduleRunner(ctx context.Context, name string, caps []Capability, requestOpts map[string]any, keepAlive *api.Duration) (llm.LlamaServer, *Model, *api.Options, error) {
Michael Yang's avatar
Michael Yang committed
80
	if name == "" {
Michael Yang's avatar
Michael Yang committed
81
		return nil, nil, nil, fmt.Errorf("model %w", errRequired)
Bruce MacDonald's avatar
Bruce MacDonald committed
82
83
	}

Michael Yang's avatar
Michael Yang committed
84
	model, err := GetModel(name)
Bruce MacDonald's avatar
Bruce MacDonald committed
85
	if err != nil {
Michael Yang's avatar
Michael Yang committed
86
		return nil, nil, nil, err
87
88
	}

Michael Yang's avatar
Michael Yang committed
89
	if err := model.CheckCapabilities(caps...); err != nil {
Michael Yang's avatar
Michael Yang committed
90
		return nil, nil, nil, fmt.Errorf("%s %w", name, err)
91
92
	}

Michael Yang's avatar
Michael Yang committed
93
	opts, err := modelOptions(model, requestOpts)
94
	if err != nil {
Michael Yang's avatar
Michael Yang committed
95
		return nil, nil, nil, err
96
97
	}

Michael Yang's avatar
Michael Yang committed
98
	runnerCh, errCh := s.sched.GetRunner(ctx, model, opts, keepAlive)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
99
100
	var runner *runnerRef
	select {
Michael Yang's avatar
Michael Yang committed
101
102
	case runner = <-runnerCh:
	case err = <-errCh:
Michael Yang's avatar
Michael Yang committed
103
		return nil, nil, nil, err
Bruce MacDonald's avatar
Bruce MacDonald committed
104
105
	}

Michael Yang's avatar
Michael Yang committed
106
	return runner.llama, model, &opts, nil
Michael Yang's avatar
Michael Yang committed
107
108
109
}

func (s *Server) GenerateHandler(c *gin.Context) {
110
	checkpointStart := time.Now()
Michael Yang's avatar
Michael Yang committed
111
112
113
114
115
116
	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
117
118
119
		return
	}

Patrick Devine's avatar
Patrick Devine committed
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
	// expire the runner
	if req.Prompt == "" && 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)})
			case err.Error() == "invalid model name":
				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.GenerateResponse{
			Model:      req.Model,
			CreatedAt:  time.Now().UTC(),
			Response:   "",
			Done:       true,
			DoneReason: "unload",
		})
		return
	}

Michael Yang's avatar
Michael Yang committed
146
147
148
149
150
	if req.Format != "" && req.Format != "json" {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "format must be empty or \"json\""})
		return
	} else if req.Raw && (req.Template != "" || req.System != "" || len(req.Context) > 0) {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "raw mode does not support template, system, or context"})
Michael Yang's avatar
Michael Yang committed
151
152
153
		return
	}

Michael Yang's avatar
Michael Yang committed
154
	caps := []Capability{CapabilityCompletion}
155
156
157
158
	if req.Suffix != "" {
		caps = append(caps, CapabilityInsert)
	}

Michael Yang's avatar
Michael Yang committed
159
	r, m, opts, err := s.scheduleRunner(c.Request.Context(), req.Model, caps, req.Options, req.KeepAlive)
Michael Yang's avatar
Michael Yang committed
160
161
162
163
	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
164
165
166
167
		handleScheduleError(c, req.Model, err)
		return
	}

168
169
	checkpointLoaded := time.Now()

Michael Yang's avatar
Michael Yang committed
170
171
172
173
174
175
176
	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
177
178
		return
	}
Bruce MacDonald's avatar
Bruce MacDonald committed
179

Michael Yang's avatar
Michael Yang committed
180
181
182
183
	images := make([]llm.ImageData, len(req.Images))
	for i := range req.Images {
		images[i] = llm.ImageData{ID: i, Data: req.Images[i]}
	}
Bruce MacDonald's avatar
Bruce MacDonald committed
184

Michael Yang's avatar
Michael Yang committed
185
186
	prompt := req.Prompt
	if !req.Raw {
Michael Yang's avatar
Michael Yang committed
187
		tmpl := m.Template
Michael Yang's avatar
Michael Yang committed
188
189
190
191
192
193
194
195
		if req.Template != "" {
			tmpl, err = template.Parse(req.Template)
			if err != nil {
				c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
				return
			}
		}

196
197
198
199
200
201
202
203
204
205
206
207
		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
208
209
210
211
			if req.Context == nil {
				msgs = append(msgs, m.Messages...)
			}

212
213
214
215
216
217
218
			for _, i := range images {
				msgs = append(msgs, api.Message{Role: "user", Content: fmt.Sprintf("[img-%d]", i.ID)})
			}

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

Michael Yang's avatar
Michael Yang committed
219
220
		var b bytes.Buffer
		if req.Context != nil {
221
			s, err := r.Detokenize(c.Request.Context(), req.Context)
Michael Yang's avatar
Michael Yang committed
222
223
224
225
			if err != nil {
				c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
				return
			}
226
			b.WriteString(s)
Michael Yang's avatar
Michael Yang committed
227
		}
228
229
230
231
232
233
234

		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
235
236
	}

Michael Yang's avatar
Michael Yang committed
237
	slog.Debug("generate request", "prompt", prompt, "images", images)
238

Bruce MacDonald's avatar
Bruce MacDonald committed
239
240
	ch := make(chan any)
	go func() {
241
242
		// TODO (jmorganca): avoid building the response twice both here and below
		var sb strings.Builder
Bruce MacDonald's avatar
Bruce MacDonald committed
243
		defer close(ch)
Michael Yang's avatar
Michael Yang committed
244
		if err := r.Completion(c.Request.Context(), llm.CompletionRequest{
Michael Yang's avatar
Michael Yang committed
245
246
247
			Prompt:  prompt,
			Images:  images,
			Format:  req.Format,
Michael Yang's avatar
Michael Yang committed
248
			Options: opts,
249
250
		}, func(cr llm.CompletionResponse) {
			res := api.GenerateResponse{
251
252
				Model:      req.Model,
				CreatedAt:  time.Now().UTC(),
253
254
255
				Response:   cr.Content,
				Done:       cr.Done,
				DoneReason: cr.DoneReason,
Bruce MacDonald's avatar
Bruce MacDonald committed
256
				Metrics: api.Metrics{
257
258
259
260
					PromptEvalCount:    cr.PromptEvalCount,
					PromptEvalDuration: cr.PromptEvalDuration,
					EvalCount:          cr.EvalCount,
					EvalDuration:       cr.EvalDuration,
Bruce MacDonald's avatar
Bruce MacDonald committed
261
				},
Bruce MacDonald's avatar
Bruce MacDonald committed
262
			}
263
264
265
266
267
268
269
270
271
272

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

			if cr.Done {
				res.TotalDuration = time.Since(checkpointStart)
				res.LoadDuration = checkpointLoaded.Sub(checkpointStart)

				if !req.Raw {
273
					tokens, err := r.Tokenize(c.Request.Context(), prompt+sb.String())
274
275
276
277
					if err != nil {
						ch <- gin.H{"error": err.Error()}
						return
					}
278
					res.Context = tokens
279
280
281
282
				}
			}

			ch <- res
Michael Yang's avatar
Michael Yang committed
283
		}); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
284
285
286
287
288
			ch <- gin.H{"error": err.Error()}
		}
	}()

	if req.Stream != nil && !*req.Stream {
Michael Yang's avatar
Michael Yang committed
289
		var r api.GenerateResponse
Bruce MacDonald's avatar
Bruce MacDonald committed
290
		var sb strings.Builder
Michael Yang's avatar
Michael Yang committed
291
292
		for rr := range ch {
			switch t := rr.(type) {
293
			case api.GenerateResponse:
Michael Yang's avatar
Michael Yang committed
294
295
				sb.WriteString(t.Response)
				r = t
296
			case gin.H:
Michael Yang's avatar
Michael Yang committed
297
298
299
				msg, ok := t["error"].(string)
				if !ok {
					msg = "unexpected error format in response"
300
				}
Michael Yang's avatar
Michael Yang committed
301
302
303

				c.JSON(http.StatusInternalServerError, gin.H{"error": msg})
				return
304
			default:
Michael Yang's avatar
Michael Yang committed
305
				c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected response"})
Bruce MacDonald's avatar
Bruce MacDonald committed
306
307
308
				return
			}
		}
309

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

	streamResponse(c, ch)
}

318
func (s *Server) EmbedHandler(c *gin.Context) {
319
	checkpointStart := time.Now()
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
	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:
353
354
355
356
		if req.Input != nil {
			c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "invalid input type"})
			return
		}
357
358
359
360
361
362
363
364
	}

	r, m, opts, err := s.scheduleRunner(c.Request.Context(), req.Model, []Capability{}, req.Options, req.KeepAlive)
	if err != nil {
		handleScheduleError(c, req.Model, err)
		return
	}

365
366
	checkpointLoaded := time.Now()

367
368
369
370
371
	if len(input) == 0 {
		c.JSON(http.StatusOK, api.EmbedResponse{Model: req.Model, Embeddings: [][]float32{}})
		return
	}

372
373
374
375
376
377
	kvData, err := getKVData(m.ModelPath, false)
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

378
	var count int
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
	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
			}
		}

401
402
		count += len(tokens)

403
404
		input[i] = s
	}
405
406
407
408
409
410
411
412
413
414
415
416

	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
		})
417
418
	}

419
420
421
422
	if err := g.Wait(); err != nil {
		slog.Error("embedding generation failed", "error", err)
		c.JSON(http.StatusInternalServerError, gin.H{"error": fmt.Errorf("failed to generate embeddings: %v", err)})
		return
423
424
425
	}

	resp := api.EmbedResponse{
426
		Model:           req.Model,
427
		Embeddings:      embeddings,
428
429
		TotalDuration:   time.Since(checkpointStart),
		LoadDuration:    checkpointLoaded.Sub(checkpointStart),
430
		PromptEvalCount: count,
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
	}
	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
452
func (s *Server) EmbeddingsHandler(c *gin.Context) {
Bruce MacDonald's avatar
Bruce MacDonald committed
453
	var req api.EmbeddingRequest
Michael Yang's avatar
Michael Yang committed
454
	if err := c.ShouldBindJSON(&req); errors.Is(err, io.EOF) {
Bruce MacDonald's avatar
Bruce MacDonald committed
455
456
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
457
	} else if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
458
459
460
461
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

Michael Yang's avatar
Michael Yang committed
462
	r, _, _, err := s.scheduleRunner(c.Request.Context(), req.Model, []Capability{}, req.Options, req.KeepAlive)
Bruce MacDonald's avatar
Bruce MacDonald committed
463
	if err != nil {
Michael Yang's avatar
Michael Yang committed
464
		handleScheduleError(c, req.Model, err)
Bruce MacDonald's avatar
Bruce MacDonald committed
465
466
467
		return
	}

468
469
470
	// an empty request loads the model
	if req.Prompt == "" {
		c.JSON(http.StatusOK, api.EmbeddingResponse{Embedding: []float64{}})
Bruce MacDonald's avatar
Bruce MacDonald committed
471
472
473
		return
	}

474
	embedding, err := r.Embedding(c.Request.Context(), req.Prompt)
Bruce MacDonald's avatar
Bruce MacDonald committed
475
	if err != nil {
476
		slog.Info(fmt.Sprintf("embedding generation failed: %v", err))
Bruce MacDonald's avatar
Bruce MacDonald committed
477
478
479
480
		c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to generate embedding"})
		return
	}

481
482
483
	var e []float64
	for _, v := range embedding {
		e = append(e, float64(v))
484
485
486
	}

	resp := api.EmbeddingResponse{
487
		Embedding: e,
488
489
	}
	c.JSON(http.StatusOK, resp)
Bruce MacDonald's avatar
Bruce MacDonald committed
490
491
}

492
func (s *Server) PullHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
493
	var req api.PullRequest
Michael Yang's avatar
Michael Yang committed
494
495
496
497
498
499
500
	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
501
502
503
		return
	}

504
505
506
507
508
509
510
511
	name := model.ParseName(cmp.Or(req.Model, req.Name))
	if !name.IsValid() {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "invalid model name"})
		return
	}

	if err := checkNameExists(name); err != nil {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
512
513
514
		return
	}

515
516
517
	ch := make(chan any)
	go func() {
		defer close(ch)
518
519
		fn := func(r api.ProgressResponse) {
			ch <- r
520
		}
521

Michael Yang's avatar
Michael Yang committed
522
		regOpts := &registryOptions{
523
524
525
			Insecure: req.Insecure,
		}

526
527
528
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

529
		if err := PullModel(ctx, name.DisplayShortest(), regOpts, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
530
			ch <- gin.H{"error": err.Error()}
531
532
533
		}
	}()

534
535
536
537
538
	if req.Stream != nil && !*req.Stream {
		waitForStream(c, ch)
		return
	}

539
540
541
	streamResponse(c, ch)
}

542
func (s *Server) PushHandler(c *gin.Context) {
543
	var req api.PushRequest
Michael Yang's avatar
Michael Yang committed
544
545
546
547
548
549
550
	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
551
552
		return
	}
Michael Yang's avatar
Michael Yang committed
553

Michael Yang's avatar
Michael Yang committed
554
555
556
557
558
559
560
	var model string
	if req.Model != "" {
		model = req.Model
	} else if req.Name != "" {
		model = req.Name
	} else {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
561
562
563
		return
	}

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

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

Michael Yang's avatar
Michael Yang committed
575
576
577
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

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

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

588
589
590
	streamResponse(c, ch)
}

591
592
593
594
595
596
597
598
func checkNameExists(name model.Name) error {
	names, err := Manifests()
	if err != nil {
		return err
	}

	for n := range names {
		if strings.EqualFold(n.Filepath(), name.Filepath()) && n != name {
Michael Yang's avatar
lint  
Michael Yang committed
599
			return errors.New("a model with that name already exists")
600
601
602
603
604
605
		}
	}

	return nil
}

606
func (s *Server) CreateHandler(c *gin.Context) {
607
608
	var r api.CreateRequest
	if err := c.ShouldBindJSON(&r); errors.Is(err, io.EOF) {
Michael Yang's avatar
Michael Yang committed
609
610
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
611
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
612
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Michael Yang's avatar
Michael Yang committed
613
		return
614
615
	}

616
	name := model.ParseName(cmp.Or(r.Model, r.Name))
Michael Yang's avatar
Michael Yang committed
617
	if !name.IsValid() {
618
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": errtypes.InvalidModelNameErrMsg})
619
620
621
		return
	}

622
623
624
625
626
	if err := checkNameExists(name); err != nil {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

627
	if r.Path == "" && r.Modelfile == "" {
Michael Yang's avatar
Michael Yang committed
628
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "path or modelfile are required"})
Michael Yang's avatar
Michael Yang committed
629
630
		return
	}
Michael Yang's avatar
Michael Yang committed
631

632
633
634
	var sr io.Reader = strings.NewReader(r.Modelfile)
	if r.Path != "" && r.Modelfile == "" {
		f, err := os.Open(r.Path)
Michael Yang's avatar
Michael Yang committed
635
636
637
638
		if err != nil {
			c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("error reading modelfile: %s", err)})
			return
		}
Michael Yang's avatar
Michael Yang committed
639
		defer f.Close()
Michael Yang's avatar
Michael Yang committed
640

641
		sr = f
Michael Yang's avatar
Michael Yang committed
642
	}
Michael Yang's avatar
Michael Yang committed
643

644
	f, err := parser.ParseFile(sr)
Michael Yang's avatar
Michael Yang committed
645
646
647
648
649
	if err != nil {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

Michael Yang's avatar
Michael Yang committed
650
	ch := make(chan any)
Michael Yang's avatar
Michael Yang committed
651
652
	go func() {
		defer close(ch)
653
654
		fn := func(resp api.ProgressResponse) {
			ch <- resp
655
656
		}

657
658
659
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

660
		quantization := cmp.Or(r.Quantize, r.Quantization)
Josh's avatar
Josh committed
661
662
663
		if err := CreateModel(ctx, name, filepath.Dir(r.Path), strings.ToUpper(quantization), f, fn); errors.Is(err, errBadTemplate) {
			ch <- gin.H{"error": err.Error(), "status": http.StatusBadRequest}
		} else if err != nil {
Michael Yang's avatar
Michael Yang committed
664
			ch <- gin.H{"error": err.Error()}
665
		}
Michael Yang's avatar
Michael Yang committed
666
	}()
Michael Yang's avatar
Michael Yang committed
667

668
	if r.Stream != nil && !*r.Stream {
669
670
671
672
		waitForStream(c, ch)
		return
	}

Michael Yang's avatar
Michael Yang committed
673
	streamResponse(c, ch)
Bruce MacDonald's avatar
Bruce MacDonald committed
674
675
}

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

686
687
688
	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))})
689
690
		return
	}
Michael Yang's avatar
Michael Yang committed
691

692
	m, err := ParseNamedManifest(n)
Michael Yang's avatar
Michael Yang committed
693
694
695
696
697
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

698
	if err := m.Remove(); err != nil {
Michael Yang's avatar
Michael Yang committed
699
700
701
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}
702
703
704
705
706

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

709
func (s *Server) ShowHandler(c *gin.Context) {
Patrick Devine's avatar
Patrick Devine committed
710
	var req api.ShowRequest
Michael Yang's avatar
Michael Yang committed
711
712
713
714
715
716
717
	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
718
719
720
		return
	}

Michael Yang's avatar
Michael Yang committed
721
	if req.Model != "" {
Michael Yang's avatar
Michael Yang committed
722
		// noop
Michael Yang's avatar
Michael Yang committed
723
	} else if req.Name != "" {
Michael Yang's avatar
Michael Yang committed
724
		req.Model = req.Name
Michael Yang's avatar
Michael Yang committed
725
	} else {
726
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
727
728
729
		return
	}

730
	resp, err := GetModelInfo(req)
Patrick Devine's avatar
Patrick Devine committed
731
	if err != nil {
732
733
		switch {
		case os.IsNotExist(err):
Michael Yang's avatar
Michael Yang committed
734
			c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found", req.Model)})
735
736
737
		case err.Error() == "invalid model name":
			c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		default:
Patrick Devine's avatar
Patrick Devine committed
738
739
740
741
742
743
744
745
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		}
		return
	}

	c.JSON(http.StatusOK, resp)
}

746
func GetModelInfo(req api.ShowRequest) (*api.ShowResponse, error) {
747
	m, err := GetModel(req.Model)
Patrick Devine's avatar
Patrick Devine committed
748
749
750
751
	if err != nil {
		return nil, err
	}

Patrick Devine's avatar
Patrick Devine committed
752
	modelDetails := api.ModelDetails{
753
754
755
756
757
758
		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
759
760
	}

761
	if req.System != "" {
762
		m.System = req.System
763
764
	}

Michael Yang's avatar
Michael Yang committed
765
766
767
	msgs := make([]api.Message, len(m.Messages))
	for i, msg := range m.Messages {
		msgs[i] = api.Message{Role: msg.Role, Content: msg.Content}
768
769
	}

770
771
	n := model.ParseName(req.Model)
	if !n.IsValid() {
Michael Yang's avatar
lint  
Michael Yang committed
772
		return nil, errors.New("invalid model name")
773
774
775
776
777
778
779
	}

	manifest, err := ParseNamedManifest(n)
	if err != nil {
		return nil, err
	}

Patrick Devine's avatar
Patrick Devine committed
780
	resp := &api.ShowResponse{
781
782
		License:    strings.Join(m.License, "\n"),
		System:     m.System,
Michael Yang's avatar
Michael Yang committed
783
		Template:   m.Template.String(),
784
785
786
		Details:    modelDetails,
		Messages:   msgs,
		ModifiedAt: manifest.fi.ModTime(),
Patrick Devine's avatar
Patrick Devine committed
787
788
789
790
	}

	var params []string
	cs := 30
791
	for k, v := range m.Options {
Patrick Devine's avatar
Patrick Devine committed
792
793
794
		switch val := v.(type) {
		case []interface{}:
			for _, nv := range val {
Patrick Devine's avatar
Patrick Devine committed
795
				params = append(params, fmt.Sprintf("%-*s %#v", cs, k, nv))
Patrick Devine's avatar
Patrick Devine committed
796
			}
Patrick Devine's avatar
Patrick Devine committed
797
798
		default:
			params = append(params, fmt.Sprintf("%-*s %#v", cs, k, v))
Patrick Devine's avatar
Patrick Devine committed
799
800
801
802
		}
	}
	resp.Parameters = strings.Join(params, "\n")

803
804
	for k, v := range req.Options {
		if _, ok := req.Options[k]; ok {
805
			m.Options[k] = v
806
807
808
		}
	}

809
	var sb strings.Builder
810
	fmt.Fprintln(&sb, "# Modelfile generated by \"ollama show\"")
811
	fmt.Fprintln(&sb, "# To build a new Modelfile based on this, replace FROM with:")
812
813
	fmt.Fprintf(&sb, "# FROM %s\n\n", m.ShortName)
	fmt.Fprint(&sb, m.String())
814
	resp.Modelfile = sb.String()
815

816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
	kvData, err := getKVData(m.ModelPath, req.Verbose)
	if err != nil {
		return nil, err
	}
	delete(kvData, "general.name")
	delete(kvData, "tokenizer.chat_template")
	resp.ModelInfo = kvData

	if len(m.ProjectorPaths) > 0 {
		projectorData, err := getKVData(m.ProjectorPaths[0], req.Verbose)
		if err != nil {
			return nil, err
		}
		resp.ProjectorInfo = projectorData
	}

Patrick Devine's avatar
Patrick Devine committed
832
833
834
	return resp, nil
}

835
func getKVData(digest string, verbose bool) (llm.KV, error) {
836
837
838
839
840
	maxArraySize := 0
	if verbose {
		maxArraySize = -1
	}
	kvData, err := llm.LoadModel(digest, maxArraySize)
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
	if err != nil {
		return nil, err
	}

	kv := kvData.KV()

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

	return kv, nil
}

858
func (s *Server) ListHandler(c *gin.Context) {
859
	ms, err := Manifests()
Patrick Devine's avatar
Patrick Devine committed
860
861
862
863
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}
Michael Yang's avatar
Michael Yang committed
864

865
	models := []api.ListModelResponse{}
866
867
	for n, m := range ms {
		var cf ConfigV2
868
869
870
871
872
873
874
875
876
877
878
879
880

		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
881
		}
Michael Yang's avatar
Michael Yang committed
882

883
		// tag should never be masked
884
		models = append(models, api.ListModelResponse{
885
886
887
888
889
890
891
892
893
894
895
896
897
			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
898
899
	}

900
	slices.SortStableFunc(models, func(i, j api.ListModelResponse) int {
901
902
903
904
		// most recently modified first
		return cmp.Compare(j.ModifiedAt.Unix(), i.ModifiedAt.Unix())
	})

Michael Yang's avatar
Michael Yang committed
905
	c.JSON(http.StatusOK, api.ListResponse{Models: models})
Patrick Devine's avatar
Patrick Devine committed
906
907
}

908
func (s *Server) CopyHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
909
910
	var r api.CopyRequest
	if err := c.ShouldBindJSON(&r); errors.Is(err, io.EOF) {
Michael Yang's avatar
Michael Yang committed
911
912
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
913
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
914
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Patrick Devine's avatar
Patrick Devine committed
915
916
917
		return
	}

Michael Yang's avatar
Michael Yang committed
918
919
	src := model.ParseName(r.Source)
	if !src.IsValid() {
Michael Yang's avatar
Michael Yang committed
920
921
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("source %q is invalid", r.Source)})
		return
922
923
	}

Michael Yang's avatar
Michael Yang committed
924
925
	dst := model.ParseName(r.Destination)
	if !dst.IsValid() {
926
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("destination %q is invalid", r.Destination)})
Patrick Devine's avatar
Patrick Devine committed
927
928
		return
	}
Michael Yang's avatar
Michael Yang committed
929

930
931
932
933
934
	if err := checkNameExists(dst); err != nil {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

Michael Yang's avatar
Michael Yang committed
935
936
937
938
939
	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
940
941
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
942
func (s *Server) HeadBlobHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
943
944
945
946
947
948
949
950
951
952
953
	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
954
	c.Status(http.StatusOK)
Michael Yang's avatar
Michael Yang committed
955
956
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
957
func (s *Server) CreateBlobHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
958
959
	if ib, ok := intermediateBlobs[c.Param("digest")]; ok {
		p, err := GetBlobsPath(ib)
960
961
962
963
964
965
		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
966
967
			slog.Info("evicting intermediate blob which no longer exists", "digest", ib)
			delete(intermediateBlobs, c.Param("digest"))
968
969
970
971
972
973
974
975
976
		} else if err != nil {
			c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
			return
		} else {
			c.Status(http.StatusOK)
			return
		}
	}

977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
	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
	}

995
	layer, err := NewLayer(c.Request.Body, "")
Michael Yang's avatar
Michael Yang committed
996
997
998
999
1000
	if err != nil {
		c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

1001
1002
	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
1003
1004
1005
		return
	}

Michael Yang's avatar
Michael Yang committed
1006
	c.Status(http.StatusCreated)
Michael Yang's avatar
Michael Yang committed
1007
1008
}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
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
}

1030
func allowedHost(host string) bool {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1031
	if host == "" || host == "localhost" {
1032
1033
1034
1035
1036
1037
1038
		return true
	}

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

Michael Yang's avatar
lint  
Michael Yang committed
1039
	tlds := []string{
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1040
1041
1042
		"localhost",
		"local",
		"internal",
1043
	}
1044

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1045
	// check if the host is a local TLD
1046
1047
1048
1049
1050
1051
	for _, tld := range tlds {
		if strings.HasSuffix(host, "."+tld) {
			return true
		}
	}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1052
	return false
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1053
}
1054

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1055
1056
1057
func allowedHostsMiddleware(addr net.Addr) gin.HandlerFunc {
	return func(c *gin.Context) {
		if addr == nil {
1058
1059
1060
1061
			c.Next()
			return
		}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1062
		if addr, err := netip.ParseAddrPort(addr.String()); err == nil && !addr.Addr().IsLoopback() {
1063
1064
1065
1066
1067
1068
1069
1070
1071
			c.Next()
			return
		}

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

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1072
		if addr, err := netip.ParseAddr(host); err == nil {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1073
			if addr.IsLoopback() || addr.IsPrivate() || addr.IsUnspecified() || isLocalIP(addr) {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1074
1075
1076
1077
1078
				c.Next()
				return
			}
		}

1079
		if allowedHost(host) {
Michael Yang's avatar
lint  
Michael Yang committed
1080
			if c.Request.Method == http.MethodOptions {
1081
1082
1083
1084
				c.AbortWithStatus(http.StatusNoContent)
				return
			}

1085
1086
1087
1088
1089
1090
			c.Next()
			return
		}

		c.AbortWithStatus(http.StatusForbidden)
	}
1091
}
1092

1093
func (s *Server) GenerateRoutes() http.Handler {
Michael Yang's avatar
Michael Yang committed
1094
1095
	config := cors.DefaultConfig()
	config.AllowWildcard = true
1096
	config.AllowBrowserExtensions = true
1097
	config.AllowHeaders = []string{"Authorization", "Content-Type", "User-Agent", "Accept", "X-Requested-With"}
royjhan's avatar
royjhan committed
1098
1099
1100
1101
	openAIProperties := []string{"lang", "package-version", "os", "arch", "runtime", "runtime-version", "async"}
	for _, prop := range openAIProperties {
		config.AllowHeaders = append(config.AllowHeaders, "x-stainless-"+prop)
	}
Michael Yang's avatar
origins  
Michael Yang committed
1102
	config.AllowOrigins = envconfig.Origins()
Michael Yang's avatar
Michael Yang committed
1103

Bruce MacDonald's avatar
Bruce MacDonald committed
1104
	r := gin.Default()
1105
1106
	r.Use(
		cors.New(config),
1107
		allowedHostsMiddleware(s.addr),
1108
	)
Bruce MacDonald's avatar
Bruce MacDonald committed
1109

1110
	r.POST("/api/pull", s.PullHandler)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1111
1112
	r.POST("/api/generate", s.GenerateHandler)
	r.POST("/api/chat", s.ChatHandler)
1113
	r.POST("/api/embed", s.EmbedHandler)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1114
	r.POST("/api/embeddings", s.EmbeddingsHandler)
1115
1116
1117
1118
1119
	r.POST("/api/create", s.CreateHandler)
	r.POST("/api/push", s.PushHandler)
	r.POST("/api/copy", s.CopyHandler)
	r.DELETE("/api/delete", s.DeleteHandler)
	r.POST("/api/show", s.ShowHandler)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1120
1121
	r.POST("/api/blobs/:digest", s.CreateBlobHandler)
	r.HEAD("/api/blobs/:digest", s.HeadBlobHandler)
1122
	r.GET("/api/ps", s.PsHandler)
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1123

1124
	// Compatibility endpoints
1125
	r.POST("/v1/chat/completions", openai.ChatMiddleware(), s.ChatHandler)
1126
	r.POST("/v1/completions", openai.CompletionsMiddleware(), s.GenerateHandler)
1127
	r.POST("/v1/embeddings", openai.EmbeddingsMiddleware(), s.EmbedHandler)
1128
1129
	r.GET("/v1/models", openai.ListMiddleware(), s.ListHandler)
	r.GET("/v1/models/:model", openai.RetrieveMiddleware(), s.ShowHandler)
1130

Michael Yang's avatar
Michael Yang committed
1131
1132
1133
1134
1135
	for _, method := range []string{http.MethodGet, http.MethodHead} {
		r.Handle(method, "/", func(c *gin.Context) {
			c.String(http.StatusOK, "Ollama is running")
		})

1136
		r.Handle(method, "/api/tags", s.ListHandler)
Michael Yang's avatar
Michael Yang committed
1137
1138
1139
		r.Handle(method, "/api/version", func(c *gin.Context) {
			c.JSON(http.StatusOK, gin.H{"version": version.Version})
		})
Michael Yang's avatar
Michael Yang committed
1140
1141
	}

1142
1143
1144
1145
	return r
}

func Serve(ln net.Listener) error {
Michael Yang's avatar
Michael Yang committed
1146
	level := slog.LevelInfo
Michael Yang's avatar
Michael Yang committed
1147
	if envconfig.Debug() {
Michael Yang's avatar
Michael Yang committed
1148
		level = slog.LevelDebug
1149
	}
Michael Yang's avatar
Michael Yang committed
1150

1151
	slog.Info("server config", "env", envconfig.Values())
Michael Yang's avatar
Michael Yang committed
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
	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))

1167
1168
1169
1170
1171
1172
1173
1174
	blobsDir, err := GetBlobsPath("")
	if err != nil {
		return err
	}
	if err := fixBlobs(blobsDir); err != nil {
		return err
	}

Michael Yang's avatar
bool  
Michael Yang committed
1175
	if !envconfig.NoPrune() {
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
		// clean up unused layers and manifests
		if err := PruneLayers(); err != nil {
			return err
		}

		manifestsPath, err := GetManifestPath()
		if err != nil {
			return err
		}

		if err := PruneDirectory(manifestsPath); err != nil {
			return err
		}
	}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1191
	ctx, done := context.WithCancel(context.Background())
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1192
1193
	schedCtx, schedDone := context.WithCancel(ctx)
	sched := InitScheduler(schedCtx)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1194
	s := &Server{addr: ln.Addr(), sched: sched}
1195
1196

	http.Handle("/", s.GenerateRoutes())
1197

1198
	slog.Info(fmt.Sprintf("Listening on %s (version %s)", ln.Addr(), version.Version))
1199
	srvr := &http.Server{
1200
1201
1202
1203
1204
1205
1206
1207
1208
		// 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
1209
1210
	}

1211
1212
	// listen for a ctrl+c and stop any loaded llm
	signals := make(chan os.Signal, 1)
1213
	signal.Notify(signals, syscall.SIGINT, syscall.SIGTERM)
1214
1215
	go func() {
		<-signals
1216
		srvr.Close()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1217
		schedDone()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1218
		sched.unloadAllRunners()
1219
		gpu.Cleanup()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1220
		done()
1221
1222
	}()

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1223
	if err := llm.Init(); err != nil {
1224
1225
		return fmt.Errorf("unable to initialize llm library %w", err)
	}
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1226

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1227
	s.sched.Run(schedCtx)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1228
1229
1230

	// At startup we retrieve GPU information so we can get log messages before loading a model
	// This will log warnings to the log in case we have problems with detected GPUs
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1231
1232
	gpus := gpu.GetGPUInfo()
	gpus.LogDetails()
1233

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1234
1235
1236
1237
1238
1239
1240
	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()
1241
	return nil
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1242
}
Michael Yang's avatar
Michael Yang committed
1243

1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
func waitForStream(c *gin.Context, ch chan interface{}) {
	c.Header("Content-Type", "application/json")
	for resp := range ch {
		switch r := resp.(type) {
		case api.ProgressResponse:
			if r.Status == "success" {
				c.JSON(http.StatusOK, r)
				return
			}
		case gin.H:
Josh's avatar
Josh committed
1254
1255
1256
1257
			status, ok := r["status"].(int)
			if !ok {
				status = http.StatusInternalServerError
			}
1258
			if errorMsg, ok := r["error"].(string); ok {
Josh's avatar
Josh committed
1259
				c.JSON(status, gin.H{"error": errorMsg})
1260
1261
				return
			} else {
Josh's avatar
Josh committed
1262
				c.JSON(status, gin.H{"error": "unexpected error format in progress response"})
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
				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
1273
func streamResponse(c *gin.Context, ch chan any) {
1274
	c.Header("Content-Type", "application/x-ndjson")
Michael Yang's avatar
Michael Yang committed
1275
1276
1277
1278
1279
1280
1281
1282
	c.Stream(func(w io.Writer) bool {
		val, ok := <-ch
		if !ok {
			return false
		}

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

1287
		// Delineate chunks with new-line delimiter
Michael Yang's avatar
Michael Yang committed
1288
1289
		bts = append(bts, '\n')
		if _, err := w.Write(bts); err != nil {
1290
			slog.Info(fmt.Sprintf("streamResponse: w.Write failed with %s", err))
Michael Yang's avatar
Michael Yang committed
1291
1292
1293
1294
1295
1296
			return false
		}

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

1298
func (s *Server) PsHandler(c *gin.Context) {
1299
	models := []api.ProcessModelResponse{}
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310

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

1311
		mr := api.ProcessModelResponse{
1312
1313
1314
1315
1316
1317
1318
1319
			Model:     model.ShortName,
			Name:      model.ShortName,
			Size:      int64(v.estimatedTotal),
			SizeVRAM:  int64(v.estimatedVRAM),
			Digest:    model.Digest,
			Details:   modelDetails,
			ExpiresAt: v.expiresAt,
		}
1320
1321
1322
1323
1324
1325
1326
1327
		// 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)
		}

1328
1329
1330
		models = append(models, mr)
	}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1331
1332
1333
1334
1335
	slices.SortStableFunc(models, func(i, j api.ProcessModelResponse) int {
		// longest duration remaining listed first
		return cmp.Compare(j.ExpiresAt.Unix(), i.ExpiresAt.Unix())
	})

1336
	c.JSON(http.StatusOK, api.ProcessResponse{Models: models})
1337
1338
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1339
func (s *Server) ChatHandler(c *gin.Context) {
1340
1341
	checkpointStart := time.Now()

Bruce MacDonald's avatar
Bruce MacDonald committed
1342
	var req api.ChatRequest
Michael Yang's avatar
Michael Yang committed
1343
	if err := c.ShouldBindJSON(&req); errors.Is(err, io.EOF) {
Bruce MacDonald's avatar
Bruce MacDonald committed
1344
1345
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
1346
	} else if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1347
1348
1349
1350
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

Patrick Devine's avatar
Patrick Devine committed
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
	// 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)})
			case err.Error() == "invalid model name":
				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
	}

Michael Yang's avatar
Michael Yang committed
1377
	caps := []Capability{CapabilityCompletion}
1378
	if len(req.Tools) > 0 {
Michael Yang's avatar
tools  
Michael Yang committed
1379
1380
1381
		caps = append(caps, CapabilityTools)
	}

Michael Yang's avatar
Michael Yang committed
1382
	r, m, opts, err := s.scheduleRunner(c.Request.Context(), req.Model, caps, req.Options, req.KeepAlive)
Michael Yang's avatar
Michael Yang committed
1383
1384
	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
1385
		return
Michael Yang's avatar
Michael Yang committed
1386
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
1387
		handleScheduleError(c, req.Model, err)
Bruce MacDonald's avatar
Bruce MacDonald committed
1388
1389
		return
	}
Michael Yang's avatar
Michael Yang committed
1390

1391
1392
	checkpointLoaded := time.Now()

Michael Yang's avatar
Michael Yang committed
1393
1394
	if len(req.Messages) == 0 {
		c.JSON(http.StatusOK, api.ChatResponse{
1395
			Model:      req.Model,
Michael Yang's avatar
Michael Yang committed
1396
1397
			CreatedAt:  time.Now().UTC(),
			Message:    api.Message{Role: "assistant"},
1398
1399
			Done:       true,
			DoneReason: "load",
Michael Yang's avatar
Michael Yang committed
1400
		})
1401
1402
1403
		return
	}

Michael Yang's avatar
Michael Yang committed
1404
	msgs := append(m.Messages, req.Messages...)
1405
	if req.Messages[0].Role != "system" && m.System != "" {
Michael Yang's avatar
Michael Yang committed
1406
		msgs = append([]api.Message{{Role: "system", Content: m.System}}, msgs...)
1407
1408
	}

Michael Yang's avatar
Michael Yang committed
1409
	prompt, images, err := chatPrompt(c.Request.Context(), m, r.Tokenize, opts, msgs, req.Tools)
Michael Yang's avatar
Michael Yang committed
1410
1411
1412
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
1413
1414
	}

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

Bruce MacDonald's avatar
Bruce MacDonald committed
1417
1418
1419
	ch := make(chan any)
	go func() {
		defer close(ch)
Michael Yang's avatar
Michael Yang committed
1420
		if err := r.Completion(c.Request.Context(), llm.CompletionRequest{
Michael Yang's avatar
Michael Yang committed
1421
1422
1423
			Prompt:  prompt,
			Images:  images,
			Format:  req.Format,
Michael Yang's avatar
Michael Yang committed
1424
			Options: opts,
Michael Yang's avatar
Michael Yang committed
1425
		}, func(r llm.CompletionResponse) {
1426
			res := api.ChatResponse{
1427
1428
1429
1430
1431
				Model:      req.Model,
				CreatedAt:  time.Now().UTC(),
				Message:    api.Message{Role: "assistant", Content: r.Content},
				Done:       r.Done,
				DoneReason: r.DoneReason,
Bruce MacDonald's avatar
Bruce MacDonald committed
1432
1433
1434
1435
1436
1437
1438
				Metrics: api.Metrics{
					PromptEvalCount:    r.PromptEvalCount,
					PromptEvalDuration: r.PromptEvalDuration,
					EvalCount:          r.EvalCount,
					EvalDuration:       r.EvalDuration,
				},
			}
1439
1440
1441
1442
1443
1444
1445

			if r.Done {
				res.TotalDuration = time.Since(checkpointStart)
				res.LoadDuration = checkpointLoaded.Sub(checkpointStart)
			}

			ch <- res
Michael Yang's avatar
Michael Yang committed
1446
		}); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1447
1448
1449
1450
1451
			ch <- gin.H{"error": err.Error()}
		}
	}()

	if req.Stream != nil && !*req.Stream {
Michael Yang's avatar
tools  
Michael Yang committed
1452
		var resp api.ChatResponse
Bruce MacDonald's avatar
Bruce MacDonald committed
1453
		var sb strings.Builder
Michael Yang's avatar
Michael Yang committed
1454
1455
		for rr := range ch {
			switch t := rr.(type) {
1456
			case api.ChatResponse:
Michael Yang's avatar
Michael Yang committed
1457
				sb.WriteString(t.Message.Content)
Michael Yang's avatar
tools  
Michael Yang committed
1458
				resp = t
1459
			case gin.H:
Michael Yang's avatar
Michael Yang committed
1460
1461
1462
				msg, ok := t["error"].(string)
				if !ok {
					msg = "unexpected error format in response"
1463
				}
Michael Yang's avatar
Michael Yang committed
1464
1465
1466

				c.JSON(http.StatusInternalServerError, gin.H{"error": msg})
				return
1467
			default:
Michael Yang's avatar
Michael Yang committed
1468
				c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected response"})
1469
				return
Bruce MacDonald's avatar
Bruce MacDonald committed
1470
1471
			}
		}
1472

Michael Yang's avatar
tools  
Michael Yang committed
1473
		resp.Message.Content = sb.String()
1474
1475
1476
1477
1478
1479

		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
1480
1481
1482
		}

		c.JSON(http.StatusOK, resp)
Bruce MacDonald's avatar
Bruce MacDonald committed
1483
1484
1485
1486
1487
		return
	}

	streamResponse(c, ch)
}
1488

Michael Yang's avatar
Michael Yang committed
1489
func handleScheduleError(c *gin.Context, name string, err error) {
Michael Yang's avatar
Michael Yang committed
1490
	switch {
1491
	case errors.Is(err, errCapabilities), errors.Is(err, errRequired):
Michael Yang's avatar
Michael Yang committed
1492
		c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Michael Yang's avatar
Michael Yang committed
1493
	case errors.Is(err, context.Canceled):
1494
		c.JSON(499, gin.H{"error": "request canceled"})
Michael Yang's avatar
Michael Yang committed
1495
	case errors.Is(err, ErrMaxQueue):
1496
		c.JSON(http.StatusServiceUnavailable, gin.H{"error": err.Error()})
Michael Yang's avatar
Michael Yang committed
1497
1498
	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
1499
1500
	default:
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
1501
1502
	}
}