routes.go 35.7 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
	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:
327
328
329
330
		if req.Input != nil {
			c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "invalid input type"})
			return
		}
331
332
333
334
335
336
337
338
	}

	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
	}

339
340
	checkpointLoaded := time.Now()

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

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

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

375
376
		count += len(tokens)

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

	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
		})
391
392
	}

393
394
395
396
	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
397
398
399
	}

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

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

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

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

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

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

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

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

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

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

500
501
502
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

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

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

513
514
515
	streamResponse(c, ch)
}

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

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

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

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

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

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

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

562
563
564
	streamResponse(c, ch)
}

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

	return nil
}

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

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

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

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

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

615
		sr = f
Michael Yang's avatar
Michael Yang committed
616
	}
Michael Yang's avatar
Michael Yang committed
617

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

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

631
632
633
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

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

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

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

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

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

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

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

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

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

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

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

	c.JSON(http.StatusOK, resp)
}

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

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

735
	if req.System != "" {
736
		m.System = req.System
737
738
	}

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

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

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

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

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

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

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

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

809
func getKVData(digest string, verbose bool) (llm.KV, error) {
810
811
812
813
814
	maxArraySize := 0
	if verbose {
		maxArraySize = -1
	}
	kvData, err := llm.LoadModel(digest, maxArraySize)
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
	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
832
func (s *Server) ListModelsHandler(c *gin.Context) {
833
	ms, err := Manifests()
Patrick Devine's avatar
Patrick Devine committed
834
835
836
837
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}
Michael Yang's avatar
Michael Yang committed
838

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

		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
855
		}
Michael Yang's avatar
Michael Yang committed
856

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

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

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

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

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

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

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

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

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

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

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

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

975
976
	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
977
978
979
		return
	}

Michael Yang's avatar
Michael Yang committed
980
	c.Status(http.StatusCreated)
Michael Yang's avatar
Michael Yang committed
981
982
}

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

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

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

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

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

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1026
	return false
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1027
}
1028

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

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

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

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

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

1059
1060
1061
1062
1063
1064
			c.Next()
			return
		}

		c.AbortWithStatus(http.StatusForbidden)
	}
1065
}
1066

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

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

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1084
1085
1086
	r.POST("/api/pull", s.PullModelHandler)
	r.POST("/api/generate", s.GenerateHandler)
	r.POST("/api/chat", s.ChatHandler)
1087
	r.POST("/api/embed", s.EmbedHandler)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1088
1089
1090
1091
1092
1093
1094
1095
	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)
1096
	r.GET("/api/ps", s.ProcessHandler)
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1097

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

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

1116
1117
1118
1119
	return r
}

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

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

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

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

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

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

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

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

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1201
	s.sched.Run(schedCtx)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1202
1203
1204

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

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

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

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

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

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

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

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

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

1302
1303
1304
		models = append(models, mr)
	}

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

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

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

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

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

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

1339
1340
	checkpointLoaded := time.Now()

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

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

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

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

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

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

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

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

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

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

		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
1428
1429
1430
		}

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

	streamResponse(c, ch)
}
1436

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