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
	"cmp"
5
	"context"
Michael Yang's avatar
Michael Yang committed
6
	"encoding/json"
7
	"errors"
8
	"fmt"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
9
	"io"
10
	"io/fs"
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"
20
	"strconv"
Michael Yang's avatar
Michael Yang committed
21
	"strings"
22
	"syscall"
23
	"time"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
24

Michael Yang's avatar
Michael Yang committed
25
	"github.com/gin-contrib/cors"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
26
27
	"github.com/gin-gonic/gin"

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

59
60
var defaultSessionDuration = 5 * time.Minute

61
62
63
64
65
66
67
68
69
70
71
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
72
73
}

74
75
76
77
78
79
func isSupportedImageType(image []byte) bool {
	contentType := http.DetectContentType(image)
	allowedTypes := []string{"image/jpeg", "image/jpg", "image/png"}
	return slices.Contains(allowedTypes, contentType)
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
80
func (s *Server) GenerateHandler(c *gin.Context) {
Bruce MacDonald's avatar
Bruce MacDonald committed
81
82
	checkpointStart := time.Now()
	var req api.GenerateRequest
Michael Yang's avatar
Michael Yang committed
83
	err := c.ShouldBindJSON(&req)
Patrick Devine's avatar
Patrick Devine committed
84

Michael Yang's avatar
Michael Yang committed
85
86
87
88
89
90
	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()})
Bruce MacDonald's avatar
Bruce MacDonald committed
91
92
93
		return
	}

94
95
96
	// validate the request
	switch {
	case req.Model == "":
97
98
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
		return
99
100
101
	case len(req.Format) > 0 && req.Format != "json":
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "format must be json"})
		return
102
103
104
	case 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"})
		return
105
106
	}

107
108
109
110
111
112
113
	for _, img := range req.Images {
		if !isSupportedImageType(img) {
			c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "unsupported image format"})
			return
		}
	}

114
	model, err := GetModel(req.Model)
Bruce MacDonald's avatar
Bruce MacDonald committed
115
	if err != nil {
116
		var pErr *fs.PathError
117
		if errors.As(err, &pErr) {
118
			c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found, try pulling it first", req.Model)})
119
120
121
122
123
124
			return
		}
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

Michael Yang's avatar
Michael Yang committed
125
126
	if !model.Has(CapabilityCompletion) {
		c.JSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("%s does not support generate", req.Model)})
127
128
129
		return
	}

130
131
132
133
134
135
	opts, err := modelOptions(model, req.Options)
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

136
137
	var sessionDuration time.Duration
	if req.KeepAlive == nil {
138
		sessionDuration = getDefaultSessionDuration()
139
140
141
142
	} else {
		sessionDuration = req.KeepAlive.Duration
	}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
143
144
145
146
147
	rCh, eCh := s.sched.GetRunner(c.Request.Context(), model, opts, sessionDuration)
	var runner *runnerRef
	select {
	case runner = <-rCh:
	case err = <-eCh:
148
		handleErrorResponse(c, err)
Bruce MacDonald's avatar
Bruce MacDonald committed
149
150
151
		return
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
152
	// an empty request loads the model
153
154
	// note: for a short while template was used in lieu
	// of `raw` mode so we need to check for it too
Bruce MacDonald's avatar
Bruce MacDonald committed
155
	if req.Prompt == "" && req.Template == "" && req.System == "" {
156
		c.JSON(http.StatusOK, api.GenerateResponse{
157
158
159
160
			CreatedAt:  time.Now().UTC(),
			Model:      req.Model,
			Done:       true,
			DoneReason: "load",
Michael Yang's avatar
Michael Yang committed
161
		})
Bruce MacDonald's avatar
Bruce MacDonald committed
162
163
164
		return
	}

Michael Yang's avatar
Michael Yang committed
165
166
167
168
169
170
	tmpl, err := template.Parse(req.Template)
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
171
172
	checkpointLoaded := time.Now()

Bruce MacDonald's avatar
Bruce MacDonald committed
173
174
175
176
177
	var prompt string
	switch {
	case req.Raw:
		prompt = req.Prompt
	case req.Prompt != "":
178
		if req.Template == "" {
Michael Yang's avatar
Michael Yang committed
179
			tmpl = model.Template
Bruce MacDonald's avatar
Bruce MacDonald committed
180
181
		}

182
183
184
185
186
187
188
189
190
		if req.System == "" {
			req.System = model.System
		}

		slog.Debug("generate handler", "prompt", req.Prompt)
		slog.Debug("generate handler", "template", req.Template)
		slog.Debug("generate handler", "system", req.System)

		var sb strings.Builder
Michael Yang's avatar
Michael Yang committed
191
192
193
194
195
196
		for i := range req.Images {
			fmt.Fprintf(&sb, "[img-%d] ", i)
		}

		sb.WriteString(req.Prompt)

Michael Yang's avatar
Michael Yang committed
197
		p, err := Prompt(tmpl, req.System, sb.String(), "", true)
Michael Yang's avatar
Michael Yang committed
198
199
200
201
202
203
		if err != nil {
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
			return
		}

		sb.Reset()
Bruce MacDonald's avatar
Bruce MacDonald committed
204
		if req.Context != nil {
Daniel Hiltgen's avatar
Daniel Hiltgen committed
205
			prev, err := runner.llama.Detokenize(c.Request.Context(), req.Context)
Bruce MacDonald's avatar
Bruce MacDonald committed
206
207
208
209
210
			if err != nil {
				c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
				return
			}

211
			sb.WriteString(prev)
212
213
		}

214
215
216
		sb.WriteString(p)

		prompt = sb.String()
Bruce MacDonald's avatar
Bruce MacDonald committed
217
218
	}

Michael Yang's avatar
Michael Yang committed
219
	slog.Debug("generate handler", "prompt", prompt)
220

Bruce MacDonald's avatar
Bruce MacDonald committed
221
	ch := make(chan any)
Bruce MacDonald's avatar
Bruce MacDonald committed
222
	var generated strings.Builder
Bruce MacDonald's avatar
Bruce MacDonald committed
223
224
225
	go func() {
		defer close(ch)

226
		fn := func(r llm.CompletionResponse) {
Bruce MacDonald's avatar
Bruce MacDonald committed
227
228
229
230
			// Build up the full response
			if _, err := generated.WriteString(r.Content); err != nil {
				ch <- gin.H{"error": err.Error()}
				return
Bruce MacDonald's avatar
Bruce MacDonald committed
231
232
			}

Bruce MacDonald's avatar
Bruce MacDonald committed
233
			resp := api.GenerateResponse{
234
235
236
237
238
				Model:      req.Model,
				CreatedAt:  time.Now().UTC(),
				Done:       r.Done,
				Response:   r.Content,
				DoneReason: r.DoneReason,
Bruce MacDonald's avatar
Bruce MacDonald committed
239
240
241
242
243
244
				Metrics: api.Metrics{
					PromptEvalCount:    r.PromptEvalCount,
					PromptEvalDuration: r.PromptEvalDuration,
					EvalCount:          r.EvalCount,
					EvalDuration:       r.EvalDuration,
				},
Bruce MacDonald's avatar
Bruce MacDonald committed
245
246
			}

247
248
249
250
251
			if r.Done {
				resp.TotalDuration = time.Since(checkpointStart)
				resp.LoadDuration = checkpointLoaded.Sub(checkpointStart)

				if !req.Raw {
Michael Yang's avatar
Michael Yang committed
252
					p, err := Prompt(tmpl, req.System, req.Prompt, generated.String(), false)
253
					if err != nil {
254
						c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
255
256
						return
					}
257
258

					// TODO (jmorganca): encode() should not strip special tokens
Daniel Hiltgen's avatar
Daniel Hiltgen committed
259
					tokens, err := runner.llama.Tokenize(c.Request.Context(), p)
260
261
262
263
					if err != nil {
						ch <- gin.H{"error": err.Error()}
						return
					}
264
265

					resp.Context = append(req.Context, tokens...)
Bruce MacDonald's avatar
Bruce MacDonald committed
266
267
268
269
				}
			}

			ch <- resp
Bruce MacDonald's avatar
Bruce MacDonald committed
270
271
		}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
272
		var images []llm.ImageData
Michael Yang's avatar
Michael Yang committed
273
		for i := range req.Images {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
274
275
276
277
			images = append(images, llm.ImageData{
				ID:   i,
				Data: req.Images[i],
			})
Michael Yang's avatar
Michael Yang committed
278
279
		}

Bruce MacDonald's avatar
Bruce MacDonald committed
280
		// Start prediction
281
		req := llm.CompletionRequest{
282
283
			Prompt:  prompt,
			Format:  req.Format,
Michael Yang's avatar
Michael Yang committed
284
			Images:  images,
285
			Options: opts,
Bruce MacDonald's avatar
Bruce MacDonald committed
286
		}
Daniel Hiltgen's avatar
Daniel Hiltgen committed
287
		if err := runner.llama.Completion(c.Request.Context(), req, fn); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
288
289
290
291
292
			ch <- gin.H{"error": err.Error()}
		}
	}()

	if req.Stream != nil && !*req.Stream {
293
294
		// Accumulate responses into the final response
		var final api.GenerateResponse
Bruce MacDonald's avatar
Bruce MacDonald committed
295
		var sb strings.Builder
Bruce MacDonald's avatar
Bruce MacDonald committed
296
		for resp := range ch {
297
298
299
300
301
302
303
304
305
306
307
308
309
310
			switch r := resp.(type) {
			case api.GenerateResponse:
				sb.WriteString(r.Response)
				final = r
			case gin.H:
				if errorMsg, ok := r["error"].(string); ok {
					c.JSON(http.StatusInternalServerError, gin.H{"error": errorMsg})
					return
				} else {
					c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected error format in response"})
					return
				}
			default:
				c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected error"})
Bruce MacDonald's avatar
Bruce MacDonald committed
311
312
313
				return
			}
		}
314
315
316

		final.Response = sb.String()
		c.JSON(http.StatusOK, final)
Bruce MacDonald's avatar
Bruce MacDonald committed
317
318
319
320
321
322
		return
	}

	streamResponse(c, ch)
}

323
func getDefaultSessionDuration() time.Duration {
324
325
	if envconfig.KeepAlive != "" {
		v, err := strconv.Atoi(envconfig.KeepAlive)
326
		if err != nil {
327
			d, err := time.ParseDuration(envconfig.KeepAlive)
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
			if err != nil {
				return defaultSessionDuration
			}

			if d < 0 {
				return time.Duration(math.MaxInt64)
			}

			return d
		}

		d := time.Duration(v) * time.Second
		if d < 0 {
			return time.Duration(math.MaxInt64)
		}
		return d
	}

	return defaultSessionDuration
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
349
func (s *Server) EmbeddingsHandler(c *gin.Context) {
Bruce MacDonald's avatar
Bruce MacDonald committed
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
	var req api.EmbeddingRequest
	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
	}

	if req.Model == "" {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
		return
	}

366
	model, err := GetModel(req.Model)
Bruce MacDonald's avatar
Bruce MacDonald committed
367
	if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
368
		var pErr *fs.PathError
369
		if errors.As(err, &pErr) {
Bruce MacDonald's avatar
Bruce MacDonald committed
370
			c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found, try pulling it first", req.Model)})
371
372
373
374
375
376
377
378
379
380
381
			return
		}
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

	opts, err := modelOptions(model, req.Options)
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}
382
383
384

	var sessionDuration time.Duration
	if req.KeepAlive == nil {
385
		sessionDuration = getDefaultSessionDuration()
386
387
388
389
	} else {
		sessionDuration = req.KeepAlive.Duration
	}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
390
391
392
393
394
	rCh, eCh := s.sched.GetRunner(c.Request.Context(), model, opts, sessionDuration)
	var runner *runnerRef
	select {
	case runner = <-rCh:
	case err = <-eCh:
395
		handleErrorResponse(c, err)
Bruce MacDonald's avatar
Bruce MacDonald committed
396
397
398
		return
	}

399
400
401
	// an empty request loads the model
	if req.Prompt == "" {
		c.JSON(http.StatusOK, api.EmbeddingResponse{Embedding: []float64{}})
Bruce MacDonald's avatar
Bruce MacDonald committed
402
403
404
		return
	}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
405
	embedding, err := runner.llama.Embedding(c.Request.Context(), req.Prompt)
Bruce MacDonald's avatar
Bruce MacDonald committed
406
	if err != nil {
407
		slog.Info(fmt.Sprintf("embedding generation failed: %v", err))
Bruce MacDonald's avatar
Bruce MacDonald committed
408
409
410
411
412
413
414
415
416
417
		c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to generate embedding"})
		return
	}

	resp := api.EmbeddingResponse{
		Embedding: embedding,
	}
	c.JSON(http.StatusOK, resp)
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
418
func (s *Server) PullModelHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
419
	var req api.PullRequest
Michael Yang's avatar
Michael Yang committed
420
421
422
423
424
425
426
	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
427
428
429
		return
	}

430
431
432
433
434
435
436
437
	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()})
438
439
440
		return
	}

441
442
443
	ch := make(chan any)
	go func() {
		defer close(ch)
444
445
		fn := func(r api.ProgressResponse) {
			ch <- r
446
		}
447

Michael Yang's avatar
Michael Yang committed
448
		regOpts := &registryOptions{
449
450
451
			Insecure: req.Insecure,
		}

452
453
454
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

455
		if err := PullModel(ctx, name.DisplayShortest(), regOpts, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
456
			ch <- gin.H{"error": err.Error()}
457
458
459
		}
	}()

460
461
462
463
464
	if req.Stream != nil && !*req.Stream {
		waitForStream(c, ch)
		return
	}

465
466
467
	streamResponse(c, ch)
}

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

Michael Yang's avatar
Michael Yang committed
480
481
482
483
484
485
486
	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"})
487
488
489
		return
	}

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

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

Michael Yang's avatar
Michael Yang committed
501
502
503
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

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

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

514
515
516
	streamResponse(c, ch)
}

517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
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 {
			return fmt.Errorf("a model with that name already exists")
		}
	}

	return nil
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
532
func (s *Server) CreateModelHandler(c *gin.Context) {
533
534
	var r api.CreateRequest
	if err := c.ShouldBindJSON(&r); errors.Is(err, io.EOF) {
Michael Yang's avatar
Michael Yang committed
535
536
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
537
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
538
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Michael Yang's avatar
Michael Yang committed
539
		return
540
541
	}

542
	name := model.ParseName(cmp.Or(r.Model, r.Name))
Michael Yang's avatar
Michael Yang committed
543
	if !name.IsValid() {
544
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": errtypes.InvalidModelNameErrMsg})
545
546
547
		return
	}

548
549
550
551
552
	if err := checkNameExists(name); err != nil {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

553
	if r.Path == "" && r.Modelfile == "" {
Michael Yang's avatar
Michael Yang committed
554
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "path or modelfile are required"})
Michael Yang's avatar
Michael Yang committed
555
556
		return
	}
Michael Yang's avatar
Michael Yang committed
557

558
559
560
	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
561
562
563
564
		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
565
		defer f.Close()
Michael Yang's avatar
Michael Yang committed
566

567
		sr = f
Michael Yang's avatar
Michael Yang committed
568
	}
Michael Yang's avatar
Michael Yang committed
569

570
	f, err := parser.ParseFile(sr)
Michael Yang's avatar
Michael Yang committed
571
572
573
574
575
	if err != nil {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

Michael Yang's avatar
Michael Yang committed
576
	ch := make(chan any)
Michael Yang's avatar
Michael Yang committed
577
578
	go func() {
		defer close(ch)
579
580
		fn := func(resp api.ProgressResponse) {
			ch <- resp
581
582
		}

583
584
585
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

586
587
		quantization := cmp.Or(r.Quantize, r.Quantization)
		if err := CreateModel(ctx, name, filepath.Dir(r.Path), strings.ToUpper(quantization), f, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
588
			ch <- gin.H{"error": err.Error()}
589
		}
Michael Yang's avatar
Michael Yang committed
590
	}()
Michael Yang's avatar
Michael Yang committed
591

592
	if r.Stream != nil && !*r.Stream {
593
594
595
596
		waitForStream(c, ch)
		return
	}

Michael Yang's avatar
Michael Yang committed
597
	streamResponse(c, ch)
Bruce MacDonald's avatar
Bruce MacDonald committed
598
599
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
600
func (s *Server) DeleteModelHandler(c *gin.Context) {
601
602
	var r api.DeleteRequest
	if err := c.ShouldBindJSON(&r); errors.Is(err, io.EOF) {
Michael Yang's avatar
Michael Yang committed
603
604
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
605
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
606
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
607
608
609
		return
	}

610
611
612
	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))})
613
614
		return
	}
Michael Yang's avatar
Michael Yang committed
615

616
	m, err := ParseNamedManifest(n)
Michael Yang's avatar
Michael Yang committed
617
618
619
620
621
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

622
	if err := m.Remove(); err != nil {
Michael Yang's avatar
Michael Yang committed
623
624
625
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}
626
627
628
629
630

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

Daniel Hiltgen's avatar
Daniel Hiltgen committed
633
func (s *Server) ShowModelHandler(c *gin.Context) {
Patrick Devine's avatar
Patrick Devine committed
634
	var req api.ShowRequest
Michael Yang's avatar
Michael Yang committed
635
636
637
638
639
640
641
	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
642
643
644
		return
	}

Michael Yang's avatar
Michael Yang committed
645
	if req.Model != "" {
Michael Yang's avatar
Michael Yang committed
646
		// noop
Michael Yang's avatar
Michael Yang committed
647
	} else if req.Name != "" {
Michael Yang's avatar
Michael Yang committed
648
		req.Model = req.Name
Michael Yang's avatar
Michael Yang committed
649
	} else {
650
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
651
652
653
		return
	}

654
	resp, err := GetModelInfo(req)
Patrick Devine's avatar
Patrick Devine committed
655
	if err != nil {
656
657
		switch {
		case os.IsNotExist(err):
Michael Yang's avatar
Michael Yang committed
658
			c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found", req.Model)})
659
660
661
		case err.Error() == "invalid model name":
			c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		default:
Patrick Devine's avatar
Patrick Devine committed
662
663
664
665
666
667
668
669
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		}
		return
	}

	c.JSON(http.StatusOK, resp)
}

670
func GetModelInfo(req api.ShowRequest) (*api.ShowResponse, error) {
671
	m, err := GetModel(req.Model)
Patrick Devine's avatar
Patrick Devine committed
672
673
674
675
	if err != nil {
		return nil, err
	}

Patrick Devine's avatar
Patrick Devine committed
676
	modelDetails := api.ModelDetails{
677
678
679
680
681
682
		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
683
684
	}

685
	if req.System != "" {
686
		m.System = req.System
687
688
689
	}

	if req.Template != "" {
Michael Yang's avatar
Michael Yang committed
690
691
692
693
		m.Template, err = template.Parse(req.Template)
		if err != nil {
			return nil, err
		}
694
695
	}

696
	msgs := make([]api.Message, 0)
697
	for _, msg := range m.Messages {
698
699
700
		msgs = append(msgs, api.Message{Role: msg.Role, Content: msg.Content})
	}

701
702
703
704
705
706
707
708
709
710
	n := model.ParseName(req.Model)
	if !n.IsValid() {
		return nil, fmt.Errorf("invalid model name")
	}

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

Patrick Devine's avatar
Patrick Devine committed
711
	resp := &api.ShowResponse{
712
713
		License:    strings.Join(m.License, "\n"),
		System:     m.System,
Michael Yang's avatar
Michael Yang committed
714
		Template:   m.Template.String(),
715
716
717
		Details:    modelDetails,
		Messages:   msgs,
		ModifiedAt: manifest.fi.ModTime(),
Patrick Devine's avatar
Patrick Devine committed
718
719
720
721
	}

	var params []string
	cs := 30
722
	for k, v := range m.Options {
Patrick Devine's avatar
Patrick Devine committed
723
724
725
		switch val := v.(type) {
		case []interface{}:
			for _, nv := range val {
Patrick Devine's avatar
Patrick Devine committed
726
				params = append(params, fmt.Sprintf("%-*s %#v", cs, k, nv))
Patrick Devine's avatar
Patrick Devine committed
727
			}
Patrick Devine's avatar
Patrick Devine committed
728
729
		default:
			params = append(params, fmt.Sprintf("%-*s %#v", cs, k, v))
Patrick Devine's avatar
Patrick Devine committed
730
731
732
733
		}
	}
	resp.Parameters = strings.Join(params, "\n")

734
735
	for k, v := range req.Options {
		if _, ok := req.Options[k]; ok {
736
			m.Options[k] = v
737
738
739
		}
	}

740
	var sb strings.Builder
741
	fmt.Fprintln(&sb, "# Modelfile generated by \"ollama show\"")
742
	fmt.Fprintln(&sb, "# To build a new Modelfile based on this, replace FROM with:")
743
744
	fmt.Fprintf(&sb, "# FROM %s\n\n", m.ShortName)
	fmt.Fprint(&sb, m.String())
745
	resp.Modelfile = sb.String()
746

747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
	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
763
764
765
	return resp, nil
}

766
func getKVData(digest string, verbose bool) (llm.KV, error) {
767
768
769
770
771
	maxArraySize := 0
	if verbose {
		maxArraySize = -1
	}
	kvData, err := llm.LoadModel(digest, maxArraySize)
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
	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
789
func (s *Server) ListModelsHandler(c *gin.Context) {
790
	ms, err := Manifests()
Patrick Devine's avatar
Patrick Devine committed
791
792
793
794
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}
Michael Yang's avatar
Michael Yang committed
795

796
	models := []api.ListModelResponse{}
797
798
799
800
801
802
803
	for n, m := range ms {
		f, err := m.Config.Open()
		if err != nil {
			slog.Warn("bad manifest filepath", "name", n, "error", err)
			continue
		}
		defer f.Close()
804

805
806
807
808
		var cf ConfigV2
		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
809
		}
Michael Yang's avatar
Michael Yang committed
810

811
		// tag should never be masked
812
		models = append(models, api.ListModelResponse{
813
814
815
816
817
818
819
820
821
822
823
824
825
			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
826
827
	}

828
	slices.SortStableFunc(models, func(i, j api.ListModelResponse) int {
829
830
831
832
		// most recently modified first
		return cmp.Compare(j.ModifiedAt.Unix(), i.ModifiedAt.Unix())
	})

Michael Yang's avatar
Michael Yang committed
833
	c.JSON(http.StatusOK, api.ListResponse{Models: models})
Patrick Devine's avatar
Patrick Devine committed
834
835
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
836
func (s *Server) CopyModelHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
837
838
	var r api.CopyRequest
	if err := c.ShouldBindJSON(&r); errors.Is(err, io.EOF) {
Michael Yang's avatar
Michael Yang committed
839
840
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
841
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
842
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Patrick Devine's avatar
Patrick Devine committed
843
844
845
		return
	}

Michael Yang's avatar
Michael Yang committed
846
847
	src := model.ParseName(r.Source)
	if !src.IsValid() {
Michael Yang's avatar
Michael Yang committed
848
849
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("source %q is invalid", r.Source)})
		return
850
851
	}

Michael Yang's avatar
Michael Yang committed
852
853
	dst := model.ParseName(r.Destination)
	if !dst.IsValid() {
854
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("destination %q is invalid", r.Destination)})
Patrick Devine's avatar
Patrick Devine committed
855
856
		return
	}
Michael Yang's avatar
Michael Yang committed
857

858
859
860
861
862
	if err := checkNameExists(dst); err != nil {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

Michael Yang's avatar
Michael Yang committed
863
864
865
866
867
	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
868
869
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
870
func (s *Server) HeadBlobHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
871
872
873
874
875
876
877
878
879
880
881
	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
882
	c.Status(http.StatusOK)
Michael Yang's avatar
Michael Yang committed
883
884
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
885
func (s *Server) CreateBlobHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
886
887
	if ib, ok := intermediateBlobs[c.Param("digest")]; ok {
		p, err := GetBlobsPath(ib)
888
889
890
891
892
893
		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
894
895
			slog.Info("evicting intermediate blob which no longer exists", "digest", ib)
			delete(intermediateBlobs, c.Param("digest"))
896
897
898
899
900
901
902
903
904
		} else if err != nil {
			c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
			return
		} else {
			c.Status(http.StatusOK)
			return
		}
	}

905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
	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
	}

923
	layer, err := NewLayer(c.Request.Body, "")
Michael Yang's avatar
Michael Yang committed
924
925
926
927
928
	if err != nil {
		c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

929
930
	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
931
932
933
		return
	}

Michael Yang's avatar
Michael Yang committed
934
	c.Status(http.StatusCreated)
Michael Yang's avatar
Michael Yang committed
935
936
}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
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
}

958
func allowedHost(host string) bool {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
959
	if host == "" || host == "localhost" {
960
961
962
963
964
965
966
967
		return true
	}

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

	var tlds = []string{
Jeffrey Morgan's avatar
Jeffrey Morgan committed
968
969
970
		"localhost",
		"local",
		"internal",
971
	}
972

Jeffrey Morgan's avatar
Jeffrey Morgan committed
973
	// check if the host is a local TLD
974
975
976
977
978
979
	for _, tld := range tlds {
		if strings.HasSuffix(host, "."+tld) {
			return true
		}
	}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
980
	return false
Jeffrey Morgan's avatar
Jeffrey Morgan committed
981
}
982

Jeffrey Morgan's avatar
Jeffrey Morgan committed
983
984
985
func allowedHostsMiddleware(addr net.Addr) gin.HandlerFunc {
	return func(c *gin.Context) {
		if addr == nil {
986
987
988
989
			c.Next()
			return
		}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
990
		if addr, err := netip.ParseAddrPort(addr.String()); err == nil && !addr.Addr().IsLoopback() {
991
992
993
994
995
996
997
998
999
			c.Next()
			return
		}

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

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1000
		if addr, err := netip.ParseAddr(host); err == nil {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1001
			if addr.IsLoopback() || addr.IsPrivate() || addr.IsUnspecified() || isLocalIP(addr) {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1002
1003
1004
1005
1006
				c.Next()
				return
			}
		}

1007
		if allowedHost(host) {
Michael Yang's avatar
lint  
Michael Yang committed
1008
			if c.Request.Method == http.MethodOptions {
1009
1010
1011
1012
				c.AbortWithStatus(http.StatusNoContent)
				return
			}

1013
1014
1015
1016
1017
1018
			c.Next()
			return
		}

		c.AbortWithStatus(http.StatusForbidden)
	}
1019
}
1020

1021
func (s *Server) GenerateRoutes() http.Handler {
Michael Yang's avatar
Michael Yang committed
1022
1023
	config := cors.DefaultConfig()
	config.AllowWildcard = true
1024
	config.AllowBrowserExtensions = true
1025
	config.AllowHeaders = []string{"Authorization", "Content-Type", "User-Agent", "Accept", "X-Requested-With"}
royjhan's avatar
royjhan committed
1026
1027
1028
1029
	openAIProperties := []string{"lang", "package-version", "os", "arch", "runtime", "runtime-version", "async"}
	for _, prop := range openAIProperties {
		config.AllowHeaders = append(config.AllowHeaders, "x-stainless-"+prop)
	}
1030
	config.AllowOrigins = envconfig.AllowOrigins
Michael Yang's avatar
Michael Yang committed
1031

Bruce MacDonald's avatar
Bruce MacDonald committed
1032
	r := gin.Default()
1033
1034
	r.Use(
		cors.New(config),
1035
		allowedHostsMiddleware(s.addr),
1036
	)
Bruce MacDonald's avatar
Bruce MacDonald committed
1037

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
	r.POST("/api/pull", s.PullModelHandler)
	r.POST("/api/generate", s.GenerateHandler)
	r.POST("/api/chat", s.ChatHandler)
	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)
1049
	r.GET("/api/ps", s.ProcessHandler)
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1050

1051
	// Compatibility endpoints
1052
	r.POST("/v1/chat/completions", openai.ChatMiddleware(), s.ChatHandler)
1053
	r.POST("/v1/completions", openai.CompletionsMiddleware(), s.GenerateHandler)
1054
1055
	r.GET("/v1/models", openai.ListMiddleware(), s.ListModelsHandler)
	r.GET("/v1/models/:model", openai.RetrieveMiddleware(), s.ShowModelHandler)
1056

Michael Yang's avatar
Michael Yang committed
1057
1058
1059
1060
1061
	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
1062
		r.Handle(method, "/api/tags", s.ListModelsHandler)
Michael Yang's avatar
Michael Yang committed
1063
1064
1065
		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
1066
1067
	}

1068
1069
1070
1071
	return r
}

func Serve(ln net.Listener) error {
Michael Yang's avatar
Michael Yang committed
1072
	level := slog.LevelInfo
1073
	if envconfig.Debug {
Michael Yang's avatar
Michael Yang committed
1074
		level = slog.LevelDebug
1075
	}
Michael Yang's avatar
Michael Yang committed
1076

1077
	slog.Info("server config", "env", envconfig.Values())
Michael Yang's avatar
Michael Yang committed
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
	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))

1093
1094
1095
1096
1097
1098
1099
1100
	blobsDir, err := GetBlobsPath("")
	if err != nil {
		return err
	}
	if err := fixBlobs(blobsDir); err != nil {
		return err
	}

1101
	if !envconfig.NoPrune {
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
		// 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
1117
	ctx, done := context.WithCancel(context.Background())
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1118
1119
	schedCtx, schedDone := context.WithCancel(ctx)
	sched := InitScheduler(schedCtx)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1120
	s := &Server{addr: ln.Addr(), sched: sched}
1121
1122

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

1124
	slog.Info(fmt.Sprintf("Listening on %s (version %s)", ln.Addr(), version.Version))
1125
	srvr := &http.Server{
1126
1127
1128
1129
1130
1131
1132
1133
1134
		// 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
1135
1136
	}

1137
1138
	// listen for a ctrl+c and stop any loaded llm
	signals := make(chan os.Signal, 1)
1139
	signal.Notify(signals, syscall.SIGINT, syscall.SIGTERM)
1140
1141
	go func() {
		<-signals
1142
		srvr.Close()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1143
		schedDone()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1144
		sched.unloadAllRunners()
1145
		gpu.Cleanup()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1146
		done()
1147
1148
	}()

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1149
	if err := llm.Init(); err != nil {
1150
1151
		return fmt.Errorf("unable to initialize llm library %w", err)
	}
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1152

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1153
	s.sched.Run(schedCtx)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1154
1155
1156

	// 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
1157
1158
	gpus := gpu.GetGPUInfo()
	gpus.LogDetails()
1159

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1160
1161
1162
1163
1164
1165
1166
	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()
1167
	return nil
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1168
}
Michael Yang's avatar
Michael Yang committed
1169

1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
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:
			if errorMsg, ok := r["error"].(string); ok {
				c.JSON(http.StatusInternalServerError, gin.H{"error": errorMsg})
				return
			} else {
				c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected error format in progress response"})
				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
1195
func streamResponse(c *gin.Context, ch chan any) {
1196
	c.Header("Content-Type", "application/x-ndjson")
Michael Yang's avatar
Michael Yang committed
1197
1198
1199
1200
1201
1202
1203
1204
	c.Stream(func(w io.Writer) bool {
		val, ok := <-ch
		if !ok {
			return false
		}

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

1209
		// Delineate chunks with new-line delimiter
Michael Yang's avatar
Michael Yang committed
1210
1211
		bts = append(bts, '\n')
		if _, err := w.Write(bts); err != nil {
1212
			slog.Info(fmt.Sprintf("streamResponse: w.Write failed with %s", err))
Michael Yang's avatar
Michael Yang committed
1213
1214
1215
1216
1217
1218
			return false
		}

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

1220
func (s *Server) ProcessHandler(c *gin.Context) {
1221
	models := []api.ProcessModelResponse{}
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232

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

1233
		mr := api.ProcessModelResponse{
1234
1235
1236
1237
1238
1239
1240
1241
			Model:     model.ShortName,
			Name:      model.ShortName,
			Size:      int64(v.estimatedTotal),
			SizeVRAM:  int64(v.estimatedVRAM),
			Digest:    model.Digest,
			Details:   modelDetails,
			ExpiresAt: v.expiresAt,
		}
1242
1243
1244
1245
1246
1247
1248
1249
		// 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)
		}

1250
1251
1252
		models = append(models, mr)
	}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1253
1254
1255
1256
1257
	slices.SortStableFunc(models, func(i, j api.ProcessModelResponse) int {
		// longest duration remaining listed first
		return cmp.Compare(j.ExpiresAt.Unix(), i.ExpiresAt.Unix())
	})

1258
	c.JSON(http.StatusOK, api.ProcessResponse{Models: models})
1259
1260
}

1261
// ChatPrompt builds up a prompt from a series of messages for the currently `loaded` model
Michael Yang's avatar
Michael Yang committed
1262
func chatPrompt(ctx context.Context, runner *runnerRef, template *template.Template, messages []api.Message, numCtx int) (string, error) {
1263
	encode := func(s string) ([]int, error) {
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1264
		return runner.llama.Tokenize(ctx, s)
1265
1266
	}

1267
	prompt, err := ChatPrompt(template, messages, numCtx, encode)
1268
1269
1270
1271
1272
1273
1274
	if err != nil {
		return "", err
	}

	return prompt, nil
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1275
func (s *Server) ChatHandler(c *gin.Context) {
Bruce MacDonald's avatar
Bruce MacDonald committed
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
	checkpointStart := time.Now()

	var req api.ChatRequest
	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
	}

	// validate the request
	switch {
	case req.Model == "":
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
		return
	case len(req.Format) > 0 && req.Format != "json":
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "format must be json"})
		return
	}

1299
	model, err := GetModel(req.Model)
Bruce MacDonald's avatar
Bruce MacDonald committed
1300
1301
	if err != nil {
		var pErr *fs.PathError
1302
		if errors.As(err, &pErr) {
Bruce MacDonald's avatar
Bruce MacDonald committed
1303
			c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found, try pulling it first", req.Model)})
1304
1305
1306
1307
1308
1309
			return
		}
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

Michael Yang's avatar
Michael Yang committed
1310
1311
	if !model.Has(CapabilityCompletion) {
		c.JSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("%s does not support chat", req.Model)})
1312
1313
1314
		return
	}

1315
1316
1317
1318
1319
	opts, err := modelOptions(model, req.Options)
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}
1320
1321
1322

	var sessionDuration time.Duration
	if req.KeepAlive == nil {
1323
		sessionDuration = getDefaultSessionDuration()
1324
1325
1326
1327
	} else {
		sessionDuration = req.KeepAlive.Duration
	}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1328
1329
1330
1331
1332
	rCh, eCh := s.sched.GetRunner(c.Request.Context(), model, opts, sessionDuration)
	var runner *runnerRef
	select {
	case runner = <-rCh:
	case err = <-eCh:
1333
		handleErrorResponse(c, err)
Bruce MacDonald's avatar
Bruce MacDonald committed
1334
1335
1336
1337
1338
		return
	}

	checkpointLoaded := time.Now()

1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
	// if the first message is not a system message, then add the model's default system message
	if len(req.Messages) > 0 && req.Messages[0].Role != "system" {
		req.Messages = append([]api.Message{
			{
				Role:    "system",
				Content: model.System,
			},
		}, req.Messages...)
	}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1349
	prompt, err := chatPrompt(c.Request.Context(), runner, model.Template, req.Messages, opts.NumCtx)
Bruce MacDonald's avatar
Bruce MacDonald committed
1350
1351
1352
1353
	if err != nil {
		c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}
Michael Yang's avatar
Michael Yang committed
1354

1355
	// an empty request loads the model
1356
	if len(req.Messages) == 0 || prompt == "" {
1357
		resp := api.ChatResponse{
1358
1359
1360
1361
1362
			CreatedAt:  time.Now().UTC(),
			Model:      req.Model,
			Done:       true,
			DoneReason: "load",
			Message:    api.Message{Role: "assistant"},
1363
1364
1365
1366
1367
		}
		c.JSON(http.StatusOK, resp)
		return
	}

1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
	// only send images that are in the prompt
	var i int
	var images []llm.ImageData
	for _, m := range req.Messages {
		for _, img := range m.Images {
			if !isSupportedImageType(img) {
				c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "unsupported image format"})
				return
			}

			if strings.Contains(prompt, fmt.Sprintf("[img-%d]", i)) {
				images = append(images, llm.ImageData{Data: img, ID: i})
			}
			i += 1
		}
	}

	slog.Debug("chat handler", "prompt", prompt, "images", len(images))
1386

Bruce MacDonald's avatar
Bruce MacDonald committed
1387
1388
1389
1390
1391
	ch := make(chan any)

	go func() {
		defer close(ch)

1392
		fn := func(r llm.CompletionResponse) {
Bruce MacDonald's avatar
Bruce MacDonald committed
1393
			resp := api.ChatResponse{
1394
1395
1396
1397
1398
				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
1399
1400
1401
1402
1403
1404
1405
1406
				Metrics: api.Metrics{
					PromptEvalCount:    r.PromptEvalCount,
					PromptEvalDuration: r.PromptEvalDuration,
					EvalCount:          r.EvalCount,
					EvalDuration:       r.EvalDuration,
				},
			}

1407
1408
1409
			if r.Done {
				resp.TotalDuration = time.Since(checkpointStart)
				resp.LoadDuration = checkpointLoaded.Sub(checkpointStart)
Bruce MacDonald's avatar
Bruce MacDonald committed
1410
1411
1412
1413
1414
			}

			ch <- resp
		}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1415
		if err := runner.llama.Completion(c.Request.Context(), llm.CompletionRequest{
1416
1417
			Prompt:  prompt,
			Format:  req.Format,
Michael Yang's avatar
Michael Yang committed
1418
			Images:  images,
1419
			Options: opts,
1420
		}, fn); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1421
1422
1423
1424
1425
			ch <- gin.H{"error": err.Error()}
		}
	}()

	if req.Stream != nil && !*req.Stream {
1426
1427
		// Accumulate responses into the final response
		var final api.ChatResponse
Bruce MacDonald's avatar
Bruce MacDonald committed
1428
1429
		var sb strings.Builder
		for resp := range ch {
1430
1431
			switch r := resp.(type) {
			case api.ChatResponse:
1432
				sb.WriteString(r.Message.Content)
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
				final = r
			case gin.H:
				if errorMsg, ok := r["error"].(string); ok {
					c.JSON(http.StatusInternalServerError, gin.H{"error": errorMsg})
					return
				} else {
					c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected error format in response"})
					return
				}
			default:
				c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected error"})
				return
Bruce MacDonald's avatar
Bruce MacDonald committed
1445
1446
			}
		}
1447

1448
		final.Message = api.Message{Role: "assistant", Content: sb.String()}
1449
		c.JSON(http.StatusOK, final)
Bruce MacDonald's avatar
Bruce MacDonald committed
1450
1451
1452
1453
1454
		return
	}

	streamResponse(c, ch)
}
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466

func handleErrorResponse(c *gin.Context, err error) {
	if errors.Is(err, context.Canceled) {
		c.JSON(499, gin.H{"error": "request canceled"})
		return
	}
	if errors.Is(err, ErrMaxQueue) {
		c.JSON(http.StatusServiceUnavailable, gin.H{"error": err.Error()})
		return
	}
	c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
}