routes.go 35.6 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
	}

Michael Yang's avatar
Michael Yang committed
120
121
122
123
124
	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
125
126
127
		return
	}

Michael Yang's avatar
Michael Yang committed
128
	caps := []Capability{CapabilityCompletion}
129
130
131
132
	if req.Suffix != "" {
		caps = append(caps, CapabilityInsert)
	}

Michael Yang's avatar
Michael Yang committed
133
	r, m, opts, err := s.scheduleRunner(c.Request.Context(), req.Model, caps, req.Options, req.KeepAlive)
Michael Yang's avatar
Michael Yang committed
134
135
136
137
	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
138
139
140
141
		handleScheduleError(c, req.Model, err)
		return
	}

142
143
	checkpointLoaded := time.Now()

Michael Yang's avatar
Michael Yang committed
144
145
146
147
148
149
150
	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
151
152
		return
	}
Bruce MacDonald's avatar
Bruce MacDonald committed
153

Michael Yang's avatar
Michael Yang committed
154
155
156
157
	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
158

Michael Yang's avatar
Michael Yang committed
159
160
	prompt := req.Prompt
	if !req.Raw {
Michael Yang's avatar
Michael Yang committed
161
		tmpl := m.Template
Michael Yang's avatar
Michael Yang committed
162
163
164
165
166
167
168
169
		if req.Template != "" {
			tmpl, err = template.Parse(req.Template)
			if err != nil {
				c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
				return
			}
		}

170
171
172
173
174
175
176
177
178
179
180
181
		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
182
183
184
185
			if req.Context == nil {
				msgs = append(msgs, m.Messages...)
			}

186
187
188
189
190
191
192
			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
193
194
		var b bytes.Buffer
		if req.Context != nil {
195
			s, err := r.Detokenize(c.Request.Context(), req.Context)
Michael Yang's avatar
Michael Yang committed
196
197
198
199
			if err != nil {
				c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
				return
			}
200
			b.WriteString(s)
Michael Yang's avatar
Michael Yang committed
201
		}
202
203
204
205
206
207
208

		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
209
210
	}

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

Bruce MacDonald's avatar
Bruce MacDonald committed
213
214
	ch := make(chan any)
	go func() {
215
216
		// TODO (jmorganca): avoid building the response twice both here and below
		var sb strings.Builder
Bruce MacDonald's avatar
Bruce MacDonald committed
217
		defer close(ch)
Michael Yang's avatar
Michael Yang committed
218
		if err := r.Completion(c.Request.Context(), llm.CompletionRequest{
Michael Yang's avatar
Michael Yang committed
219
220
221
			Prompt:  prompt,
			Images:  images,
			Format:  req.Format,
Michael Yang's avatar
Michael Yang committed
222
			Options: opts,
223
224
		}, func(cr llm.CompletionResponse) {
			res := api.GenerateResponse{
225
226
				Model:      req.Model,
				CreatedAt:  time.Now().UTC(),
227
228
229
				Response:   cr.Content,
				Done:       cr.Done,
				DoneReason: cr.DoneReason,
Bruce MacDonald's avatar
Bruce MacDonald committed
230
				Metrics: api.Metrics{
231
232
233
234
					PromptEvalCount:    cr.PromptEvalCount,
					PromptEvalDuration: cr.PromptEvalDuration,
					EvalCount:          cr.EvalCount,
					EvalDuration:       cr.EvalDuration,
Bruce MacDonald's avatar
Bruce MacDonald committed
235
				},
Bruce MacDonald's avatar
Bruce MacDonald committed
236
			}
237
238
239
240
241
242
243
244
245
246

			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 {
247
					tokens, err := r.Tokenize(c.Request.Context(), prompt+sb.String())
248
249
250
251
					if err != nil {
						ch <- gin.H{"error": err.Error()}
						return
					}
252
					res.Context = tokens
253
254
255
256
				}
			}

			ch <- res
Michael Yang's avatar
Michael Yang committed
257
		}); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
258
259
260
261
262
			ch <- gin.H{"error": err.Error()}
		}
	}()

	if req.Stream != nil && !*req.Stream {
Michael Yang's avatar
Michael Yang committed
263
		var r api.GenerateResponse
Bruce MacDonald's avatar
Bruce MacDonald committed
264
		var sb strings.Builder
Michael Yang's avatar
Michael Yang committed
265
266
		for rr := range ch {
			switch t := rr.(type) {
267
			case api.GenerateResponse:
Michael Yang's avatar
Michael Yang committed
268
269
				sb.WriteString(t.Response)
				r = t
270
			case gin.H:
Michael Yang's avatar
Michael Yang committed
271
272
273
				msg, ok := t["error"].(string)
				if !ok {
					msg = "unexpected error format in response"
274
				}
Michael Yang's avatar
Michael Yang committed
275
276
277

				c.JSON(http.StatusInternalServerError, gin.H{"error": msg})
				return
278
			default:
Michael Yang's avatar
Michael Yang committed
279
				c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected response"})
Bruce MacDonald's avatar
Bruce MacDonald committed
280
281
282
				return
			}
		}
283

Michael Yang's avatar
Michael Yang committed
284
285
		r.Response = sb.String()
		c.JSON(http.StatusOK, r)
Bruce MacDonald's avatar
Bruce MacDonald committed
286
287
288
289
290
291
		return
	}

	streamResponse(c, ch)
}

292
func (s *Server) EmbedHandler(c *gin.Context) {
293
	checkpointStart := time.Now()
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
	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:
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "invalid input type"})
		return
	}

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

	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
	}

342
343
	checkpointLoaded := time.Now()

344
345
346
347
348
349
	kvData, err := getKVData(m.ModelPath, false)
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

350
	var count int
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
	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
			}
		}

373
374
		count += len(tokens)

375
376
		input[i] = s
	}
377
378
379
380
381
382
383
384
385
386
387
388

	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
		})
389
390
	}

391
392
393
394
	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
395
396
397
	}

	resp := api.EmbedResponse{
398
		Model:           req.Model,
399
		Embeddings:      embeddings,
400
401
		TotalDuration:   time.Since(checkpointStart),
		LoadDuration:    checkpointLoaded.Sub(checkpointStart),
402
		PromptEvalCount: count,
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
	}
	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
424
func (s *Server) EmbeddingsHandler(c *gin.Context) {
Bruce MacDonald's avatar
Bruce MacDonald committed
425
	var req api.EmbeddingRequest
Michael Yang's avatar
Michael Yang committed
426
	if err := c.ShouldBindJSON(&req); errors.Is(err, io.EOF) {
Bruce MacDonald's avatar
Bruce MacDonald committed
427
428
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
429
	} else if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
430
431
432
433
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

Michael Yang's avatar
Michael Yang committed
434
	r, _, _, err := s.scheduleRunner(c.Request.Context(), req.Model, []Capability{}, req.Options, req.KeepAlive)
Bruce MacDonald's avatar
Bruce MacDonald committed
435
	if err != nil {
Michael Yang's avatar
Michael Yang committed
436
		handleScheduleError(c, req.Model, err)
Bruce MacDonald's avatar
Bruce MacDonald committed
437
438
439
		return
	}

440
441
442
	// an empty request loads the model
	if req.Prompt == "" {
		c.JSON(http.StatusOK, api.EmbeddingResponse{Embedding: []float64{}})
Bruce MacDonald's avatar
Bruce MacDonald committed
443
444
445
		return
	}

446
	embedding, err := r.Embedding(c.Request.Context(), req.Prompt)
Bruce MacDonald's avatar
Bruce MacDonald committed
447
	if err != nil {
448
		slog.Info(fmt.Sprintf("embedding generation failed: %v", err))
Bruce MacDonald's avatar
Bruce MacDonald committed
449
450
451
452
		c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to generate embedding"})
		return
	}

453
454
455
	var e []float64
	for _, v := range embedding {
		e = append(e, float64(v))
456
457
458
	}

	resp := api.EmbeddingResponse{
459
		Embedding: e,
460
461
	}
	c.JSON(http.StatusOK, resp)
Bruce MacDonald's avatar
Bruce MacDonald committed
462
463
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
464
func (s *Server) PullModelHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
465
	var req api.PullRequest
Michael Yang's avatar
Michael Yang committed
466
467
468
469
470
471
472
	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
473
474
475
		return
	}

476
477
478
479
480
481
482
483
	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()})
484
485
486
		return
	}

487
488
489
	ch := make(chan any)
	go func() {
		defer close(ch)
490
491
		fn := func(r api.ProgressResponse) {
			ch <- r
492
		}
493

Michael Yang's avatar
Michael Yang committed
494
		regOpts := &registryOptions{
495
496
497
			Insecure: req.Insecure,
		}

498
499
500
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

501
		if err := PullModel(ctx, name.DisplayShortest(), regOpts, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
502
			ch <- gin.H{"error": err.Error()}
503
504
505
		}
	}()

506
507
508
509
510
	if req.Stream != nil && !*req.Stream {
		waitForStream(c, ch)
		return
	}

511
512
513
	streamResponse(c, ch)
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
514
func (s *Server) PushModelHandler(c *gin.Context) {
515
	var req api.PushRequest
Michael Yang's avatar
Michael Yang committed
516
517
518
519
520
521
522
	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
523
524
		return
	}
Michael Yang's avatar
Michael Yang committed
525

Michael Yang's avatar
Michael Yang committed
526
527
528
529
530
531
532
	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"})
533
534
535
		return
	}

536
537
538
	ch := make(chan any)
	go func() {
		defer close(ch)
539
540
		fn := func(r api.ProgressResponse) {
			ch <- r
541
		}
542

Michael Yang's avatar
Michael Yang committed
543
		regOpts := &registryOptions{
544
545
546
			Insecure: req.Insecure,
		}

Michael Yang's avatar
Michael Yang committed
547
548
549
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

Michael Yang's avatar
Michael Yang committed
550
		if err := PushModel(ctx, model, regOpts, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
551
			ch <- gin.H{"error": err.Error()}
552
553
554
		}
	}()

555
556
557
558
559
	if req.Stream != nil && !*req.Stream {
		waitForStream(c, ch)
		return
	}

560
561
562
	streamResponse(c, ch)
}

563
564
565
566
567
568
569
570
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
571
			return errors.New("a model with that name already exists")
572
573
574
575
576
577
		}
	}

	return nil
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
578
func (s *Server) CreateModelHandler(c *gin.Context) {
579
580
	var r api.CreateRequest
	if err := c.ShouldBindJSON(&r); errors.Is(err, io.EOF) {
Michael Yang's avatar
Michael Yang committed
581
582
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
583
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
584
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Michael Yang's avatar
Michael Yang committed
585
		return
586
587
	}

588
	name := model.ParseName(cmp.Or(r.Model, r.Name))
Michael Yang's avatar
Michael Yang committed
589
	if !name.IsValid() {
590
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": errtypes.InvalidModelNameErrMsg})
591
592
593
		return
	}

594
595
596
597
598
	if err := checkNameExists(name); err != nil {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

599
	if r.Path == "" && r.Modelfile == "" {
Michael Yang's avatar
Michael Yang committed
600
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "path or modelfile are required"})
Michael Yang's avatar
Michael Yang committed
601
602
		return
	}
Michael Yang's avatar
Michael Yang committed
603

604
605
606
	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
607
608
609
610
		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
611
		defer f.Close()
Michael Yang's avatar
Michael Yang committed
612

613
		sr = f
Michael Yang's avatar
Michael Yang committed
614
	}
Michael Yang's avatar
Michael Yang committed
615

616
	f, err := parser.ParseFile(sr)
Michael Yang's avatar
Michael Yang committed
617
618
619
620
621
	if err != nil {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

Michael Yang's avatar
Michael Yang committed
622
	ch := make(chan any)
Michael Yang's avatar
Michael Yang committed
623
624
	go func() {
		defer close(ch)
625
626
		fn := func(resp api.ProgressResponse) {
			ch <- resp
627
628
		}

629
630
631
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

632
		quantization := cmp.Or(r.Quantize, r.Quantization)
Josh's avatar
Josh committed
633
634
635
		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
636
			ch <- gin.H{"error": err.Error()}
637
		}
Michael Yang's avatar
Michael Yang committed
638
	}()
Michael Yang's avatar
Michael Yang committed
639

640
	if r.Stream != nil && !*r.Stream {
641
642
643
644
		waitForStream(c, ch)
		return
	}

Michael Yang's avatar
Michael Yang committed
645
	streamResponse(c, ch)
Bruce MacDonald's avatar
Bruce MacDonald committed
646
647
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
648
func (s *Server) DeleteModelHandler(c *gin.Context) {
649
650
	var r api.DeleteRequest
	if err := c.ShouldBindJSON(&r); errors.Is(err, io.EOF) {
Michael Yang's avatar
Michael Yang committed
651
652
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
653
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
654
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
655
656
657
		return
	}

658
659
660
	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))})
661
662
		return
	}
Michael Yang's avatar
Michael Yang committed
663

664
	m, err := ParseNamedManifest(n)
Michael Yang's avatar
Michael Yang committed
665
666
667
668
669
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

670
	if err := m.Remove(); err != nil {
Michael Yang's avatar
Michael Yang committed
671
672
673
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}
674
675
676
677
678

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

Daniel Hiltgen's avatar
Daniel Hiltgen committed
681
func (s *Server) ShowModelHandler(c *gin.Context) {
Patrick Devine's avatar
Patrick Devine committed
682
	var req api.ShowRequest
Michael Yang's avatar
Michael Yang committed
683
684
685
686
687
688
689
	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
690
691
692
		return
	}

Michael Yang's avatar
Michael Yang committed
693
	if req.Model != "" {
Michael Yang's avatar
Michael Yang committed
694
		// noop
Michael Yang's avatar
Michael Yang committed
695
	} else if req.Name != "" {
Michael Yang's avatar
Michael Yang committed
696
		req.Model = req.Name
Michael Yang's avatar
Michael Yang committed
697
	} else {
698
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
699
700
701
		return
	}

702
	resp, err := GetModelInfo(req)
Patrick Devine's avatar
Patrick Devine committed
703
	if err != nil {
704
705
		switch {
		case os.IsNotExist(err):
Michael Yang's avatar
Michael Yang committed
706
			c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found", req.Model)})
707
708
709
		case err.Error() == "invalid model name":
			c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		default:
Patrick Devine's avatar
Patrick Devine committed
710
711
712
713
714
715
716
717
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		}
		return
	}

	c.JSON(http.StatusOK, resp)
}

718
func GetModelInfo(req api.ShowRequest) (*api.ShowResponse, error) {
719
	m, err := GetModel(req.Model)
Patrick Devine's avatar
Patrick Devine committed
720
721
722
723
	if err != nil {
		return nil, err
	}

Patrick Devine's avatar
Patrick Devine committed
724
	modelDetails := api.ModelDetails{
725
726
727
728
729
730
		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
731
732
	}

733
	if req.System != "" {
734
		m.System = req.System
735
736
	}

Michael Yang's avatar
Michael Yang committed
737
738
739
	msgs := make([]api.Message, len(m.Messages))
	for i, msg := range m.Messages {
		msgs[i] = api.Message{Role: msg.Role, Content: msg.Content}
740
741
	}

742
743
	n := model.ParseName(req.Model)
	if !n.IsValid() {
Michael Yang's avatar
lint  
Michael Yang committed
744
		return nil, errors.New("invalid model name")
745
746
747
748
749
750
751
	}

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

Patrick Devine's avatar
Patrick Devine committed
752
	resp := &api.ShowResponse{
753
754
		License:    strings.Join(m.License, "\n"),
		System:     m.System,
Michael Yang's avatar
Michael Yang committed
755
		Template:   m.Template.String(),
756
757
758
		Details:    modelDetails,
		Messages:   msgs,
		ModifiedAt: manifest.fi.ModTime(),
Patrick Devine's avatar
Patrick Devine committed
759
760
761
762
	}

	var params []string
	cs := 30
763
	for k, v := range m.Options {
Patrick Devine's avatar
Patrick Devine committed
764
765
766
		switch val := v.(type) {
		case []interface{}:
			for _, nv := range val {
Patrick Devine's avatar
Patrick Devine committed
767
				params = append(params, fmt.Sprintf("%-*s %#v", cs, k, nv))
Patrick Devine's avatar
Patrick Devine committed
768
			}
Patrick Devine's avatar
Patrick Devine committed
769
770
		default:
			params = append(params, fmt.Sprintf("%-*s %#v", cs, k, v))
Patrick Devine's avatar
Patrick Devine committed
771
772
773
774
		}
	}
	resp.Parameters = strings.Join(params, "\n")

775
776
	for k, v := range req.Options {
		if _, ok := req.Options[k]; ok {
777
			m.Options[k] = v
778
779
780
		}
	}

781
	var sb strings.Builder
782
	fmt.Fprintln(&sb, "# Modelfile generated by \"ollama show\"")
783
	fmt.Fprintln(&sb, "# To build a new Modelfile based on this, replace FROM with:")
784
785
	fmt.Fprintf(&sb, "# FROM %s\n\n", m.ShortName)
	fmt.Fprint(&sb, m.String())
786
	resp.Modelfile = sb.String()
787

788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
	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
804
805
806
	return resp, nil
}

807
func getKVData(digest string, verbose bool) (llm.KV, error) {
808
809
810
811
812
	maxArraySize := 0
	if verbose {
		maxArraySize = -1
	}
	kvData, err := llm.LoadModel(digest, maxArraySize)
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
	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
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
830
func (s *Server) ListModelsHandler(c *gin.Context) {
831
	ms, err := Manifests()
Patrick Devine's avatar
Patrick Devine committed
832
833
834
835
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}
Michael Yang's avatar
Michael Yang committed
836

837
	models := []api.ListModelResponse{}
838
839
	for n, m := range ms {
		var cf ConfigV2
840
841
842
843
844
845
846
847
848
849
850
851
852

		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
853
		}
Michael Yang's avatar
Michael Yang committed
854

855
		// tag should never be masked
856
		models = append(models, api.ListModelResponse{
857
858
859
860
861
862
863
864
865
866
867
868
869
			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
870
871
	}

872
	slices.SortStableFunc(models, func(i, j api.ListModelResponse) int {
873
874
875
876
		// most recently modified first
		return cmp.Compare(j.ModifiedAt.Unix(), i.ModifiedAt.Unix())
	})

Michael Yang's avatar
Michael Yang committed
877
	c.JSON(http.StatusOK, api.ListResponse{Models: models})
Patrick Devine's avatar
Patrick Devine committed
878
879
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
880
func (s *Server) CopyModelHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
881
882
	var r api.CopyRequest
	if err := c.ShouldBindJSON(&r); errors.Is(err, io.EOF) {
Michael Yang's avatar
Michael Yang committed
883
884
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
885
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
886
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Patrick Devine's avatar
Patrick Devine committed
887
888
889
		return
	}

Michael Yang's avatar
Michael Yang committed
890
891
	src := model.ParseName(r.Source)
	if !src.IsValid() {
Michael Yang's avatar
Michael Yang committed
892
893
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("source %q is invalid", r.Source)})
		return
894
895
	}

Michael Yang's avatar
Michael Yang committed
896
897
	dst := model.ParseName(r.Destination)
	if !dst.IsValid() {
898
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("destination %q is invalid", r.Destination)})
Patrick Devine's avatar
Patrick Devine committed
899
900
		return
	}
Michael Yang's avatar
Michael Yang committed
901

902
903
904
905
906
	if err := checkNameExists(dst); err != nil {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

Michael Yang's avatar
Michael Yang committed
907
908
909
910
911
	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
912
913
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
914
func (s *Server) HeadBlobHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
915
916
917
918
919
920
921
922
923
924
925
	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
926
	c.Status(http.StatusOK)
Michael Yang's avatar
Michael Yang committed
927
928
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
929
func (s *Server) CreateBlobHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
930
931
	if ib, ok := intermediateBlobs[c.Param("digest")]; ok {
		p, err := GetBlobsPath(ib)
932
933
934
935
936
937
		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
938
939
			slog.Info("evicting intermediate blob which no longer exists", "digest", ib)
			delete(intermediateBlobs, c.Param("digest"))
940
941
942
943
944
945
946
947
948
		} else if err != nil {
			c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
			return
		} else {
			c.Status(http.StatusOK)
			return
		}
	}

949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
	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
	}

967
	layer, err := NewLayer(c.Request.Body, "")
Michael Yang's avatar
Michael Yang committed
968
969
970
971
972
	if err != nil {
		c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

973
974
	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
975
976
977
		return
	}

Michael Yang's avatar
Michael Yang committed
978
	c.Status(http.StatusCreated)
Michael Yang's avatar
Michael Yang committed
979
980
}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
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
}

1002
func allowedHost(host string) bool {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1003
	if host == "" || host == "localhost" {
1004
1005
1006
1007
1008
1009
1010
		return true
	}

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

Michael Yang's avatar
lint  
Michael Yang committed
1011
	tlds := []string{
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1012
1013
1014
		"localhost",
		"local",
		"internal",
1015
	}
1016

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1017
	// check if the host is a local TLD
1018
1019
1020
1021
1022
1023
	for _, tld := range tlds {
		if strings.HasSuffix(host, "."+tld) {
			return true
		}
	}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1024
	return false
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1025
}
1026

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1027
1028
1029
func allowedHostsMiddleware(addr net.Addr) gin.HandlerFunc {
	return func(c *gin.Context) {
		if addr == nil {
1030
1031
1032
1033
			c.Next()
			return
		}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1034
		if addr, err := netip.ParseAddrPort(addr.String()); err == nil && !addr.Addr().IsLoopback() {
1035
1036
1037
1038
1039
1040
1041
1042
1043
			c.Next()
			return
		}

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

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1044
		if addr, err := netip.ParseAddr(host); err == nil {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1045
			if addr.IsLoopback() || addr.IsPrivate() || addr.IsUnspecified() || isLocalIP(addr) {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1046
1047
1048
1049
1050
				c.Next()
				return
			}
		}

1051
		if allowedHost(host) {
Michael Yang's avatar
lint  
Michael Yang committed
1052
			if c.Request.Method == http.MethodOptions {
1053
1054
1055
1056
				c.AbortWithStatus(http.StatusNoContent)
				return
			}

1057
1058
1059
1060
1061
1062
			c.Next()
			return
		}

		c.AbortWithStatus(http.StatusForbidden)
	}
1063
}
1064

1065
func (s *Server) GenerateRoutes() http.Handler {
Michael Yang's avatar
Michael Yang committed
1066
1067
	config := cors.DefaultConfig()
	config.AllowWildcard = true
1068
	config.AllowBrowserExtensions = true
1069
	config.AllowHeaders = []string{"Authorization", "Content-Type", "User-Agent", "Accept", "X-Requested-With"}
royjhan's avatar
royjhan committed
1070
1071
1072
1073
	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
1074
	config.AllowOrigins = envconfig.Origins()
Michael Yang's avatar
Michael Yang committed
1075

Bruce MacDonald's avatar
Bruce MacDonald committed
1076
	r := gin.Default()
1077
1078
	r.Use(
		cors.New(config),
1079
		allowedHostsMiddleware(s.addr),
1080
	)
Bruce MacDonald's avatar
Bruce MacDonald committed
1081

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1082
1083
1084
	r.POST("/api/pull", s.PullModelHandler)
	r.POST("/api/generate", s.GenerateHandler)
	r.POST("/api/chat", s.ChatHandler)
1085
	r.POST("/api/embed", s.EmbedHandler)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1086
1087
1088
1089
1090
1091
1092
1093
	r.POST("/api/embeddings", s.EmbeddingsHandler)
	r.POST("/api/create", s.CreateModelHandler)
	r.POST("/api/push", s.PushModelHandler)
	r.POST("/api/copy", s.CopyModelHandler)
	r.DELETE("/api/delete", s.DeleteModelHandler)
	r.POST("/api/show", s.ShowModelHandler)
	r.POST("/api/blobs/:digest", s.CreateBlobHandler)
	r.HEAD("/api/blobs/:digest", s.HeadBlobHandler)
1094
	r.GET("/api/ps", s.ProcessHandler)
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1095

1096
	// Compatibility endpoints
1097
	r.POST("/v1/chat/completions", openai.ChatMiddleware(), s.ChatHandler)
1098
	r.POST("/v1/completions", openai.CompletionsMiddleware(), s.GenerateHandler)
1099
	r.POST("/v1/embeddings", openai.EmbeddingsMiddleware(), s.EmbedHandler)
1100
1101
	r.GET("/v1/models", openai.ListMiddleware(), s.ListModelsHandler)
	r.GET("/v1/models/:model", openai.RetrieveMiddleware(), s.ShowModelHandler)
1102

Michael Yang's avatar
Michael Yang committed
1103
1104
1105
1106
1107
	for _, method := range []string{http.MethodGet, http.MethodHead} {
		r.Handle(method, "/", func(c *gin.Context) {
			c.String(http.StatusOK, "Ollama is running")
		})

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1108
		r.Handle(method, "/api/tags", s.ListModelsHandler)
Michael Yang's avatar
Michael Yang committed
1109
1110
1111
		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
1112
1113
	}

1114
1115
1116
1117
	return r
}

func Serve(ln net.Listener) error {
Michael Yang's avatar
Michael Yang committed
1118
	level := slog.LevelInfo
Michael Yang's avatar
Michael Yang committed
1119
	if envconfig.Debug() {
Michael Yang's avatar
Michael Yang committed
1120
		level = slog.LevelDebug
1121
	}
Michael Yang's avatar
Michael Yang committed
1122

1123
	slog.Info("server config", "env", envconfig.Values())
Michael Yang's avatar
Michael Yang committed
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
	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))

1139
1140
1141
1142
1143
1144
1145
1146
	blobsDir, err := GetBlobsPath("")
	if err != nil {
		return err
	}
	if err := fixBlobs(blobsDir); err != nil {
		return err
	}

Michael Yang's avatar
bool  
Michael Yang committed
1147
	if !envconfig.NoPrune() {
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
		// 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
1163
	ctx, done := context.WithCancel(context.Background())
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1164
1165
	schedCtx, schedDone := context.WithCancel(ctx)
	sched := InitScheduler(schedCtx)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1166
	s := &Server{addr: ln.Addr(), sched: sched}
1167
1168

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

1170
	slog.Info(fmt.Sprintf("Listening on %s (version %s)", ln.Addr(), version.Version))
1171
	srvr := &http.Server{
1172
1173
1174
1175
1176
1177
1178
1179
1180
		// 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
1181
1182
	}

1183
1184
	// listen for a ctrl+c and stop any loaded llm
	signals := make(chan os.Signal, 1)
1185
	signal.Notify(signals, syscall.SIGINT, syscall.SIGTERM)
1186
1187
	go func() {
		<-signals
1188
		srvr.Close()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1189
		schedDone()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1190
		sched.unloadAllRunners()
1191
		gpu.Cleanup()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1192
		done()
1193
1194
	}()

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1195
	if err := llm.Init(); err != nil {
1196
1197
		return fmt.Errorf("unable to initialize llm library %w", err)
	}
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1198

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1199
	s.sched.Run(schedCtx)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1200
1201
1202

	// 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
1203
1204
	gpus := gpu.GetGPUInfo()
	gpus.LogDetails()
1205

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1206
1207
1208
1209
1210
1211
1212
	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()
1213
	return nil
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1214
}
Michael Yang's avatar
Michael Yang committed
1215

1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
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
1226
1227
1228
1229
			status, ok := r["status"].(int)
			if !ok {
				status = http.StatusInternalServerError
			}
1230
			if errorMsg, ok := r["error"].(string); ok {
Josh's avatar
Josh committed
1231
				c.JSON(status, gin.H{"error": errorMsg})
1232
1233
				return
			} else {
Josh's avatar
Josh committed
1234
				c.JSON(status, gin.H{"error": "unexpected error format in progress response"})
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
				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
1245
func streamResponse(c *gin.Context, ch chan any) {
1246
	c.Header("Content-Type", "application/x-ndjson")
Michael Yang's avatar
Michael Yang committed
1247
1248
1249
1250
1251
1252
1253
1254
	c.Stream(func(w io.Writer) bool {
		val, ok := <-ch
		if !ok {
			return false
		}

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

1259
		// Delineate chunks with new-line delimiter
Michael Yang's avatar
Michael Yang committed
1260
1261
		bts = append(bts, '\n')
		if _, err := w.Write(bts); err != nil {
1262
			slog.Info(fmt.Sprintf("streamResponse: w.Write failed with %s", err))
Michael Yang's avatar
Michael Yang committed
1263
1264
1265
1266
1267
1268
			return false
		}

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

1270
func (s *Server) ProcessHandler(c *gin.Context) {
1271
	models := []api.ProcessModelResponse{}
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282

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

1283
		mr := api.ProcessModelResponse{
1284
1285
1286
1287
1288
1289
1290
1291
			Model:     model.ShortName,
			Name:      model.ShortName,
			Size:      int64(v.estimatedTotal),
			SizeVRAM:  int64(v.estimatedVRAM),
			Digest:    model.Digest,
			Details:   modelDetails,
			ExpiresAt: v.expiresAt,
		}
1292
1293
1294
1295
1296
1297
1298
1299
		// 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)
		}

1300
1301
1302
		models = append(models, mr)
	}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1303
1304
1305
1306
1307
	slices.SortStableFunc(models, func(i, j api.ProcessModelResponse) int {
		// longest duration remaining listed first
		return cmp.Compare(j.ExpiresAt.Unix(), i.ExpiresAt.Unix())
	})

1308
	c.JSON(http.StatusOK, api.ProcessResponse{Models: models})
1309
1310
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1311
func (s *Server) ChatHandler(c *gin.Context) {
1312
1313
	checkpointStart := time.Now()

Bruce MacDonald's avatar
Bruce MacDonald committed
1314
	var req api.ChatRequest
Michael Yang's avatar
Michael Yang committed
1315
	if err := c.ShouldBindJSON(&req); errors.Is(err, io.EOF) {
Bruce MacDonald's avatar
Bruce MacDonald committed
1316
1317
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
1318
	} else if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1319
1320
1321
1322
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

Michael Yang's avatar
Michael Yang committed
1323
	caps := []Capability{CapabilityCompletion}
1324
	if len(req.Tools) > 0 {
Michael Yang's avatar
tools  
Michael Yang committed
1325
1326
1327
		caps = append(caps, CapabilityTools)
	}

Michael Yang's avatar
Michael Yang committed
1328
	r, m, opts, err := s.scheduleRunner(c.Request.Context(), req.Model, caps, req.Options, req.KeepAlive)
Michael Yang's avatar
Michael Yang committed
1329
1330
	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
1331
		return
Michael Yang's avatar
Michael Yang committed
1332
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
1333
		handleScheduleError(c, req.Model, err)
Bruce MacDonald's avatar
Bruce MacDonald committed
1334
1335
		return
	}
Michael Yang's avatar
Michael Yang committed
1336

1337
1338
	checkpointLoaded := time.Now()

Michael Yang's avatar
Michael Yang committed
1339
1340
	if len(req.Messages) == 0 {
		c.JSON(http.StatusOK, api.ChatResponse{
1341
			Model:      req.Model,
Michael Yang's avatar
Michael Yang committed
1342
1343
			CreatedAt:  time.Now().UTC(),
			Message:    api.Message{Role: "assistant"},
1344
1345
			Done:       true,
			DoneReason: "load",
Michael Yang's avatar
Michael Yang committed
1346
		})
1347
1348
1349
		return
	}

Michael Yang's avatar
Michael Yang committed
1350
	msgs := append(m.Messages, req.Messages...)
1351
	if req.Messages[0].Role != "system" && m.System != "" {
Michael Yang's avatar
Michael Yang committed
1352
		msgs = append([]api.Message{{Role: "system", Content: m.System}}, msgs...)
1353
1354
	}

Michael Yang's avatar
Michael Yang committed
1355
	prompt, images, err := chatPrompt(c.Request.Context(), m, r.Tokenize, opts, msgs, req.Tools)
Michael Yang's avatar
Michael Yang committed
1356
1357
1358
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
1359
1360
	}

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

Bruce MacDonald's avatar
Bruce MacDonald committed
1363
1364
1365
	ch := make(chan any)
	go func() {
		defer close(ch)
Michael Yang's avatar
Michael Yang committed
1366
		if err := r.Completion(c.Request.Context(), llm.CompletionRequest{
Michael Yang's avatar
Michael Yang committed
1367
1368
1369
			Prompt:  prompt,
			Images:  images,
			Format:  req.Format,
Michael Yang's avatar
Michael Yang committed
1370
			Options: opts,
Michael Yang's avatar
Michael Yang committed
1371
		}, func(r llm.CompletionResponse) {
1372
			res := api.ChatResponse{
1373
1374
1375
1376
1377
				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
1378
1379
1380
1381
1382
1383
1384
				Metrics: api.Metrics{
					PromptEvalCount:    r.PromptEvalCount,
					PromptEvalDuration: r.PromptEvalDuration,
					EvalCount:          r.EvalCount,
					EvalDuration:       r.EvalDuration,
				},
			}
1385
1386
1387
1388
1389
1390
1391

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

			ch <- res
Michael Yang's avatar
Michael Yang committed
1392
		}); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1393
1394
1395
1396
1397
			ch <- gin.H{"error": err.Error()}
		}
	}()

	if req.Stream != nil && !*req.Stream {
Michael Yang's avatar
tools  
Michael Yang committed
1398
		var resp api.ChatResponse
Bruce MacDonald's avatar
Bruce MacDonald committed
1399
		var sb strings.Builder
Michael Yang's avatar
Michael Yang committed
1400
1401
		for rr := range ch {
			switch t := rr.(type) {
1402
			case api.ChatResponse:
Michael Yang's avatar
Michael Yang committed
1403
				sb.WriteString(t.Message.Content)
Michael Yang's avatar
tools  
Michael Yang committed
1404
				resp = t
1405
			case gin.H:
Michael Yang's avatar
Michael Yang committed
1406
1407
1408
				msg, ok := t["error"].(string)
				if !ok {
					msg = "unexpected error format in response"
1409
				}
Michael Yang's avatar
Michael Yang committed
1410
1411
1412

				c.JSON(http.StatusInternalServerError, gin.H{"error": msg})
				return
1413
			default:
Michael Yang's avatar
Michael Yang committed
1414
				c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected response"})
1415
				return
Bruce MacDonald's avatar
Bruce MacDonald committed
1416
1417
			}
		}
1418

Michael Yang's avatar
tools  
Michael Yang committed
1419
		resp.Message.Content = sb.String()
1420
1421
1422
1423
1424
1425

		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
1426
1427
1428
		}

		c.JSON(http.StatusOK, resp)
Bruce MacDonald's avatar
Bruce MacDonald committed
1429
1430
1431
1432
1433
		return
	}

	streamResponse(c, ch)
}
1434

Michael Yang's avatar
Michael Yang committed
1435
func handleScheduleError(c *gin.Context, name string, err error) {
Michael Yang's avatar
Michael Yang committed
1436
	switch {
1437
	case errors.Is(err, errCapabilities), errors.Is(err, errRequired):
Michael Yang's avatar
Michael Yang committed
1438
		c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Michael Yang's avatar
Michael Yang committed
1439
	case errors.Is(err, context.Canceled):
1440
		c.JSON(499, gin.H{"error": "request canceled"})
Michael Yang's avatar
Michael Yang committed
1441
	case errors.Is(err, ErrMaxQueue):
1442
		c.JSON(http.StatusServiceUnavailable, gin.H{"error": err.Error()})
Michael Yang's avatar
Michael Yang committed
1443
1444
	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
1445
1446
	default:
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
1447
1448
	}
}