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
Michael Yang committed
58
var errRequired = errors.New("is required")
Josh's avatar
Josh committed
59
var errBadTemplate = errors.New("template error")
Michael Yang's avatar
Michael Yang committed
60

61
62
63
64
65
66
67
68
69
70
71
func modelOptions(model *Model, requestOpts map[string]interface{}) (api.Options, error) {
	opts := api.DefaultOptions()
	if err := opts.FromMap(model.Options); err != nil {
		return api.Options{}, err
	}

	if err := opts.FromMap(requestOpts); err != nil {
		return api.Options{}, err
	}

	return opts, nil
Bruce MacDonald's avatar
Bruce MacDonald committed
72
73
}

Michael Yang's avatar
Michael Yang committed
74
75
76
// scheduleRunner schedules a runner after validating inputs such as capabilities and model options.
// It returns the allocated runner, model instance, and consolidated options if successful and error otherwise.
func (s *Server) scheduleRunner(ctx context.Context, name string, caps []Capability, requestOpts map[string]any, keepAlive *api.Duration) (llm.LlamaServer, *Model, *api.Options, error) {
Michael Yang's avatar
Michael Yang committed
77
	if name == "" {
Michael Yang's avatar
Michael Yang committed
78
		return nil, nil, nil, fmt.Errorf("model %w", errRequired)
Bruce MacDonald's avatar
Bruce MacDonald committed
79
80
	}

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

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

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

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

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

func (s *Server) GenerateHandler(c *gin.Context) {
107
	checkpointStart := time.Now()
Michael Yang's avatar
Michael Yang committed
108
109
110
111
112
113
	var req api.GenerateRequest
	if err := c.ShouldBindJSON(&req); errors.Is(err, io.EOF) {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
	} else if err != nil {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Bruce MacDonald's avatar
Bruce MacDonald committed
114
115
116
		return
	}

Michael Yang's avatar
Michael Yang committed
117
118
119
120
121
	if req.Format != "" && req.Format != "json" {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "format must be empty or \"json\""})
		return
	} else if req.Raw && (req.Template != "" || req.System != "" || len(req.Context) > 0) {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "raw mode does not support template, system, or context"})
Michael Yang's avatar
Michael Yang committed
122
123
124
		return
	}

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

Michael Yang's avatar
Michael Yang committed
130
	r, m, opts, err := s.scheduleRunner(c.Request.Context(), req.Model, caps, req.Options, req.KeepAlive)
Michael Yang's avatar
Michael Yang committed
131
132
133
134
	if errors.Is(err, errCapabilityCompletion) {
		c.JSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("%q does not support generate", req.Model)})
		return
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
135
136
137
138
		handleScheduleError(c, req.Model, err)
		return
	}

139
140
	checkpointLoaded := time.Now()

Michael Yang's avatar
Michael Yang committed
141
142
143
144
145
146
147
	if req.Prompt == "" {
		c.JSON(http.StatusOK, api.GenerateResponse{
			Model:      req.Model,
			CreatedAt:  time.Now().UTC(),
			Done:       true,
			DoneReason: "load",
		})
Michael Yang's avatar
Michael Yang committed
148
149
		return
	}
Bruce MacDonald's avatar
Bruce MacDonald committed
150

Michael Yang's avatar
Michael Yang committed
151
152
153
154
	images := make([]llm.ImageData, len(req.Images))
	for i := range req.Images {
		images[i] = llm.ImageData{ID: i, Data: req.Images[i]}
	}
Bruce MacDonald's avatar
Bruce MacDonald committed
155

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

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

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

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

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

Michael Yang's avatar
Michael Yang committed
190
		var b bytes.Buffer
191
192
		var t bytes.Buffer
		if err := tmpl.Execute(&t, values); err != nil {
Michael Yang's avatar
Michael Yang committed
193
194
195
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
			return
		}
196

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

206
		b.WriteString(t.String());
Michael Yang's avatar
Michael Yang committed
207
		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
380
	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
	}

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

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

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

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

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

Bruce MacDonald's avatar
Bruce MacDonald committed
436
	if err != nil {
437
		slog.Info(fmt.Sprintf("embedding generation failed: %v", err))
Bruce MacDonald's avatar
Bruce MacDonald committed
438
439
440
441
		c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to generate embedding"})
		return
	}

442
	embedding := make([]float64, len(embeddings.Embedding[0]))
443

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

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

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

466
467
468
469
470
471
472
473
	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()})
474
475
476
		return
	}

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

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

488
489
490
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

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

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

501
502
503
	streamResponse(c, ch)
}

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

Michael Yang's avatar
Michael Yang committed
516
517
518
519
520
521
522
	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"})
523
524
525
		return
	}

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

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

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

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

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

550
551
552
	streamResponse(c, ch)
}

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

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

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

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

594
595
596
	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
597
598
599
600
		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
601
		defer f.Close()
Michael Yang's avatar
Michael Yang committed
602

603
		sr = f
Michael Yang's avatar
Michael Yang committed
604
	}
Michael Yang's avatar
Michael Yang committed
605

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

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

619
620
621
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

622
		quantization := cmp.Or(r.Quantize, r.Quantization)
Josh's avatar
Josh committed
623
624
625
		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
626
			ch <- gin.H{"error": err.Error()}
627
		}
Michael Yang's avatar
Michael Yang committed
628
	}()
Michael Yang's avatar
Michael Yang committed
629

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

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

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

648
649
650
	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))})
651
652
		return
	}
Michael Yang's avatar
Michael Yang committed
653

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

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

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

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

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

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

	c.JSON(http.StatusOK, resp)
}

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

Patrick Devine's avatar
Patrick Devine committed
714
	modelDetails := api.ModelDetails{
715
716
717
718
719
720
		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
721
722
	}

723
	if req.System != "" {
724
		m.System = req.System
725
726
	}

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

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

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

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

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

778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
	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
794
795
796
	return resp, nil
}

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

827
	models := []api.ListModelResponse{}
828
829
830
831
832
833
834
	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()
835

836
837
838
839
		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
840
		}
Michael Yang's avatar
Michael Yang committed
841

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	var tlds = []string{
Jeffrey Morgan's avatar
Jeffrey Morgan committed
999
1000
1001
		"localhost",
		"local",
		"internal",
1002
	}
1003

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1101
1102
1103
1104
	return r
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1324
1325
	checkpointLoaded := time.Now()

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

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

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

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

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

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

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

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

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

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

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

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

	streamResponse(c, ch)
}
1421

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