routes.go 31.6 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"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
12
13
	"net"
	"net/http"
14
	"net/netip"
15
	"os"
16
	"os/signal"
Michael Yang's avatar
Michael Yang committed
17
	"path/filepath"
18
	"slices"
Michael Yang's avatar
Michael Yang committed
19
	"strings"
20
	"syscall"
21
	"time"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
22

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

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

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

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

Michael Yang's avatar
Michael Yang committed
45
46
47
48
49
50
51
52
53
54
55
56
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
57
58
var errRequired = errors.New("is required")

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

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

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

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

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

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

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

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

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

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

133
134
	checkpointLoaded := time.Now()

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

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

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

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

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

Michael Yang's avatar
Michael Yang committed
165
		tmpl := m.Template
Michael Yang's avatar
Michael Yang committed
166
167
168
169
170
171
172
173
174
		if req.Template != "" {
			tmpl, err = template.Parse(req.Template)
			if err != nil {
				c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
				return
			}
		}

		var b bytes.Buffer
Bruce MacDonald's avatar
Bruce MacDonald committed
175
		if req.Context != nil {
Michael Yang's avatar
Michael Yang committed
176
			s, err := r.Detokenize(c.Request.Context(), req.Context)
Bruce MacDonald's avatar
Bruce MacDonald committed
177
178
179
180
181
			if err != nil {
				c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
				return
			}

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

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

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

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

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

			if _, err := sb.WriteString(cr.Content); err != nil {
				ch <- gin.H{"error": err.Error()}
			}

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

				if !req.Raw {
					tokens, err := r.Tokenize(c.Request.Context(), prompt+sb.String())
					if err != nil {
						ch <- gin.H{"error": err.Error()}
						return
					}
					res.Context = append(req.Context, tokens...)
				}
			}

			ch <- res
Michael Yang's avatar
Michael Yang committed
239
		}); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
240
241
242
243
244
			ch <- gin.H{"error": err.Error()}
		}
	}()

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

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

Michael Yang's avatar
Michael Yang committed
266
267
		r.Response = sb.String()
		c.JSON(http.StatusOK, r)
Bruce MacDonald's avatar
Bruce MacDonald committed
268
269
270
271
272
273
		return
	}

	streamResponse(c, ch)
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
274
func (s *Server) EmbeddingsHandler(c *gin.Context) {
Bruce MacDonald's avatar
Bruce MacDonald committed
275
	var req api.EmbeddingRequest
Michael Yang's avatar
Michael Yang committed
276
	if err := c.ShouldBindJSON(&req); errors.Is(err, io.EOF) {
Bruce MacDonald's avatar
Bruce MacDonald committed
277
278
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
279
	} else if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
280
281
282
283
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

Michael Yang's avatar
Michael Yang committed
284
	r, _, _, err := s.scheduleRunner(c.Request.Context(), req.Model, []Capability{}, req.Options, req.KeepAlive)
Bruce MacDonald's avatar
Bruce MacDonald committed
285
	if err != nil {
Michael Yang's avatar
Michael Yang committed
286
		handleScheduleError(c, req.Model, err)
Bruce MacDonald's avatar
Bruce MacDonald committed
287
288
289
		return
	}

290
291
292
	// an empty request loads the model
	if req.Prompt == "" {
		c.JSON(http.StatusOK, api.EmbeddingResponse{Embedding: []float64{}})
Bruce MacDonald's avatar
Bruce MacDonald committed
293
294
295
		return
	}

Michael Yang's avatar
Michael Yang committed
296
	embedding, err := r.Embedding(c.Request.Context(), req.Prompt)
Bruce MacDonald's avatar
Bruce MacDonald committed
297
	if err != nil {
298
		slog.Info(fmt.Sprintf("embedding generation failed: %v", err))
Bruce MacDonald's avatar
Bruce MacDonald committed
299
300
301
302
		c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to generate embedding"})
		return
	}

Michael Yang's avatar
Michael Yang committed
303
	c.JSON(http.StatusOK, api.EmbeddingResponse{Embedding: embedding})
Bruce MacDonald's avatar
Bruce MacDonald committed
304
305
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
306
func (s *Server) PullModelHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
307
	var req api.PullRequest
Michael Yang's avatar
Michael Yang committed
308
309
310
311
312
313
314
	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
315
316
317
		return
	}

318
319
320
321
322
323
324
325
	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()})
326
327
328
		return
	}

329
330
331
	ch := make(chan any)
	go func() {
		defer close(ch)
332
333
		fn := func(r api.ProgressResponse) {
			ch <- r
334
		}
335

Michael Yang's avatar
Michael Yang committed
336
		regOpts := &registryOptions{
337
338
339
			Insecure: req.Insecure,
		}

340
341
342
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

343
		if err := PullModel(ctx, name.DisplayShortest(), regOpts, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
344
			ch <- gin.H{"error": err.Error()}
345
346
347
		}
	}()

348
349
350
351
352
	if req.Stream != nil && !*req.Stream {
		waitForStream(c, ch)
		return
	}

353
354
355
	streamResponse(c, ch)
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
356
func (s *Server) PushModelHandler(c *gin.Context) {
357
	var req api.PushRequest
Michael Yang's avatar
Michael Yang committed
358
359
360
361
362
363
364
	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
365
366
		return
	}
Michael Yang's avatar
Michael Yang committed
367

Michael Yang's avatar
Michael Yang committed
368
369
370
371
372
373
374
	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"})
375
376
377
		return
	}

378
379
380
	ch := make(chan any)
	go func() {
		defer close(ch)
381
382
		fn := func(r api.ProgressResponse) {
			ch <- r
383
		}
384

Michael Yang's avatar
Michael Yang committed
385
		regOpts := &registryOptions{
386
387
388
			Insecure: req.Insecure,
		}

Michael Yang's avatar
Michael Yang committed
389
390
391
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

Michael Yang's avatar
Michael Yang committed
392
		if err := PushModel(ctx, model, regOpts, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
393
			ch <- gin.H{"error": err.Error()}
394
395
396
		}
	}()

397
398
399
400
401
	if req.Stream != nil && !*req.Stream {
		waitForStream(c, ch)
		return
	}

402
403
404
	streamResponse(c, ch)
}

405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
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
420
func (s *Server) CreateModelHandler(c *gin.Context) {
421
422
	var r api.CreateRequest
	if err := c.ShouldBindJSON(&r); errors.Is(err, io.EOF) {
Michael Yang's avatar
Michael Yang committed
423
424
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
425
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
426
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Michael Yang's avatar
Michael Yang committed
427
		return
428
429
	}

430
	name := model.ParseName(cmp.Or(r.Model, r.Name))
Michael Yang's avatar
Michael Yang committed
431
	if !name.IsValid() {
432
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": errtypes.InvalidModelNameErrMsg})
433
434
435
		return
	}

436
437
438
439
440
	if err := checkNameExists(name); err != nil {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

441
	if r.Path == "" && r.Modelfile == "" {
Michael Yang's avatar
Michael Yang committed
442
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "path or modelfile are required"})
Michael Yang's avatar
Michael Yang committed
443
444
		return
	}
Michael Yang's avatar
Michael Yang committed
445

446
447
448
	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
449
450
451
452
		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
453
		defer f.Close()
Michael Yang's avatar
Michael Yang committed
454

455
		sr = f
Michael Yang's avatar
Michael Yang committed
456
	}
Michael Yang's avatar
Michael Yang committed
457

458
	f, err := parser.ParseFile(sr)
Michael Yang's avatar
Michael Yang committed
459
460
461
462
463
	if err != nil {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

Michael Yang's avatar
Michael Yang committed
464
	ch := make(chan any)
Michael Yang's avatar
Michael Yang committed
465
466
	go func() {
		defer close(ch)
467
468
		fn := func(resp api.ProgressResponse) {
			ch <- resp
469
470
		}

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

474
475
		quantization := cmp.Or(r.Quantize, r.Quantization)
		if err := CreateModel(ctx, name, filepath.Dir(r.Path), strings.ToUpper(quantization), f, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
476
			ch <- gin.H{"error": err.Error()}
477
		}
Michael Yang's avatar
Michael Yang committed
478
	}()
Michael Yang's avatar
Michael Yang committed
479

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

Michael Yang's avatar
Michael Yang committed
485
	streamResponse(c, ch)
Bruce MacDonald's avatar
Bruce MacDonald committed
486
487
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
488
func (s *Server) DeleteModelHandler(c *gin.Context) {
489
490
	var r api.DeleteRequest
	if err := c.ShouldBindJSON(&r); errors.Is(err, io.EOF) {
Michael Yang's avatar
Michael Yang committed
491
492
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
493
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
494
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
495
496
497
		return
	}

498
499
500
	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))})
501
502
		return
	}
Michael Yang's avatar
Michael Yang committed
503

504
	m, err := ParseNamedManifest(n)
Michael Yang's avatar
Michael Yang committed
505
506
507
508
509
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

510
	if err := m.Remove(); err != nil {
Michael Yang's avatar
Michael Yang committed
511
512
513
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}
514
515
516
517
518

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

Daniel Hiltgen's avatar
Daniel Hiltgen committed
521
func (s *Server) ShowModelHandler(c *gin.Context) {
Patrick Devine's avatar
Patrick Devine committed
522
	var req api.ShowRequest
Michael Yang's avatar
Michael Yang committed
523
524
525
526
527
528
529
	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
530
531
532
		return
	}

Michael Yang's avatar
Michael Yang committed
533
	if req.Model != "" {
Michael Yang's avatar
Michael Yang committed
534
		// noop
Michael Yang's avatar
Michael Yang committed
535
	} else if req.Name != "" {
Michael Yang's avatar
Michael Yang committed
536
		req.Model = req.Name
Michael Yang's avatar
Michael Yang committed
537
	} else {
538
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
539
540
541
		return
	}

542
	resp, err := GetModelInfo(req)
Patrick Devine's avatar
Patrick Devine committed
543
	if err != nil {
544
545
		switch {
		case os.IsNotExist(err):
Michael Yang's avatar
Michael Yang committed
546
			c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found", req.Model)})
547
548
549
		case err.Error() == "invalid model name":
			c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		default:
Patrick Devine's avatar
Patrick Devine committed
550
551
552
553
554
555
556
557
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		}
		return
	}

	c.JSON(http.StatusOK, resp)
}

558
func GetModelInfo(req api.ShowRequest) (*api.ShowResponse, error) {
559
	m, err := GetModel(req.Model)
Patrick Devine's avatar
Patrick Devine committed
560
561
562
563
	if err != nil {
		return nil, err
	}

Patrick Devine's avatar
Patrick Devine committed
564
	modelDetails := api.ModelDetails{
565
566
567
568
569
570
		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
571
572
	}

573
	if req.System != "" {
574
		m.System = req.System
575
576
577
	}

	if req.Template != "" {
Michael Yang's avatar
Michael Yang committed
578
579
580
581
		m.Template, err = template.Parse(req.Template)
		if err != nil {
			return nil, err
		}
582
583
	}

Michael Yang's avatar
Michael Yang committed
584
585
586
	msgs := make([]api.Message, len(m.Messages))
	for i, msg := range m.Messages {
		msgs[i] = api.Message{Role: msg.Role, Content: msg.Content}
587
588
	}

589
590
591
592
593
594
595
596
597
598
	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
599
	resp := &api.ShowResponse{
600
601
		License:    strings.Join(m.License, "\n"),
		System:     m.System,
Michael Yang's avatar
Michael Yang committed
602
		Template:   m.Template.String(),
603
604
605
		Details:    modelDetails,
		Messages:   msgs,
		ModifiedAt: manifest.fi.ModTime(),
Patrick Devine's avatar
Patrick Devine committed
606
607
608
609
	}

	var params []string
	cs := 30
610
	for k, v := range m.Options {
Patrick Devine's avatar
Patrick Devine committed
611
612
613
		switch val := v.(type) {
		case []interface{}:
			for _, nv := range val {
Patrick Devine's avatar
Patrick Devine committed
614
				params = append(params, fmt.Sprintf("%-*s %#v", cs, k, nv))
Patrick Devine's avatar
Patrick Devine committed
615
			}
Patrick Devine's avatar
Patrick Devine committed
616
617
		default:
			params = append(params, fmt.Sprintf("%-*s %#v", cs, k, v))
Patrick Devine's avatar
Patrick Devine committed
618
619
620
621
		}
	}
	resp.Parameters = strings.Join(params, "\n")

622
623
	for k, v := range req.Options {
		if _, ok := req.Options[k]; ok {
624
			m.Options[k] = v
625
626
627
		}
	}

628
	var sb strings.Builder
629
	fmt.Fprintln(&sb, "# Modelfile generated by \"ollama show\"")
630
	fmt.Fprintln(&sb, "# To build a new Modelfile based on this, replace FROM with:")
631
632
	fmt.Fprintf(&sb, "# FROM %s\n\n", m.ShortName)
	fmt.Fprint(&sb, m.String())
633
	resp.Modelfile = sb.String()
634

635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
	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
651
652
653
	return resp, nil
}

654
func getKVData(digest string, verbose bool) (llm.KV, error) {
655
656
657
658
659
	maxArraySize := 0
	if verbose {
		maxArraySize = -1
	}
	kvData, err := llm.LoadModel(digest, maxArraySize)
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
	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
677
func (s *Server) ListModelsHandler(c *gin.Context) {
678
	ms, err := Manifests()
Patrick Devine's avatar
Patrick Devine committed
679
680
681
682
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}
Michael Yang's avatar
Michael Yang committed
683

684
	models := []api.ListModelResponse{}
685
686
687
688
689
690
691
	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()
692

693
694
695
696
		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
697
		}
Michael Yang's avatar
Michael Yang committed
698

699
		// tag should never be masked
700
		models = append(models, api.ListModelResponse{
701
702
703
704
705
706
707
708
709
710
711
712
713
			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
714
715
	}

716
	slices.SortStableFunc(models, func(i, j api.ListModelResponse) int {
717
718
719
720
		// most recently modified first
		return cmp.Compare(j.ModifiedAt.Unix(), i.ModifiedAt.Unix())
	})

Michael Yang's avatar
Michael Yang committed
721
	c.JSON(http.StatusOK, api.ListResponse{Models: models})
Patrick Devine's avatar
Patrick Devine committed
722
723
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
724
func (s *Server) CopyModelHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
725
726
	var r api.CopyRequest
	if err := c.ShouldBindJSON(&r); errors.Is(err, io.EOF) {
Michael Yang's avatar
Michael Yang committed
727
728
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
729
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
730
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Patrick Devine's avatar
Patrick Devine committed
731
732
733
		return
	}

Michael Yang's avatar
Michael Yang committed
734
735
	src := model.ParseName(r.Source)
	if !src.IsValid() {
Michael Yang's avatar
Michael Yang committed
736
737
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("source %q is invalid", r.Source)})
		return
738
739
	}

Michael Yang's avatar
Michael Yang committed
740
741
	dst := model.ParseName(r.Destination)
	if !dst.IsValid() {
742
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("destination %q is invalid", r.Destination)})
Patrick Devine's avatar
Patrick Devine committed
743
744
		return
	}
Michael Yang's avatar
Michael Yang committed
745

746
747
748
749
750
	if err := checkNameExists(dst); err != nil {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

Michael Yang's avatar
Michael Yang committed
751
752
753
754
755
	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
756
757
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
758
func (s *Server) HeadBlobHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
759
760
761
762
763
764
765
766
767
768
769
	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
770
	c.Status(http.StatusOK)
Michael Yang's avatar
Michael Yang committed
771
772
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
773
func (s *Server) CreateBlobHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
774
775
	if ib, ok := intermediateBlobs[c.Param("digest")]; ok {
		p, err := GetBlobsPath(ib)
776
777
778
779
780
781
		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
782
783
			slog.Info("evicting intermediate blob which no longer exists", "digest", ib)
			delete(intermediateBlobs, c.Param("digest"))
784
785
786
787
788
789
790
791
792
		} else if err != nil {
			c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
			return
		} else {
			c.Status(http.StatusOK)
			return
		}
	}

793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
	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
	}

811
	layer, err := NewLayer(c.Request.Body, "")
Michael Yang's avatar
Michael Yang committed
812
813
814
815
816
	if err != nil {
		c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

817
818
	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
819
820
821
		return
	}

Michael Yang's avatar
Michael Yang committed
822
	c.Status(http.StatusCreated)
Michael Yang's avatar
Michael Yang committed
823
824
}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
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
}

846
func allowedHost(host string) bool {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
847
	if host == "" || host == "localhost" {
848
849
850
851
852
853
854
855
		return true
	}

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

	var tlds = []string{
Jeffrey Morgan's avatar
Jeffrey Morgan committed
856
857
858
		"localhost",
		"local",
		"internal",
859
	}
860

Jeffrey Morgan's avatar
Jeffrey Morgan committed
861
	// check if the host is a local TLD
862
863
864
865
866
867
	for _, tld := range tlds {
		if strings.HasSuffix(host, "."+tld) {
			return true
		}
	}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
868
	return false
Jeffrey Morgan's avatar
Jeffrey Morgan committed
869
}
870

Jeffrey Morgan's avatar
Jeffrey Morgan committed
871
872
873
func allowedHostsMiddleware(addr net.Addr) gin.HandlerFunc {
	return func(c *gin.Context) {
		if addr == nil {
874
875
876
877
			c.Next()
			return
		}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
878
		if addr, err := netip.ParseAddrPort(addr.String()); err == nil && !addr.Addr().IsLoopback() {
879
880
881
882
883
884
885
886
887
			c.Next()
			return
		}

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

Jeffrey Morgan's avatar
Jeffrey Morgan committed
888
		if addr, err := netip.ParseAddr(host); err == nil {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
889
			if addr.IsLoopback() || addr.IsPrivate() || addr.IsUnspecified() || isLocalIP(addr) {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
890
891
892
893
894
				c.Next()
				return
			}
		}

895
		if allowedHost(host) {
Michael Yang's avatar
lint  
Michael Yang committed
896
			if c.Request.Method == http.MethodOptions {
897
898
899
900
				c.AbortWithStatus(http.StatusNoContent)
				return
			}

901
902
903
904
905
906
			c.Next()
			return
		}

		c.AbortWithStatus(http.StatusForbidden)
	}
907
}
908

909
func (s *Server) GenerateRoutes() http.Handler {
Michael Yang's avatar
Michael Yang committed
910
911
	config := cors.DefaultConfig()
	config.AllowWildcard = true
912
	config.AllowBrowserExtensions = true
913
	config.AllowHeaders = []string{"Authorization", "Content-Type", "User-Agent", "Accept", "X-Requested-With"}
royjhan's avatar
royjhan committed
914
915
916
917
	openAIProperties := []string{"lang", "package-version", "os", "arch", "runtime", "runtime-version", "async"}
	for _, prop := range openAIProperties {
		config.AllowHeaders = append(config.AllowHeaders, "x-stainless-"+prop)
	}
918
	config.AllowOrigins = envconfig.AllowOrigins
Michael Yang's avatar
Michael Yang committed
919

Bruce MacDonald's avatar
Bruce MacDonald committed
920
	r := gin.Default()
921
922
	r.Use(
		cors.New(config),
923
		allowedHostsMiddleware(s.addr),
924
	)
Bruce MacDonald's avatar
Bruce MacDonald committed
925

Daniel Hiltgen's avatar
Daniel Hiltgen committed
926
927
928
929
930
931
932
933
934
935
936
	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)
937
	r.GET("/api/ps", s.ProcessHandler)
Jeffrey Morgan's avatar
Jeffrey Morgan committed
938

939
	// Compatibility endpoints
940
	r.POST("/v1/chat/completions", openai.ChatMiddleware(), s.ChatHandler)
941
	r.POST("/v1/completions", openai.CompletionsMiddleware(), s.GenerateHandler)
942
943
	r.GET("/v1/models", openai.ListMiddleware(), s.ListModelsHandler)
	r.GET("/v1/models/:model", openai.RetrieveMiddleware(), s.ShowModelHandler)
944

Michael Yang's avatar
Michael Yang committed
945
946
947
948
949
	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
950
		r.Handle(method, "/api/tags", s.ListModelsHandler)
Michael Yang's avatar
Michael Yang committed
951
952
953
		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
954
955
	}

956
957
958
959
	return r
}

func Serve(ln net.Listener) error {
Michael Yang's avatar
Michael Yang committed
960
	level := slog.LevelInfo
961
	if envconfig.Debug {
Michael Yang's avatar
Michael Yang committed
962
		level = slog.LevelDebug
963
	}
Michael Yang's avatar
Michael Yang committed
964

965
	slog.Info("server config", "env", envconfig.Values())
Michael Yang's avatar
Michael Yang committed
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
	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))

981
982
983
984
985
986
987
988
	blobsDir, err := GetBlobsPath("")
	if err != nil {
		return err
	}
	if err := fixBlobs(blobsDir); err != nil {
		return err
	}

989
	if !envconfig.NoPrune {
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
		// 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
1005
	ctx, done := context.WithCancel(context.Background())
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1006
1007
	schedCtx, schedDone := context.WithCancel(ctx)
	sched := InitScheduler(schedCtx)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1008
	s := &Server{addr: ln.Addr(), sched: sched}
1009
1010

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

1012
	slog.Info(fmt.Sprintf("Listening on %s (version %s)", ln.Addr(), version.Version))
1013
	srvr := &http.Server{
1014
1015
1016
1017
1018
1019
1020
1021
1022
		// 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
1023
1024
	}

1025
1026
	// listen for a ctrl+c and stop any loaded llm
	signals := make(chan os.Signal, 1)
1027
	signal.Notify(signals, syscall.SIGINT, syscall.SIGTERM)
1028
1029
	go func() {
		<-signals
1030
		srvr.Close()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1031
		schedDone()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1032
		sched.unloadAllRunners()
1033
		gpu.Cleanup()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1034
		done()
1035
1036
	}()

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1037
	if err := llm.Init(); err != nil {
1038
1039
		return fmt.Errorf("unable to initialize llm library %w", err)
	}
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1040

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1041
	s.sched.Run(schedCtx)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1042
1043
1044

	// 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
1045
1046
	gpus := gpu.GetGPUInfo()
	gpus.LogDetails()
1047

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1048
1049
1050
1051
1052
1053
1054
	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()
1055
	return nil
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1056
}
Michael Yang's avatar
Michael Yang committed
1057

1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
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
1083
func streamResponse(c *gin.Context, ch chan any) {
1084
	c.Header("Content-Type", "application/x-ndjson")
Michael Yang's avatar
Michael Yang committed
1085
1086
1087
1088
1089
1090
1091
1092
	c.Stream(func(w io.Writer) bool {
		val, ok := <-ch
		if !ok {
			return false
		}

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

1097
		// Delineate chunks with new-line delimiter
Michael Yang's avatar
Michael Yang committed
1098
1099
		bts = append(bts, '\n')
		if _, err := w.Write(bts); err != nil {
1100
			slog.Info(fmt.Sprintf("streamResponse: w.Write failed with %s", err))
Michael Yang's avatar
Michael Yang committed
1101
1102
1103
1104
1105
1106
			return false
		}

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

1108
func (s *Server) ProcessHandler(c *gin.Context) {
1109
	models := []api.ProcessModelResponse{}
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120

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

1121
		mr := api.ProcessModelResponse{
1122
1123
1124
1125
1126
1127
1128
1129
			Model:     model.ShortName,
			Name:      model.ShortName,
			Size:      int64(v.estimatedTotal),
			SizeVRAM:  int64(v.estimatedVRAM),
			Digest:    model.Digest,
			Details:   modelDetails,
			ExpiresAt: v.expiresAt,
		}
1130
1131
1132
1133
1134
1135
1136
1137
		// 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)
		}

1138
1139
1140
		models = append(models, mr)
	}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1141
1142
1143
1144
1145
	slices.SortStableFunc(models, func(i, j api.ProcessModelResponse) int {
		// longest duration remaining listed first
		return cmp.Compare(j.ExpiresAt.Unix(), i.ExpiresAt.Unix())
	})

1146
	c.JSON(http.StatusOK, api.ProcessResponse{Models: models})
1147
1148
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1149
func (s *Server) ChatHandler(c *gin.Context) {
1150
1151
	checkpointStart := time.Now()

Bruce MacDonald's avatar
Bruce MacDonald committed
1152
	var req api.ChatRequest
Michael Yang's avatar
Michael Yang committed
1153
	if err := c.ShouldBindJSON(&req); errors.Is(err, io.EOF) {
Bruce MacDonald's avatar
Bruce MacDonald committed
1154
1155
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
1156
	} else if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1157
1158
1159
1160
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

Michael Yang's avatar
Michael Yang committed
1161
	caps := []Capability{CapabilityCompletion}
Michael Yang's avatar
Michael Yang committed
1162
	r, m, opts, err := s.scheduleRunner(c.Request.Context(), req.Model, caps, req.Options, req.KeepAlive)
Michael Yang's avatar
Michael Yang committed
1163
1164
	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
1165
		return
Michael Yang's avatar
Michael Yang committed
1166
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
1167
		handleScheduleError(c, req.Model, err)
Bruce MacDonald's avatar
Bruce MacDonald committed
1168
1169
		return
	}
Michael Yang's avatar
Michael Yang committed
1170

1171
1172
	checkpointLoaded := time.Now()

Michael Yang's avatar
Michael Yang committed
1173
1174
	if len(req.Messages) == 0 {
		c.JSON(http.StatusOK, api.ChatResponse{
1175
			Model:      req.Model,
Michael Yang's avatar
Michael Yang committed
1176
1177
			CreatedAt:  time.Now().UTC(),
			Message:    api.Message{Role: "assistant"},
1178
1179
			Done:       true,
			DoneReason: "load",
Michael Yang's avatar
Michael Yang committed
1180
		})
1181
1182
1183
		return
	}

Michael Yang's avatar
Michael Yang committed
1184
	prompt, images, err := chatPrompt(c.Request.Context(), m, r.Tokenize, opts, req.Messages)
Michael Yang's avatar
Michael Yang committed
1185
1186
1187
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
1188
1189
	}

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

Bruce MacDonald's avatar
Bruce MacDonald committed
1192
1193
1194
	ch := make(chan any)
	go func() {
		defer close(ch)
Michael Yang's avatar
Michael Yang committed
1195
		if err := r.Completion(c.Request.Context(), llm.CompletionRequest{
Michael Yang's avatar
Michael Yang committed
1196
1197
1198
			Prompt:  prompt,
			Images:  images,
			Format:  req.Format,
Michael Yang's avatar
Michael Yang committed
1199
			Options: opts,
Michael Yang's avatar
Michael Yang committed
1200
		}, func(r llm.CompletionResponse) {
1201
			res := api.ChatResponse{
1202
1203
1204
1205
1206
				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
1207
1208
1209
1210
1211
1212
1213
				Metrics: api.Metrics{
					PromptEvalCount:    r.PromptEvalCount,
					PromptEvalDuration: r.PromptEvalDuration,
					EvalCount:          r.EvalCount,
					EvalDuration:       r.EvalDuration,
				},
			}
1214
1215
1216
1217
1218
1219
1220

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

			ch <- res
Michael Yang's avatar
Michael Yang committed
1221
		}); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1222
1223
1224
1225
1226
			ch <- gin.H{"error": err.Error()}
		}
	}()

	if req.Stream != nil && !*req.Stream {
Michael Yang's avatar
Michael Yang committed
1227
		var r api.ChatResponse
Bruce MacDonald's avatar
Bruce MacDonald committed
1228
		var sb strings.Builder
Michael Yang's avatar
Michael Yang committed
1229
1230
		for rr := range ch {
			switch t := rr.(type) {
1231
			case api.ChatResponse:
Michael Yang's avatar
Michael Yang committed
1232
1233
				sb.WriteString(t.Message.Content)
				r = t
1234
			case gin.H:
Michael Yang's avatar
Michael Yang committed
1235
1236
1237
				msg, ok := t["error"].(string)
				if !ok {
					msg = "unexpected error format in response"
1238
				}
Michael Yang's avatar
Michael Yang committed
1239
1240
1241

				c.JSON(http.StatusInternalServerError, gin.H{"error": msg})
				return
1242
			default:
Michael Yang's avatar
Michael Yang committed
1243
				c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected response"})
1244
				return
Bruce MacDonald's avatar
Bruce MacDonald committed
1245
1246
			}
		}
1247

Michael Yang's avatar
Michael Yang committed
1248
1249
		r.Message.Content = sb.String()
		c.JSON(http.StatusOK, r)
Bruce MacDonald's avatar
Bruce MacDonald committed
1250
1251
1252
1253
1254
		return
	}

	streamResponse(c, ch)
}
1255

Michael Yang's avatar
Michael Yang committed
1256
func handleScheduleError(c *gin.Context, name string, err error) {
Michael Yang's avatar
Michael Yang committed
1257
	switch {
Michael Yang's avatar
Michael Yang committed
1258
1259
	case errors.Is(err, errRequired):
		c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Michael Yang's avatar
Michael Yang committed
1260
	case errors.Is(err, context.Canceled):
1261
		c.JSON(499, gin.H{"error": "request canceled"})
Michael Yang's avatar
Michael Yang committed
1262
	case errors.Is(err, ErrMaxQueue):
1263
		c.JSON(http.StatusServiceUnavailable, gin.H{"error": err.Error()})
Michael Yang's avatar
Michael Yang committed
1264
1265
	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
1266
1267
	default:
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
1268
1269
	}
}