routes.go 35.4 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
167
		if req.Template != "" {
			tmpl, err = template.Parse(req.Template)
			if err != nil {
				c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
				return
			}
		}

		var b bytes.Buffer
Bruce MacDonald's avatar
Bruce MacDonald committed
168
		if req.Context != nil {
Michael Yang's avatar
Michael Yang committed
169
			s, err := r.Detokenize(c.Request.Context(), req.Context)
Bruce MacDonald's avatar
Bruce MacDonald committed
170
171
172
173
174
			if err != nil {
				c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
				return
			}

Michael Yang's avatar
Michael Yang committed
175
			b.WriteString(s)
176
177
		}

178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
		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})
			}

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

		if err := tmpl.Execute(&b, values); err != nil {
Michael Yang's avatar
Michael Yang committed
198
199
200
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
			return
		}
201

Michael Yang's avatar
Michael Yang committed
202
		prompt = b.String()
Bruce MacDonald's avatar
Bruce MacDonald committed
203
204
	}

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

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

			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 {
					tokens, err := r.Tokenize(c.Request.Context(), prompt+sb.String())
					if err != nil {
						ch <- gin.H{"error": err.Error()}
						return
					}
					res.Context = append(req.Context, tokens...)
				}
			}

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

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

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

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

	streamResponse(c, ch)
}

286
func (s *Server) EmbedHandler(c *gin.Context) {
287
	checkpointStart := time.Now()
288
289
290
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
	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
	}

336
337
	checkpointLoaded := time.Now()

338
339
340
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
	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
	}

376
377
	for i, e := range embeddings.Embedding {
		embeddings.Embedding[i] = normalize(e)
378
379
380
	}

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

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

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

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

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

437
	embedding := make([]float64, len(embeddings.Embedding[0]))
438

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

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

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

461
462
463
464
465
466
467
468
	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()})
469
470
471
		return
	}

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

Michael Yang's avatar
Michael Yang committed
479
		regOpts := &registryOptions{
480
481
482
			Insecure: req.Insecure,
		}

483
484
485
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

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

491
492
493
494
495
	if req.Stream != nil && !*req.Stream {
		waitForStream(c, ch)
		return
	}

496
497
498
	streamResponse(c, ch)
}

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

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

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

Michael Yang's avatar
Michael Yang committed
528
		regOpts := &registryOptions{
529
530
531
			Insecure: req.Insecure,
		}

Michael Yang's avatar
Michael Yang committed
532
533
534
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

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

540
541
542
543
544
	if req.Stream != nil && !*req.Stream {
		waitForStream(c, ch)
		return
	}

545
546
547
	streamResponse(c, ch)
}

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

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

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

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

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

598
		sr = f
Michael Yang's avatar
Michael Yang committed
599
	}
Michael Yang's avatar
Michael Yang committed
600

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

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

614
615
616
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

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

625
	if r.Stream != nil && !*r.Stream {
626
627
628
629
		waitForStream(c, ch)
		return
	}

Michael Yang's avatar
Michael Yang committed
630
	streamResponse(c, ch)
Bruce MacDonald's avatar
Bruce MacDonald committed
631
632
}

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

643
644
645
	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))})
646
647
		return
	}
Michael Yang's avatar
Michael Yang committed
648

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

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

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

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

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

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

	c.JSON(http.StatusOK, resp)
}

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

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

718
	if req.System != "" {
719
		m.System = req.System
720
721
	}

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

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

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

760
761
	for k, v := range req.Options {
		if _, ok := req.Options[k]; ok {
762
			m.Options[k] = v
763
764
765
		}
	}

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

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

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

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

831
832
833
834
		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
835
		}
Michael Yang's avatar
Michael Yang committed
836

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

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

Michael Yang's avatar
Michael Yang committed
859
	c.JSON(http.StatusOK, api.ListResponse{Models: models})
Patrick Devine's avatar
Patrick Devine committed
860
861
}

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

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

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

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

Michael Yang's avatar
Michael Yang committed
889
890
891
892
893
	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
894
895
}

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

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

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

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

955
956
	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
957
958
959
		return
	}

Michael Yang's avatar
Michael Yang committed
960
	c.Status(http.StatusCreated)
Michael Yang's avatar
Michael Yang committed
961
962
}

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

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

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

	var tlds = []string{
Jeffrey Morgan's avatar
Jeffrey Morgan committed
994
995
996
		"localhost",
		"local",
		"internal",
997
	}
998

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

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1006
	return false
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1007
}
1008

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

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

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

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

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

1039
1040
1041
1042
1043
1044
			c.Next()
			return
		}

		c.AbortWithStatus(http.StatusForbidden)
	}
1045
}
1046

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

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

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

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

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

1096
1097
1098
1099
	return r
}

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

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

1121
1122
1123
1124
1125
1126
1127
1128
	blobsDir, err := GetBlobsPath("")
	if err != nil {
		return err
	}
	if err := fixBlobs(blobsDir); err != nil {
		return err
	}

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

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

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

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

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

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1181
	s.sched.Run(schedCtx)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1182
1183
1184

	// 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
1185
1186
	gpus := gpu.GetGPUInfo()
	gpus.LogDetails()
1187

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

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

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

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

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

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

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

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

1282
1283
1284
		models = append(models, mr)
	}

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

1290
	c.JSON(http.StatusOK, api.ProcessResponse{Models: models})
1291
1292
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1293
func (s *Server) ChatHandler(c *gin.Context) {
1294
1295
	checkpointStart := time.Now()

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

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

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

1319
1320
	checkpointLoaded := time.Now()

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

1332
	if req.Messages[0].Role != "system" && m.System != "" {
1333
1334
1335
		req.Messages = append([]api.Message{{Role: "system", Content: m.System}}, req.Messages...)
	}

Michael Yang's avatar
tools  
Michael Yang committed
1336
	prompt, images, err := chatPrompt(c.Request.Context(), m, r.Tokenize, opts, req.Messages, req.Tools)
Michael Yang's avatar
Michael Yang committed
1337
1338
1339
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
1340
1341
	}

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

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

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

			ch <- res
Michael Yang's avatar
Michael Yang committed
1373
		}); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1374
1375
1376
1377
1378
			ch <- gin.H{"error": err.Error()}
		}
	}()

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

				c.JSON(http.StatusInternalServerError, gin.H{"error": msg})
				return
1394
			default:
Michael Yang's avatar
Michael Yang committed
1395
				c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected response"})
1396
				return
Bruce MacDonald's avatar
Bruce MacDonald committed
1397
1398
			}
		}
1399

Michael Yang's avatar
tools  
Michael Yang committed
1400
		resp.Message.Content = sb.String()
1401
1402
1403
1404
1405
1406

		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
1407
1408
1409
		}

		c.JSON(http.StatusOK, resp)
Bruce MacDonald's avatar
Bruce MacDonald committed
1410
1411
1412
1413
1414
		return
	}

	streamResponse(c, ch)
}
1415

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