routes.go 34.7 KB
Newer Older
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1
2
3
package server

import (
Michael Yang's avatar
Michael Yang committed
4
	"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
59
var errRequired = errors.New("is required")

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

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

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

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

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

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

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

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

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

Michael Yang's avatar
Michael Yang committed
124
	caps := []Capability{CapabilityCompletion}
Michael Yang's avatar
Michael Yang committed
125
	r, m, opts, err := s.scheduleRunner(c.Request.Context(), req.Model, caps, req.Options, req.KeepAlive)
Michael Yang's avatar
Michael Yang committed
126
127
128
129
	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
130
131
132
133
		handleScheduleError(c, req.Model, err)
		return
	}

134
135
	checkpointLoaded := time.Now()

Michael Yang's avatar
Michael Yang committed
136
137
138
139
140
141
142
	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
143
144
		return
	}
Bruce MacDonald's avatar
Bruce MacDonald committed
145

Michael Yang's avatar
Michael Yang committed
146
147
148
149
	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
150

Michael Yang's avatar
Michael Yang committed
151
152
153
154
155
	prompt := req.Prompt
	if !req.Raw {
		var msgs []api.Message
		if req.System != "" {
			msgs = append(msgs, api.Message{Role: "system", Content: req.System})
Michael Yang's avatar
Michael Yang committed
156
157
		} else if m.System != "" {
			msgs = append(msgs, api.Message{Role: "system", Content: m.System})
158
159
		}

Michael Yang's avatar
Michael Yang committed
160
161
		for _, i := range images {
			msgs = append(msgs, api.Message{Role: "user", Content: fmt.Sprintf("[img-%d]", i.ID)})
Michael Yang's avatar
Michael Yang committed
162
163
		}

Michael Yang's avatar
Michael Yang committed
164
		msgs = append(msgs, api.Message{Role: "user", Content: req.Prompt})
Michael Yang's avatar
Michael Yang committed
165

Michael Yang's avatar
Michael Yang committed
166
		tmpl := m.Template
Michael Yang's avatar
Michael Yang committed
167
168
169
170
171
172
173
174
175
		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
176
		if req.Context != nil {
Michael Yang's avatar
Michael Yang committed
177
			s, err := r.Detokenize(c.Request.Context(), req.Context)
Bruce MacDonald's avatar
Bruce MacDonald committed
178
179
180
181
182
			if err != nil {
				c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
				return
			}

Michael Yang's avatar
Michael Yang committed
183
			b.WriteString(s)
184
185
		}

Michael Yang's avatar
Michael Yang committed
186
187
188
189
		if err := tmpl.Execute(&b, template.Values{Messages: msgs}); err != nil {
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
			return
		}
190

Michael Yang's avatar
Michael Yang committed
191
		prompt = b.String()
Bruce MacDonald's avatar
Bruce MacDonald committed
192
193
	}

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

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

			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
240
		}); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
241
242
243
244
245
			ch <- gin.H{"error": err.Error()}
		}
	}()

	if req.Stream != nil && !*req.Stream {
Michael Yang's avatar
Michael Yang committed
246
		var r api.GenerateResponse
Bruce MacDonald's avatar
Bruce MacDonald committed
247
		var sb strings.Builder
Michael Yang's avatar
Michael Yang committed
248
249
		for rr := range ch {
			switch t := rr.(type) {
250
			case api.GenerateResponse:
Michael Yang's avatar
Michael Yang committed
251
252
				sb.WriteString(t.Response)
				r = t
253
			case gin.H:
Michael Yang's avatar
Michael Yang committed
254
255
256
				msg, ok := t["error"].(string)
				if !ok {
					msg = "unexpected error format in response"
257
				}
Michael Yang's avatar
Michael Yang committed
258
259
260

				c.JSON(http.StatusInternalServerError, gin.H{"error": msg})
				return
261
			default:
Michael Yang's avatar
Michael Yang committed
262
				c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected response"})
Bruce MacDonald's avatar
Bruce MacDonald committed
263
264
265
				return
			}
		}
266

Michael Yang's avatar
Michael Yang committed
267
		r.Response = sb.String()
Michael Yang's avatar
tools  
Michael Yang committed
268
269
270
271
272
		if toolCalls, ok := m.parseToolCalls(sb.String()); ok {
			r.ToolCalls = toolCalls
			r.Response = ""
		}

Michael Yang's avatar
Michael Yang committed
273
		c.JSON(http.StatusOK, r)
Bruce MacDonald's avatar
Bruce MacDonald committed
274
275
276
277
278
279
		return
	}

	streamResponse(c, ch)
}

280
281
282
283
284
285
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
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
395
func (s *Server) EmbeddingsHandler(c *gin.Context) {
Bruce MacDonald's avatar
Bruce MacDonald committed
396
	var req api.EmbeddingRequest
Michael Yang's avatar
Michael Yang committed
397
	if err := c.ShouldBindJSON(&req); errors.Is(err, io.EOF) {
Bruce MacDonald's avatar
Bruce MacDonald committed
398
399
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
400
	} else if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
401
402
403
404
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

Michael Yang's avatar
Michael Yang committed
405
	r, _, _, err := s.scheduleRunner(c.Request.Context(), req.Model, []Capability{}, req.Options, req.KeepAlive)
Bruce MacDonald's avatar
Bruce MacDonald committed
406
	if err != nil {
Michael Yang's avatar
Michael Yang committed
407
		handleScheduleError(c, req.Model, err)
Bruce MacDonald's avatar
Bruce MacDonald committed
408
409
410
		return
	}

411
412
413
	// an empty request loads the model
	if req.Prompt == "" {
		c.JSON(http.StatusOK, api.EmbeddingResponse{Embedding: []float64{}})
Bruce MacDonald's avatar
Bruce MacDonald committed
414
415
416
		return
	}

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

Bruce MacDonald's avatar
Bruce MacDonald committed
419
	if err != nil {
420
		slog.Info(fmt.Sprintf("embedding generation failed: %v", err))
Bruce MacDonald's avatar
Bruce MacDonald committed
421
422
423
424
		c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to generate embedding"})
		return
	}

425
426
427
428
429
430
431
432
433
434
	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
435
436
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
437
func (s *Server) PullModelHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
438
	var req api.PullRequest
Michael Yang's avatar
Michael Yang committed
439
440
441
442
443
444
445
	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
446
447
448
		return
	}

449
450
451
452
453
454
455
456
	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()})
457
458
459
		return
	}

460
461
462
	ch := make(chan any)
	go func() {
		defer close(ch)
463
464
		fn := func(r api.ProgressResponse) {
			ch <- r
465
		}
466

Michael Yang's avatar
Michael Yang committed
467
		regOpts := &registryOptions{
468
469
470
			Insecure: req.Insecure,
		}

471
472
473
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

474
		if err := PullModel(ctx, name.DisplayShortest(), regOpts, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
475
			ch <- gin.H{"error": err.Error()}
476
477
478
		}
	}()

479
480
481
482
483
	if req.Stream != nil && !*req.Stream {
		waitForStream(c, ch)
		return
	}

484
485
486
	streamResponse(c, ch)
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
487
func (s *Server) PushModelHandler(c *gin.Context) {
488
	var req api.PushRequest
Michael Yang's avatar
Michael Yang committed
489
490
491
492
493
494
495
	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
496
497
		return
	}
Michael Yang's avatar
Michael Yang committed
498

Michael Yang's avatar
Michael Yang committed
499
500
501
502
503
504
505
	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"})
506
507
508
		return
	}

509
510
511
	ch := make(chan any)
	go func() {
		defer close(ch)
512
513
		fn := func(r api.ProgressResponse) {
			ch <- r
514
		}
515

Michael Yang's avatar
Michael Yang committed
516
		regOpts := &registryOptions{
517
518
519
			Insecure: req.Insecure,
		}

Michael Yang's avatar
Michael Yang committed
520
521
522
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

Michael Yang's avatar
Michael Yang committed
523
		if err := PushModel(ctx, model, regOpts, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
524
			ch <- gin.H{"error": err.Error()}
525
526
527
		}
	}()

528
529
530
531
532
	if req.Stream != nil && !*req.Stream {
		waitForStream(c, ch)
		return
	}

533
534
535
	streamResponse(c, ch)
}

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

561
	name := model.ParseName(cmp.Or(r.Model, r.Name))
Michael Yang's avatar
Michael Yang committed
562
	if !name.IsValid() {
563
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": errtypes.InvalidModelNameErrMsg})
564
565
566
		return
	}

567
568
569
570
571
	if err := checkNameExists(name); err != nil {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

572
	if r.Path == "" && r.Modelfile == "" {
Michael Yang's avatar
Michael Yang committed
573
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "path or modelfile are required"})
Michael Yang's avatar
Michael Yang committed
574
575
		return
	}
Michael Yang's avatar
Michael Yang committed
576

577
578
579
	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
580
581
582
583
		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
584
		defer f.Close()
Michael Yang's avatar
Michael Yang committed
585

586
		sr = f
Michael Yang's avatar
Michael Yang committed
587
	}
Michael Yang's avatar
Michael Yang committed
588

589
	f, err := parser.ParseFile(sr)
Michael Yang's avatar
Michael Yang committed
590
591
592
593
594
	if err != nil {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

Michael Yang's avatar
Michael Yang committed
595
	ch := make(chan any)
Michael Yang's avatar
Michael Yang committed
596
597
	go func() {
		defer close(ch)
598
599
		fn := func(resp api.ProgressResponse) {
			ch <- resp
600
601
		}

602
603
604
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

605
606
		quantization := cmp.Or(r.Quantize, r.Quantization)
		if err := CreateModel(ctx, name, filepath.Dir(r.Path), strings.ToUpper(quantization), f, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
607
			ch <- gin.H{"error": err.Error()}
608
		}
Michael Yang's avatar
Michael Yang committed
609
	}()
Michael Yang's avatar
Michael Yang committed
610

611
	if r.Stream != nil && !*r.Stream {
612
613
614
615
		waitForStream(c, ch)
		return
	}

Michael Yang's avatar
Michael Yang committed
616
	streamResponse(c, ch)
Bruce MacDonald's avatar
Bruce MacDonald committed
617
618
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
619
func (s *Server) DeleteModelHandler(c *gin.Context) {
620
621
	var r api.DeleteRequest
	if err := c.ShouldBindJSON(&r); errors.Is(err, io.EOF) {
Michael Yang's avatar
Michael Yang committed
622
623
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
624
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
625
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
626
627
628
		return
	}

629
630
631
	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))})
632
633
		return
	}
Michael Yang's avatar
Michael Yang committed
634

635
	m, err := ParseNamedManifest(n)
Michael Yang's avatar
Michael Yang committed
636
637
638
639
640
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

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

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

Daniel Hiltgen's avatar
Daniel Hiltgen committed
652
func (s *Server) ShowModelHandler(c *gin.Context) {
Patrick Devine's avatar
Patrick Devine committed
653
	var req api.ShowRequest
Michael Yang's avatar
Michael Yang committed
654
655
656
657
658
659
660
	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
661
662
663
		return
	}

Michael Yang's avatar
Michael Yang committed
664
	if req.Model != "" {
Michael Yang's avatar
Michael Yang committed
665
		// noop
Michael Yang's avatar
Michael Yang committed
666
	} else if req.Name != "" {
Michael Yang's avatar
Michael Yang committed
667
		req.Model = req.Name
Michael Yang's avatar
Michael Yang committed
668
	} else {
669
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
670
671
672
		return
	}

673
	resp, err := GetModelInfo(req)
Patrick Devine's avatar
Patrick Devine committed
674
	if err != nil {
675
676
		switch {
		case os.IsNotExist(err):
Michael Yang's avatar
Michael Yang committed
677
			c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found", req.Model)})
678
679
680
		case err.Error() == "invalid model name":
			c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		default:
Patrick Devine's avatar
Patrick Devine committed
681
682
683
684
685
686
687
688
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		}
		return
	}

	c.JSON(http.StatusOK, resp)
}

689
func GetModelInfo(req api.ShowRequest) (*api.ShowResponse, error) {
690
	m, err := GetModel(req.Model)
Patrick Devine's avatar
Patrick Devine committed
691
692
693
694
	if err != nil {
		return nil, err
	}

Patrick Devine's avatar
Patrick Devine committed
695
	modelDetails := api.ModelDetails{
696
697
698
699
700
701
		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
702
703
	}

704
	if req.System != "" {
705
		m.System = req.System
706
707
	}

Michael Yang's avatar
Michael Yang committed
708
709
710
	msgs := make([]api.Message, len(m.Messages))
	for i, msg := range m.Messages {
		msgs[i] = api.Message{Role: msg.Role, Content: msg.Content}
711
712
	}

713
714
715
716
717
718
719
720
721
722
	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
723
	resp := &api.ShowResponse{
724
725
		License:    strings.Join(m.License, "\n"),
		System:     m.System,
Michael Yang's avatar
Michael Yang committed
726
		Template:   m.Template.String(),
727
728
729
		Details:    modelDetails,
		Messages:   msgs,
		ModifiedAt: manifest.fi.ModTime(),
Patrick Devine's avatar
Patrick Devine committed
730
731
732
733
	}

	var params []string
	cs := 30
734
	for k, v := range m.Options {
Patrick Devine's avatar
Patrick Devine committed
735
736
737
		switch val := v.(type) {
		case []interface{}:
			for _, nv := range val {
Patrick Devine's avatar
Patrick Devine committed
738
				params = append(params, fmt.Sprintf("%-*s %#v", cs, k, nv))
Patrick Devine's avatar
Patrick Devine committed
739
			}
Patrick Devine's avatar
Patrick Devine committed
740
741
		default:
			params = append(params, fmt.Sprintf("%-*s %#v", cs, k, v))
Patrick Devine's avatar
Patrick Devine committed
742
743
744
745
		}
	}
	resp.Parameters = strings.Join(params, "\n")

746
747
	for k, v := range req.Options {
		if _, ok := req.Options[k]; ok {
748
			m.Options[k] = v
749
750
751
		}
	}

752
	var sb strings.Builder
753
	fmt.Fprintln(&sb, "# Modelfile generated by \"ollama show\"")
754
	fmt.Fprintln(&sb, "# To build a new Modelfile based on this, replace FROM with:")
755
756
	fmt.Fprintf(&sb, "# FROM %s\n\n", m.ShortName)
	fmt.Fprint(&sb, m.String())
757
	resp.Modelfile = sb.String()
758

759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
	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
775
776
777
	return resp, nil
}

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

808
	models := []api.ListModelResponse{}
809
810
811
812
813
814
815
	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()
816

817
818
819
820
		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
821
		}
Michael Yang's avatar
Michael Yang committed
822

823
		// tag should never be masked
824
		models = append(models, api.ListModelResponse{
825
826
827
828
829
830
831
832
833
834
835
836
837
			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
838
839
	}

840
	slices.SortStableFunc(models, func(i, j api.ListModelResponse) int {
841
842
843
844
		// most recently modified first
		return cmp.Compare(j.ModifiedAt.Unix(), i.ModifiedAt.Unix())
	})

Michael Yang's avatar
Michael Yang committed
845
	c.JSON(http.StatusOK, api.ListResponse{Models: models})
Patrick Devine's avatar
Patrick Devine committed
846
847
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
848
func (s *Server) CopyModelHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
849
850
	var r api.CopyRequest
	if err := c.ShouldBindJSON(&r); errors.Is(err, io.EOF) {
Michael Yang's avatar
Michael Yang committed
851
852
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
853
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
854
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Patrick Devine's avatar
Patrick Devine committed
855
856
857
		return
	}

Michael Yang's avatar
Michael Yang committed
858
859
	src := model.ParseName(r.Source)
	if !src.IsValid() {
Michael Yang's avatar
Michael Yang committed
860
861
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("source %q is invalid", r.Source)})
		return
862
863
	}

Michael Yang's avatar
Michael Yang committed
864
865
	dst := model.ParseName(r.Destination)
	if !dst.IsValid() {
866
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("destination %q is invalid", r.Destination)})
Patrick Devine's avatar
Patrick Devine committed
867
868
		return
	}
Michael Yang's avatar
Michael Yang committed
869

870
871
872
873
874
	if err := checkNameExists(dst); err != nil {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

Michael Yang's avatar
Michael Yang committed
875
876
877
878
879
	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
880
881
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
882
func (s *Server) HeadBlobHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
883
884
885
886
887
888
889
890
891
892
893
	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
894
	c.Status(http.StatusOK)
Michael Yang's avatar
Michael Yang committed
895
896
}

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

917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
	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
	}

935
	layer, err := NewLayer(c.Request.Body, "")
Michael Yang's avatar
Michael Yang committed
936
937
938
939
940
	if err != nil {
		c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

941
942
	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
943
944
945
		return
	}

Michael Yang's avatar
Michael Yang committed
946
	c.Status(http.StatusCreated)
Michael Yang's avatar
Michael Yang committed
947
948
}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
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
}

970
func allowedHost(host string) bool {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
971
	if host == "" || host == "localhost" {
972
973
974
975
976
977
978
979
		return true
	}

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

	var tlds = []string{
Jeffrey Morgan's avatar
Jeffrey Morgan committed
980
981
982
		"localhost",
		"local",
		"internal",
983
	}
984

Jeffrey Morgan's avatar
Jeffrey Morgan committed
985
	// check if the host is a local TLD
986
987
988
989
990
991
	for _, tld := range tlds {
		if strings.HasSuffix(host, "."+tld) {
			return true
		}
	}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
992
	return false
Jeffrey Morgan's avatar
Jeffrey Morgan committed
993
}
994

Jeffrey Morgan's avatar
Jeffrey Morgan committed
995
996
997
func allowedHostsMiddleware(addr net.Addr) gin.HandlerFunc {
	return func(c *gin.Context) {
		if addr == nil {
998
999
1000
1001
			c.Next()
			return
		}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1002
		if addr, err := netip.ParseAddrPort(addr.String()); err == nil && !addr.Addr().IsLoopback() {
1003
1004
1005
1006
1007
1008
1009
1010
1011
			c.Next()
			return
		}

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

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1012
		if addr, err := netip.ParseAddr(host); err == nil {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1013
			if addr.IsLoopback() || addr.IsPrivate() || addr.IsUnspecified() || isLocalIP(addr) {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1014
1015
1016
1017
1018
				c.Next()
				return
			}
		}

1019
		if allowedHost(host) {
Michael Yang's avatar
lint  
Michael Yang committed
1020
			if c.Request.Method == http.MethodOptions {
1021
1022
1023
1024
				c.AbortWithStatus(http.StatusNoContent)
				return
			}

1025
1026
1027
1028
1029
1030
			c.Next()
			return
		}

		c.AbortWithStatus(http.StatusForbidden)
	}
1031
}
1032

1033
func (s *Server) GenerateRoutes() http.Handler {
Michael Yang's avatar
Michael Yang committed
1034
1035
	config := cors.DefaultConfig()
	config.AllowWildcard = true
1036
	config.AllowBrowserExtensions = true
1037
	config.AllowHeaders = []string{"Authorization", "Content-Type", "User-Agent", "Accept", "X-Requested-With"}
royjhan's avatar
royjhan committed
1038
1039
1040
1041
	openAIProperties := []string{"lang", "package-version", "os", "arch", "runtime", "runtime-version", "async"}
	for _, prop := range openAIProperties {
		config.AllowHeaders = append(config.AllowHeaders, "x-stainless-"+prop)
	}
1042
	config.AllowOrigins = envconfig.AllowOrigins
Michael Yang's avatar
Michael Yang committed
1043

Bruce MacDonald's avatar
Bruce MacDonald committed
1044
	r := gin.Default()
1045
1046
	r.Use(
		cors.New(config),
1047
		allowedHostsMiddleware(s.addr),
1048
	)
Bruce MacDonald's avatar
Bruce MacDonald committed
1049

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1050
1051
1052
	r.POST("/api/pull", s.PullModelHandler)
	r.POST("/api/generate", s.GenerateHandler)
	r.POST("/api/chat", s.ChatHandler)
1053
	r.POST("/api/embed", s.EmbedHandler)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1054
1055
1056
1057
1058
1059
1060
1061
	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)
1062
	r.GET("/api/ps", s.ProcessHandler)
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1063

1064
	// Compatibility endpoints
1065
	r.POST("/v1/chat/completions", openai.ChatMiddleware(), s.ChatHandler)
1066
	r.POST("/v1/completions", openai.CompletionsMiddleware(), s.GenerateHandler)
1067
1068
	r.GET("/v1/models", openai.ListMiddleware(), s.ListModelsHandler)
	r.GET("/v1/models/:model", openai.RetrieveMiddleware(), s.ShowModelHandler)
1069

Michael Yang's avatar
Michael Yang committed
1070
1071
1072
1073
1074
	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
1075
		r.Handle(method, "/api/tags", s.ListModelsHandler)
Michael Yang's avatar
Michael Yang committed
1076
1077
1078
		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
1079
1080
	}

1081
1082
1083
1084
	return r
}

func Serve(ln net.Listener) error {
Michael Yang's avatar
Michael Yang committed
1085
	level := slog.LevelInfo
1086
	if envconfig.Debug {
Michael Yang's avatar
Michael Yang committed
1087
		level = slog.LevelDebug
1088
	}
Michael Yang's avatar
Michael Yang committed
1089

1090
	slog.Info("server config", "env", envconfig.Values())
Michael Yang's avatar
Michael Yang committed
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
	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))

1106
1107
1108
1109
1110
1111
1112
1113
	blobsDir, err := GetBlobsPath("")
	if err != nil {
		return err
	}
	if err := fixBlobs(blobsDir); err != nil {
		return err
	}

1114
	if !envconfig.NoPrune {
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
		// 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
1130
	ctx, done := context.WithCancel(context.Background())
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1131
1132
	schedCtx, schedDone := context.WithCancel(ctx)
	sched := InitScheduler(schedCtx)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1133
	s := &Server{addr: ln.Addr(), sched: sched}
1134
1135

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

1137
	slog.Info(fmt.Sprintf("Listening on %s (version %s)", ln.Addr(), version.Version))
1138
	srvr := &http.Server{
1139
1140
1141
1142
1143
1144
1145
1146
1147
		// 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
1148
1149
	}

1150
1151
	// listen for a ctrl+c and stop any loaded llm
	signals := make(chan os.Signal, 1)
1152
	signal.Notify(signals, syscall.SIGINT, syscall.SIGTERM)
1153
1154
	go func() {
		<-signals
1155
		srvr.Close()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1156
		schedDone()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1157
		sched.unloadAllRunners()
1158
		gpu.Cleanup()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1159
		done()
1160
1161
	}()

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1162
	if err := llm.Init(); err != nil {
1163
1164
		return fmt.Errorf("unable to initialize llm library %w", err)
	}
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1165

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1166
	s.sched.Run(schedCtx)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1167
1168
1169

	// 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
1170
1171
	gpus := gpu.GetGPUInfo()
	gpus.LogDetails()
1172

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1173
1174
1175
1176
1177
1178
1179
	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()
1180
	return nil
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1181
}
Michael Yang's avatar
Michael Yang committed
1182

1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
func waitForStream(c *gin.Context, ch chan interface{}) {
	c.Header("Content-Type", "application/json")
	for resp := range ch {
		switch r := resp.(type) {
		case api.ProgressResponse:
			if r.Status == "success" {
				c.JSON(http.StatusOK, r)
				return
			}
		case gin.H:
			if errorMsg, ok := r["error"].(string); ok {
				c.JSON(http.StatusInternalServerError, gin.H{"error": errorMsg})
				return
			} else {
				c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected error format in progress response"})
				return
			}
		default:
			c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected progress response"})
			return
		}
	}
	c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected end of progress response"})
}

Michael Yang's avatar
Michael Yang committed
1208
func streamResponse(c *gin.Context, ch chan any) {
1209
	c.Header("Content-Type", "application/x-ndjson")
Michael Yang's avatar
Michael Yang committed
1210
1211
1212
1213
1214
1215
1216
1217
	c.Stream(func(w io.Writer) bool {
		val, ok := <-ch
		if !ok {
			return false
		}

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

1222
		// Delineate chunks with new-line delimiter
Michael Yang's avatar
Michael Yang committed
1223
1224
		bts = append(bts, '\n')
		if _, err := w.Write(bts); err != nil {
1225
			slog.Info(fmt.Sprintf("streamResponse: w.Write failed with %s", err))
Michael Yang's avatar
Michael Yang committed
1226
1227
1228
1229
1230
1231
			return false
		}

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

1233
func (s *Server) ProcessHandler(c *gin.Context) {
1234
	models := []api.ProcessModelResponse{}
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245

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

1246
		mr := api.ProcessModelResponse{
1247
1248
1249
1250
1251
1252
1253
1254
			Model:     model.ShortName,
			Name:      model.ShortName,
			Size:      int64(v.estimatedTotal),
			SizeVRAM:  int64(v.estimatedVRAM),
			Digest:    model.Digest,
			Details:   modelDetails,
			ExpiresAt: v.expiresAt,
		}
1255
1256
1257
1258
1259
1260
1261
1262
		// 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)
		}

1263
1264
1265
		models = append(models, mr)
	}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1266
1267
1268
1269
1270
	slices.SortStableFunc(models, func(i, j api.ProcessModelResponse) int {
		// longest duration remaining listed first
		return cmp.Compare(j.ExpiresAt.Unix(), i.ExpiresAt.Unix())
	})

1271
	c.JSON(http.StatusOK, api.ProcessResponse{Models: models})
1272
1273
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1274
func (s *Server) ChatHandler(c *gin.Context) {
1275
1276
	checkpointStart := time.Now()

Bruce MacDonald's avatar
Bruce MacDonald committed
1277
	var req api.ChatRequest
Michael Yang's avatar
Michael Yang committed
1278
	if err := c.ShouldBindJSON(&req); errors.Is(err, io.EOF) {
Bruce MacDonald's avatar
Bruce MacDonald committed
1279
1280
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
1281
	} else if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1282
1283
1284
1285
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

Michael Yang's avatar
Michael Yang committed
1286
	caps := []Capability{CapabilityCompletion}
Michael Yang's avatar
tools  
Michael Yang committed
1287
1288
1289
1290
	if req.Tools != nil {
		caps = append(caps, CapabilityTools)
	}

Michael Yang's avatar
Michael Yang committed
1291
	r, m, opts, err := s.scheduleRunner(c.Request.Context(), req.Model, caps, req.Options, req.KeepAlive)
Michael Yang's avatar
Michael Yang committed
1292
1293
	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
1294
		return
Michael Yang's avatar
Michael Yang committed
1295
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
1296
		handleScheduleError(c, req.Model, err)
Bruce MacDonald's avatar
Bruce MacDonald committed
1297
1298
		return
	}
Michael Yang's avatar
Michael Yang committed
1299

1300
1301
	checkpointLoaded := time.Now()

Michael Yang's avatar
Michael Yang committed
1302
1303
	if len(req.Messages) == 0 {
		c.JSON(http.StatusOK, api.ChatResponse{
1304
			Model:      req.Model,
Michael Yang's avatar
Michael Yang committed
1305
1306
			CreatedAt:  time.Now().UTC(),
			Message:    api.Message{Role: "assistant"},
1307
1308
			Done:       true,
			DoneReason: "load",
Michael Yang's avatar
Michael Yang committed
1309
		})
1310
1311
1312
		return
	}

1313
	if req.Messages[0].Role != "system" && m.System != "" {
1314
1315
1316
		req.Messages = append([]api.Message{{Role: "system", Content: m.System}}, req.Messages...)
	}

Michael Yang's avatar
tools  
Michael Yang committed
1317
	prompt, images, err := chatPrompt(c.Request.Context(), m, r.Tokenize, opts, req.Messages, req.Tools)
Michael Yang's avatar
Michael Yang committed
1318
1319
1320
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
1321
1322
	}

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

Bruce MacDonald's avatar
Bruce MacDonald committed
1325
1326
1327
	ch := make(chan any)
	go func() {
		defer close(ch)
Michael Yang's avatar
Michael Yang committed
1328
		if err := r.Completion(c.Request.Context(), llm.CompletionRequest{
Michael Yang's avatar
Michael Yang committed
1329
1330
1331
			Prompt:  prompt,
			Images:  images,
			Format:  req.Format,
Michael Yang's avatar
Michael Yang committed
1332
			Options: opts,
Michael Yang's avatar
Michael Yang committed
1333
		}, func(r llm.CompletionResponse) {
1334
			res := api.ChatResponse{
1335
1336
1337
1338
1339
				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
1340
1341
1342
1343
1344
1345
1346
				Metrics: api.Metrics{
					PromptEvalCount:    r.PromptEvalCount,
					PromptEvalDuration: r.PromptEvalDuration,
					EvalCount:          r.EvalCount,
					EvalDuration:       r.EvalDuration,
				},
			}
1347
1348
1349
1350
1351
1352
1353

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

			ch <- res
Michael Yang's avatar
Michael Yang committed
1354
		}); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1355
1356
1357
1358
1359
			ch <- gin.H{"error": err.Error()}
		}
	}()

	if req.Stream != nil && !*req.Stream {
Michael Yang's avatar
tools  
Michael Yang committed
1360
		var resp api.ChatResponse
Bruce MacDonald's avatar
Bruce MacDonald committed
1361
		var sb strings.Builder
Michael Yang's avatar
Michael Yang committed
1362
1363
		for rr := range ch {
			switch t := rr.(type) {
1364
			case api.ChatResponse:
Michael Yang's avatar
Michael Yang committed
1365
				sb.WriteString(t.Message.Content)
Michael Yang's avatar
tools  
Michael Yang committed
1366
				resp = t
1367
			case gin.H:
Michael Yang's avatar
Michael Yang committed
1368
1369
1370
				msg, ok := t["error"].(string)
				if !ok {
					msg = "unexpected error format in response"
1371
				}
Michael Yang's avatar
Michael Yang committed
1372
1373
1374

				c.JSON(http.StatusInternalServerError, gin.H{"error": msg})
				return
1375
			default:
Michael Yang's avatar
Michael Yang committed
1376
				c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected response"})
1377
				return
Bruce MacDonald's avatar
Bruce MacDonald committed
1378
1379
			}
		}
1380

Michael Yang's avatar
tools  
Michael Yang committed
1381
1382
1383
1384
1385
1386
1387
		resp.Message.Content = sb.String()
		if toolCalls, ok := m.parseToolCalls(sb.String()); ok {
			resp.Message.ToolCalls = toolCalls
			resp.Message.Content = ""
		}

		c.JSON(http.StatusOK, resp)
Bruce MacDonald's avatar
Bruce MacDonald committed
1388
1389
1390
1391
1392
		return
	}

	streamResponse(c, ch)
}
1393

Michael Yang's avatar
Michael Yang committed
1394
func handleScheduleError(c *gin.Context, name string, err error) {
Michael Yang's avatar
Michael Yang committed
1395
	switch {
Michael Yang's avatar
Michael Yang committed
1396
1397
	case errors.Is(err, errRequired):
		c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Michael Yang's avatar
Michael Yang committed
1398
	case errors.Is(err, context.Canceled):
1399
		c.JSON(499, gin.H{"error": "request canceled"})
Michael Yang's avatar
Michael Yang committed
1400
	case errors.Is(err, ErrMaxQueue):
1401
		c.JSON(http.StatusServiceUnavailable, gin.H{"error": err.Error()})
Michael Yang's avatar
Michael Yang committed
1402
1403
	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
1404
1405
	default:
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
1406
1407
	}
}