routes.go 37.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"
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/build"
30
	"github.com/ollama/ollama/envconfig"
31
32
33
	"github.com/ollama/ollama/gpu"
	"github.com/ollama/ollama/llm"
	"github.com/ollama/ollama/openai"
34
	"github.com/ollama/ollama/parser"
35
	"github.com/ollama/ollama/runners"
Michael Yang's avatar
Michael Yang committed
36
	"github.com/ollama/ollama/template"
37
	"github.com/ollama/ollama/types/errtypes"
Michael Yang's avatar
Michael Yang committed
38
	"github.com/ollama/ollama/types/model"
39
	"github.com/ollama/ollama/version"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
40
41
)

Michael Yang's avatar
Michael Yang committed
42
43
var mode string = gin.DebugMode

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

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

66
67
68
69
70
71
72
73
74
75
76
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
77
78
}

Michael Yang's avatar
Michael Yang committed
79
80
81
// 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
82
	if name == "" {
Michael Yang's avatar
Michael Yang committed
83
		return nil, nil, nil, fmt.Errorf("model %w", errRequired)
Bruce MacDonald's avatar
Bruce MacDonald committed
84
85
	}

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

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

Michael Yang's avatar
Michael Yang committed
95
	opts, err := modelOptions(model, requestOpts)
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
	runnerCh, errCh := s.sched.GetRunner(ctx, model, opts, keepAlive)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
101
102
	var runner *runnerRef
	select {
Michael Yang's avatar
Michael Yang committed
103
104
	case runner = <-runnerCh:
	case err = <-errCh:
Michael Yang's avatar
Michael Yang committed
105
		return nil, nil, nil, err
Bruce MacDonald's avatar
Bruce MacDonald committed
106
107
	}

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

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

Patrick Devine's avatar
Patrick Devine committed
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
	// 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
148
149
150
151
152
	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
153
154
155
		return
	}

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

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

170
171
	checkpointLoaded := time.Now()

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

Michael Yang's avatar
Michael Yang committed
182
183
184
185
	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
186

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

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

214
215
216
217
218
219
220
			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
221
222
		var b bytes.Buffer
		if req.Context != nil {
223
			s, err := r.Detokenize(c.Request.Context(), req.Context)
Michael Yang's avatar
Michael Yang committed
224
225
226
227
			if err != nil {
				c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
				return
			}
228
			b.WriteString(s)
Michael Yang's avatar
Michael Yang committed
229
		}
230
231
232
233
234
235
236

		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
237
238
	}

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

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

			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 {
275
					tokens, err := r.Tokenize(c.Request.Context(), prompt+sb.String())
276
277
278
279
					if err != nil {
						ch <- gin.H{"error": err.Error()}
						return
					}
280
					res.Context = tokens
281
282
283
284
				}
			}

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

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

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

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

	streamResponse(c, ch)
}

320
func (s *Server) EmbedHandler(c *gin.Context) {
321
	checkpointStart := time.Now()
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
353
354
	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:
355
356
357
358
		if req.Input != nil {
			c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "invalid input type"})
			return
		}
359
360
361
362
363
364
365
366
	}

	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
	}

367
368
	checkpointLoaded := time.Now()

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

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

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

403
404
		count += len(tokens)

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

	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
		})
419
420
	}

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

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

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

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

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

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

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

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

506
507
508
509
510
511
512
513
	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()})
514
515
516
		return
	}

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

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

528
529
530
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

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

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

541
542
543
	streamResponse(c, ch)
}

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

Michael Yang's avatar
Michael Yang committed
556
557
558
559
560
561
562
	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"})
563
564
565
		return
	}

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

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

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

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

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

590
591
592
	streamResponse(c, ch)
}

593
594
595
596
597
598
599
600
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
601
			return errors.New("a model with that name already exists")
602
603
604
605
606
607
		}
	}

	return nil
}

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

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

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

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

634
635
636
	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
637
638
639
640
		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
641
		defer f.Close()
Michael Yang's avatar
Michael Yang committed
642

643
		sr = f
Michael Yang's avatar
Michael Yang committed
644
	}
Michael Yang's avatar
Michael Yang committed
645

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

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

659
660
661
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

662
		quantization := cmp.Or(r.Quantize, r.Quantization)
Josh's avatar
Josh committed
663
664
665
		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
666
			ch <- gin.H{"error": err.Error()}
667
		}
Michael Yang's avatar
Michael Yang committed
668
	}()
Michael Yang's avatar
Michael Yang committed
669

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

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

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

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

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

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

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

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

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

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

	c.JSON(http.StatusOK, resp)
}

753
func GetModelInfo(req api.ShowRequest) (*api.ShowResponse, error) {
754
	m, err := GetModel(req.Model)
Patrick Devine's avatar
Patrick Devine committed
755
756
757
758
	if err != nil {
		return nil, err
	}

Patrick Devine's avatar
Patrick Devine committed
759
	modelDetails := api.ModelDetails{
760
761
762
763
764
765
		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
766
767
	}

768
	if req.System != "" {
769
		m.System = req.System
770
771
	}

Michael Yang's avatar
Michael Yang committed
772
773
774
	msgs := make([]api.Message, len(m.Messages))
	for i, msg := range m.Messages {
		msgs[i] = api.Message{Role: msg.Role, Content: msg.Content}
775
776
	}

777
778
	n := model.ParseName(req.Model)
	if !n.IsValid() {
Michael Yang's avatar
lint  
Michael Yang committed
779
		return nil, errors.New("invalid model name")
780
781
782
783
784
785
786
	}

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

Patrick Devine's avatar
Patrick Devine committed
787
	resp := &api.ShowResponse{
788
789
		License:    strings.Join(m.License, "\n"),
		System:     m.System,
Michael Yang's avatar
Michael Yang committed
790
		Template:   m.Template.String(),
791
792
793
		Details:    modelDetails,
		Messages:   msgs,
		ModifiedAt: manifest.fi.ModTime(),
Patrick Devine's avatar
Patrick Devine committed
794
795
796
797
	}

	var params []string
	cs := 30
798
	for k, v := range m.Options {
Patrick Devine's avatar
Patrick Devine committed
799
800
801
		switch val := v.(type) {
		case []interface{}:
			for _, nv := range val {
Patrick Devine's avatar
Patrick Devine committed
802
				params = append(params, fmt.Sprintf("%-*s %#v", cs, k, nv))
Patrick Devine's avatar
Patrick Devine committed
803
			}
Patrick Devine's avatar
Patrick Devine committed
804
805
		default:
			params = append(params, fmt.Sprintf("%-*s %#v", cs, k, v))
Patrick Devine's avatar
Patrick Devine committed
806
807
808
809
		}
	}
	resp.Parameters = strings.Join(params, "\n")

810
811
	for k, v := range req.Options {
		if _, ok := req.Options[k]; ok {
812
			m.Options[k] = v
813
814
815
		}
	}

816
	var sb strings.Builder
817
	fmt.Fprintln(&sb, "# Modelfile generated by \"ollama show\"")
818
	fmt.Fprintln(&sb, "# To build a new Modelfile based on this, replace FROM with:")
819
820
	fmt.Fprintf(&sb, "# FROM %s\n\n", m.ShortName)
	fmt.Fprint(&sb, m.String())
821
	resp.Modelfile = sb.String()
822

823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
	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
839
840
841
	return resp, nil
}

842
func getKVData(digest string, verbose bool) (llm.KV, error) {
843
844
845
846
847
	maxArraySize := 0
	if verbose {
		maxArraySize = -1
	}
	kvData, err := llm.LoadModel(digest, maxArraySize)
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
	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
}

865
func (s *Server) ListHandler(c *gin.Context) {
866
	ms, err := Manifests()
Patrick Devine's avatar
Patrick Devine committed
867
868
869
870
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}
Michael Yang's avatar
Michael Yang committed
871

872
	models := []api.ListModelResponse{}
873
874
	for n, m := range ms {
		var cf ConfigV2
875
876
877
878
879
880
881
882
883
884
885
886
887

		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
888
		}
Michael Yang's avatar
Michael Yang committed
889

890
		// tag should never be masked
891
		models = append(models, api.ListModelResponse{
892
893
894
895
896
897
898
899
900
901
902
903
904
			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
905
906
	}

907
	slices.SortStableFunc(models, func(i, j api.ListModelResponse) int {
908
909
910
911
		// most recently modified first
		return cmp.Compare(j.ModifiedAt.Unix(), i.ModifiedAt.Unix())
	})

Michael Yang's avatar
Michael Yang committed
912
	c.JSON(http.StatusOK, api.ListResponse{Models: models})
Patrick Devine's avatar
Patrick Devine committed
913
914
}

915
func (s *Server) CopyHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
916
917
	var r api.CopyRequest
	if err := c.ShouldBindJSON(&r); errors.Is(err, io.EOF) {
Michael Yang's avatar
Michael Yang committed
918
919
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
920
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
921
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Patrick Devine's avatar
Patrick Devine committed
922
923
924
		return
	}

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

Michael Yang's avatar
Michael Yang committed
931
932
	dst := model.ParseName(r.Destination)
	if !dst.IsValid() {
933
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("destination %q is invalid", r.Destination)})
Patrick Devine's avatar
Patrick Devine committed
934
935
		return
	}
Michael Yang's avatar
Michael Yang committed
936

937
938
939
940
941
	if err := checkNameExists(dst); err != nil {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

Michael Yang's avatar
Michael Yang committed
942
943
944
945
946
	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
947
948
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
949
func (s *Server) HeadBlobHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
950
951
952
953
954
955
956
957
958
959
960
	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
961
	c.Status(http.StatusOK)
Michael Yang's avatar
Michael Yang committed
962
963
}

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

984
985
986
987
988
989
990
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
	}

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

1002
	layer, err := NewLayer(c.Request.Body, "")
Michael Yang's avatar
Michael Yang committed
1003
1004
1005
1006
1007
	if err != nil {
		c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

1008
1009
	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
1010
1011
1012
		return
	}

Michael Yang's avatar
Michael Yang committed
1013
	c.Status(http.StatusCreated)
Michael Yang's avatar
Michael Yang committed
1014
1015
}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
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
}

1037
func allowedHost(host string) bool {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1038
	if host == "" || host == "localhost" {
1039
1040
1041
1042
1043
1044
1045
		return true
	}

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

Michael Yang's avatar
lint  
Michael Yang committed
1046
	tlds := []string{
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1047
1048
1049
		"localhost",
		"local",
		"internal",
1050
	}
1051

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1052
	// check if the host is a local TLD
1053
1054
1055
1056
1057
1058
	for _, tld := range tlds {
		if strings.HasSuffix(host, "."+tld) {
			return true
		}
	}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1059
	return false
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1060
}
1061

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1062
1063
1064
func allowedHostsMiddleware(addr net.Addr) gin.HandlerFunc {
	return func(c *gin.Context) {
		if addr == nil {
1065
1066
1067
1068
			c.Next()
			return
		}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1069
		if addr, err := netip.ParseAddrPort(addr.String()); err == nil && !addr.Addr().IsLoopback() {
1070
1071
1072
1073
1074
1075
1076
1077
1078
			c.Next()
			return
		}

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

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1079
		if addr, err := netip.ParseAddr(host); err == nil {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1080
			if addr.IsLoopback() || addr.IsPrivate() || addr.IsUnspecified() || isLocalIP(addr) {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1081
1082
1083
1084
1085
				c.Next()
				return
			}
		}

1086
		if allowedHost(host) {
Michael Yang's avatar
lint  
Michael Yang committed
1087
			if c.Request.Method == http.MethodOptions {
1088
1089
1090
1091
				c.AbortWithStatus(http.StatusNoContent)
				return
			}

1092
1093
1094
1095
1096
1097
			c.Next()
			return
		}

		c.AbortWithStatus(http.StatusForbidden)
	}
1098
}
1099

1100
func (s *Server) GenerateRoutes() http.Handler {
Michael Yang's avatar
Michael Yang committed
1101
1102
	config := cors.DefaultConfig()
	config.AllowWildcard = true
1103
	config.AllowBrowserExtensions = true
1104
	config.AllowHeaders = []string{"Authorization", "Content-Type", "User-Agent", "Accept", "X-Requested-With"}
royjhan's avatar
royjhan committed
1105
1106
1107
1108
	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
1109
	config.AllowOrigins = envconfig.Origins()
Michael Yang's avatar
Michael Yang committed
1110

Bruce MacDonald's avatar
Bruce MacDonald committed
1111
	r := gin.Default()
1112
1113
	r.Use(
		cors.New(config),
1114
		allowedHostsMiddleware(s.addr),
1115
	)
Bruce MacDonald's avatar
Bruce MacDonald committed
1116

1117
	r.POST("/api/pull", s.PullHandler)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1118
1119
	r.POST("/api/generate", s.GenerateHandler)
	r.POST("/api/chat", s.ChatHandler)
1120
	r.POST("/api/embed", s.EmbedHandler)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1121
	r.POST("/api/embeddings", s.EmbeddingsHandler)
1122
1123
1124
1125
1126
	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
1127
1128
	r.POST("/api/blobs/:digest", s.CreateBlobHandler)
	r.HEAD("/api/blobs/:digest", s.HeadBlobHandler)
1129
	r.GET("/api/ps", s.PsHandler)
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1130

1131
	// Compatibility endpoints
1132
	r.POST("/v1/chat/completions", openai.ChatMiddleware(), s.ChatHandler)
1133
	r.POST("/v1/completions", openai.CompletionsMiddleware(), s.GenerateHandler)
1134
	r.POST("/v1/embeddings", openai.EmbeddingsMiddleware(), s.EmbedHandler)
1135
1136
	r.GET("/v1/models", openai.ListMiddleware(), s.ListHandler)
	r.GET("/v1/models/:model", openai.RetrieveMiddleware(), s.ShowHandler)
1137

Michael Yang's avatar
Michael Yang committed
1138
1139
1140
1141
1142
	for _, method := range []string{http.MethodGet, http.MethodHead} {
		r.Handle(method, "/", func(c *gin.Context) {
			c.String(http.StatusOK, "Ollama is running")
		})

1143
		r.Handle(method, "/api/tags", s.ListHandler)
Michael Yang's avatar
Michael Yang committed
1144
1145
1146
		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
1147
1148
	}

1149
1150
1151
1152
	return r
}

func Serve(ln net.Listener) error {
Michael Yang's avatar
Michael Yang committed
1153
	level := slog.LevelInfo
Michael Yang's avatar
Michael Yang committed
1154
	if envconfig.Debug() {
Michael Yang's avatar
Michael Yang committed
1155
		level = slog.LevelDebug
1156
	}
Michael Yang's avatar
Michael Yang committed
1157

1158
	slog.Info("server config", "env", envconfig.Values())
Michael Yang's avatar
Michael Yang committed
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
	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))

1174
1175
1176
1177
1178
1179
1180
1181
	blobsDir, err := GetBlobsPath("")
	if err != nil {
		return err
	}
	if err := fixBlobs(blobsDir); err != nil {
		return err
	}

Michael Yang's avatar
bool  
Michael Yang committed
1182
	if !envconfig.NoPrune() {
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
		// 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
1198
	ctx, done := context.WithCancel(context.Background())
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1199
1200
	schedCtx, schedDone := context.WithCancel(ctx)
	sched := InitScheduler(schedCtx)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1201
	s := &Server{addr: ln.Addr(), sched: sched}
1202
1203

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

1205
	slog.Info(fmt.Sprintf("Listening on %s (version %s)", ln.Addr(), version.Version))
1206
	srvr := &http.Server{
1207
1208
1209
1210
1211
1212
1213
1214
1215
		// 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
1216
1217
	}

1218
1219
	// listen for a ctrl+c and stop any loaded llm
	signals := make(chan os.Signal, 1)
1220
	signal.Notify(signals, syscall.SIGINT, syscall.SIGTERM)
1221
1222
	go func() {
		<-signals
1223
		srvr.Close()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1224
		schedDone()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1225
		sched.unloadAllRunners()
1226
		runners.Cleanup(build.EmbedFS)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1227
		done()
1228
1229
	}()

1230
1231
	if _, err := runners.Refresh(build.EmbedFS); err != nil {
		return fmt.Errorf("unable to initialize llm runners %w", err)
1232
	}
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1233

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1234
	s.sched.Run(schedCtx)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1235
1236
1237

	// 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
1238
1239
	gpus := gpu.GetGPUInfo()
	gpus.LogDetails()
1240

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1241
1242
1243
1244
1245
1246
1247
	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()
1248
	return nil
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1249
}
Michael Yang's avatar
Michael Yang committed
1250

1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
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
1261
1262
1263
1264
			status, ok := r["status"].(int)
			if !ok {
				status = http.StatusInternalServerError
			}
1265
			if errorMsg, ok := r["error"].(string); ok {
Josh's avatar
Josh committed
1266
				c.JSON(status, gin.H{"error": errorMsg})
1267
1268
				return
			} else {
Josh's avatar
Josh committed
1269
				c.JSON(status, gin.H{"error": "unexpected error format in progress response"})
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
				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
1280
func streamResponse(c *gin.Context, ch chan any) {
1281
	c.Header("Content-Type", "application/x-ndjson")
Michael Yang's avatar
Michael Yang committed
1282
1283
1284
1285
1286
1287
1288
1289
	c.Stream(func(w io.Writer) bool {
		val, ok := <-ch
		if !ok {
			return false
		}

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

1294
		// Delineate chunks with new-line delimiter
Michael Yang's avatar
Michael Yang committed
1295
1296
		bts = append(bts, '\n')
		if _, err := w.Write(bts); err != nil {
1297
			slog.Info(fmt.Sprintf("streamResponse: w.Write failed with %s", err))
Michael Yang's avatar
Michael Yang committed
1298
1299
1300
1301
1302
1303
			return false
		}

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

1305
func (s *Server) PsHandler(c *gin.Context) {
1306
	models := []api.ProcessModelResponse{}
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317

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

1318
		mr := api.ProcessModelResponse{
1319
1320
1321
1322
1323
1324
1325
1326
			Model:     model.ShortName,
			Name:      model.ShortName,
			Size:      int64(v.estimatedTotal),
			SizeVRAM:  int64(v.estimatedVRAM),
			Digest:    model.Digest,
			Details:   modelDetails,
			ExpiresAt: v.expiresAt,
		}
1327
1328
1329
1330
1331
1332
1333
1334
		// 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)
		}

1335
1336
1337
		models = append(models, mr)
	}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1338
1339
1340
1341
1342
	slices.SortStableFunc(models, func(i, j api.ProcessModelResponse) int {
		// longest duration remaining listed first
		return cmp.Compare(j.ExpiresAt.Unix(), i.ExpiresAt.Unix())
	})

1343
	c.JSON(http.StatusOK, api.ProcessResponse{Models: models})
1344
1345
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1346
func (s *Server) ChatHandler(c *gin.Context) {
1347
1348
	checkpointStart := time.Now()

Bruce MacDonald's avatar
Bruce MacDonald committed
1349
	var req api.ChatRequest
Michael Yang's avatar
Michael Yang committed
1350
	if err := c.ShouldBindJSON(&req); errors.Is(err, io.EOF) {
Bruce MacDonald's avatar
Bruce MacDonald committed
1351
1352
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
1353
	} else if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1354
1355
1356
1357
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

Patrick Devine's avatar
Patrick Devine committed
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
	// 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
1384
	caps := []Capability{CapabilityCompletion}
1385
	if len(req.Tools) > 0 {
Michael Yang's avatar
tools  
Michael Yang committed
1386
1387
1388
		caps = append(caps, CapabilityTools)
	}

Michael Yang's avatar
Michael Yang committed
1389
	r, m, opts, err := s.scheduleRunner(c.Request.Context(), req.Model, caps, req.Options, req.KeepAlive)
Michael Yang's avatar
Michael Yang committed
1390
1391
	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
1392
		return
Michael Yang's avatar
Michael Yang committed
1393
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
1394
		handleScheduleError(c, req.Model, err)
Bruce MacDonald's avatar
Bruce MacDonald committed
1395
1396
		return
	}
Michael Yang's avatar
Michael Yang committed
1397

1398
1399
	checkpointLoaded := time.Now()

Michael Yang's avatar
Michael Yang committed
1400
1401
	if len(req.Messages) == 0 {
		c.JSON(http.StatusOK, api.ChatResponse{
1402
			Model:      req.Model,
Michael Yang's avatar
Michael Yang committed
1403
1404
			CreatedAt:  time.Now().UTC(),
			Message:    api.Message{Role: "assistant"},
1405
1406
			Done:       true,
			DoneReason: "load",
Michael Yang's avatar
Michael Yang committed
1407
		})
1408
1409
1410
		return
	}

Michael Yang's avatar
Michael Yang committed
1411
	msgs := append(m.Messages, req.Messages...)
1412
	if req.Messages[0].Role != "system" && m.System != "" {
Michael Yang's avatar
Michael Yang committed
1413
		msgs = append([]api.Message{{Role: "system", Content: m.System}}, msgs...)
1414
1415
	}

Michael Yang's avatar
Michael Yang committed
1416
	prompt, images, err := chatPrompt(c.Request.Context(), m, r.Tokenize, opts, msgs, req.Tools)
Michael Yang's avatar
Michael Yang committed
1417
1418
1419
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
1420
1421
	}

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

Bruce MacDonald's avatar
Bruce MacDonald committed
1424
1425
1426
	ch := make(chan any)
	go func() {
		defer close(ch)
Michael Yang's avatar
Michael Yang committed
1427
		if err := r.Completion(c.Request.Context(), llm.CompletionRequest{
Michael Yang's avatar
Michael Yang committed
1428
1429
1430
			Prompt:  prompt,
			Images:  images,
			Format:  req.Format,
Michael Yang's avatar
Michael Yang committed
1431
			Options: opts,
Michael Yang's avatar
Michael Yang committed
1432
		}, func(r llm.CompletionResponse) {
1433
			res := api.ChatResponse{
1434
1435
1436
1437
1438
				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
1439
1440
1441
1442
1443
1444
1445
				Metrics: api.Metrics{
					PromptEvalCount:    r.PromptEvalCount,
					PromptEvalDuration: r.PromptEvalDuration,
					EvalCount:          r.EvalCount,
					EvalDuration:       r.EvalDuration,
				},
			}
1446
1447
1448
1449
1450
1451
1452

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

			ch <- res
Michael Yang's avatar
Michael Yang committed
1453
		}); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1454
1455
1456
1457
1458
			ch <- gin.H{"error": err.Error()}
		}
	}()

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

				c.JSON(http.StatusInternalServerError, gin.H{"error": msg})
				return
1474
			default:
Michael Yang's avatar
Michael Yang committed
1475
				c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected response"})
1476
				return
Bruce MacDonald's avatar
Bruce MacDonald committed
1477
1478
			}
		}
1479

Michael Yang's avatar
tools  
Michael Yang committed
1480
		resp.Message.Content = sb.String()
1481
1482
1483
1484
1485
1486

		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
1487
1488
1489
		}

		c.JSON(http.StatusOK, resp)
Bruce MacDonald's avatar
Bruce MacDonald committed
1490
1491
1492
1493
1494
		return
	}

	streamResponse(c, ch)
}
1495

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