routes.go 35.1 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
287
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
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
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
401
func (s *Server) EmbeddingsHandler(c *gin.Context) {
Bruce MacDonald's avatar
Bruce MacDonald committed
402
	var req api.EmbeddingRequest
Michael Yang's avatar
Michael Yang committed
403
	if err := c.ShouldBindJSON(&req); errors.Is(err, io.EOF) {
Bruce MacDonald's avatar
Bruce MacDonald committed
404
405
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
406
	} else if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
407
408
409
410
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

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

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

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

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

431
432
433
434
435
436
437
438
439
440
	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
441
442
}

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

455
456
457
458
459
460
461
462
	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()})
463
464
465
		return
	}

466
467
468
	ch := make(chan any)
	go func() {
		defer close(ch)
469
470
		fn := func(r api.ProgressResponse) {
			ch <- r
471
		}
472

Michael Yang's avatar
Michael Yang committed
473
		regOpts := &registryOptions{
474
475
476
			Insecure: req.Insecure,
		}

477
478
479
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

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

485
486
487
488
489
	if req.Stream != nil && !*req.Stream {
		waitForStream(c, ch)
		return
	}

490
491
492
	streamResponse(c, ch)
}

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

Michael Yang's avatar
Michael Yang committed
505
506
507
508
509
510
511
	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"})
512
513
514
		return
	}

515
516
517
	ch := make(chan any)
	go func() {
		defer close(ch)
518
519
		fn := func(r api.ProgressResponse) {
			ch <- r
520
		}
521

Michael Yang's avatar
Michael Yang committed
522
		regOpts := &registryOptions{
523
524
525
			Insecure: req.Insecure,
		}

Michael Yang's avatar
Michael Yang committed
526
527
528
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

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

534
535
536
537
538
	if req.Stream != nil && !*req.Stream {
		waitForStream(c, ch)
		return
	}

539
540
541
	streamResponse(c, ch)
}

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

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

573
574
575
576
577
	if err := checkNameExists(name); err != nil {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

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

583
584
585
	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
586
587
588
589
		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
590
		defer f.Close()
Michael Yang's avatar
Michael Yang committed
591

592
		sr = f
Michael Yang's avatar
Michael Yang committed
593
	}
Michael Yang's avatar
Michael Yang committed
594

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

Michael Yang's avatar
Michael Yang committed
601
	ch := make(chan any)
Michael Yang's avatar
Michael Yang committed
602
603
	go func() {
		defer close(ch)
604
605
		fn := func(resp api.ProgressResponse) {
			ch <- resp
606
607
		}

608
609
610
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

611
612
		quantization := cmp.Or(r.Quantize, r.Quantization)
		if err := CreateModel(ctx, name, filepath.Dir(r.Path), strings.ToUpper(quantization), f, fn); err != nil {
Josh's avatar
Josh committed
613
			if errors.Is(err, errBadTemplate) {
614
				ch <- gin.H{"error": err.Error(), "status": http.StatusBadRequest}
Josh's avatar
Josh committed
615
			}
Michael Yang's avatar
Michael Yang committed
616
			ch <- gin.H{"error": err.Error()}
617
		}
Michael Yang's avatar
Michael Yang committed
618
	}()
Michael Yang's avatar
Michael Yang committed
619

620
	if r.Stream != nil && !*r.Stream {
621
622
623
624
		waitForStream(c, ch)
		return
	}

Michael Yang's avatar
Michael Yang committed
625
	streamResponse(c, ch)
Bruce MacDonald's avatar
Bruce MacDonald committed
626
627
}

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

638
639
640
	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))})
641
642
		return
	}
Michael Yang's avatar
Michael Yang committed
643

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

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

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

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

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

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

	c.JSON(http.StatusOK, resp)
}

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

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

713
	if req.System != "" {
714
		m.System = req.System
715
716
	}

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

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

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

755
756
	for k, v := range req.Options {
		if _, ok := req.Options[k]; ok {
757
			m.Options[k] = v
758
759
760
		}
	}

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

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

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

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

826
827
828
829
		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
830
		}
Michael Yang's avatar
Michael Yang committed
831

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

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

Michael Yang's avatar
Michael Yang committed
854
	c.JSON(http.StatusOK, api.ListResponse{Models: models})
Patrick Devine's avatar
Patrick Devine committed
855
856
}

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

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

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

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

Michael Yang's avatar
Michael Yang committed
884
885
886
887
888
	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
889
890
}

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

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

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

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

950
951
	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
952
953
954
		return
	}

Michael Yang's avatar
Michael Yang committed
955
	c.Status(http.StatusCreated)
Michael Yang's avatar
Michael Yang committed
956
957
}

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

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

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

	var tlds = []string{
Jeffrey Morgan's avatar
Jeffrey Morgan committed
989
990
991
		"localhost",
		"local",
		"internal",
992
	}
993

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

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1001
	return false
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1002
}
1003

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

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

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

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

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

1034
1035
1036
1037
1038
1039
			c.Next()
			return
		}

		c.AbortWithStatus(http.StatusForbidden)
	}
1040
}
1041

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

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

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

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

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

1091
1092
1093
1094
	return r
}

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

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

1116
1117
1118
1119
1120
1121
1122
1123
	blobsDir, err := GetBlobsPath("")
	if err != nil {
		return err
	}
	if err := fixBlobs(blobsDir); err != nil {
		return err
	}

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

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

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

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

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

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1176
	s.sched.Run(schedCtx)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1177
1178
1179

	// 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
1180
1181
	gpus := gpu.GetGPUInfo()
	gpus.LogDetails()
1182

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

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

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

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

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

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

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

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

1277
1278
1279
		models = append(models, mr)
	}

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

1285
	c.JSON(http.StatusOK, api.ProcessResponse{Models: models})
1286
1287
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1288
func (s *Server) ChatHandler(c *gin.Context) {
1289
1290
	checkpointStart := time.Now()

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

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

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

1314
1315
	checkpointLoaded := time.Now()

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

1327
	if req.Messages[0].Role != "system" && m.System != "" {
1328
1329
1330
		req.Messages = append([]api.Message{{Role: "system", Content: m.System}}, req.Messages...)
	}

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

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

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

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

			ch <- res
Michael Yang's avatar
Michael Yang committed
1368
		}); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1369
1370
1371
1372
1373
			ch <- gin.H{"error": err.Error()}
		}
	}()

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

				c.JSON(http.StatusInternalServerError, gin.H{"error": msg})
				return
1389
			default:
Michael Yang's avatar
Michael Yang committed
1390
				c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected response"})
1391
				return
Bruce MacDonald's avatar
Bruce MacDonald committed
1392
1393
			}
		}
1394

Michael Yang's avatar
tools  
Michael Yang committed
1395
		resp.Message.Content = sb.String()
1396
1397
1398
1399
1400
1401

		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
1402
1403
1404
		}

		c.JSON(http.StatusOK, resp)
Bruce MacDonald's avatar
Bruce MacDonald committed
1405
1406
1407
1408
1409
		return
	}

	streamResponse(c, ch)
}
1410

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