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

import (
4
	"context"
Michael Yang's avatar
Michael Yang committed
5
	"encoding/json"
6
	"errors"
7
	"fmt"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
8
	"io"
9
	"io/fs"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
10
11
12
	"log"
	"net"
	"net/http"
13
	"os"
14
	"os/signal"
Michael Yang's avatar
Michael Yang committed
15
	"path/filepath"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
16
	"reflect"
17
	"runtime"
Patrick Devine's avatar
Patrick Devine committed
18
	"strconv"
Michael Yang's avatar
Michael Yang committed
19
	"strings"
Michael Yang's avatar
Michael Yang committed
20
	"sync"
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"

Jeffrey Morgan's avatar
Jeffrey Morgan committed
27
	"github.com/jmorganca/ollama/api"
28
	"github.com/jmorganca/ollama/llm"
Michael Yang's avatar
Michael Yang committed
29
	"github.com/jmorganca/ollama/parser"
Michael Yang's avatar
Michael Yang committed
30
	"github.com/jmorganca/ollama/version"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
31
32
)

Michael Yang's avatar
Michael Yang committed
33
34
35
36
37
38
39
40
41
42
43
44
45
46
var mode string = gin.DebugMode

func init() {
	switch mode {
	case gin.DebugMode:
	case gin.ReleaseMode:
	case gin.TestMode:
	default:
		mode = gin.DebugMode
	}

	gin.SetMode(mode)
}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
47
var loaded struct {
Michael Yang's avatar
Michael Yang committed
48
49
	mu sync.Mutex

50
	runner llm.LLM
Michael Yang's avatar
Michael Yang committed
51
52
53

	expireAt    time.Time
	expireTimer *time.Timer
Jeffrey Morgan's avatar
Jeffrey Morgan committed
54

55
56
	*Model
	*api.Options
Michael Yang's avatar
Michael Yang committed
57
58
}

59
60
var defaultSessionDuration = 5 * time.Minute

Bruce MacDonald's avatar
Bruce MacDonald committed
61
// load a model into memory if it is not already loaded, it is up to the caller to lock loaded.mu before calling this function
Bruce MacDonald's avatar
Bruce MacDonald committed
62
63
64
65
66
67
68
69
func load(c *gin.Context, modelName string, reqOpts map[string]interface{}, sessionDuration time.Duration) (*Model, error) {
	model, err := GetModel(modelName)
	if err != nil {
		return nil, err
	}

	workDir := c.GetString("workDir")

70
71
72
	opts := api.DefaultOptions()
	if err := opts.FromMap(model.Options); err != nil {
		log.Printf("could not load model options: %v", err)
Bruce MacDonald's avatar
Bruce MacDonald committed
73
		return nil, err
74
75
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
76
	if err := opts.FromMap(reqOpts); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
77
		return nil, err
78
79
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
80
81
	ctx := c.Request.Context()

82
	// check if the loaded model is still running in a subprocess, in case something unexpected happened
83
84
	if loaded.runner != nil {
		if err := loaded.runner.Ping(ctx); err != nil {
85
86
			log.Print("loaded llm process not responding, closing now")
			// the subprocess is no longer running, so close it
87
88
89
90
			loaded.runner.Close()
			loaded.runner = nil
			loaded.Model = nil
			loaded.Options = nil
91
92
93
		}
	}

94
95
96
97
98
99
100
	needLoad := loaded.runner == nil || // is there a model loaded?
		loaded.ModelPath != model.ModelPath || // has the base model changed?
		!reflect.DeepEqual(loaded.AdapterPaths, model.AdapterPaths) || // have the adapters changed?
		!reflect.DeepEqual(loaded.Options.Runner, opts.Runner) // have the runner options changed?

	if needLoad {
		if loaded.runner != nil {
101
			log.Println("changing loaded model")
102
103
104
105
			loaded.runner.Close()
			loaded.runner = nil
			loaded.Model = nil
			loaded.Options = nil
Michael Yang's avatar
Michael Yang committed
106
		}
Michael Yang's avatar
Michael Yang committed
107

108
		llmRunner, err := llm.New(workDir, model.ModelPath, model.AdapterPaths, opts)
Michael Yang's avatar
Michael Yang committed
109
		if err != nil {
110
111
112
113
114
115
116
			// some older models are not compatible with newer versions of llama.cpp
			// show a generalized compatibility error until there is a better way to
			// check for model compatibility
			if strings.Contains(err.Error(), "failed to load model") {
				err = fmt.Errorf("%v: this model may be incompatible with your version of Ollama. If you previously pulled this model, try updating it by running `ollama pull %s`", err, model.ShortName)
			}

Bruce MacDonald's avatar
Bruce MacDonald committed
117
			return nil, err
Michael Yang's avatar
Michael Yang committed
118
119
		}

120
121
122
		loaded.Model = model
		loaded.runner = llmRunner
		loaded.Options = &opts
Michael Yang's avatar
Michael Yang committed
123
	}
124

Michael Yang's avatar
Michael Yang committed
125
126
127
128
	// update options for the loaded llm
	// TODO(mxyng): this isn't thread safe, but it should be fine for now
	loaded.runner.SetOptions(opts)

Jeffrey Morgan's avatar
Jeffrey Morgan committed
129
	loaded.expireAt = time.Now().Add(sessionDuration)
Bruce MacDonald's avatar
Bruce MacDonald committed
130

Jeffrey Morgan's avatar
Jeffrey Morgan committed
131
132
133
134
	if loaded.expireTimer == nil {
		loaded.expireTimer = time.AfterFunc(sessionDuration, func() {
			loaded.mu.Lock()
			defer loaded.mu.Unlock()
Michael Yang's avatar
Michael Yang committed
135

Jeffrey Morgan's avatar
Jeffrey Morgan committed
136
			if time.Now().Before(loaded.expireAt) {
Michael Yang's avatar
Michael Yang committed
137
138
139
				return
			}

140
141
			if loaded.runner != nil {
				loaded.runner.Close()
Michael Yang's avatar
Michael Yang committed
142
143
			}

144
145
146
			loaded.runner = nil
			loaded.Model = nil
			loaded.Options = nil
Michael Yang's avatar
Michael Yang committed
147
		})
Michael Yang's avatar
Michael Yang committed
148
	}
149

Jeffrey Morgan's avatar
Jeffrey Morgan committed
150
	loaded.expireTimer.Reset(sessionDuration)
Bruce MacDonald's avatar
Bruce MacDonald committed
151
	return model, nil
Bruce MacDonald's avatar
Bruce MacDonald committed
152
153
154
155
156
157
158
159
160
}

func GenerateHandler(c *gin.Context) {
	loaded.mu.Lock()
	defer loaded.mu.Unlock()

	checkpointStart := time.Now()

	var req api.GenerateRequest
Michael Yang's avatar
Michael Yang committed
161
162
163
164
165
166
167
	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()})
Bruce MacDonald's avatar
Bruce MacDonald committed
168
169
170
		return
	}

171
172
173
	// validate the request
	switch {
	case req.Model == "":
174
175
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
		return
176
177
178
	case len(req.Format) > 0 && req.Format != "json":
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "format must be json"})
		return
179
180
181
	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
182
183
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
184
185
	sessionDuration := defaultSessionDuration
	model, err := load(c, req.Model, req.Options, sessionDuration)
Bruce MacDonald's avatar
Bruce MacDonald committed
186
	if err != nil {
187
		var pErr *fs.PathError
Bruce MacDonald's avatar
Bruce MacDonald committed
188
189
		switch {
		case errors.As(err, &pErr):
190
			c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found, try pulling it first", req.Model)})
Bruce MacDonald's avatar
Bruce MacDonald committed
191
192
193
194
		case errors.Is(err, api.ErrInvalidOpts):
			c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		default:
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
195
		}
Bruce MacDonald's avatar
Bruce MacDonald committed
196
197
198
		return
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
199
200
201
	// an empty request loads the model
	if req.Prompt == "" && req.Template == "" && req.System == "" {
		c.JSON(http.StatusOK, api.GenerateResponse{CreatedAt: time.Now().UTC(), Model: req.Model, Done: true})
Bruce MacDonald's avatar
Bruce MacDonald committed
202
203
		return
	}
Michael Yang's avatar
Michael Yang committed
204

Michael Yang's avatar
Michael Yang committed
205
206
	checkpointLoaded := time.Now()

Bruce MacDonald's avatar
Bruce MacDonald committed
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
	var prompt string
	sendContext := false
	switch {
	case req.Raw:
		prompt = req.Prompt
	case req.Prompt != "":
		if req.Template != "" {
			// override the default model template
			model.Template = req.Template
		}

		var rebuild strings.Builder
		if req.Context != nil {
			// TODO: context is deprecated, at some point the context logic within this conditional should be removed
			prevCtx, err := loaded.runner.Decode(c.Request.Context(), req.Context)
			if err != nil {
				c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
				return
			}

			// Remove leading spaces from prevCtx if present
			prevCtx = strings.TrimPrefix(prevCtx, " ")
			rebuild.WriteString(prevCtx)
		}
		p, err := model.Prompt(PromptVars{
			System: req.System,
			Prompt: req.Prompt,
		})
235
236
237
238
		if err != nil {
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
			return
		}
Bruce MacDonald's avatar
Bruce MacDonald committed
239
240
241
		rebuild.WriteString(p)
		prompt = rebuild.String()
		sendContext = true
Michael Yang's avatar
Michael Yang committed
242
	}
Jeffrey Morgan's avatar
Jeffrey Morgan committed
243

Michael Yang's avatar
Michael Yang committed
244
	ch := make(chan any)
Bruce MacDonald's avatar
Bruce MacDonald committed
245
	var generated strings.Builder
Michael Yang's avatar
Michael Yang committed
246
247
	go func() {
		defer close(ch)
Michael Yang's avatar
Michael Yang committed
248

Bruce MacDonald's avatar
Bruce MacDonald committed
249
250
		fn := func(r llm.PredictResponse) {
			// Update model expiration
Jeffrey Morgan's avatar
Jeffrey Morgan committed
251
252
			loaded.expireAt = time.Now().Add(sessionDuration)
			loaded.expireTimer.Reset(sessionDuration)
Michael Yang's avatar
Michael Yang committed
253

Bruce MacDonald's avatar
Bruce MacDonald committed
254
255
256
257
			// Build up the full response
			if _, err := generated.WriteString(r.Content); err != nil {
				ch <- gin.H{"error": err.Error()}
				return
Michael Yang's avatar
Michael Yang committed
258
259
			}

Bruce MacDonald's avatar
Bruce MacDonald committed
260
261
262
263
264
265
266
267
268
269
270
271
272
			resp := api.GenerateResponse{
				Model:     r.Model,
				CreatedAt: r.CreatedAt,
				Done:      r.Done,
				Response:  r.Content,
				EvalMetrics: api.EvalMetrics{
					TotalDuration:      r.TotalDuration,
					LoadDuration:       r.LoadDuration,
					PromptEvalCount:    r.PromptEvalCount,
					PromptEvalDuration: r.PromptEvalDuration,
					EvalCount:          r.EvalCount,
					EvalDuration:       r.EvalDuration,
				},
273
274
			}

Bruce MacDonald's avatar
Bruce MacDonald committed
275
276
277
278
279
280
281
282
283
284
			if r.Done && sendContext {
				embd, err := loaded.runner.Encode(c.Request.Context(), req.Prompt+generated.String())
				if err != nil {
					ch <- gin.H{"error": err.Error()}
					return
				}
				r.Context = embd
			}

			ch <- resp
Michael Yang's avatar
Michael Yang committed
285
286
		}

Bruce MacDonald's avatar
Bruce MacDonald committed
287
288
289
290
291
292
293
294
295
		// Start prediction
		predictReq := llm.PredictRequest{
			Model:            model.Name,
			Prompt:           prompt,
			Format:           req.Format,
			CheckpointStart:  checkpointStart,
			CheckpointLoaded: checkpointLoaded,
		}
		if err := loaded.runner.Predict(c.Request.Context(), predictReq, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
296
			ch <- gin.H{"error": err.Error()}
Michael Yang's avatar
Michael Yang committed
297
		}
Michael Yang's avatar
Michael Yang committed
298
	}()
Michael Yang's avatar
Michael Yang committed
299

300
	if req.Stream != nil && !*req.Stream {
Bruce MacDonald's avatar
Bruce MacDonald committed
301
302
303
		// Wait for the channel to close
		var r api.GenerateResponse
		var sb strings.Builder
304
		for resp := range ch {
Bruce MacDonald's avatar
Bruce MacDonald committed
305
306
			var ok bool
			if r, ok = resp.(api.GenerateResponse); !ok {
307
308
309
				c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
				return
			}
Bruce MacDonald's avatar
Bruce MacDonald committed
310
			sb.WriteString(r.Response)
311
		}
Bruce MacDonald's avatar
Bruce MacDonald committed
312
313
		r.Response = sb.String()
		c.JSON(http.StatusOK, r)
314
315
316
		return
	}

Michael Yang's avatar
Michael Yang committed
317
	streamResponse(c, ch)
Michael Yang's avatar
Michael Yang committed
318
}
Michael Yang's avatar
Michael Yang committed
319

Bruce MacDonald's avatar
Bruce MacDonald committed
320
func ChatHandler(c *gin.Context) {
Bruce MacDonald's avatar
Bruce MacDonald committed
321
322
323
	loaded.mu.Lock()
	defer loaded.mu.Unlock()

Bruce MacDonald's avatar
Bruce MacDonald committed
324
325
326
	checkpointStart := time.Now()

	var req api.ChatRequest
Michael Yang's avatar
Michael Yang committed
327
328
329
330
331
332
333
	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()})
Bruce MacDonald's avatar
Bruce MacDonald committed
334
335
336
		return
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
337
338
339
	// validate the request
	switch {
	case req.Model == "":
340
341
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
		return
Bruce MacDonald's avatar
Bruce MacDonald committed
342
343
344
	case len(req.Format) > 0 && req.Format != "json":
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "format must be json"})
		return
345
346
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
347
348
	sessionDuration := defaultSessionDuration
	model, err := load(c, req.Model, req.Options, sessionDuration)
Bruce MacDonald's avatar
Bruce MacDonald committed
349
	if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
350
351
352
353
354
355
356
357
358
		var pErr *fs.PathError
		switch {
		case errors.As(err, &pErr):
			c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found, try pulling it first", req.Model)})
		case errors.Is(err, api.ErrInvalidOpts):
			c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		default:
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		}
Bruce MacDonald's avatar
Bruce MacDonald committed
359
360
		return
	}
361

Bruce MacDonald's avatar
Bruce MacDonald committed
362
363
364
365
366
367
368
369
370
371
372
373
374
375
	// an empty request loads the model
	if len(req.Messages) == 0 {
		c.JSON(http.StatusOK, api.ChatResponse{CreatedAt: time.Now().UTC(), Model: req.Model, Done: true})
		return
	}

	checkpointLoaded := time.Now()

	if req.Template != "" {
		// override the default model template
		model.Template = req.Template
	}
	prompt, err := model.ChatPrompt(req.Messages)
	if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
376
377
378
379
		c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
	ch := make(chan any)

	go func() {
		defer close(ch)

		fn := func(r llm.PredictResponse) {
			// Update model expiration
			loaded.expireAt = time.Now().Add(sessionDuration)
			loaded.expireTimer.Reset(sessionDuration)

			resp := api.ChatResponse{
				Model:     r.Model,
				CreatedAt: r.CreatedAt,
				Done:      r.Done,
				EvalMetrics: api.EvalMetrics{
					TotalDuration:      r.TotalDuration,
					LoadDuration:       r.LoadDuration,
					PromptEvalCount:    r.PromptEvalCount,
					PromptEvalDuration: r.PromptEvalDuration,
					EvalCount:          r.EvalCount,
					EvalDuration:       r.EvalDuration,
				},
			}

			if !r.Done {
				resp.Message = &api.Message{Role: "assistant", Content: r.Content}
			}

			ch <- resp
		}

		// Start prediction
		predictReq := llm.PredictRequest{
			Model:            model.Name,
			Prompt:           prompt,
			Format:           req.Format,
			CheckpointStart:  checkpointStart,
			CheckpointLoaded: checkpointLoaded,
		}
		if err := loaded.runner.Predict(c.Request.Context(), predictReq, fn); err != nil {
			ch <- gin.H{"error": err.Error()}
		}
	}()

	if req.Stream != nil && !*req.Stream {
		// Wait for the channel to close
		var r api.ChatResponse
		var sb strings.Builder
		for resp := range ch {
			var ok bool
			if r, ok = resp.(api.ChatResponse); !ok {
				c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
				return
			}
			if r.Message != nil {
				sb.WriteString(r.Message.Content)
			}
		}
		r.Message = &api.Message{Role: "assistant", Content: sb.String()}
		c.JSON(http.StatusOK, r)
		return
	}

	streamResponse(c, ch)
}

func EmbeddingHandler(c *gin.Context) {
	loaded.mu.Lock()
	defer loaded.mu.Unlock()

	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
	}

	sessionDuration := defaultSessionDuration
	_, err = load(c, req.Model, req.Options, sessionDuration)
	if err != nil {
		var pErr *fs.PathError
		switch {
		case errors.As(err, &pErr):
			c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found, try pulling it first", req.Model)})
		case errors.Is(err, api.ErrInvalidOpts):
			c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		default:
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		}
		return
	}

481
	if !loaded.Options.EmbeddingOnly {
Bruce MacDonald's avatar
Bruce MacDonald committed
482
483
484
485
		c.JSON(http.StatusBadRequest, gin.H{"error": "embedding option must be set to true"})
		return
	}

486
	embedding, err := loaded.runner.Embedding(c.Request.Context(), req.Prompt)
Bruce MacDonald's avatar
Bruce MacDonald committed
487
488
489
490
491
492
493
494
495
496
497
498
	if err != nil {
		log.Printf("embedding generation failed: %v", err)
		c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to generate embedding"})
		return
	}

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

499
func PullModelHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
500
	var req api.PullRequest
Michael Yang's avatar
Michael Yang committed
501
502
503
504
505
506
507
	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
508
509
510
		return
	}

511
512
513
514
515
	if req.Name == "" {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "name is required"})
		return
	}

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

523
524
525
526
		regOpts := &RegistryOptions{
			Insecure: req.Insecure,
		}

527
528
529
530
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

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

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

540
541
542
	streamResponse(c, ch)
}

543
func PushModelHandler(c *gin.Context) {
544
	var req api.PushRequest
Michael Yang's avatar
Michael Yang committed
545
546
547
548
549
550
551
	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
552
553
		return
	}
Michael Yang's avatar
Michael Yang committed
554

555
556
557
558
559
	if req.Name == "" {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "name is required"})
		return
	}

560
561
562
	ch := make(chan any)
	go func() {
		defer close(ch)
563
564
		fn := func(r api.ProgressResponse) {
			ch <- r
565
		}
566

567
568
569
570
		regOpts := &RegistryOptions{
			Insecure: req.Insecure,
		}

Michael Yang's avatar
Michael Yang committed
571
572
573
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

574
		if err := PushModel(ctx, req.Name, regOpts, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
575
			ch <- gin.H{"error": err.Error()}
576
577
578
		}
	}()

579
580
581
582
583
	if req.Stream != nil && !*req.Stream {
		waitForStream(c, ch)
		return
	}

584
585
586
	streamResponse(c, ch)
}

587
func CreateModelHandler(c *gin.Context) {
588
	var req api.CreateRequest
Michael Yang's avatar
Michael Yang committed
589
590
591
592
593
594
595
	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
596
		return
597
598
	}

Michael Yang's avatar
Michael Yang committed
599
600
	if req.Name == "" {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "name is required"})
601
602
603
		return
	}

604
605
	if err := ParseModelPath(req.Name).Validate(); err != nil {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
606
607
608
		return
	}

Michael Yang's avatar
Michael Yang committed
609
610
	if req.Path == "" && req.Modelfile == "" {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "path or modelfile are required"})
Michael Yang's avatar
Michael Yang committed
611
612
		return
	}
Michael Yang's avatar
Michael Yang committed
613
614
615

	var modelfile io.Reader = strings.NewReader(req.Modelfile)
	if req.Path != "" && req.Modelfile == "" {
616
		mf, err := os.Open(req.Path)
Michael Yang's avatar
Michael Yang committed
617
618
619
620
		if err != nil {
			c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("error reading modelfile: %s", err)})
			return
		}
621
		defer mf.Close()
Michael Yang's avatar
Michael Yang committed
622

623
		modelfile = mf
Michael Yang's avatar
Michael Yang committed
624
	}
Michael Yang's avatar
Michael Yang committed
625
626
627
628
629
630
631

	commands, err := parser.Parse(modelfile)
	if err != nil {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

Michael Yang's avatar
Michael Yang committed
632
	ch := make(chan any)
Michael Yang's avatar
Michael Yang committed
633
634
	go func() {
		defer close(ch)
635
636
		fn := func(resp api.ProgressResponse) {
			ch <- resp
637
638
		}

639
640
641
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

642
		if err := CreateModel(ctx, req.Name, filepath.Dir(req.Path), commands, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
643
			ch <- gin.H{"error": err.Error()}
644
		}
Michael Yang's avatar
Michael Yang committed
645
	}()
Michael Yang's avatar
Michael Yang committed
646

647
648
649
650
651
	if req.Stream != nil && !*req.Stream {
		waitForStream(c, ch)
		return
	}

Michael Yang's avatar
Michael Yang committed
652
	streamResponse(c, ch)
Bruce MacDonald's avatar
Bruce MacDonald committed
653
654
}

655
656
func DeleteModelHandler(c *gin.Context) {
	var req api.DeleteRequest
Michael Yang's avatar
Michael Yang committed
657
658
659
660
661
662
663
	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()})
664
665
666
		return
	}

667
668
669
670
671
	if req.Name == "" {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "name is required"})
		return
	}

672
673
674
675
	if err := DeleteModel(req.Name); err != nil {
		if os.IsNotExist(err) {
			c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found", req.Name)})
		} else {
676
677
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		}
678
679
		return
	}
Michael Yang's avatar
Michael Yang committed
680
681
682
683
684
685
686
687
688
689
690
691

	manifestsPath, err := GetManifestPath()
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

	if err := PruneDirectory(manifestsPath); err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

692
	c.JSON(http.StatusOK, nil)
693
694
}

Patrick Devine's avatar
Patrick Devine committed
695
696
func ShowModelHandler(c *gin.Context) {
	var req api.ShowRequest
Michael Yang's avatar
Michael Yang committed
697
698
699
700
701
702
703
	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
704
705
706
		return
	}

707
708
709
710
711
	if req.Name == "" {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "name is required"})
		return
	}

Patrick Devine's avatar
Patrick Devine committed
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
	resp, err := GetModelInfo(req.Name)
	if err != nil {
		if os.IsNotExist(err) {
			c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found", req.Name)})
		} else {
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		}
		return
	}

	c.JSON(http.StatusOK, resp)
}

func GetModelInfo(name string) (*api.ShowResponse, error) {
	model, err := GetModel(name)
	if err != nil {
		return nil, err
	}

	resp := &api.ShowResponse{
		License:  strings.Join(model.License, "\n"),
		System:   model.System,
		Template: model.Template,
	}

	mf, err := ShowModelfile(model)
	if err != nil {
		return nil, err
	}

	resp.Modelfile = mf

	var params []string
	cs := 30
	for k, v := range model.Options {
		switch val := v.(type) {
		case string:
			params = append(params, fmt.Sprintf("%-*s %s", cs, k, val))
		case int:
			params = append(params, fmt.Sprintf("%-*s %s", cs, k, strconv.Itoa(val)))
		case float64:
			params = append(params, fmt.Sprintf("%-*s %s", cs, k, strconv.FormatFloat(val, 'f', 0, 64)))
		case bool:
			params = append(params, fmt.Sprintf("%-*s %s", cs, k, strconv.FormatBool(val)))
		case []interface{}:
			for _, nv := range val {
				switch nval := nv.(type) {
				case string:
					params = append(params, fmt.Sprintf("%-*s %s", cs, k, nval))
				case int:
					params = append(params, fmt.Sprintf("%-*s %s", cs, k, strconv.Itoa(nval)))
				case float64:
					params = append(params, fmt.Sprintf("%-*s %s", cs, k, strconv.FormatFloat(nval, 'f', 0, 64)))
				case bool:
					params = append(params, fmt.Sprintf("%-*s %s", cs, k, strconv.FormatBool(nval)))
				}
			}
		}
	}
	resp.Parameters = strings.Join(params, "\n")

	return resp, nil
}

776
func ListModelsHandler(c *gin.Context) {
777
	models := make([]api.ModelResponse, 0)
Patrick Devine's avatar
Patrick Devine committed
778
779
780
781
782
	fp, err := GetManifestPath()
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}
Michael Yang's avatar
Michael Yang committed
783
784

	walkFunc := func(path string, info os.FileInfo, _ error) error {
Patrick Devine's avatar
Patrick Devine committed
785
		if !info.IsDir() {
Michael Yang's avatar
Michael Yang committed
786
787
788
			dir, file := filepath.Split(path)
			dir = strings.Trim(strings.TrimPrefix(dir, fp), string(os.PathSeparator))
			tag := strings.Join([]string{dir, file}, ":")
789

790
			mp := ParseModelPath(tag)
Patrick Devine's avatar
Patrick Devine committed
791
			manifest, digest, err := GetManifest(mp)
Patrick Devine's avatar
Patrick Devine committed
792
			if err != nil {
793
794
				log.Printf("skipping file: %s", fp)
				return nil
Patrick Devine's avatar
Patrick Devine committed
795
			}
Michael Yang's avatar
Michael Yang committed
796
797

			models = append(models, api.ModelResponse{
Patrick Devine's avatar
Patrick Devine committed
798
799
				Name:       mp.GetShortTagname(),
				Size:       manifest.GetTotalSize(),
Patrick Devine's avatar
Patrick Devine committed
800
				Digest:     digest,
Michael Yang's avatar
Michael Yang committed
801
802
				ModifiedAt: info.ModTime(),
			})
Patrick Devine's avatar
Patrick Devine committed
803
		}
Michael Yang's avatar
Michael Yang committed
804

Patrick Devine's avatar
Patrick Devine committed
805
		return nil
Michael Yang's avatar
Michael Yang committed
806
807
808
	}

	if err := filepath.Walk(fp, walkFunc); err != nil {
Patrick Devine's avatar
Patrick Devine committed
809
810
811
812
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

Michael Yang's avatar
Michael Yang committed
813
	c.JSON(http.StatusOK, api.ListResponse{Models: models})
Patrick Devine's avatar
Patrick Devine committed
814
815
}

Patrick Devine's avatar
Patrick Devine committed
816
817
func CopyModelHandler(c *gin.Context) {
	var req api.CopyRequest
Michael Yang's avatar
Michael Yang committed
818
819
820
821
822
823
824
	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
825
826
827
		return
	}

828
829
830
831
832
	if req.Source == "" || req.Destination == "" {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "source add destination are required"})
		return
	}

833
834
835
836
837
	if err := ParseModelPath(req.Destination).Validate(); err != nil {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

Patrick Devine's avatar
Patrick Devine committed
838
839
840
841
842
843
844
845
846
847
	if err := CopyModel(req.Source, req.Destination); err != nil {
		if os.IsNotExist(err) {
			c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found", req.Source)})
		} else {
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		}
		return
	}
}

Michael Yang's avatar
Michael Yang committed
848
func HeadBlobHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
849
850
851
852
853
854
855
856
857
858
859
	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
860
	c.Status(http.StatusOK)
Michael Yang's avatar
Michael Yang committed
861
862
863
}

func CreateBlobHandler(c *gin.Context) {
864
	layer, err := NewLayer(c.Request.Body, "")
Michael Yang's avatar
Michael Yang committed
865
866
867
868
869
	if err != nil {
		c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

870
871
	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
872
873
874
		return
	}

875
	if _, err := layer.Commit(); err != nil {
Michael Yang's avatar
Michael Yang committed
876
877
878
879
		c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

Michael Yang's avatar
Michael Yang committed
880
	c.Status(http.StatusCreated)
Michael Yang's avatar
Michael Yang committed
881
882
}

Michael Yang's avatar
Michael Yang committed
883
884
885
886
887
888
889
var defaultAllowOrigins = []string{
	"localhost",
	"127.0.0.1",
	"0.0.0.0",
}

func Serve(ln net.Listener, allowOrigins []string) error {
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
	if noprune := os.Getenv("OLLAMA_NOPRUNE"); noprune == "" {
		// 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
		}
	}

Michael Yang's avatar
Michael Yang committed
906
907
	config := cors.DefaultConfig()
	config.AllowWildcard = true
Michael Yang's avatar
Michael Yang committed
908
909
910
911
912
913
914
915
916
917

	config.AllowOrigins = allowOrigins
	for _, allowOrigin := range defaultAllowOrigins {
		config.AllowOrigins = append(config.AllowOrigins,
			fmt.Sprintf("http://%s", allowOrigin),
			fmt.Sprintf("https://%s", allowOrigin),
			fmt.Sprintf("http://%s:*", allowOrigin),
			fmt.Sprintf("https://%s:*", allowOrigin),
		)
	}
Michael Yang's avatar
Michael Yang committed
918

919
920
921
922
923
924
	workDir, err := os.MkdirTemp("", "ollama")
	if err != nil {
		return err
	}
	defer os.RemoveAll(workDir)

Bruce MacDonald's avatar
Bruce MacDonald committed
925
	r := gin.Default()
926
927
928
929
930
931
932
	r.Use(
		cors.New(config),
		func(c *gin.Context) {
			c.Set("workDir", workDir)
			c.Next()
		},
	)
Bruce MacDonald's avatar
Bruce MacDonald committed
933

934
935
	r.POST("/api/pull", PullModelHandler)
	r.POST("/api/generate", GenerateHandler)
Bruce MacDonald's avatar
Bruce MacDonald committed
936
	r.POST("/api/chat", ChatHandler)
Bruce MacDonald's avatar
Bruce MacDonald committed
937
	r.POST("/api/embeddings", EmbeddingHandler)
938
939
	r.POST("/api/create", CreateModelHandler)
	r.POST("/api/push", PushModelHandler)
Patrick Devine's avatar
Patrick Devine committed
940
	r.POST("/api/copy", CopyModelHandler)
941
	r.DELETE("/api/delete", DeleteModelHandler)
Patrick Devine's avatar
Patrick Devine committed
942
	r.POST("/api/show", ShowModelHandler)
Michael Yang's avatar
Michael Yang committed
943
	r.POST("/api/blobs/:digest", CreateBlobHandler)
Michael Yang's avatar
Michael Yang committed
944
	r.HEAD("/api/blobs/:digest", HeadBlobHandler)
Jeffrey Morgan's avatar
Jeffrey Morgan committed
945

Michael Yang's avatar
Michael Yang committed
946
947
948
949
950
951
952
953
	for _, method := range []string{http.MethodGet, http.MethodHead} {
		r.Handle(method, "/", func(c *gin.Context) {
			c.String(http.StatusOK, "Ollama is running")
		})

		r.Handle(method, "/api/tags", ListModelsHandler)
	}

Michael Yang's avatar
Michael Yang committed
954
	log.Printf("Listening on %s (version %s)", ln.Addr(), version.Version)
Jeffrey Morgan's avatar
Jeffrey Morgan committed
955
956
957
958
	s := &http.Server{
		Handler: r,
	}

959
960
	// listen for a ctrl+c and stop any loaded llm
	signals := make(chan os.Signal, 1)
961
	signal.Notify(signals, syscall.SIGINT, syscall.SIGTERM)
962
963
	go func() {
		<-signals
964
965
		if loaded.runner != nil {
			loaded.runner.Close()
966
		}
967
		os.RemoveAll(workDir)
968
969
970
		os.Exit(0)
	}()

971
972
973
	if runtime.GOOS == "linux" {
		// check compatibility to log warnings
		if _, err := llm.CheckVRAM(); err != nil {
974
			log.Printf(err.Error())
975
976
977
		}
	}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
978
979
	return s.Serve(ln)
}
Michael Yang's avatar
Michael Yang committed
980

981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
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
1006
func streamResponse(c *gin.Context, ch chan any) {
1007
	c.Header("Content-Type", "application/x-ndjson")
Michael Yang's avatar
Michael Yang committed
1008
1009
1010
1011
1012
1013
1014
1015
	c.Stream(func(w io.Writer) bool {
		val, ok := <-ch
		if !ok {
			return false
		}

		bts, err := json.Marshal(val)
		if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1016
			log.Printf("streamResponse: json.Marshal failed with %s", err)
Michael Yang's avatar
Michael Yang committed
1017
1018
1019
			return false
		}

1020
		// Delineate chunks with new-line delimiter
Michael Yang's avatar
Michael Yang committed
1021
1022
		bts = append(bts, '\n')
		if _, err := w.Write(bts); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1023
			log.Printf("streamResponse: w.Write failed with %s", err)
Michael Yang's avatar
Michael Yang committed
1024
1025
1026
1027
1028
1029
			return false
		}

		return true
	})
}