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

import (
Michael Yang's avatar
Michael Yang committed
4
	"bytes"
Michael Yang's avatar
Michael Yang committed
5
	"cmp"
6
	"context"
Michael Yang's avatar
Michael Yang committed
7
	"encoding/json"
8
	"errors"
9
	"fmt"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
10
	"io"
11
	"log/slog"
12
	"math"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
13
14
	"net"
	"net/http"
15
	"net/netip"
16
	"os"
17
	"os/signal"
Michael Yang's avatar
Michael Yang committed
18
	"path/filepath"
19
	"slices"
Michael Yang's avatar
Michael Yang committed
20
	"strings"
21
	"syscall"
22
	"time"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
23

Michael Yang's avatar
Michael Yang committed
24
	"github.com/gin-contrib/cors"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
25
26
	"github.com/gin-gonic/gin"

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

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

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

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

	gin.SetMode(mode)
}

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

63
64
65
66
67
68
69
70
71
72
73
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
74
75
}

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

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

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

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

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

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

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

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

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

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

141
142
	checkpointLoaded := time.Now()

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

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

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

169
170
171
172
173
174
175
176
177
178
179
180
		var values template.Values
		if req.Suffix != "" {
			values.Prompt = prompt
			values.Suffix = req.Suffix
		} else {
			var msgs []api.Message
			if req.System != "" {
				msgs = append(msgs, api.Message{Role: "system", Content: req.System})
			} else if m.System != "" {
				msgs = append(msgs, api.Message{Role: "system", Content: m.System})
			}

Michael Yang's avatar
Michael Yang committed
181
182
183
184
			if req.Context == nil {
				msgs = append(msgs, m.Messages...)
			}

185
186
187
188
189
190
191
			for _, i := range images {
				msgs = append(msgs, api.Message{Role: "user", Content: fmt.Sprintf("[img-%d]", i.ID)})
			}

			values.Messages = append(msgs, api.Message{Role: "user", Content: req.Prompt})
		}

Michael Yang's avatar
Michael Yang committed
192
193
		var b bytes.Buffer
		if req.Context != nil {
194
			s, err := r.Detokenize(c.Request.Context(), req.Context)
Michael Yang's avatar
Michael Yang committed
195
196
197
198
			if err != nil {
				c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
				return
			}
199
			b.WriteString(s)
Michael Yang's avatar
Michael Yang committed
200
		}
201
202
203
204
205
206
207

		if err := tmpl.Execute(&b, values); err != nil {
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
			return
		}

		prompt = b.String()
Bruce MacDonald's avatar
Bruce MacDonald committed
208
209
	}

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

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

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

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

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

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

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

	streamResponse(c, ch)
}

291
func (s *Server) EmbedHandler(c *gin.Context) {
292
	checkpointStart := time.Now()
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
	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
	}

341
342
	checkpointLoaded := time.Now()

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

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

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

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

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

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

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

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

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

Daniel Hiltgen's avatar
Daniel Hiltgen committed
452
func (s *Server) PullModelHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
453
	var req api.PullRequest
Michael Yang's avatar
Michael Yang committed
454
455
456
457
458
459
460
	err := c.ShouldBindJSON(&req)
	switch {
	case errors.Is(err, io.EOF):
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
	case err != nil:
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Michael Yang's avatar
Michael Yang committed
461
462
463
		return
	}

464
465
466
467
468
469
470
471
	name := model.ParseName(cmp.Or(req.Model, req.Name))
	if !name.IsValid() {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "invalid model name"})
		return
	}

	if err := checkNameExists(name); err != nil {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
472
473
474
		return
	}

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

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

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

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

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

499
500
501
	streamResponse(c, ch)
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
502
func (s *Server) PushModelHandler(c *gin.Context) {
503
	var req api.PushRequest
Michael Yang's avatar
Michael Yang committed
504
505
506
507
508
509
510
	err := c.ShouldBindJSON(&req)
	switch {
	case errors.Is(err, io.EOF):
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
	case err != nil:
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Michael Yang's avatar
Michael Yang committed
511
512
		return
	}
Michael Yang's avatar
Michael Yang committed
513

Michael Yang's avatar
Michael Yang committed
514
515
516
517
518
519
520
	var model string
	if req.Model != "" {
		model = req.Model
	} else if req.Name != "" {
		model = req.Name
	} else {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
521
522
523
		return
	}

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

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

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

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

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

548
549
550
	streamResponse(c, ch)
}

551
552
553
554
555
556
557
558
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 {
Michael Yang's avatar
lint  
Michael Yang committed
559
			return errors.New("a model with that name already exists")
560
561
562
563
564
565
		}
	}

	return nil
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
566
func (s *Server) CreateModelHandler(c *gin.Context) {
567
568
	var r api.CreateRequest
	if err := c.ShouldBindJSON(&r); errors.Is(err, io.EOF) {
Michael Yang's avatar
Michael Yang committed
569
570
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
571
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
572
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Michael Yang's avatar
Michael Yang committed
573
		return
574
575
	}

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

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

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

592
593
594
	var sr io.Reader = strings.NewReader(r.Modelfile)
	if r.Path != "" && r.Modelfile == "" {
		f, err := os.Open(r.Path)
Michael Yang's avatar
Michael Yang committed
595
596
597
598
		if err != nil {
			c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("error reading modelfile: %s", err)})
			return
		}
Michael Yang's avatar
Michael Yang committed
599
		defer f.Close()
Michael Yang's avatar
Michael Yang committed
600

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

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

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

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

620
		quantization := cmp.Or(r.Quantize, r.Quantization)
Josh's avatar
Josh committed
621
622
623
		if err := CreateModel(ctx, name, filepath.Dir(r.Path), strings.ToUpper(quantization), f, fn); errors.Is(err, errBadTemplate) {
			ch <- gin.H{"error": err.Error(), "status": http.StatusBadRequest}
		} else if err != nil {
Michael Yang's avatar
Michael Yang committed
624
			ch <- gin.H{"error": err.Error()}
625
		}
Michael Yang's avatar
Michael Yang committed
626
	}()
Michael Yang's avatar
Michael Yang committed
627

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

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

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

646
647
648
	n := model.ParseName(cmp.Or(r.Model, r.Name))
	if !n.IsValid() {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("name %q is invalid", cmp.Or(r.Model, r.Name))})
649
650
		return
	}
Michael Yang's avatar
Michael Yang committed
651

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

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

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

Daniel Hiltgen's avatar
Daniel Hiltgen committed
669
func (s *Server) ShowModelHandler(c *gin.Context) {
Patrick Devine's avatar
Patrick Devine committed
670
	var req api.ShowRequest
Michael Yang's avatar
Michael Yang committed
671
672
673
674
675
676
677
	err := c.ShouldBindJSON(&req)
	switch {
	case errors.Is(err, io.EOF):
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
	case err != nil:
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Patrick Devine's avatar
Patrick Devine committed
678
679
680
		return
	}

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

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

	c.JSON(http.StatusOK, resp)
}

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

Patrick Devine's avatar
Patrick Devine committed
712
	modelDetails := api.ModelDetails{
713
714
715
716
717
718
		ParentModel:       m.ParentModel,
		Format:            m.Config.ModelFormat,
		Family:            m.Config.ModelFamily,
		Families:          m.Config.ModelFamilies,
		ParameterSize:     m.Config.ModelType,
		QuantizationLevel: m.Config.FileType,
Patrick Devine's avatar
Patrick Devine committed
719
720
	}

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

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

730
731
	n := model.ParseName(req.Model)
	if !n.IsValid() {
Michael Yang's avatar
lint  
Michael Yang committed
732
		return nil, errors.New("invalid model name")
733
734
735
736
737
738
739
	}

	manifest, err := ParseNamedManifest(n)
	if err != nil {
		return nil, err
	}

Patrick Devine's avatar
Patrick Devine committed
740
	resp := &api.ShowResponse{
741
742
		License:    strings.Join(m.License, "\n"),
		System:     m.System,
Michael Yang's avatar
Michael Yang committed
743
		Template:   m.Template.String(),
744
745
746
		Details:    modelDetails,
		Messages:   msgs,
		ModifiedAt: manifest.fi.ModTime(),
Patrick Devine's avatar
Patrick Devine committed
747
748
749
750
	}

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

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

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

776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
	kvData, err := getKVData(m.ModelPath, req.Verbose)
	if err != nil {
		return nil, err
	}
	delete(kvData, "general.name")
	delete(kvData, "tokenizer.chat_template")
	resp.ModelInfo = kvData

	if len(m.ProjectorPaths) > 0 {
		projectorData, err := getKVData(m.ProjectorPaths[0], req.Verbose)
		if err != nil {
			return nil, err
		}
		resp.ProjectorInfo = projectorData
	}

Patrick Devine's avatar
Patrick Devine committed
792
793
794
	return resp, nil
}

795
func getKVData(digest string, verbose bool) (llm.KV, error) {
796
797
798
799
800
	maxArraySize := 0
	if verbose {
		maxArraySize = -1
	}
	kvData, err := llm.LoadModel(digest, maxArraySize)
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
	if err != nil {
		return nil, err
	}

	kv := kvData.KV()

	if !verbose {
		for k := range kv {
			if t, ok := kv[k].([]any); len(t) > 5 && ok {
				kv[k] = []any{}
			}
		}
	}

	return kv, nil
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
818
func (s *Server) ListModelsHandler(c *gin.Context) {
819
	ms, err := Manifests()
Patrick Devine's avatar
Patrick Devine committed
820
821
822
823
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}
Michael Yang's avatar
Michael Yang committed
824

825
	models := []api.ListModelResponse{}
826
827
	for n, m := range ms {
		var cf ConfigV2
828
829
830
831
832
833
834
835
836
837
838
839
840

		if m.Config.Digest != "" {
			f, err := m.Config.Open()
			if err != nil {
				slog.Warn("bad manifest filepath", "name", n, "error", err)
				continue
			}
			defer f.Close()

			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
841
		}
Michael Yang's avatar
Michael Yang committed
842

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

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

Michael Yang's avatar
Michael Yang committed
865
	c.JSON(http.StatusOK, api.ListResponse{Models: models})
Patrick Devine's avatar
Patrick Devine committed
866
867
}

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

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

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

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

Michael Yang's avatar
Michael Yang committed
895
896
897
898
899
	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
900
901
}

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

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

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

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

961
962
	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
963
964
965
		return
	}

Michael Yang's avatar
Michael Yang committed
966
	c.Status(http.StatusCreated)
Michael Yang's avatar
Michael Yang committed
967
968
}

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

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

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

Michael Yang's avatar
lint  
Michael Yang committed
999
	tlds := []string{
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1000
1001
1002
		"localhost",
		"local",
		"internal",
1003
	}
1004

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

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1012
	return false
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1013
}
1014

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

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

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

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

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

1045
1046
1047
1048
1049
1050
			c.Next()
			return
		}

		c.AbortWithStatus(http.StatusForbidden)
	}
1051
}
1052

1053
func (s *Server) GenerateRoutes() http.Handler {
Michael Yang's avatar
Michael Yang committed
1054
1055
	config := cors.DefaultConfig()
	config.AllowWildcard = true
1056
	config.AllowBrowserExtensions = true
1057
	config.AllowHeaders = []string{"Authorization", "Content-Type", "User-Agent", "Accept", "X-Requested-With"}
royjhan's avatar
royjhan committed
1058
1059
1060
1061
	openAIProperties := []string{"lang", "package-version", "os", "arch", "runtime", "runtime-version", "async"}
	for _, prop := range openAIProperties {
		config.AllowHeaders = append(config.AllowHeaders, "x-stainless-"+prop)
	}
Michael Yang's avatar
origins  
Michael Yang committed
1062
	config.AllowOrigins = envconfig.Origins()
Michael Yang's avatar
Michael Yang committed
1063

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

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

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

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

1102
1103
1104
1105
	return r
}

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

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

1127
1128
1129
1130
1131
1132
1133
1134
	blobsDir, err := GetBlobsPath("")
	if err != nil {
		return err
	}
	if err := fixBlobs(blobsDir); err != nil {
		return err
	}

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

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

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

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

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

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1187
	s.sched.Run(schedCtx)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1188
1189
1190

	// 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
1191
1192
	gpus := gpu.GetGPUInfo()
	gpus.LogDetails()
1193

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

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

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

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

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

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

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

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

1288
1289
1290
		models = append(models, mr)
	}

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

1296
	c.JSON(http.StatusOK, api.ProcessResponse{Models: models})
1297
1298
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1299
func (s *Server) ChatHandler(c *gin.Context) {
1300
1301
	checkpointStart := time.Now()

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

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

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

1325
1326
	checkpointLoaded := time.Now()

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

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

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

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

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

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

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

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

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

Michael Yang's avatar
tools  
Michael Yang committed
1407
		resp.Message.Content = sb.String()
1408
1409
1410
1411
1412
1413

		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
1414
1415
1416
		}

		c.JSON(http.StatusOK, resp)
Bruce MacDonald's avatar
Bruce MacDonald committed
1417
1418
1419
1420
1421
		return
	}

	streamResponse(c, ch)
}
1422

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