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

import (
Michael Yang's avatar
Michael Yang committed
4
	"cmp"
5
	"context"
Michael Yang's avatar
Michael Yang committed
6
	"encoding/json"
7
	"errors"
8
	"fmt"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
9
	"io"
10
	"io/fs"
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
	"strconv"
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
	"github.com/gin-gonic/gin"
26
	"golang.org/x/exp/slices"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
27

28
	"github.com/ollama/ollama/api"
29
	"github.com/ollama/ollama/envconfig"
30
31
32
	"github.com/ollama/ollama/gpu"
	"github.com/ollama/ollama/llm"
	"github.com/ollama/ollama/openai"
33
	"github.com/ollama/ollama/parser"
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)
}

58
59
var defaultSessionDuration = 5 * time.Minute

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

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

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

73
74
75
76
77
78
func isSupportedImageType(image []byte) bool {
	contentType := http.DetectContentType(image)
	allowedTypes := []string{"image/jpeg", "image/jpg", "image/png"}
	return slices.Contains(allowedTypes, contentType)
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
79
func (s *Server) GenerateHandler(c *gin.Context) {
Bruce MacDonald's avatar
Bruce MacDonald committed
80
81
82

	checkpointStart := time.Now()
	var req api.GenerateRequest
Michael Yang's avatar
Michael Yang committed
83
	err := c.ShouldBindJSON(&req)
Patrick Devine's avatar
Patrick Devine committed
84

Michael Yang's avatar
Michael Yang committed
85
86
87
88
89
90
	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()})
Bruce MacDonald's avatar
Bruce MacDonald committed
91
92
93
		return
	}

94
95
96
	// validate the request
	switch {
	case req.Model == "":
97
98
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
		return
99
100
101
	case len(req.Format) > 0 && req.Format != "json":
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "format must be json"})
		return
102
103
104
	case 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"})
		return
105
106
	}

107
108
109
110
111
112
113
	for _, img := range req.Images {
		if !isSupportedImageType(img) {
			c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "unsupported image format"})
			return
		}
	}

114
	model, err := GetModel(req.Model)
Bruce MacDonald's avatar
Bruce MacDonald committed
115
	if err != nil {
116
		var pErr *fs.PathError
117
		if errors.As(err, &pErr) {
118
			c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found, try pulling it first", req.Model)})
119
120
121
122
123
124
			return
		}
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

125
	if model.IsEmbedding() {
126
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "embedding models do not support generate"})
127
128
129
		return
	}

130
131
132
133
134
135
	opts, err := modelOptions(model, req.Options)
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

136
137
	var sessionDuration time.Duration
	if req.KeepAlive == nil {
138
		sessionDuration = getDefaultSessionDuration()
139
140
141
142
	} else {
		sessionDuration = req.KeepAlive.Duration
	}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
143
144
145
146
147
	rCh, eCh := s.sched.GetRunner(c.Request.Context(), model, opts, sessionDuration)
	var runner *runnerRef
	select {
	case runner = <-rCh:
	case err = <-eCh:
148
		handleErrorResponse(c, err)
Bruce MacDonald's avatar
Bruce MacDonald committed
149
150
151
		return
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
152
	// an empty request loads the model
153
154
	// note: for a short while template was used in lieu
	// of `raw` mode so we need to check for it too
Bruce MacDonald's avatar
Bruce MacDonald committed
155
	if req.Prompt == "" && req.Template == "" && req.System == "" {
156
		c.JSON(http.StatusOK, api.GenerateResponse{
157
158
159
160
			CreatedAt:  time.Now().UTC(),
			Model:      req.Model,
			Done:       true,
			DoneReason: "load",
Michael Yang's avatar
Michael Yang committed
161
		})
Bruce MacDonald's avatar
Bruce MacDonald committed
162
163
164
165
166
		return
	}

	checkpointLoaded := time.Now()

Bruce MacDonald's avatar
Bruce MacDonald committed
167
168
169
170
171
	var prompt string
	switch {
	case req.Raw:
		prompt = req.Prompt
	case req.Prompt != "":
172
173
		if req.Template == "" {
			req.Template = model.Template
Bruce MacDonald's avatar
Bruce MacDonald committed
174
175
		}

176
177
178
179
180
181
182
183
184
		if req.System == "" {
			req.System = model.System
		}

		slog.Debug("generate handler", "prompt", req.Prompt)
		slog.Debug("generate handler", "template", req.Template)
		slog.Debug("generate handler", "system", req.System)

		var sb strings.Builder
Michael Yang's avatar
Michael Yang committed
185
186
187
188
189
190
191
192
193
194
195
196
197
		for i := range req.Images {
			fmt.Fprintf(&sb, "[img-%d] ", i)
		}

		sb.WriteString(req.Prompt)

		p, err := Prompt(req.Template, req.System, sb.String(), "", true)
		if err != nil {
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
			return
		}

		sb.Reset()
Bruce MacDonald's avatar
Bruce MacDonald committed
198
		if req.Context != nil {
Daniel Hiltgen's avatar
Daniel Hiltgen committed
199
			prev, err := runner.llama.Detokenize(c.Request.Context(), req.Context)
Bruce MacDonald's avatar
Bruce MacDonald committed
200
201
202
203
204
			if err != nil {
				c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
				return
			}

205
			sb.WriteString(prev)
206
207
		}

208
209
210
		sb.WriteString(p)

		prompt = sb.String()
Bruce MacDonald's avatar
Bruce MacDonald committed
211
212
	}

Michael Yang's avatar
Michael Yang committed
213
	slog.Debug("generate handler", "prompt", prompt)
214

Bruce MacDonald's avatar
Bruce MacDonald committed
215
	ch := make(chan any)
Bruce MacDonald's avatar
Bruce MacDonald committed
216
	var generated strings.Builder
Bruce MacDonald's avatar
Bruce MacDonald committed
217
218
219
	go func() {
		defer close(ch)

220
		fn := func(r llm.CompletionResponse) {
Bruce MacDonald's avatar
Bruce MacDonald committed
221
222
223
224
			// Build up the full response
			if _, err := generated.WriteString(r.Content); err != nil {
				ch <- gin.H{"error": err.Error()}
				return
Bruce MacDonald's avatar
Bruce MacDonald committed
225
226
			}

Bruce MacDonald's avatar
Bruce MacDonald committed
227
			resp := api.GenerateResponse{
228
229
230
231
232
				Model:      req.Model,
				CreatedAt:  time.Now().UTC(),
				Done:       r.Done,
				Response:   r.Content,
				DoneReason: r.DoneReason,
Bruce MacDonald's avatar
Bruce MacDonald committed
233
234
235
236
237
238
				Metrics: api.Metrics{
					PromptEvalCount:    r.PromptEvalCount,
					PromptEvalDuration: r.PromptEvalDuration,
					EvalCount:          r.EvalCount,
					EvalDuration:       r.EvalDuration,
				},
Bruce MacDonald's avatar
Bruce MacDonald committed
239
240
			}

241
242
243
244
245
			if r.Done {
				resp.TotalDuration = time.Since(checkpointStart)
				resp.LoadDuration = checkpointLoaded.Sub(checkpointStart)

				if !req.Raw {
246
					p, err := Prompt(req.Template, req.System, req.Prompt, generated.String(), false)
247
					if err != nil {
248
						c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
249
250
						return
					}
251
252

					// TODO (jmorganca): encode() should not strip special tokens
Daniel Hiltgen's avatar
Daniel Hiltgen committed
253
					tokens, err := runner.llama.Tokenize(c.Request.Context(), p)
254
255
256
257
					if err != nil {
						ch <- gin.H{"error": err.Error()}
						return
					}
258
259

					resp.Context = append(req.Context, tokens...)
Bruce MacDonald's avatar
Bruce MacDonald committed
260
261
262
263
				}
			}

			ch <- resp
Bruce MacDonald's avatar
Bruce MacDonald committed
264
265
		}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
266
		var images []llm.ImageData
Michael Yang's avatar
Michael Yang committed
267
		for i := range req.Images {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
268
269
270
271
			images = append(images, llm.ImageData{
				ID:   i,
				Data: req.Images[i],
			})
Michael Yang's avatar
Michael Yang committed
272
273
		}

Bruce MacDonald's avatar
Bruce MacDonald committed
274
		// Start prediction
275
		req := llm.CompletionRequest{
276
277
			Prompt:  prompt,
			Format:  req.Format,
Michael Yang's avatar
Michael Yang committed
278
			Images:  images,
279
			Options: opts,
Bruce MacDonald's avatar
Bruce MacDonald committed
280
		}
Daniel Hiltgen's avatar
Daniel Hiltgen committed
281
		if err := runner.llama.Completion(c.Request.Context(), req, fn); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
282
283
284
285
286
			ch <- gin.H{"error": err.Error()}
		}
	}()

	if req.Stream != nil && !*req.Stream {
287
288
		// Accumulate responses into the final response
		var final api.GenerateResponse
Bruce MacDonald's avatar
Bruce MacDonald committed
289
		var sb strings.Builder
Bruce MacDonald's avatar
Bruce MacDonald committed
290
		for resp := range ch {
291
292
293
294
295
296
297
298
299
300
301
302
303
304
			switch r := resp.(type) {
			case api.GenerateResponse:
				sb.WriteString(r.Response)
				final = r
			case gin.H:
				if errorMsg, ok := r["error"].(string); ok {
					c.JSON(http.StatusInternalServerError, gin.H{"error": errorMsg})
					return
				} else {
					c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected error format in response"})
					return
				}
			default:
				c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected error"})
Bruce MacDonald's avatar
Bruce MacDonald committed
305
306
307
				return
			}
		}
308
309
310

		final.Response = sb.String()
		c.JSON(http.StatusOK, final)
Bruce MacDonald's avatar
Bruce MacDonald committed
311
312
313
314
315
316
		return
	}

	streamResponse(c, ch)
}

317
func getDefaultSessionDuration() time.Duration {
318
319
	if envconfig.KeepAlive != "" {
		v, err := strconv.Atoi(envconfig.KeepAlive)
320
		if err != nil {
321
			d, err := time.ParseDuration(envconfig.KeepAlive)
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
			if err != nil {
				return defaultSessionDuration
			}

			if d < 0 {
				return time.Duration(math.MaxInt64)
			}

			return d
		}

		d := time.Duration(v) * time.Second
		if d < 0 {
			return time.Duration(math.MaxInt64)
		}
		return d
	}

	return defaultSessionDuration
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
343
func (s *Server) EmbeddingsHandler(c *gin.Context) {
Bruce MacDonald's avatar
Bruce MacDonald committed
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
	var req api.EmbeddingRequest
	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
	}

	if req.Model == "" {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
		return
	}

360
	model, err := GetModel(req.Model)
Bruce MacDonald's avatar
Bruce MacDonald committed
361
	if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
362
		var pErr *fs.PathError
363
		if errors.As(err, &pErr) {
Bruce MacDonald's avatar
Bruce MacDonald committed
364
			c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found, try pulling it first", req.Model)})
365
366
367
368
369
370
371
372
373
374
375
			return
		}
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

	opts, err := modelOptions(model, req.Options)
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}
376
377
378

	var sessionDuration time.Duration
	if req.KeepAlive == nil {
379
		sessionDuration = getDefaultSessionDuration()
380
381
382
383
	} else {
		sessionDuration = req.KeepAlive.Duration
	}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
384
385
386
387
388
	rCh, eCh := s.sched.GetRunner(c.Request.Context(), model, opts, sessionDuration)
	var runner *runnerRef
	select {
	case runner = <-rCh:
	case err = <-eCh:
389
		handleErrorResponse(c, err)
Bruce MacDonald's avatar
Bruce MacDonald committed
390
391
392
		return
	}

393
394
395
	// an empty request loads the model
	if req.Prompt == "" {
		c.JSON(http.StatusOK, api.EmbeddingResponse{Embedding: []float64{}})
Bruce MacDonald's avatar
Bruce MacDonald committed
396
397
398
		return
	}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
399
	embedding, err := runner.llama.Embedding(c.Request.Context(), req.Prompt)
Bruce MacDonald's avatar
Bruce MacDonald committed
400
	if err != nil {
401
		slog.Info(fmt.Sprintf("embedding generation failed: %v", err))
Bruce MacDonald's avatar
Bruce MacDonald committed
402
403
404
405
406
407
408
409
410
411
		c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to generate embedding"})
		return
	}

	resp := api.EmbeddingResponse{
		Embedding: embedding,
	}
	c.JSON(http.StatusOK, resp)
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
412
func (s *Server) PullModelHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
413
	var req api.PullRequest
Michael Yang's avatar
Michael Yang committed
414
415
416
417
418
419
420
	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
421
422
423
		return
	}

Michael Yang's avatar
Michael Yang committed
424
425
426
427
428
429
430
	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"})
431
432
433
		return
	}

434
435
436
	ch := make(chan any)
	go func() {
		defer close(ch)
437
438
		fn := func(r api.ProgressResponse) {
			ch <- r
439
		}
440

Michael Yang's avatar
Michael Yang committed
441
		regOpts := &registryOptions{
442
443
444
			Insecure: req.Insecure,
		}

445
446
447
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

Michael Yang's avatar
Michael Yang committed
448
		if err := PullModel(ctx, model, regOpts, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
449
			ch <- gin.H{"error": err.Error()}
450
451
452
		}
	}()

453
454
455
456
457
	if req.Stream != nil && !*req.Stream {
		waitForStream(c, ch)
		return
	}

458
459
460
	streamResponse(c, ch)
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
461
func (s *Server) PushModelHandler(c *gin.Context) {
462
	var req api.PushRequest
Michael Yang's avatar
Michael Yang committed
463
464
465
466
467
468
469
	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
470
471
		return
	}
Michael Yang's avatar
Michael Yang committed
472

Michael Yang's avatar
Michael Yang committed
473
474
475
476
477
478
479
	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"})
480
481
482
		return
	}

483
484
485
	ch := make(chan any)
	go func() {
		defer close(ch)
486
487
		fn := func(r api.ProgressResponse) {
			ch <- r
488
		}
489

Michael Yang's avatar
Michael Yang committed
490
		regOpts := &registryOptions{
491
492
493
			Insecure: req.Insecure,
		}

Michael Yang's avatar
Michael Yang committed
494
495
496
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

Michael Yang's avatar
Michael Yang committed
497
		if err := PushModel(ctx, model, regOpts, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
498
			ch <- gin.H{"error": err.Error()}
499
500
501
		}
	}()

502
503
504
505
506
	if req.Stream != nil && !*req.Stream {
		waitForStream(c, ch)
		return
	}

507
508
509
	streamResponse(c, ch)
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
510
func (s *Server) CreateModelHandler(c *gin.Context) {
511
	var req api.CreateRequest
Michael Yang's avatar
Michael Yang committed
512
	if err := c.ShouldBindJSON(&req); errors.Is(err, io.EOF) {
Michael Yang's avatar
Michael Yang committed
513
514
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
515
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
516
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Michael Yang's avatar
Michael Yang committed
517
		return
518
519
	}

Michael Yang's avatar
Michael Yang committed
520
521
	name := model.ParseName(cmp.Or(req.Model, req.Name))
	if !name.IsValid() {
522
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": errtypes.InvalidModelNameErrMsg})
523
524
525
		return
	}

Michael Yang's avatar
Michael Yang committed
526
527
	if req.Path == "" && req.Modelfile == "" {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "path or modelfile are required"})
Michael Yang's avatar
Michael Yang committed
528
529
		return
	}
Michael Yang's avatar
Michael Yang committed
530

Michael Yang's avatar
Michael Yang committed
531
	var r io.Reader = strings.NewReader(req.Modelfile)
Michael Yang's avatar
Michael Yang committed
532
	if req.Path != "" && req.Modelfile == "" {
Michael Yang's avatar
Michael Yang committed
533
		f, err := os.Open(req.Path)
Michael Yang's avatar
Michael Yang committed
534
535
536
537
		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
538
		defer f.Close()
Michael Yang's avatar
Michael Yang committed
539

Michael Yang's avatar
Michael Yang committed
540
		r = f
Michael Yang's avatar
Michael Yang committed
541
	}
Michael Yang's avatar
Michael Yang committed
542

543
	modelfile, err := parser.ParseFile(r)
Michael Yang's avatar
Michael Yang committed
544
545
546
547
548
	if err != nil {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

Michael Yang's avatar
Michael Yang committed
549
	ch := make(chan any)
Michael Yang's avatar
Michael Yang committed
550
551
	go func() {
		defer close(ch)
552
553
		fn := func(resp api.ProgressResponse) {
			ch <- resp
554
555
		}

556
557
558
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

559
560
561
562
563
564
		quantization := req.Quantization
		if req.Quantize != "" {
			quantization = req.Quantize
		}

		if err := CreateModel(ctx, name.String(), filepath.Dir(req.Path), strings.ToUpper(quantization), modelfile, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
565
			ch <- gin.H{"error": err.Error()}
566
		}
Michael Yang's avatar
Michael Yang committed
567
	}()
Michael Yang's avatar
Michael Yang committed
568

569
570
571
572
573
	if req.Stream != nil && !*req.Stream {
		waitForStream(c, ch)
		return
	}

Michael Yang's avatar
Michael Yang committed
574
	streamResponse(c, ch)
Bruce MacDonald's avatar
Bruce MacDonald committed
575
576
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
577
func (s *Server) DeleteModelHandler(c *gin.Context) {
578
579
	var r api.DeleteRequest
	if err := c.ShouldBindJSON(&r); errors.Is(err, io.EOF) {
Michael Yang's avatar
Michael Yang committed
580
581
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
582
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
583
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
584
585
586
		return
	}

587
588
589
	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))})
590
591
		return
	}
Michael Yang's avatar
Michael Yang committed
592

593
	m, err := ParseNamedManifest(n)
Michael Yang's avatar
Michael Yang committed
594
595
596
597
598
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

599
	if err := m.Remove(); err != nil {
Michael Yang's avatar
Michael Yang committed
600
601
602
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}
603
604
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
605
func (s *Server) ShowModelHandler(c *gin.Context) {
Patrick Devine's avatar
Patrick Devine committed
606
	var req api.ShowRequest
Michael Yang's avatar
Michael Yang committed
607
608
609
610
611
612
613
	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
614
615
616
		return
	}

Michael Yang's avatar
Michael Yang committed
617
	if req.Model != "" {
Michael Yang's avatar
Michael Yang committed
618
		// noop
Michael Yang's avatar
Michael Yang committed
619
	} else if req.Name != "" {
Michael Yang's avatar
Michael Yang committed
620
		req.Model = req.Name
Michael Yang's avatar
Michael Yang committed
621
	} else {
622
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
623
624
625
		return
	}

626
	resp, err := GetModelInfo(req)
Patrick Devine's avatar
Patrick Devine committed
627
628
	if err != nil {
		if os.IsNotExist(err) {
Michael Yang's avatar
Michael Yang committed
629
			c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found", req.Model)})
Patrick Devine's avatar
Patrick Devine committed
630
631
632
633
634
635
636
637
638
		} else {
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		}
		return
	}

	c.JSON(http.StatusOK, resp)
}

639
640
func GetModelInfo(req api.ShowRequest) (*api.ShowResponse, error) {
	model, err := GetModel(req.Model)
Patrick Devine's avatar
Patrick Devine committed
641
642
643
644
	if err != nil {
		return nil, err
	}

Patrick Devine's avatar
Patrick Devine committed
645
	modelDetails := api.ModelDetails{
646
		ParentModel:       model.ParentModel,
Patrick Devine's avatar
Patrick Devine committed
647
648
649
650
651
652
653
		Format:            model.Config.ModelFormat,
		Family:            model.Config.ModelFamily,
		Families:          model.Config.ModelFamilies,
		ParameterSize:     model.Config.ModelType,
		QuantizationLevel: model.Config.FileType,
	}

654
655
656
657
658
659
660
661
	if req.System != "" {
		model.System = req.System
	}

	if req.Template != "" {
		model.Template = req.Template
	}

662
663
664
665
666
	msgs := make([]api.Message, 0)
	for _, msg := range model.Messages {
		msgs = append(msgs, api.Message{Role: msg.Role, Content: msg.Content})
	}

Patrick Devine's avatar
Patrick Devine committed
667
668
669
670
	resp := &api.ShowResponse{
		License:  strings.Join(model.License, "\n"),
		System:   model.System,
		Template: model.Template,
Patrick Devine's avatar
Patrick Devine committed
671
		Details:  modelDetails,
672
		Messages: msgs,
Patrick Devine's avatar
Patrick Devine committed
673
674
675
676
677
678
679
680
	}

	var params []string
	cs := 30
	for k, v := range model.Options {
		switch val := v.(type) {
		case []interface{}:
			for _, nv := range val {
Patrick Devine's avatar
Patrick Devine committed
681
				params = append(params, fmt.Sprintf("%-*s %#v", cs, k, nv))
Patrick Devine's avatar
Patrick Devine committed
682
			}
Patrick Devine's avatar
Patrick Devine committed
683
684
		default:
			params = append(params, fmt.Sprintf("%-*s %#v", cs, k, v))
Patrick Devine's avatar
Patrick Devine committed
685
686
687
688
		}
	}
	resp.Parameters = strings.Join(params, "\n")

689
690
691
692
693
694
	for k, v := range req.Options {
		if _, ok := req.Options[k]; ok {
			model.Options[k] = v
		}
	}

695
	var sb strings.Builder
696
	fmt.Fprintln(&sb, "# Modelfile generated by \"ollama show\"")
697
698
	fmt.Fprintln(&sb, "# To build a new Modelfile based on this, replace FROM with:")
	fmt.Fprintf(&sb, "# FROM %s\n\n", model.ShortName)
Michael Yang's avatar
Michael Yang committed
699
	fmt.Fprint(&sb, model.String())
700
	resp.Modelfile = sb.String()
701

Patrick Devine's avatar
Patrick Devine committed
702
703
704
	return resp, nil
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
705
func (s *Server) ListModelsHandler(c *gin.Context) {
706
	ms, err := Manifests()
Patrick Devine's avatar
Patrick Devine committed
707
708
709
710
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}
Michael Yang's avatar
Michael Yang committed
711

712
	models := []api.ModelResponse{}
713
714
715
716
717
718
719
	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()
720

721
722
723
724
		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
725
		}
Michael Yang's avatar
Michael Yang committed
726

727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
		// tag should never be masked
		models = append(models, api.ModelResponse{
			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
742
743
	}

744
745
746
747
748
	slices.SortStableFunc(models, func(i, j api.ModelResponse) int {
		// most recently modified first
		return cmp.Compare(j.ModifiedAt.Unix(), i.ModifiedAt.Unix())
	})

Michael Yang's avatar
Michael Yang committed
749
	c.JSON(http.StatusOK, api.ListResponse{Models: models})
Patrick Devine's avatar
Patrick Devine committed
750
751
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
752
func (s *Server) CopyModelHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
753
754
	var r api.CopyRequest
	if err := c.ShouldBindJSON(&r); errors.Is(err, io.EOF) {
Michael Yang's avatar
Michael Yang committed
755
756
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
757
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
758
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Patrick Devine's avatar
Patrick Devine committed
759
760
761
		return
	}

Michael Yang's avatar
Michael Yang committed
762
763
	src := model.ParseName(r.Source)
	if !src.IsValid() {
Michael Yang's avatar
Michael Yang committed
764
765
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("source %q is invalid", r.Source)})
		return
766
767
	}

Michael Yang's avatar
Michael Yang committed
768
769
	dst := model.ParseName(r.Destination)
	if !dst.IsValid() {
770
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("destination %q is invalid", r.Destination)})
Patrick Devine's avatar
Patrick Devine committed
771
772
		return
	}
Michael Yang's avatar
Michael Yang committed
773
774
775
776
777
778

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

Daniel Hiltgen's avatar
Daniel Hiltgen committed
781
func (s *Server) HeadBlobHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
782
783
784
785
786
787
788
789
790
791
792
	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
793
	c.Status(http.StatusOK)
Michael Yang's avatar
Michael Yang committed
794
795
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
796
func (s *Server) CreateBlobHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
797
798
	if ib, ok := intermediateBlobs[c.Param("digest")]; ok {
		p, err := GetBlobsPath(ib)
799
800
801
802
803
804
		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
805
806
			slog.Info("evicting intermediate blob which no longer exists", "digest", ib)
			delete(intermediateBlobs, c.Param("digest"))
807
808
809
810
811
812
813
814
815
		} else if err != nil {
			c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
			return
		} else {
			c.Status(http.StatusOK)
			return
		}
	}

816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
	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
	}

834
	layer, err := NewLayer(c.Request.Body, "")
Michael Yang's avatar
Michael Yang committed
835
836
837
838
839
	if err != nil {
		c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

840
841
	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
842
843
844
		return
	}

Michael Yang's avatar
Michael Yang committed
845
	c.Status(http.StatusCreated)
Michael Yang's avatar
Michael Yang committed
846
847
}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
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
}

869
func allowedHost(host string) bool {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
870
	if host == "" || host == "localhost" {
871
872
873
874
875
876
877
878
		return true
	}

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

	var tlds = []string{
Jeffrey Morgan's avatar
Jeffrey Morgan committed
879
880
881
		"localhost",
		"local",
		"internal",
882
	}
883

Jeffrey Morgan's avatar
Jeffrey Morgan committed
884
	// check if the host is a local TLD
885
886
887
888
889
890
	for _, tld := range tlds {
		if strings.HasSuffix(host, "."+tld) {
			return true
		}
	}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
891
	return false
Jeffrey Morgan's avatar
Jeffrey Morgan committed
892
}
893

Jeffrey Morgan's avatar
Jeffrey Morgan committed
894
895
896
func allowedHostsMiddleware(addr net.Addr) gin.HandlerFunc {
	return func(c *gin.Context) {
		if addr == nil {
897
898
899
900
			c.Next()
			return
		}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
901
		if addr, err := netip.ParseAddrPort(addr.String()); err == nil && !addr.Addr().IsLoopback() {
902
903
904
905
906
907
908
909
910
			c.Next()
			return
		}

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

Jeffrey Morgan's avatar
Jeffrey Morgan committed
911
		if addr, err := netip.ParseAddr(host); err == nil {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
912
			if addr.IsLoopback() || addr.IsPrivate() || addr.IsUnspecified() || isLocalIP(addr) {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
913
914
915
916
917
				c.Next()
				return
			}
		}

918
		if allowedHost(host) {
919
920
921
922
923
			if c.Request.Method == "OPTIONS" {
				c.AbortWithStatus(http.StatusNoContent)
				return
			}

924
925
926
927
928
929
			c.Next()
			return
		}

		c.AbortWithStatus(http.StatusForbidden)
	}
930
}
931

932
func (s *Server) GenerateRoutes() http.Handler {
Michael Yang's avatar
Michael Yang committed
933
934
	config := cors.DefaultConfig()
	config.AllowWildcard = true
935
	config.AllowBrowserExtensions = true
936
	config.AllowHeaders = []string{"Authorization", "Content-Type", "User-Agent", "Accept", "X-Requested-With"}
937
	config.AllowOrigins = envconfig.AllowOrigins
Michael Yang's avatar
Michael Yang committed
938

Bruce MacDonald's avatar
Bruce MacDonald committed
939
	r := gin.Default()
940
941
	r.Use(
		cors.New(config),
942
		allowedHostsMiddleware(s.addr),
943
	)
Bruce MacDonald's avatar
Bruce MacDonald committed
944

Daniel Hiltgen's avatar
Daniel Hiltgen committed
945
946
947
948
949
950
951
952
953
954
955
	r.POST("/api/pull", s.PullModelHandler)
	r.POST("/api/generate", s.GenerateHandler)
	r.POST("/api/chat", s.ChatHandler)
	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)
956
	r.GET("/api/ps", s.ProcessHandler)
Jeffrey Morgan's avatar
Jeffrey Morgan committed
957

958
	// Compatibility endpoints
Daniel Hiltgen's avatar
Daniel Hiltgen committed
959
	r.POST("/v1/chat/completions", openai.Middleware(), s.ChatHandler)
960

Michael Yang's avatar
Michael Yang committed
961
962
963
964
965
	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
966
		r.Handle(method, "/api/tags", s.ListModelsHandler)
Michael Yang's avatar
Michael Yang committed
967
968
969
		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
970
971
	}

972
973
974
975
	return r
}

func Serve(ln net.Listener) error {
Michael Yang's avatar
Michael Yang committed
976
	level := slog.LevelInfo
977
	if envconfig.Debug {
Michael Yang's avatar
Michael Yang committed
978
		level = slog.LevelDebug
979
	}
Michael Yang's avatar
Michael Yang committed
980

981
	slog.Info("server config", "env", envconfig.Values())
Michael Yang's avatar
Michael Yang committed
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
	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))

997
998
999
1000
1001
1002
1003
1004
	blobsDir, err := GetBlobsPath("")
	if err != nil {
		return err
	}
	if err := fixBlobs(blobsDir); err != nil {
		return err
	}

1005
	if !envconfig.NoPrune {
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
		// 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
1021
	ctx, done := context.WithCancel(context.Background())
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1022
1023
	schedCtx, schedDone := context.WithCancel(ctx)
	sched := InitScheduler(schedCtx)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1024
	s := &Server{addr: ln.Addr(), sched: sched}
1025
1026
	r := s.GenerateRoutes()

1027
	slog.Info(fmt.Sprintf("Listening on %s (version %s)", ln.Addr(), version.Version))
1028
	srvr := &http.Server{
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1029
1030
1031
		Handler: r,
	}

1032
1033
	// listen for a ctrl+c and stop any loaded llm
	signals := make(chan os.Signal, 1)
1034
	signal.Notify(signals, syscall.SIGINT, syscall.SIGTERM)
1035
1036
	go func() {
		<-signals
1037
		srvr.Close()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1038
		schedDone()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1039
		sched.unloadAllRunners()
1040
		gpu.Cleanup()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1041
		done()
1042
1043
	}()

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1044
	if err := llm.Init(); err != nil {
1045
1046
		return fmt.Errorf("unable to initialize llm library %w", err)
	}
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1047

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1048
	s.sched.Run(schedCtx)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1049
1050
1051

	// 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
1052
1053
	gpus := gpu.GetGPUInfo()
	gpus.LogDetails()
1054

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1055
1056
1057
1058
1059
1060
1061
	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()
1062
	return nil
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1063
}
Michael Yang's avatar
Michael Yang committed
1064

1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
func waitForStream(c *gin.Context, ch chan interface{}) {
	c.Header("Content-Type", "application/json")
	for resp := range ch {
		switch r := resp.(type) {
		case api.ProgressResponse:
			if r.Status == "success" {
				c.JSON(http.StatusOK, r)
				return
			}
		case gin.H:
			if errorMsg, ok := r["error"].(string); ok {
				c.JSON(http.StatusInternalServerError, gin.H{"error": errorMsg})
				return
			} else {
				c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected error format in progress response"})
				return
			}
		default:
			c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected progress response"})
			return
		}
	}
	c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected end of progress response"})
}

Michael Yang's avatar
Michael Yang committed
1090
func streamResponse(c *gin.Context, ch chan any) {
1091
	c.Header("Content-Type", "application/x-ndjson")
Michael Yang's avatar
Michael Yang committed
1092
1093
1094
1095
1096
1097
1098
1099
	c.Stream(func(w io.Writer) bool {
		val, ok := <-ch
		if !ok {
			return false
		}

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

1104
		// Delineate chunks with new-line delimiter
Michael Yang's avatar
Michael Yang committed
1105
1106
		bts = append(bts, '\n')
		if _, err := w.Write(bts); err != nil {
1107
			slog.Info(fmt.Sprintf("streamResponse: w.Write failed with %s", err))
Michael Yang's avatar
Michael Yang committed
1108
1109
1110
1111
1112
1113
			return false
		}

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

1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
func (s *Server) ProcessHandler(c *gin.Context) {
	models := []api.ModelResponse{}

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

		mr := api.ModelResponse{
			Model:     model.ShortName,
			Name:      model.ShortName,
			Size:      int64(v.estimatedTotal),
			SizeVRAM:  int64(v.estimatedVRAM),
			Digest:    model.Digest,
			Details:   modelDetails,
			ExpiresAt: v.expiresAt,
		}
1137
1138
1139
1140
1141
1142
1143
1144
		// 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)
		}

1145
1146
1147
1148
1149
1150
		models = append(models, mr)
	}

	c.JSON(http.StatusOK, api.ListResponse{Models: models})
}

1151
// ChatPrompt builds up a prompt from a series of messages for the currently `loaded` model
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1152
func chatPrompt(ctx context.Context, runner *runnerRef, template string, messages []api.Message, numCtx int) (string, error) {
1153
	encode := func(s string) ([]int, error) {
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1154
		return runner.llama.Tokenize(ctx, s)
1155
1156
	}

1157
	prompt, err := ChatPrompt(template, messages, numCtx, encode)
1158
1159
1160
1161
1162
1163
1164
	if err != nil {
		return "", err
	}

	return prompt, nil
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1165
func (s *Server) ChatHandler(c *gin.Context) {
Bruce MacDonald's avatar
Bruce MacDonald committed
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
	checkpointStart := time.Now()

	var req api.ChatRequest
	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
	}

	// validate the request
	switch {
	case req.Model == "":
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
		return
	case len(req.Format) > 0 && req.Format != "json":
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "format must be json"})
		return
	}

1189
	model, err := GetModel(req.Model)
Bruce MacDonald's avatar
Bruce MacDonald committed
1190
1191
	if err != nil {
		var pErr *fs.PathError
1192
		if errors.As(err, &pErr) {
Bruce MacDonald's avatar
Bruce MacDonald committed
1193
			c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found, try pulling it first", req.Model)})
1194
1195
1196
1197
1198
1199
			return
		}
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

1200
	if model.IsEmbedding() {
1201
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "embedding models do not support chat"})
1202
1203
1204
		return
	}

1205
1206
1207
1208
1209
	opts, err := modelOptions(model, req.Options)
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}
1210
1211
1212

	var sessionDuration time.Duration
	if req.KeepAlive == nil {
1213
		sessionDuration = getDefaultSessionDuration()
1214
1215
1216
1217
	} else {
		sessionDuration = req.KeepAlive.Duration
	}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1218
1219
1220
1221
1222
	rCh, eCh := s.sched.GetRunner(c.Request.Context(), model, opts, sessionDuration)
	var runner *runnerRef
	select {
	case runner = <-rCh:
	case err = <-eCh:
1223
		handleErrorResponse(c, err)
Bruce MacDonald's avatar
Bruce MacDonald committed
1224
1225
1226
1227
1228
		return
	}

	checkpointLoaded := time.Now()

1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
	// if the first message is not a system message, then add the model's default system message
	if len(req.Messages) > 0 && req.Messages[0].Role != "system" {
		req.Messages = append([]api.Message{
			{
				Role:    "system",
				Content: model.System,
			},
		}, req.Messages...)
	}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1239
	prompt, err := chatPrompt(c.Request.Context(), runner, model.Template, req.Messages, opts.NumCtx)
Bruce MacDonald's avatar
Bruce MacDonald committed
1240
1241
1242
1243
	if err != nil {
		c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}
Michael Yang's avatar
Michael Yang committed
1244

1245
	// an empty request loads the model
1246
	if len(req.Messages) == 0 || prompt == "" {
1247
		resp := api.ChatResponse{
1248
1249
1250
1251
1252
			CreatedAt:  time.Now().UTC(),
			Model:      req.Model,
			Done:       true,
			DoneReason: "load",
			Message:    api.Message{Role: "assistant"},
1253
1254
1255
1256
1257
		}
		c.JSON(http.StatusOK, resp)
		return
	}

1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
	// only send images that are in the prompt
	var i int
	var images []llm.ImageData
	for _, m := range req.Messages {
		for _, img := range m.Images {
			if !isSupportedImageType(img) {
				c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "unsupported image format"})
				return
			}

			if strings.Contains(prompt, fmt.Sprintf("[img-%d]", i)) {
				images = append(images, llm.ImageData{Data: img, ID: i})
			}
			i += 1
		}
	}

	slog.Debug("chat handler", "prompt", prompt, "images", len(images))
1276

Bruce MacDonald's avatar
Bruce MacDonald committed
1277
1278
1279
1280
1281
	ch := make(chan any)

	go func() {
		defer close(ch)

1282
		fn := func(r llm.CompletionResponse) {
Bruce MacDonald's avatar
Bruce MacDonald committed
1283
1284

			resp := api.ChatResponse{
1285
1286
1287
1288
1289
				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
1290
1291
1292
1293
1294
1295
1296
1297
				Metrics: api.Metrics{
					PromptEvalCount:    r.PromptEvalCount,
					PromptEvalDuration: r.PromptEvalDuration,
					EvalCount:          r.EvalCount,
					EvalDuration:       r.EvalDuration,
				},
			}

1298
1299
1300
			if r.Done {
				resp.TotalDuration = time.Since(checkpointStart)
				resp.LoadDuration = checkpointLoaded.Sub(checkpointStart)
Bruce MacDonald's avatar
Bruce MacDonald committed
1301
1302
1303
1304
1305
			}

			ch <- resp
		}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1306
		if err := runner.llama.Completion(c.Request.Context(), llm.CompletionRequest{
1307
1308
			Prompt:  prompt,
			Format:  req.Format,
Michael Yang's avatar
Michael Yang committed
1309
			Images:  images,
1310
			Options: opts,
1311
		}, fn); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1312
1313
1314
1315
1316
			ch <- gin.H{"error": err.Error()}
		}
	}()

	if req.Stream != nil && !*req.Stream {
1317
1318
		// Accumulate responses into the final response
		var final api.ChatResponse
Bruce MacDonald's avatar
Bruce MacDonald committed
1319
1320
		var sb strings.Builder
		for resp := range ch {
1321
1322
			switch r := resp.(type) {
			case api.ChatResponse:
1323
				sb.WriteString(r.Message.Content)
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
				final = r
			case gin.H:
				if errorMsg, ok := r["error"].(string); ok {
					c.JSON(http.StatusInternalServerError, gin.H{"error": errorMsg})
					return
				} else {
					c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected error format in response"})
					return
				}
			default:
				c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected error"})
				return
Bruce MacDonald's avatar
Bruce MacDonald committed
1336
1337
			}
		}
1338

1339
		final.Message = api.Message{Role: "assistant", Content: sb.String()}
1340
		c.JSON(http.StatusOK, final)
Bruce MacDonald's avatar
Bruce MacDonald committed
1341
1342
1343
1344
1345
		return
	}

	streamResponse(c, ch)
}
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357

func handleErrorResponse(c *gin.Context, err error) {
	if errors.Is(err, context.Canceled) {
		c.JSON(499, gin.H{"error": "request canceled"})
		return
	}
	if errors.Is(err, ErrMaxQueue) {
		c.JSON(http.StatusServiceUnavailable, gin.H{"error": err.Error()})
		return
	}
	c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
}