routes.go 35.5 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
26
	"github.com/gin-gonic/gin"

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

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

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

Michael Yang's avatar
Michael Yang committed
46
47
48
49
50
51
52
53
54
55
56
57
func init() {
	switch mode {
	case gin.DebugMode:
	case gin.ReleaseMode:
	case gin.TestMode:
	default:
		mode = gin.DebugMode
	}

	gin.SetMode(mode)
}

Michael Yang's avatar
Michael Yang committed
58
var errRequired = errors.New("is required")
Josh's avatar
Josh committed
59
var errBadTemplate = errors.New("template error")
Michael Yang's avatar
Michael Yang committed
60

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
}

Michael Yang's avatar
Michael Yang committed
74
75
76
// 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
77
	if name == "" {
Michael Yang's avatar
Michael Yang committed
78
		return nil, nil, nil, fmt.Errorf("model %w", errRequired)
Bruce MacDonald's avatar
Bruce MacDonald committed
79
80
	}

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

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

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

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

Michael Yang's avatar
Michael Yang committed
103
	return runner.llama, model, &opts, nil
Michael Yang's avatar
Michael Yang committed
104
105
106
}

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

Michael Yang's avatar
Michael Yang committed
117
118
119
120
121
	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
122
123
124
		return
	}

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

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

139
140
	checkpointLoaded := time.Now()

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

Michael Yang's avatar
Michael Yang committed
151
152
153
154
	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
155

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

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

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

		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
206
207
	}

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

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

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

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

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

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

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

	streamResponse(c, ch)
}

289
func (s *Server) EmbedHandler(c *gin.Context) {
290
	checkpointStart := time.Now()
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
	var req api.EmbedRequest
	err := c.ShouldBindJSON(&req)
	switch {
	case errors.Is(err, io.EOF):
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
	case err != nil:
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

	truncate := true

	if req.Truncate != nil && !*req.Truncate {
		truncate = false
	}

	var input []string

	switch i := req.Input.(type) {
	case string:
		if len(i) > 0 {
			input = append(input, i)
		}
	case []any:
		for _, v := range i {
			if _, ok := v.(string); !ok {
				c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "invalid input type"})
				return
			}
			input = append(input, v.(string))
		}
	default:
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "invalid input type"})
		return
	}

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

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

339
340
	checkpointLoaded := time.Now()

341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
	kvData, err := getKVData(m.ModelPath, false)
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

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

		input[i] = s
	}
	embeddings, err := r.Embed(c.Request.Context(), input)

	if err != nil {
		slog.Error("embedding generation failed", "error", err)
		c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to generate embedding"})
		return
	}

379
380
	for i, e := range embeddings.Embedding {
		embeddings.Embedding[i] = normalize(e)
381
382
383
	}

	resp := api.EmbedResponse{
384
385
386
387
388
		Model:           req.Model,
		Embeddings:      embeddings.Embedding,
		TotalDuration:   time.Since(checkpointStart),
		LoadDuration:    checkpointLoaded.Sub(checkpointStart),
		PromptEvalCount: embeddings.PromptEvalCount,
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
	}
	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
410
func (s *Server) EmbeddingsHandler(c *gin.Context) {
Bruce MacDonald's avatar
Bruce MacDonald committed
411
	var req api.EmbeddingRequest
Michael Yang's avatar
Michael Yang committed
412
	if err := c.ShouldBindJSON(&req); errors.Is(err, io.EOF) {
Bruce MacDonald's avatar
Bruce MacDonald committed
413
414
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
415
	} else if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
416
417
418
419
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

Michael Yang's avatar
Michael Yang committed
420
	r, _, _, err := s.scheduleRunner(c.Request.Context(), req.Model, []Capability{}, req.Options, req.KeepAlive)
Bruce MacDonald's avatar
Bruce MacDonald committed
421
	if err != nil {
Michael Yang's avatar
Michael Yang committed
422
		handleScheduleError(c, req.Model, err)
Bruce MacDonald's avatar
Bruce MacDonald committed
423
424
425
		return
	}

426
427
428
	// an empty request loads the model
	if req.Prompt == "" {
		c.JSON(http.StatusOK, api.EmbeddingResponse{Embedding: []float64{}})
Bruce MacDonald's avatar
Bruce MacDonald committed
429
430
431
		return
	}

432
433
	embeddings, err := r.Embed(c.Request.Context(), []string{req.Prompt})

Bruce MacDonald's avatar
Bruce MacDonald committed
434
	if err != nil {
435
		slog.Info(fmt.Sprintf("embedding generation failed: %v", err))
Bruce MacDonald's avatar
Bruce MacDonald committed
436
437
438
439
		c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to generate embedding"})
		return
	}

440
	embedding := make([]float64, len(embeddings.Embedding[0]))
441

442
	for i, v := range embeddings.Embedding[0] {
443
444
445
446
447
448
449
		embedding[i] = float64(v)
	}

	resp := api.EmbeddingResponse{
		Embedding: embedding,
	}
	c.JSON(http.StatusOK, resp)
Bruce MacDonald's avatar
Bruce MacDonald committed
450
451
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
452
func (s *Server) PullModelHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
453
	var req api.PullRequest
Michael Yang's avatar
Michael Yang committed
454
455
456
457
458
459
460
	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
461
462
463
		return
	}

464
465
466
467
468
469
470
471
	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()})
472
473
474
		return
	}

475
476
477
	ch := make(chan any)
	go func() {
		defer close(ch)
478
479
		fn := func(r api.ProgressResponse) {
			ch <- r
480
		}
481

Michael Yang's avatar
Michael Yang committed
482
		regOpts := &registryOptions{
483
484
485
			Insecure: req.Insecure,
		}

486
487
488
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

489
		if err := PullModel(ctx, name.DisplayShortest(), regOpts, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
490
			ch <- gin.H{"error": err.Error()}
491
492
493
		}
	}()

494
495
496
497
498
	if req.Stream != nil && !*req.Stream {
		waitForStream(c, ch)
		return
	}

499
500
501
	streamResponse(c, ch)
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
502
func (s *Server) PushModelHandler(c *gin.Context) {
503
	var req api.PushRequest
Michael Yang's avatar
Michael Yang committed
504
505
506
507
508
509
510
	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
511
512
		return
	}
Michael Yang's avatar
Michael Yang committed
513

Michael Yang's avatar
Michael Yang committed
514
515
516
517
518
519
520
	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"})
521
522
523
		return
	}

524
525
526
	ch := make(chan any)
	go func() {
		defer close(ch)
527
528
		fn := func(r api.ProgressResponse) {
			ch <- r
529
		}
530

Michael Yang's avatar
Michael Yang committed
531
		regOpts := &registryOptions{
532
533
534
			Insecure: req.Insecure,
		}

Michael Yang's avatar
Michael Yang committed
535
536
537
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

Michael Yang's avatar
Michael Yang committed
538
		if err := PushModel(ctx, model, regOpts, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
539
			ch <- gin.H{"error": err.Error()}
540
541
542
		}
	}()

543
544
545
546
547
	if req.Stream != nil && !*req.Stream {
		waitForStream(c, ch)
		return
	}

548
549
550
	streamResponse(c, ch)
}

551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
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
566
func (s *Server) CreateModelHandler(c *gin.Context) {
567
568
	var r api.CreateRequest
	if err := c.ShouldBindJSON(&r); errors.Is(err, io.EOF) {
Michael Yang's avatar
Michael Yang committed
569
570
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
571
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
572
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Michael Yang's avatar
Michael Yang committed
573
		return
574
575
	}

576
	name := model.ParseName(cmp.Or(r.Model, r.Name))
Michael Yang's avatar
Michael Yang committed
577
	if !name.IsValid() {
578
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": errtypes.InvalidModelNameErrMsg})
579
580
581
		return
	}

582
583
584
585
586
	if err := checkNameExists(name); err != nil {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

587
	if r.Path == "" && r.Modelfile == "" {
Michael Yang's avatar
Michael Yang committed
588
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "path or modelfile are required"})
Michael Yang's avatar
Michael Yang committed
589
590
		return
	}
Michael Yang's avatar
Michael Yang committed
591

592
593
594
	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
595
596
597
598
		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
599
		defer f.Close()
Michael Yang's avatar
Michael Yang committed
600

601
		sr = f
Michael Yang's avatar
Michael Yang committed
602
	}
Michael Yang's avatar
Michael Yang committed
603

604
	f, err := parser.ParseFile(sr)
Michael Yang's avatar
Michael Yang committed
605
606
607
608
609
	if err != nil {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

Michael Yang's avatar
Michael Yang committed
610
	ch := make(chan any)
Michael Yang's avatar
Michael Yang committed
611
612
	go func() {
		defer close(ch)
613
614
		fn := func(resp api.ProgressResponse) {
			ch <- resp
615
616
		}

617
618
619
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

620
		quantization := cmp.Or(r.Quantize, r.Quantization)
Josh's avatar
Josh committed
621
622
623
		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
624
			ch <- gin.H{"error": err.Error()}
625
		}
Michael Yang's avatar
Michael Yang committed
626
	}()
Michael Yang's avatar
Michael Yang committed
627

628
	if r.Stream != nil && !*r.Stream {
629
630
631
632
		waitForStream(c, ch)
		return
	}

Michael Yang's avatar
Michael Yang committed
633
	streamResponse(c, ch)
Bruce MacDonald's avatar
Bruce MacDonald committed
634
635
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
636
func (s *Server) DeleteModelHandler(c *gin.Context) {
637
638
	var r api.DeleteRequest
	if err := c.ShouldBindJSON(&r); errors.Is(err, io.EOF) {
Michael Yang's avatar
Michael Yang committed
639
640
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
641
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
642
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
643
644
645
		return
	}

646
647
648
	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))})
649
650
		return
	}
Michael Yang's avatar
Michael Yang committed
651

652
	m, err := ParseNamedManifest(n)
Michael Yang's avatar
Michael Yang committed
653
654
655
656
657
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

658
	if err := m.Remove(); err != nil {
Michael Yang's avatar
Michael Yang committed
659
660
661
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}
662
663
664
665
666

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

Daniel Hiltgen's avatar
Daniel Hiltgen committed
669
func (s *Server) ShowModelHandler(c *gin.Context) {
Patrick Devine's avatar
Patrick Devine committed
670
	var req api.ShowRequest
Michael Yang's avatar
Michael Yang committed
671
672
673
674
675
676
677
	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
678
679
680
		return
	}

Michael Yang's avatar
Michael Yang committed
681
	if req.Model != "" {
Michael Yang's avatar
Michael Yang committed
682
		// noop
Michael Yang's avatar
Michael Yang committed
683
	} else if req.Name != "" {
Michael Yang's avatar
Michael Yang committed
684
		req.Model = req.Name
Michael Yang's avatar
Michael Yang committed
685
	} else {
686
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
687
688
689
		return
	}

690
	resp, err := GetModelInfo(req)
Patrick Devine's avatar
Patrick Devine committed
691
	if err != nil {
692
693
		switch {
		case os.IsNotExist(err):
Michael Yang's avatar
Michael Yang committed
694
			c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found", req.Model)})
695
696
697
		case err.Error() == "invalid model name":
			c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		default:
Patrick Devine's avatar
Patrick Devine committed
698
699
700
701
702
703
704
705
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		}
		return
	}

	c.JSON(http.StatusOK, resp)
}

706
func GetModelInfo(req api.ShowRequest) (*api.ShowResponse, error) {
707
	m, err := GetModel(req.Model)
Patrick Devine's avatar
Patrick Devine committed
708
709
710
711
	if err != nil {
		return nil, err
	}

Patrick Devine's avatar
Patrick Devine committed
712
	modelDetails := api.ModelDetails{
713
714
715
716
717
718
		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
719
720
	}

721
	if req.System != "" {
722
		m.System = req.System
723
724
	}

Michael Yang's avatar
Michael Yang committed
725
726
727
	msgs := make([]api.Message, len(m.Messages))
	for i, msg := range m.Messages {
		msgs[i] = api.Message{Role: msg.Role, Content: msg.Content}
728
729
	}

730
731
732
733
734
735
736
737
738
739
	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
740
	resp := &api.ShowResponse{
741
742
		License:    strings.Join(m.License, "\n"),
		System:     m.System,
Michael Yang's avatar
Michael Yang committed
743
		Template:   m.Template.String(),
744
745
746
		Details:    modelDetails,
		Messages:   msgs,
		ModifiedAt: manifest.fi.ModTime(),
Patrick Devine's avatar
Patrick Devine committed
747
748
749
750
	}

	var params []string
	cs := 30
751
	for k, v := range m.Options {
Patrick Devine's avatar
Patrick Devine committed
752
753
754
		switch val := v.(type) {
		case []interface{}:
			for _, nv := range val {
Patrick Devine's avatar
Patrick Devine committed
755
				params = append(params, fmt.Sprintf("%-*s %#v", cs, k, nv))
Patrick Devine's avatar
Patrick Devine committed
756
			}
Patrick Devine's avatar
Patrick Devine committed
757
758
		default:
			params = append(params, fmt.Sprintf("%-*s %#v", cs, k, v))
Patrick Devine's avatar
Patrick Devine committed
759
760
761
762
		}
	}
	resp.Parameters = strings.Join(params, "\n")

763
764
	for k, v := range req.Options {
		if _, ok := req.Options[k]; ok {
765
			m.Options[k] = v
766
767
768
		}
	}

769
	var sb strings.Builder
770
	fmt.Fprintln(&sb, "# Modelfile generated by \"ollama show\"")
771
	fmt.Fprintln(&sb, "# To build a new Modelfile based on this, replace FROM with:")
772
773
	fmt.Fprintf(&sb, "# FROM %s\n\n", m.ShortName)
	fmt.Fprint(&sb, m.String())
774
	resp.Modelfile = sb.String()
775

776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
	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
792
793
794
	return resp, nil
}

795
func getKVData(digest string, verbose bool) (llm.KV, error) {
796
797
798
799
800
	maxArraySize := 0
	if verbose {
		maxArraySize = -1
	}
	kvData, err := llm.LoadModel(digest, maxArraySize)
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
	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
818
func (s *Server) ListModelsHandler(c *gin.Context) {
819
	ms, err := Manifests()
Patrick Devine's avatar
Patrick Devine committed
820
821
822
823
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}
Michael Yang's avatar
Michael Yang committed
824

825
	models := []api.ListModelResponse{}
826
827
828
829
830
831
832
	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()
833

834
835
836
837
		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
838
		}
Michael Yang's avatar
Michael Yang committed
839

840
		// tag should never be masked
841
		models = append(models, api.ListModelResponse{
842
843
844
845
846
847
848
849
850
851
852
853
854
			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
855
856
	}

857
	slices.SortStableFunc(models, func(i, j api.ListModelResponse) int {
858
859
860
861
		// most recently modified first
		return cmp.Compare(j.ModifiedAt.Unix(), i.ModifiedAt.Unix())
	})

Michael Yang's avatar
Michael Yang committed
862
	c.JSON(http.StatusOK, api.ListResponse{Models: models})
Patrick Devine's avatar
Patrick Devine committed
863
864
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
865
func (s *Server) CopyModelHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
866
867
	var r api.CopyRequest
	if err := c.ShouldBindJSON(&r); errors.Is(err, io.EOF) {
Michael Yang's avatar
Michael Yang committed
868
869
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
870
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
871
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Patrick Devine's avatar
Patrick Devine committed
872
873
874
		return
	}

Michael Yang's avatar
Michael Yang committed
875
876
	src := model.ParseName(r.Source)
	if !src.IsValid() {
Michael Yang's avatar
Michael Yang committed
877
878
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("source %q is invalid", r.Source)})
		return
879
880
	}

Michael Yang's avatar
Michael Yang committed
881
882
	dst := model.ParseName(r.Destination)
	if !dst.IsValid() {
883
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("destination %q is invalid", r.Destination)})
Patrick Devine's avatar
Patrick Devine committed
884
885
		return
	}
Michael Yang's avatar
Michael Yang committed
886

887
888
889
890
891
	if err := checkNameExists(dst); err != nil {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

Michael Yang's avatar
Michael Yang committed
892
893
894
895
896
	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
897
898
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
899
func (s *Server) HeadBlobHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
900
901
902
903
904
905
906
907
908
909
910
	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
911
	c.Status(http.StatusOK)
Michael Yang's avatar
Michael Yang committed
912
913
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
914
func (s *Server) CreateBlobHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
915
916
	if ib, ok := intermediateBlobs[c.Param("digest")]; ok {
		p, err := GetBlobsPath(ib)
917
918
919
920
921
922
		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
923
924
			slog.Info("evicting intermediate blob which no longer exists", "digest", ib)
			delete(intermediateBlobs, c.Param("digest"))
925
926
927
928
929
930
931
932
933
		} else if err != nil {
			c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
			return
		} else {
			c.Status(http.StatusOK)
			return
		}
	}

934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
	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
	}

952
	layer, err := NewLayer(c.Request.Body, "")
Michael Yang's avatar
Michael Yang committed
953
954
955
956
957
	if err != nil {
		c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

958
959
	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
960
961
962
		return
	}

Michael Yang's avatar
Michael Yang committed
963
	c.Status(http.StatusCreated)
Michael Yang's avatar
Michael Yang committed
964
965
}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
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
}

987
func allowedHost(host string) bool {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
988
	if host == "" || host == "localhost" {
989
990
991
992
993
994
995
996
		return true
	}

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

	var tlds = []string{
Jeffrey Morgan's avatar
Jeffrey Morgan committed
997
998
999
		"localhost",
		"local",
		"internal",
1000
	}
1001

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1002
	// check if the host is a local TLD
1003
1004
1005
1006
1007
1008
	for _, tld := range tlds {
		if strings.HasSuffix(host, "."+tld) {
			return true
		}
	}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1009
	return false
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1010
}
1011

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1012
1013
1014
func allowedHostsMiddleware(addr net.Addr) gin.HandlerFunc {
	return func(c *gin.Context) {
		if addr == nil {
1015
1016
1017
1018
			c.Next()
			return
		}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1019
		if addr, err := netip.ParseAddrPort(addr.String()); err == nil && !addr.Addr().IsLoopback() {
1020
1021
1022
1023
1024
1025
1026
1027
1028
			c.Next()
			return
		}

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

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1029
		if addr, err := netip.ParseAddr(host); err == nil {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1030
			if addr.IsLoopback() || addr.IsPrivate() || addr.IsUnspecified() || isLocalIP(addr) {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1031
1032
1033
1034
1035
				c.Next()
				return
			}
		}

1036
		if allowedHost(host) {
Michael Yang's avatar
lint  
Michael Yang committed
1037
			if c.Request.Method == http.MethodOptions {
1038
1039
1040
1041
				c.AbortWithStatus(http.StatusNoContent)
				return
			}

1042
1043
1044
1045
1046
1047
			c.Next()
			return
		}

		c.AbortWithStatus(http.StatusForbidden)
	}
1048
}
1049

1050
func (s *Server) GenerateRoutes() http.Handler {
Michael Yang's avatar
Michael Yang committed
1051
1052
	config := cors.DefaultConfig()
	config.AllowWildcard = true
1053
	config.AllowBrowserExtensions = true
1054
	config.AllowHeaders = []string{"Authorization", "Content-Type", "User-Agent", "Accept", "X-Requested-With"}
royjhan's avatar
royjhan committed
1055
1056
1057
1058
	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
1059
	config.AllowOrigins = envconfig.Origins()
Michael Yang's avatar
Michael Yang committed
1060

Bruce MacDonald's avatar
Bruce MacDonald committed
1061
	r := gin.Default()
1062
1063
	r.Use(
		cors.New(config),
1064
		allowedHostsMiddleware(s.addr),
1065
	)
Bruce MacDonald's avatar
Bruce MacDonald committed
1066

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1067
1068
1069
	r.POST("/api/pull", s.PullModelHandler)
	r.POST("/api/generate", s.GenerateHandler)
	r.POST("/api/chat", s.ChatHandler)
1070
	r.POST("/api/embed", s.EmbedHandler)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1071
1072
1073
1074
1075
1076
1077
1078
	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)
1079
	r.GET("/api/ps", s.ProcessHandler)
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1080

1081
	// Compatibility endpoints
1082
	r.POST("/v1/chat/completions", openai.ChatMiddleware(), s.ChatHandler)
1083
	r.POST("/v1/completions", openai.CompletionsMiddleware(), s.GenerateHandler)
1084
	r.POST("/v1/embeddings", openai.EmbeddingsMiddleware(), s.EmbedHandler)
1085
1086
	r.GET("/v1/models", openai.ListMiddleware(), s.ListModelsHandler)
	r.GET("/v1/models/:model", openai.RetrieveMiddleware(), s.ShowModelHandler)
1087

Michael Yang's avatar
Michael Yang committed
1088
1089
1090
1091
1092
	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
1093
		r.Handle(method, "/api/tags", s.ListModelsHandler)
Michael Yang's avatar
Michael Yang committed
1094
1095
1096
		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
1097
1098
	}

1099
1100
1101
1102
	return r
}

func Serve(ln net.Listener) error {
Michael Yang's avatar
Michael Yang committed
1103
	level := slog.LevelInfo
Michael Yang's avatar
Michael Yang committed
1104
	if envconfig.Debug() {
Michael Yang's avatar
Michael Yang committed
1105
		level = slog.LevelDebug
1106
	}
Michael Yang's avatar
Michael Yang committed
1107

1108
	slog.Info("server config", "env", envconfig.Values())
Michael Yang's avatar
Michael Yang committed
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
	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))

1124
1125
1126
1127
1128
1129
1130
1131
	blobsDir, err := GetBlobsPath("")
	if err != nil {
		return err
	}
	if err := fixBlobs(blobsDir); err != nil {
		return err
	}

Michael Yang's avatar
bool  
Michael Yang committed
1132
	if !envconfig.NoPrune() {
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
		// 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
1148
	ctx, done := context.WithCancel(context.Background())
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1149
1150
	schedCtx, schedDone := context.WithCancel(ctx)
	sched := InitScheduler(schedCtx)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1151
	s := &Server{addr: ln.Addr(), sched: sched}
1152
1153

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

1155
	slog.Info(fmt.Sprintf("Listening on %s (version %s)", ln.Addr(), version.Version))
1156
	srvr := &http.Server{
1157
1158
1159
1160
1161
1162
1163
1164
1165
		// 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
1166
1167
	}

1168
1169
	// listen for a ctrl+c and stop any loaded llm
	signals := make(chan os.Signal, 1)
1170
	signal.Notify(signals, syscall.SIGINT, syscall.SIGTERM)
1171
1172
	go func() {
		<-signals
1173
		srvr.Close()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1174
		schedDone()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1175
		sched.unloadAllRunners()
1176
		gpu.Cleanup()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1177
		done()
1178
1179
	}()

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1180
	if err := llm.Init(); err != nil {
1181
1182
		return fmt.Errorf("unable to initialize llm library %w", err)
	}
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1183

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1184
	s.sched.Run(schedCtx)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1185
1186
1187

	// 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
1188
1189
	gpus := gpu.GetGPUInfo()
	gpus.LogDetails()
1190

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1191
1192
1193
1194
1195
1196
1197
	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()
1198
	return nil
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1199
}
Michael Yang's avatar
Michael Yang committed
1200

1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
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
1211
1212
1213
1214
			status, ok := r["status"].(int)
			if !ok {
				status = http.StatusInternalServerError
			}
1215
			if errorMsg, ok := r["error"].(string); ok {
Josh's avatar
Josh committed
1216
				c.JSON(status, gin.H{"error": errorMsg})
1217
1218
				return
			} else {
Josh's avatar
Josh committed
1219
				c.JSON(status, gin.H{"error": "unexpected error format in progress response"})
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
				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
1230
func streamResponse(c *gin.Context, ch chan any) {
1231
	c.Header("Content-Type", "application/x-ndjson")
Michael Yang's avatar
Michael Yang committed
1232
1233
1234
1235
1236
1237
1238
1239
	c.Stream(func(w io.Writer) bool {
		val, ok := <-ch
		if !ok {
			return false
		}

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

1244
		// Delineate chunks with new-line delimiter
Michael Yang's avatar
Michael Yang committed
1245
1246
		bts = append(bts, '\n')
		if _, err := w.Write(bts); err != nil {
1247
			slog.Info(fmt.Sprintf("streamResponse: w.Write failed with %s", err))
Michael Yang's avatar
Michael Yang committed
1248
1249
1250
1251
1252
1253
			return false
		}

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

1255
func (s *Server) ProcessHandler(c *gin.Context) {
1256
	models := []api.ProcessModelResponse{}
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267

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

1268
		mr := api.ProcessModelResponse{
1269
1270
1271
1272
1273
1274
1275
1276
			Model:     model.ShortName,
			Name:      model.ShortName,
			Size:      int64(v.estimatedTotal),
			SizeVRAM:  int64(v.estimatedVRAM),
			Digest:    model.Digest,
			Details:   modelDetails,
			ExpiresAt: v.expiresAt,
		}
1277
1278
1279
1280
1281
1282
1283
1284
		// 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)
		}

1285
1286
1287
		models = append(models, mr)
	}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1288
1289
1290
1291
1292
	slices.SortStableFunc(models, func(i, j api.ProcessModelResponse) int {
		// longest duration remaining listed first
		return cmp.Compare(j.ExpiresAt.Unix(), i.ExpiresAt.Unix())
	})

1293
	c.JSON(http.StatusOK, api.ProcessResponse{Models: models})
1294
1295
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1296
func (s *Server) ChatHandler(c *gin.Context) {
1297
1298
	checkpointStart := time.Now()

Bruce MacDonald's avatar
Bruce MacDonald committed
1299
	var req api.ChatRequest
Michael Yang's avatar
Michael Yang committed
1300
	if err := c.ShouldBindJSON(&req); errors.Is(err, io.EOF) {
Bruce MacDonald's avatar
Bruce MacDonald committed
1301
1302
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
1303
	} else if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1304
1305
1306
1307
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

Michael Yang's avatar
Michael Yang committed
1308
	caps := []Capability{CapabilityCompletion}
1309
	if len(req.Tools) > 0 {
Michael Yang's avatar
tools  
Michael Yang committed
1310
1311
1312
		caps = append(caps, CapabilityTools)
	}

Michael Yang's avatar
Michael Yang committed
1313
	r, m, opts, err := s.scheduleRunner(c.Request.Context(), req.Model, caps, req.Options, req.KeepAlive)
Michael Yang's avatar
Michael Yang committed
1314
1315
	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
1316
		return
Michael Yang's avatar
Michael Yang committed
1317
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
1318
		handleScheduleError(c, req.Model, err)
Bruce MacDonald's avatar
Bruce MacDonald committed
1319
1320
		return
	}
Michael Yang's avatar
Michael Yang committed
1321

1322
1323
	checkpointLoaded := time.Now()

Michael Yang's avatar
Michael Yang committed
1324
1325
	if len(req.Messages) == 0 {
		c.JSON(http.StatusOK, api.ChatResponse{
1326
			Model:      req.Model,
Michael Yang's avatar
Michael Yang committed
1327
1328
			CreatedAt:  time.Now().UTC(),
			Message:    api.Message{Role: "assistant"},
1329
1330
			Done:       true,
			DoneReason: "load",
Michael Yang's avatar
Michael Yang committed
1331
		})
1332
1333
1334
		return
	}

Michael Yang's avatar
Michael Yang committed
1335
	msgs := append(m.Messages, req.Messages...)
1336
	if req.Messages[0].Role != "system" && m.System != "" {
Michael Yang's avatar
Michael Yang committed
1337
		msgs = append([]api.Message{{Role: "system", Content: m.System}}, msgs...)
1338
1339
	}

Michael Yang's avatar
Michael Yang committed
1340
	prompt, images, err := chatPrompt(c.Request.Context(), m, r.Tokenize, opts, msgs, req.Tools)
Michael Yang's avatar
Michael Yang committed
1341
1342
1343
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
1344
1345
	}

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

Bruce MacDonald's avatar
Bruce MacDonald committed
1348
1349
1350
	ch := make(chan any)
	go func() {
		defer close(ch)
Michael Yang's avatar
Michael Yang committed
1351
		if err := r.Completion(c.Request.Context(), llm.CompletionRequest{
Michael Yang's avatar
Michael Yang committed
1352
1353
1354
			Prompt:  prompt,
			Images:  images,
			Format:  req.Format,
Michael Yang's avatar
Michael Yang committed
1355
			Options: opts,
Michael Yang's avatar
Michael Yang committed
1356
		}, func(r llm.CompletionResponse) {
1357
			res := api.ChatResponse{
1358
1359
1360
1361
1362
				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
1363
1364
1365
1366
1367
1368
1369
				Metrics: api.Metrics{
					PromptEvalCount:    r.PromptEvalCount,
					PromptEvalDuration: r.PromptEvalDuration,
					EvalCount:          r.EvalCount,
					EvalDuration:       r.EvalDuration,
				},
			}
1370
1371
1372
1373
1374
1375
1376

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

			ch <- res
Michael Yang's avatar
Michael Yang committed
1377
		}); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1378
1379
1380
1381
1382
			ch <- gin.H{"error": err.Error()}
		}
	}()

	if req.Stream != nil && !*req.Stream {
Michael Yang's avatar
tools  
Michael Yang committed
1383
		var resp api.ChatResponse
Bruce MacDonald's avatar
Bruce MacDonald committed
1384
		var sb strings.Builder
Michael Yang's avatar
Michael Yang committed
1385
1386
		for rr := range ch {
			switch t := rr.(type) {
1387
			case api.ChatResponse:
Michael Yang's avatar
Michael Yang committed
1388
				sb.WriteString(t.Message.Content)
Michael Yang's avatar
tools  
Michael Yang committed
1389
				resp = t
1390
			case gin.H:
Michael Yang's avatar
Michael Yang committed
1391
1392
1393
				msg, ok := t["error"].(string)
				if !ok {
					msg = "unexpected error format in response"
1394
				}
Michael Yang's avatar
Michael Yang committed
1395
1396
1397

				c.JSON(http.StatusInternalServerError, gin.H{"error": msg})
				return
1398
			default:
Michael Yang's avatar
Michael Yang committed
1399
				c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected response"})
1400
				return
Bruce MacDonald's avatar
Bruce MacDonald committed
1401
1402
			}
		}
1403

Michael Yang's avatar
tools  
Michael Yang committed
1404
		resp.Message.Content = sb.String()
1405
1406
1407
1408
1409
1410

		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
1411
1412
1413
		}

		c.JSON(http.StatusOK, resp)
Bruce MacDonald's avatar
Bruce MacDonald committed
1414
1415
1416
1417
1418
		return
	}

	streamResponse(c, ch)
}
1419

Michael Yang's avatar
Michael Yang committed
1420
func handleScheduleError(c *gin.Context, name string, err error) {
Michael Yang's avatar
Michael Yang committed
1421
	switch {
1422
	case errors.Is(err, errCapabilities), errors.Is(err, errRequired):
Michael Yang's avatar
Michael Yang committed
1423
		c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Michael Yang's avatar
Michael Yang committed
1424
	case errors.Is(err, context.Canceled):
1425
		c.JSON(499, gin.H{"error": "request canceled"})
Michael Yang's avatar
Michael Yang committed
1426
	case errors.Is(err, ErrMaxQueue):
1427
		c.JSON(http.StatusServiceUnavailable, gin.H{"error": err.Error()})
Michael Yang's avatar
Michael Yang committed
1428
1429
	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
1430
1431
	default:
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
1432
1433
	}
}