routes.go 35.2 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
		var b bytes.Buffer
191
		if err := tmpl.Execute(&b, values); err != nil {
Michael Yang's avatar
Michael Yang committed
192
193
194
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
			return
		}
195

Michael Yang's avatar
Michael Yang committed
196
197
198
199
200
201
202
203
204
205
		if req.Context != nil {
			s, err := r.Detokenize(c.Request.Context(), req.Context)
			if err != nil {
				c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
				return
			}

			b.WriteString(s)
		}

Michael Yang's avatar
Michael Yang committed
206
		prompt = b.String()
Bruce MacDonald's avatar
Bruce MacDonald committed
207
208
	}

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

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

			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
255
		}); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
256
257
258
259
260
			ch <- gin.H{"error": err.Error()}
		}
	}()

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

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

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

	streamResponse(c, ch)
}

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
336
337
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
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
func (s *Server) EmbedHandler(c *gin.Context) {
	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
	}

	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
	}

	for i, e := range embeddings {
		embeddings[i] = normalize(e)
	}

	resp := api.EmbedResponse{
		Model:      req.Model,
		Embeddings: embeddings,
	}
	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
405
func (s *Server) EmbeddingsHandler(c *gin.Context) {
Bruce MacDonald's avatar
Bruce MacDonald committed
406
	var req api.EmbeddingRequest
Michael Yang's avatar
Michael Yang committed
407
	if err := c.ShouldBindJSON(&req); errors.Is(err, io.EOF) {
Bruce MacDonald's avatar
Bruce MacDonald committed
408
409
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
410
	} else if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
411
412
413
414
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

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

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

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

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

435
436
437
438
439
440
441
442
443
444
	embedding := make([]float64, len(embeddings[0]))

	for i, v := range embeddings[0] {
		embedding[i] = float64(v)
	}

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

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

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

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

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

481
482
483
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

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

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

494
495
496
	streamResponse(c, ch)
}

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

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

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

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

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

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

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

543
544
545
	streamResponse(c, ch)
}

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

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

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

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

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

596
		sr = f
Michael Yang's avatar
Michael Yang committed
597
	}
Michael Yang's avatar
Michael Yang committed
598

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

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

612
613
614
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

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

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

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

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

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

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

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

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

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

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

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

	c.JSON(http.StatusOK, resp)
}

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

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

716
	if req.System != "" {
717
		m.System = req.System
718
719
	}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

953
954
	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
955
956
957
		return
	}

Michael Yang's avatar
Michael Yang committed
958
	c.Status(http.StatusCreated)
Michael Yang's avatar
Michael Yang committed
959
960
}

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

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

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

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

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

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1004
	return false
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1005
}
1006

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

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

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

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

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

1037
1038
1039
1040
1041
1042
			c.Next()
			return
		}

		c.AbortWithStatus(http.StatusForbidden)
	}
1043
}
1044

1045
func (s *Server) GenerateRoutes() http.Handler {
Michael Yang's avatar
Michael Yang committed
1046
1047
	config := cors.DefaultConfig()
	config.AllowWildcard = true
1048
	config.AllowBrowserExtensions = true
1049
	config.AllowHeaders = []string{"Authorization", "Content-Type", "User-Agent", "Accept", "X-Requested-With"}
royjhan's avatar
royjhan committed
1050
1051
1052
1053
	openAIProperties := []string{"lang", "package-version", "os", "arch", "runtime", "runtime-version", "async"}
	for _, prop := range openAIProperties {
		config.AllowHeaders = append(config.AllowHeaders, "x-stainless-"+prop)
	}
1054
	config.AllowOrigins = envconfig.AllowOrigins
Michael Yang's avatar
Michael Yang committed
1055

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

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

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

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

1094
1095
1096
1097
	return r
}

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

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

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

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

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

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

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

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

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1179
	s.sched.Run(schedCtx)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1180
1181
1182

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

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

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

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

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

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

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

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

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

1280
1281
1282
		models = append(models, mr)
	}

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

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

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

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

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

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

1317
1318
	checkpointLoaded := time.Now()

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

Michael Yang's avatar
Michael Yang committed
1330
	msgs := append(m.Messages, req.Messages...)
1331
	if req.Messages[0].Role != "system" && m.System != "" {
Michael Yang's avatar
Michael Yang committed
1332
		msgs = append([]api.Message{{Role: "system", Content: m.System}}, msgs...)
1333
1334
	}

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

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

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

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

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

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

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

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

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

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

	streamResponse(c, ch)
}
1414

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