routes.go 54.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
	"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"
10
	"image"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
11
	"io"
12
	"io/fs"
13
	"log/slog"
14
	"math"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
15
16
	"net"
	"net/http"
17
	"net/netip"
18
	"net/url"
19
	"os"
20
	"os/signal"
21
	"slices"
Michael Yang's avatar
Michael Yang committed
22
	"strings"
23
	"syscall"
24
	"time"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
25

Michael Yang's avatar
Michael Yang committed
26
	"github.com/gin-contrib/cors"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
27
	"github.com/gin-gonic/gin"
28
	"golang.org/x/image/webp"
29
	"golang.org/x/sync/errgroup"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
30

31
	"github.com/ollama/ollama/api"
32
	"github.com/ollama/ollama/auth"
33
	"github.com/ollama/ollama/discover"
34
	"github.com/ollama/ollama/envconfig"
35
	"github.com/ollama/ollama/format"
Michael Yang's avatar
Michael Yang committed
36
	"github.com/ollama/ollama/fs/ggml"
37
	"github.com/ollama/ollama/llm"
38
	"github.com/ollama/ollama/logutil"
Devon Rifkin's avatar
Devon Rifkin committed
39
	"github.com/ollama/ollama/model/parsers"
40
	"github.com/ollama/ollama/openai"
41
42
	"github.com/ollama/ollama/server/internal/client/ollama"
	"github.com/ollama/ollama/server/internal/registry"
Michael Yang's avatar
Michael Yang committed
43
	"github.com/ollama/ollama/template"
44
	"github.com/ollama/ollama/thinking"
45
	"github.com/ollama/ollama/tools"
46
	"github.com/ollama/ollama/types/errtypes"
Michael Yang's avatar
Michael Yang committed
47
	"github.com/ollama/ollama/types/model"
48
	"github.com/ollama/ollama/version"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
49
50
)

51
52
53
54
55
56
57
58
59
60
61
62
func shouldUseHarmony(model *Model) bool {
	if slices.Contains([]string{"gptoss", "gpt-oss"}, model.Config.ModelFamily) {
		// heuristic to check whether the template expects to be parsed via harmony:
		// search for harmony tags that are nearly always used
		if model.Template.Contains("<|start|>") && model.Template.Contains("<|end|>") {
			return true
		}
	}

	return false
}

63
64
65
66
67
68
func experimentEnabled(name string) bool {
	return slices.Contains(strings.Split(os.Getenv("OLLAMA_EXPERIMENT"), ","), name)
}

var useClient2 = experimentEnabled("client2")

69
70
71
72
// Low VRAM mode is based on the sum of total VRAM (not free) and triggers
// reduced context length on some models
var lowVRAMThreshold uint64 = 20 * format.GibiByte

Michael Yang's avatar
Michael Yang committed
73
74
var mode string = gin.DebugMode

75
type Server struct {
76
77
78
	addr    net.Addr
	sched   *Scheduler
	lowVRAM bool
79
80
}

Michael Yang's avatar
Michael Yang committed
81
82
83
84
85
86
87
88
89
90
91
92
func init() {
	switch mode {
	case gin.DebugMode:
	case gin.ReleaseMode:
	case gin.TestMode:
	default:
		mode = gin.DebugMode
	}

	gin.SetMode(mode)
}

Michael Yang's avatar
lint  
Michael Yang committed
93
94
95
96
var (
	errRequired    = errors.New("is required")
	errBadTemplate = errors.New("template error")
)
Michael Yang's avatar
Michael Yang committed
97

98
func modelOptions(model *Model, requestOpts map[string]any) (api.Options, error) {
99
100
101
102
103
104
105
106
107
108
	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
109
110
}

Michael Yang's avatar
Michael Yang committed
111
112
// 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.
113
func (s *Server) scheduleRunner(ctx context.Context, name string, caps []model.Capability, requestOpts map[string]any, keepAlive *api.Duration) (llm.LlamaServer, *Model, *api.Options, error) {
Michael Yang's avatar
Michael Yang committed
114
	if name == "" {
Michael Yang's avatar
Michael Yang committed
115
		return nil, nil, nil, fmt.Errorf("model %w", errRequired)
Bruce MacDonald's avatar
Bruce MacDonald committed
116
117
	}

Michael Yang's avatar
Michael Yang committed
118
	model, err := GetModel(name)
Bruce MacDonald's avatar
Bruce MacDonald committed
119
	if err != nil {
Michael Yang's avatar
Michael Yang committed
120
		return nil, nil, nil, err
121
122
	}

123
124
125
126
	if slices.Contains(model.Config.ModelFamilies, "mllama") && len(model.ProjectorPaths) > 0 {
		return nil, nil, nil, fmt.Errorf("'llama3.2-vision' is no longer compatible with your version of Ollama and has been replaced by a newer version. To re-download, run 'ollama pull llama3.2-vision'")
	}

Michael Yang's avatar
Michael Yang committed
127
	if err := model.CheckCapabilities(caps...); err != nil {
Michael Yang's avatar
Michael Yang committed
128
		return nil, nil, nil, fmt.Errorf("%s %w", name, err)
129
130
	}

Michael Yang's avatar
Michael Yang committed
131
	opts, err := modelOptions(model, requestOpts)
132
	if err != nil {
Michael Yang's avatar
Michael Yang committed
133
		return nil, nil, nil, err
134
135
	}

136
137
	// This model is much more capable with a larger context, so set that
	// unless it would penalize performance too much
138
	if !s.lowVRAM && slices.Contains([]string{"gptoss", "gpt-oss"}, model.Config.ModelFamily) {
Michael Yang's avatar
Michael Yang committed
139
140
141
		opts.NumCtx = max(opts.NumCtx, 8192)
	}

Michael Yang's avatar
Michael Yang committed
142
	runnerCh, errCh := s.sched.GetRunner(ctx, model, opts, keepAlive)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
143
144
	var runner *runnerRef
	select {
Michael Yang's avatar
Michael Yang committed
145
146
	case runner = <-runnerCh:
	case err = <-errCh:
Michael Yang's avatar
Michael Yang committed
147
		return nil, nil, nil, err
Bruce MacDonald's avatar
Bruce MacDonald committed
148
149
	}

Michael Yang's avatar
Michael Yang committed
150
	return runner.llama, model, &opts, nil
Michael Yang's avatar
Michael Yang committed
151
152
153
}

func (s *Server) GenerateHandler(c *gin.Context) {
154
	checkpointStart := time.Now()
Michael Yang's avatar
Michael Yang committed
155
156
157
158
159
160
	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
161
162
163
		return
	}

164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
	name := model.ParseName(req.Model)
	if !name.IsValid() {
		// Ideally this is "invalid model name" but we're keeping with
		// what the API currently returns until we can change it.
		c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found", req.Model)})
		return
	}

	// We cannot currently consolidate this into GetModel because all we'll
	// induce infinite recursion given the current code structure.
	name, err := getExistingName(name)
	if err != nil {
		c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found", req.Model)})
		return
	}

180
	m, err := GetModel(name.String())
181
182
	if err != nil {
		switch {
183
		case errors.Is(err, fs.ErrNotExist):
184
			c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found", req.Model)})
185
		case err.Error() == errtypes.InvalidModelNameErrMsg:
186
187
188
189
190
191
192
			c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		default:
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		}
		return
	}

193
194
195
196
197
198
199
200
201
202
203
204
205
206
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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
	if m.Config.RemoteHost != "" && m.Config.RemoteModel != "" {
		origModel := req.Model

		remoteURL, err := url.Parse(m.Config.RemoteHost)
		if err != nil {
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
			return
		}

		if !slices.Contains(envconfig.Remotes(), remoteURL.Hostname()) {
			slog.Info("remote model", "remotes", envconfig.Remotes(), "remoteURL", m.Config.RemoteHost, "hostname", remoteURL.Hostname())
			c.JSON(http.StatusBadRequest, gin.H{"error": "this server cannot run this remote model"})
			return
		}

		req.Model = m.Config.RemoteModel

		if req.Template == "" && m.Template.String() != "" {
			req.Template = m.Template.String()
		}

		if req.Options == nil {
			req.Options = map[string]any{}
		}

		for k, v := range m.Options {
			if _, ok := req.Options[k]; !ok {
				req.Options[k] = v
			}
		}

		// update the system prompt from the model if one isn't already specified
		if req.System == "" && m.System != "" {
			req.System = m.System
		}

		if len(m.Messages) > 0 {
			slog.Warn("embedded messages in the model not supported with '/api/generate'; try '/api/chat' instead")
		}

		fn := func(resp api.GenerateResponse) error {
			resp.Model = origModel
			resp.RemoteModel = m.Config.RemoteModel
			resp.RemoteHost = m.Config.RemoteHost

			data, err := json.Marshal(resp)
			if err != nil {
				return err
			}

			if _, err = c.Writer.Write(append(data, '\n')); err != nil {
				return err
			}
			c.Writer.Flush()
			return nil
		}

		client := api.NewClient(remoteURL, http.DefaultClient)
		err = client.Generate(c, &req, fn)
		if err != nil {
			var sErr api.AuthorizationError
			if errors.As(err, &sErr) && sErr.StatusCode == http.StatusUnauthorized {
				pk, pkErr := auth.GetPublicKey()
				if pkErr != nil {
					slog.Error("couldn't get public key", "error", pkErr)
					c.JSON(http.StatusUnauthorized, gin.H{"error": "error getting public key"})
					return
				}
261
262
263
264
				c.JSON(http.StatusUnauthorized, gin.H{
					"error":      "unauthorized",
					"public_key": pk,
				})
265
266
267
268
269
270
271
272
273
				return
			}
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
			return
		}

		return
	}

Patrick Devine's avatar
Patrick Devine committed
274
	// expire the runner
Michael Yang's avatar
Michael Yang committed
275
	if req.Prompt == "" && req.KeepAlive != nil && req.KeepAlive.Duration == 0 {
276
		s.sched.expireRunner(m)
Patrick Devine's avatar
Patrick Devine committed
277
278
279
280
281
282
283
284
285
286
287

		c.JSON(http.StatusOK, api.GenerateResponse{
			Model:      req.Model,
			CreatedAt:  time.Now().UTC(),
			Response:   "",
			Done:       true,
			DoneReason: "unload",
		})
		return
	}

288
	if req.Raw && (req.Template != "" || req.System != "" || len(req.Context) > 0) {
Michael Yang's avatar
Michael Yang committed
289
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "raw mode does not support template, system, or context"})
Michael Yang's avatar
Michael Yang committed
290
291
292
		return
	}

293
294
295
296
297
298
299
300
301
302
303
	var builtinParser parsers.Parser
	if shouldUseHarmony(m) && m.Config.Parser == "" {
		m.Config.Parser = "harmony"
	}

	if !req.Raw && m.Config.Parser != "" {
		builtinParser = parsers.ParserForName(m.Config.Parser)
		if builtinParser != nil {
			// no tools or last message for generate endpoint
			builtinParser.Init(nil, nil)
		}
Michael Yang's avatar
Michael Yang committed
304
305
	}

306
307
	// Validate Think value: string values currently only allowed for harmony/gptoss models
	if req.Think != nil && req.Think.IsString() && m.Config.Parser != "harmony" {
308
		c.JSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("think value %q is not supported for this model", req.Think.String())})
Michael Yang's avatar
Michael Yang committed
309
310
311
		return
	}

312
	caps := []model.Capability{model.CapabilityCompletion}
313
	if req.Suffix != "" {
314
		caps = append(caps, model.CapabilityInsert)
315
	}
316
	if req.Think != nil && req.Think.Bool() {
317
318
319
320
321
322
		caps = append(caps, model.CapabilityThinking)
		// TODO(drifkin): consider adding a warning if it's false and the model
		// doesn't support thinking. It's not strictly required, but it can be a
		// hint that the user is on an older qwen3/r1 model that doesn't have an
		// updated template supporting thinking
	}
323

324
	r, m, opts, err := s.scheduleRunner(c.Request.Context(), name.String(), caps, req.Options, req.KeepAlive)
Michael Yang's avatar
Michael Yang committed
325
326
327
328
	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
329
330
331
332
		handleScheduleError(c, req.Model, err)
		return
	}

333
334
	checkpointLoaded := time.Now()

335
	// load the model
Michael Yang's avatar
Michael Yang committed
336
337
338
339
340
341
342
	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
343
344
		return
	}
Bruce MacDonald's avatar
Bruce MacDonald committed
345

346
347
	if slices.Contains(m.Config.ModelFamilies, "mllama") && len(req.Images) > 1 {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "this model only supports one image while more than one image requested"})
348
349
350
		return
	}

Michael Yang's avatar
Michael Yang committed
351
352
	images := make([]llm.ImageData, len(req.Images))
	for i := range req.Images {
353
		images[i] = llm.ImageData{ID: i, Data: req.Images[i]}
Michael Yang's avatar
Michael Yang committed
354
	}
Bruce MacDonald's avatar
Bruce MacDonald committed
355

Michael Yang's avatar
Michael Yang committed
356
357
	prompt := req.Prompt
	if !req.Raw {
Michael Yang's avatar
Michael Yang committed
358
		tmpl := m.Template
Michael Yang's avatar
Michael Yang committed
359
360
361
362
363
364
365
366
		if req.Template != "" {
			tmpl, err = template.Parse(req.Template)
			if err != nil {
				c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
				return
			}
		}

367
368
369
370
371
372
373
374
375
376
377
378
		var values template.Values
		if req.Suffix != "" {
			values.Prompt = prompt
			values.Suffix = req.Suffix
		} else {
			var msgs []api.Message
			if req.System != "" {
				msgs = append(msgs, api.Message{Role: "system", Content: req.System})
			} else if m.System != "" {
				msgs = append(msgs, api.Message{Role: "system", Content: m.System})
			}

Michael Yang's avatar
Michael Yang committed
379
380
381
382
			if req.Context == nil {
				msgs = append(msgs, m.Messages...)
			}

383
			for _, i := range images {
384
385
				imgPrompt := ""
				msgs = append(msgs, api.Message{Role: "user", Content: fmt.Sprintf("[img-%d]"+imgPrompt, i.ID)})
386
387
388
389
390
			}

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

391
		values.Think = req.Think != nil && req.Think.Bool()
Michael Yang's avatar
Michael Yang committed
392
393
		values.ThinkLevel = ""
		if req.Think != nil {
394
			values.ThinkLevel = req.Think.String()
Michael Yang's avatar
Michael Yang committed
395
		}
396
397
		values.IsThinkSet = req.Think != nil

Michael Yang's avatar
Michael Yang committed
398
399
		var b bytes.Buffer
		if req.Context != nil {
400
			slog.Warn("the context field is deprecated and will be removed in a future version of Ollama")
401
			s, err := r.Detokenize(c.Request.Context(), req.Context)
Michael Yang's avatar
Michael Yang committed
402
403
404
405
			if err != nil {
				c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
				return
			}
406
			b.WriteString(s)
Michael Yang's avatar
Michael Yang committed
407
		}
408
409
410
411
412
413
414

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

		prompt = b.String()
Bruce MacDonald's avatar
Bruce MacDonald committed
415
416
	}

417
418
	// If debug mode is enabled, return the rendered template instead of calling the model
	if req.DebugRenderOnly {
Devon Rifkin's avatar
Devon Rifkin committed
419
		c.JSON(http.StatusOK, api.GenerateResponse{
420
421
			Model:     req.Model,
			CreatedAt: time.Now().UTC(),
Devon Rifkin's avatar
Devon Rifkin committed
422
			DebugInfo: &api.DebugInfo{
423
424
425
426
427
428
429
				RenderedTemplate: prompt,
				ImageCount:       len(images),
			},
		})
		return
	}

430
	var thinkingState *thinking.Parser
431
	if builtinParser == nil {
Michael Yang's avatar
Michael Yang committed
432
		openingTag, closingTag := thinking.InferTags(m.Template.Template)
433
		if req.Think != nil && req.Think.Bool() && openingTag != "" && closingTag != "" {
Michael Yang's avatar
Michael Yang committed
434
435
436
437
			thinkingState = &thinking.Parser{
				OpeningTag: openingTag,
				ClosingTag: closingTag,
			}
438
439
440
			if strings.HasSuffix(strings.TrimSpace(prompt), openingTag) {
				thinkingState.AddContent(openingTag)
			}
441
442
443
		}
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
444
445
	ch := make(chan any)
	go func() {
446
447
		// TODO (jmorganca): avoid building the response twice both here and below
		var sb strings.Builder
Bruce MacDonald's avatar
Bruce MacDonald committed
448
		defer close(ch)
Michael Yang's avatar
Michael Yang committed
449
		if err := r.Completion(c.Request.Context(), llm.CompletionRequest{
450
451
452
453
			Prompt:  prompt,
			Images:  images,
			Format:  req.Format,
			Options: opts,
454
455
		}, func(cr llm.CompletionResponse) {
			res := api.GenerateResponse{
456
457
458
459
				Model:     req.Model,
				CreatedAt: time.Now().UTC(),
				Response:  cr.Content,
				Done:      cr.Done,
Bruce MacDonald's avatar
Bruce MacDonald committed
460
				Metrics: api.Metrics{
461
462
463
464
					PromptEvalCount:    cr.PromptEvalCount,
					PromptEvalDuration: cr.PromptEvalDuration,
					EvalCount:          cr.EvalCount,
					EvalDuration:       cr.EvalDuration,
Bruce MacDonald's avatar
Bruce MacDonald committed
465
				},
Bruce MacDonald's avatar
Bruce MacDonald committed
466
			}
467

468
469
470
471
472
473
			if builtinParser != nil {
				content, thinking, toolCalls, err := builtinParser.Add(cr.Content, cr.Done)
				if err != nil {
					ch <- gin.H{"error": err.Error()}
					return
				}
474
475
				res.Response = content
				res.Thinking = thinking
476
477
478
				if cr.Done && len(toolCalls) > 0 {
					res.ToolCalls = toolCalls
				}
479
			} else if thinkingState != nil {
Devon Rifkin's avatar
Devon Rifkin committed
480
				thinking, content := thinkingState.AddContent(cr.Content)
481
482
483
484
				res.Thinking = thinking
				res.Response = content
			}

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

			if cr.Done {
490
491
492
493
				res.DoneReason = cr.DoneReason.String()
				res.TotalDuration = time.Since(checkpointStart)
				res.LoadDuration = checkpointLoaded.Sub(checkpointStart)

494
				if !req.Raw {
495
					tokens, err := r.Tokenize(c.Request.Context(), prompt+sb.String())
496
497
498
499
					if err != nil {
						ch <- gin.H{"error": err.Error()}
						return
					}
500
					res.Context = tokens
501
502
503
				}
			}

504
			if builtinParser != nil {
Michael Yang's avatar
Michael Yang committed
505
506
507
508
509
510
511
512
				// only send messages with meaningful content (empty messages confuse clients)
				if res.Response != "" || res.Thinking != "" || res.Done || len(res.ToolCalls) > 0 {
					ch <- res
				}

				return
			}

513
			ch <- res
Michael Yang's avatar
Michael Yang committed
514
		}); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
515
516
517
518
519
			ch <- gin.H{"error": err.Error()}
		}
	}()

	if req.Stream != nil && !*req.Stream {
Michael Yang's avatar
Michael Yang committed
520
		var r api.GenerateResponse
521
522
		var sbThinking strings.Builder
		var sbContent strings.Builder
Michael Yang's avatar
Michael Yang committed
523
524
		for rr := range ch {
			switch t := rr.(type) {
525
			case api.GenerateResponse:
526
527
				sbThinking.WriteString(t.Thinking)
				sbContent.WriteString(t.Response)
Michael Yang's avatar
Michael Yang committed
528
				r = t
529
			case gin.H:
Michael Yang's avatar
Michael Yang committed
530
531
532
				msg, ok := t["error"].(string)
				if !ok {
					msg = "unexpected error format in response"
533
				}
Michael Yang's avatar
Michael Yang committed
534
535
536

				c.JSON(http.StatusInternalServerError, gin.H{"error": msg})
				return
537
			default:
Michael Yang's avatar
Michael Yang committed
538
				c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected response"})
Bruce MacDonald's avatar
Bruce MacDonald committed
539
540
541
				return
			}
		}
542

543
544
545
		r.Thinking = sbThinking.String()
		r.Response = sbContent.String()

Michael Yang's avatar
Michael Yang committed
546
		c.JSON(http.StatusOK, r)
Bruce MacDonald's avatar
Bruce MacDonald committed
547
548
549
550
551
552
		return
	}

	streamResponse(c, ch)
}

553
func (s *Server) EmbedHandler(c *gin.Context) {
554
	checkpointStart := time.Now()
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
	var req api.EmbedRequest
	err := c.ShouldBindJSON(&req)
	switch {
	case errors.Is(err, io.EOF):
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
	case err != nil:
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

	truncate := true
	if req.Truncate != nil && !*req.Truncate {
		truncate = false
	}

	var input []string

	switch i := req.Input.(type) {
	case string:
		if len(i) > 0 {
			input = append(input, i)
		}
	case []any:
		for _, v := range i {
			if _, ok := v.(string); !ok {
				c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "invalid input type"})
				return
			}
			input = append(input, v.(string))
		}
	default:
587
588
589
590
		if req.Input != nil {
			c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "invalid input type"})
			return
		}
591
592
	}

593
594
595
596
597
598
	name, err := getExistingName(model.ParseName(req.Model))
	if err != nil {
		c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found", req.Model)})
		return
	}

599
	r, m, opts, err := s.scheduleRunner(c.Request.Context(), name.String(), []model.Capability{}, req.Options, req.KeepAlive)
600
601
602
603
604
	if err != nil {
		handleScheduleError(c, req.Model, err)
		return
	}

605
606
	checkpointLoaded := time.Now()

607
608
609
610
611
	if len(input) == 0 {
		c.JSON(http.StatusOK, api.EmbedResponse{Model: req.Model, Embeddings: [][]float32{}})
		return
	}

612
	kvData, _, err := getModelData(m.ModelPath, false)
613
614
615
616
617
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

618
	var count int
619
620
621
622
623
624
625
626
627
628
	for i, s := range input {
		tokens, err := r.Tokenize(c.Request.Context(), s)
		if err != nil {
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
			return
		}

		ctxLen := min(opts.NumCtx, int(kvData.ContextLength()))
		if len(tokens) > ctxLen {
			if !truncate {
629
				c.JSON(http.StatusBadRequest, gin.H{"error": "input exceeds maximum context length"})
630
631
632
				return
			}

633
634
635
636
637
638
639
640
			if bos := kvData.Uint("tokenizer.ggml.bos_token_id"); tokens[0] != int(bos) && kvData.Bool("add_bos_token", true) {
				ctxLen--
			}

			if eos := kvData.Uint("tokenizer.ggml.eos_token_id"); tokens[len(tokens)-1] != int(eos) && kvData.Bool("add_eos_token", true) {
				ctxLen--
			}

641
642
643
644
645
646
647
			slog.Info("", "ctxLen", ctxLen, "tokenCount", len(tokens))
			if ctxLen <= 0 {
				// return error if the truncated input would be empty or just special tokens
				c.JSON(http.StatusBadRequest, gin.H{"error": "input after truncation exceeds maximum context length"})
				return
			}

648
			tokens = tokens[:ctxLen]
649

650
651
652
653
654
655
656
			s, err = r.Detokenize(c.Request.Context(), tokens)
			if err != nil {
				c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
				return
			}
		}

657
658
		count += len(tokens)

659
660
		input[i] = s
	}
661
662
663
664
665
666
667
668
669

	var g errgroup.Group
	embeddings := make([][]float32, len(input))
	for i, text := range input {
		g.Go(func() error {
			embedding, err := r.Embedding(c.Request.Context(), text)
			if err != nil {
				return err
			}
670
671
672
673
674
675
			// TODO: this first normalization should be done by the model
			embedding = normalize(embedding)
			if req.Dimensions > 0 && req.Dimensions < len(embedding) {
				embedding = normalize(embedding[:req.Dimensions])
			}
			embeddings[i] = embedding
676
677
			return nil
		})
678
679
	}

680
	if err := g.Wait(); err != nil {
681
		c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": strings.TrimSpace(err.Error())})
682
		return
683
684
685
	}

	resp := api.EmbedResponse{
686
		Model:           req.Model,
687
		Embeddings:      embeddings,
688
689
		TotalDuration:   time.Since(checkpointStart),
		LoadDuration:    checkpointLoaded.Sub(checkpointStart),
690
		PromptEvalCount: count,
691
692
693
694
695
696
697
698
699
700
	}
	c.JSON(http.StatusOK, resp)
}

func normalize(vec []float32) []float32 {
	var sum float32
	for _, v := range vec {
		sum += v * v
	}

701
	norm := float32(1.0 / max(math.Sqrt(float64(sum)), 1e-12))
702
703
704
705
706
707
	for i := range vec {
		vec[i] *= norm
	}
	return vec
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
708
func (s *Server) EmbeddingsHandler(c *gin.Context) {
Bruce MacDonald's avatar
Bruce MacDonald committed
709
	var req api.EmbeddingRequest
Michael Yang's avatar
Michael Yang committed
710
	if err := c.ShouldBindJSON(&req); errors.Is(err, io.EOF) {
Bruce MacDonald's avatar
Bruce MacDonald committed
711
712
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
713
	} else if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
714
715
716
717
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

718
719
720
721
722
723
	name := model.ParseName(req.Model)
	if !name.IsValid() {
		c.JSON(http.StatusBadRequest, gin.H{"error": "model is required"})
		return
	}

724
	r, _, _, err := s.scheduleRunner(c.Request.Context(), name.String(), []model.Capability{}, req.Options, req.KeepAlive)
Bruce MacDonald's avatar
Bruce MacDonald committed
725
	if err != nil {
Michael Yang's avatar
Michael Yang committed
726
		handleScheduleError(c, req.Model, err)
Bruce MacDonald's avatar
Bruce MacDonald committed
727
728
729
		return
	}

730
731
732
	// an empty request loads the model
	if req.Prompt == "" {
		c.JSON(http.StatusOK, api.EmbeddingResponse{Embedding: []float64{}})
Bruce MacDonald's avatar
Bruce MacDonald committed
733
734
735
		return
	}

736
	embedding, err := r.Embedding(c.Request.Context(), req.Prompt)
Bruce MacDonald's avatar
Bruce MacDonald committed
737
	if err != nil {
738
		c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": strings.TrimSpace(err.Error())})
Bruce MacDonald's avatar
Bruce MacDonald committed
739
740
741
		return
	}

742
743
744
	var e []float64
	for _, v := range embedding {
		e = append(e, float64(v))
745
746
747
	}

	resp := api.EmbeddingResponse{
748
		Embedding: e,
749
750
	}
	c.JSON(http.StatusOK, resp)
Bruce MacDonald's avatar
Bruce MacDonald committed
751
752
}

753
func (s *Server) PullHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
754
	var req api.PullRequest
Michael Yang's avatar
Michael Yang committed
755
756
757
758
759
760
761
	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
762
763
764
		return
	}

765
766
	name := model.ParseName(cmp.Or(req.Model, req.Name))
	if !name.IsValid() {
767
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": errtypes.InvalidModelNameErrMsg})
768
769
770
		return
	}

771
772
	name, err = getExistingName(name)
	if err != nil {
773
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
774
775
776
		return
	}

777
778
779
	ch := make(chan any)
	go func() {
		defer close(ch)
780
781
		fn := func(r api.ProgressResponse) {
			ch <- r
782
		}
783

Michael Yang's avatar
Michael Yang committed
784
		regOpts := &registryOptions{
785
786
787
			Insecure: req.Insecure,
		}

788
789
790
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

791
		if err := PullModel(ctx, name.DisplayShortest(), regOpts, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
792
			ch <- gin.H{"error": err.Error()}
793
794
795
		}
	}()

796
797
798
799
800
	if req.Stream != nil && !*req.Stream {
		waitForStream(c, ch)
		return
	}

801
802
803
	streamResponse(c, ch)
}

804
func (s *Server) PushHandler(c *gin.Context) {
805
	var req api.PushRequest
Michael Yang's avatar
Michael Yang committed
806
807
808
809
810
811
812
	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
813
814
		return
	}
Michael Yang's avatar
Michael Yang committed
815

816
	var mname string
Michael Yang's avatar
Michael Yang committed
817
	if req.Model != "" {
818
		mname = req.Model
Michael Yang's avatar
Michael Yang committed
819
	} else if req.Name != "" {
820
		mname = req.Name
Michael Yang's avatar
Michael Yang committed
821
822
	} else {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
823
824
825
		return
	}

826
827
828
	ch := make(chan any)
	go func() {
		defer close(ch)
829
830
		fn := func(r api.ProgressResponse) {
			ch <- r
831
		}
832

Michael Yang's avatar
Michael Yang committed
833
		regOpts := &registryOptions{
834
835
836
			Insecure: req.Insecure,
		}

Michael Yang's avatar
Michael Yang committed
837
838
839
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

840
841
842
843
844
845
846
		name, err := getExistingName(model.ParseName(mname))
		if err != nil {
			ch <- gin.H{"error": err.Error()}
			return
		}

		if err := PushModel(ctx, name.DisplayShortest(), regOpts, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
847
			ch <- gin.H{"error": err.Error()}
848
849
850
		}
	}()

851
852
853
854
855
	if req.Stream != nil && !*req.Stream {
		waitForStream(c, ch)
		return
	}

856
857
858
	streamResponse(c, ch)
}

859
860
861
862
// getExistingName searches the models directory for the longest prefix match of
// the input name and returns the input name with all existing parts replaced
// with each part found. If no parts are found, the input name is returned as
// is.
863
864
865
func getExistingName(n model.Name) (model.Name, error) {
	var zero model.Name
	existing, err := Manifests(true)
866
	if err != nil {
867
		return zero, err
868
	}
869
	var set model.Name // tracks parts already canonicalized
870
	for e := range existing {
871
872
873
874
875
876
877
878
879
880
881
		if set.Host == "" && strings.EqualFold(e.Host, n.Host) {
			n.Host = e.Host
		}
		if set.Namespace == "" && strings.EqualFold(e.Namespace, n.Namespace) {
			n.Namespace = e.Namespace
		}
		if set.Model == "" && strings.EqualFold(e.Model, n.Model) {
			n.Model = e.Model
		}
		if set.Tag == "" && strings.EqualFold(e.Tag, n.Tag) {
			n.Tag = e.Tag
882
883
		}
	}
884
	return n, nil
885
886
}

887
func (s *Server) DeleteHandler(c *gin.Context) {
888
889
	var r api.DeleteRequest
	if err := c.ShouldBindJSON(&r); errors.Is(err, io.EOF) {
Michael Yang's avatar
Michael Yang committed
890
891
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
892
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
893
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
894
895
896
		return
	}

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

903
904
905
906
907
908
	n, err := getExistingName(n)
	if err != nil {
		c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found", cmp.Or(r.Model, r.Name))})
		return
	}

909
	m, err := ParseNamedManifest(n)
Michael Yang's avatar
Michael Yang committed
910
	if err != nil {
911
912
913
914
915
916
		switch {
		case os.IsNotExist(err):
			c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found", cmp.Or(r.Model, r.Name))})
		default:
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		}
Michael Yang's avatar
Michael Yang committed
917
918
919
		return
	}

920
	if err := m.Remove(); err != nil {
Michael Yang's avatar
Michael Yang committed
921
922
923
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}
924
925
926
927
928

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

931
func (s *Server) ShowHandler(c *gin.Context) {
Patrick Devine's avatar
Patrick Devine committed
932
	var req api.ShowRequest
Michael Yang's avatar
Michael Yang committed
933
934
935
936
937
938
939
	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
940
941
942
		return
	}

Michael Yang's avatar
Michael Yang committed
943
	if req.Model != "" {
Michael Yang's avatar
Michael Yang committed
944
		// noop
Michael Yang's avatar
Michael Yang committed
945
	} else if req.Name != "" {
Michael Yang's avatar
Michael Yang committed
946
		req.Model = req.Name
Michael Yang's avatar
Michael Yang committed
947
	} else {
948
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
949
950
951
		return
	}

952
	resp, err := GetModelInfo(req)
Patrick Devine's avatar
Patrick Devine committed
953
	if err != nil {
954
955
		switch {
		case os.IsNotExist(err):
Michael Yang's avatar
Michael Yang committed
956
			c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found", req.Model)})
957
		case err.Error() == errtypes.InvalidModelNameErrMsg:
958
959
			c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		default:
Patrick Devine's avatar
Patrick Devine committed
960
961
962
963
964
965
966
967
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		}
		return
	}

	c.JSON(http.StatusOK, resp)
}

968
func GetModelInfo(req api.ShowRequest) (*api.ShowResponse, error) {
969
970
	name := model.ParseName(req.Model)
	if !name.IsValid() {
CYJiang's avatar
CYJiang committed
971
		return nil, ErrModelPathInvalid
972
973
974
975
976
977
978
	}
	name, err := getExistingName(name)
	if err != nil {
		return nil, err
	}

	m, err := GetModel(name.String())
Patrick Devine's avatar
Patrick Devine committed
979
980
981
982
	if err != nil {
		return nil, err
	}

Patrick Devine's avatar
Patrick Devine committed
983
	modelDetails := api.ModelDetails{
984
985
986
987
988
989
		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
990
991
	}

992
	if req.System != "" {
993
		m.System = req.System
994
995
	}

Michael Yang's avatar
Michael Yang committed
996
997
998
	msgs := make([]api.Message, len(m.Messages))
	for i, msg := range m.Messages {
		msgs[i] = api.Message{Role: msg.Role, Content: msg.Content}
999
1000
	}

1001
	manifest, err := ParseNamedManifest(name)
1002
1003
1004
1005
	if err != nil {
		return nil, err
	}

Patrick Devine's avatar
Patrick Devine committed
1006
	resp := &api.ShowResponse{
1007
1008
1009
1010
1011
1012
1013
		License:      strings.Join(m.License, "\n"),
		System:       m.System,
		Template:     m.Template.String(),
		Details:      modelDetails,
		Messages:     msgs,
		Capabilities: m.Capabilities(),
		ModifiedAt:   manifest.fi.ModTime(),
Patrick Devine's avatar
Patrick Devine committed
1014
1015
	}

1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
	if m.Config.RemoteHost != "" {
		resp.RemoteHost = m.Config.RemoteHost
		resp.RemoteModel = m.Config.RemoteModel

		if m.Config.ModelFamily != "" {
			resp.ModelInfo = make(map[string]any)
			resp.ModelInfo["general.architecture"] = m.Config.ModelFamily

			if m.Config.BaseName != "" {
				resp.ModelInfo["general.basename"] = m.Config.BaseName
			}

			if m.Config.ContextLen > 0 {
				resp.ModelInfo[fmt.Sprintf("%s.context_length", m.Config.ModelFamily)] = m.Config.ContextLen
			}

			if m.Config.EmbedLen > 0 {
				resp.ModelInfo[fmt.Sprintf("%s.embedding_length", m.Config.ModelFamily)] = m.Config.EmbedLen
			}
		}
	}

Patrick Devine's avatar
Patrick Devine committed
1038
1039
	var params []string
	cs := 30
1040
	for k, v := range m.Options {
Patrick Devine's avatar
Patrick Devine committed
1041
		switch val := v.(type) {
1042
		case []any:
Patrick Devine's avatar
Patrick Devine committed
1043
			for _, nv := range val {
Patrick Devine's avatar
Patrick Devine committed
1044
				params = append(params, fmt.Sprintf("%-*s %#v", cs, k, nv))
Patrick Devine's avatar
Patrick Devine committed
1045
			}
Patrick Devine's avatar
Patrick Devine committed
1046
1047
		default:
			params = append(params, fmt.Sprintf("%-*s %#v", cs, k, v))
Patrick Devine's avatar
Patrick Devine committed
1048
1049
1050
1051
		}
	}
	resp.Parameters = strings.Join(params, "\n")

Patrick Devine's avatar
Patrick Devine committed
1052
1053
1054
1055
1056
	if len(req.Options) > 0 {
		if m.Options == nil {
			m.Options = make(map[string]any)
		}
		for k, v := range req.Options {
1057
			m.Options[k] = v
1058
1059
1060
		}
	}

1061
	var sb strings.Builder
1062
	fmt.Fprintln(&sb, "# Modelfile generated by \"ollama show\"")
1063
	fmt.Fprintln(&sb, "# To build a new Modelfile based on this, replace FROM with:")
1064
1065
	fmt.Fprintf(&sb, "# FROM %s\n\n", m.ShortName)
	fmt.Fprint(&sb, m.String())
1066
	resp.Modelfile = sb.String()
1067

1068
1069
1070
1071
1072
	// skip loading tensor information if this is a remote model
	if m.Config.RemoteHost != "" && m.Config.RemoteModel != "" {
		return resp, nil
	}

1073
	kvData, tensors, err := getModelData(m.ModelPath, req.Verbose)
1074
1075
1076
	if err != nil {
		return nil, err
	}
1077

1078
1079
1080
1081
	delete(kvData, "general.name")
	delete(kvData, "tokenizer.chat_template")
	resp.ModelInfo = kvData

1082
1083
1084
1085
1086
1087
	tensorData := make([]api.Tensor, len(tensors.Items()))
	for cnt, t := range tensors.Items() {
		tensorData[cnt] = api.Tensor{Name: t.Name, Type: t.Type(), Shape: t.Shape}
	}
	resp.Tensors = tensorData

1088
	if len(m.ProjectorPaths) > 0 {
1089
		projectorData, _, err := getModelData(m.ProjectorPaths[0], req.Verbose)
1090
1091
1092
1093
1094
1095
		if err != nil {
			return nil, err
		}
		resp.ProjectorInfo = projectorData
	}

Patrick Devine's avatar
Patrick Devine committed
1096
1097
1098
	return resp, nil
}

1099
func getModelData(digest string, verbose bool) (ggml.KV, ggml.Tensors, error) {
1100
1101
1102
1103
	maxArraySize := 0
	if verbose {
		maxArraySize = -1
	}
1104
	data, err := llm.LoadModel(digest, maxArraySize)
1105
	if err != nil {
1106
		return nil, ggml.Tensors{}, err
1107
1108
	}

1109
	kv := data.KV()
1110
1111
1112
1113
1114
1115
1116
1117
1118

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

1119
	return kv, data.Tensors(), nil
1120
1121
}

1122
func (s *Server) ListHandler(c *gin.Context) {
1123
	ms, err := Manifests(true)
Patrick Devine's avatar
Patrick Devine committed
1124
1125
1126
1127
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}
Michael Yang's avatar
Michael Yang committed
1128

1129
	models := []api.ListModelResponse{}
1130
1131
	for n, m := range ms {
		var cf ConfigV2
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144

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

			if err := json.NewDecoder(f).Decode(&cf); err != nil {
				slog.Warn("bad manifest config", "name", n, "error", err)
				continue
			}
Patrick Devine's avatar
Patrick Devine committed
1145
		}
Michael Yang's avatar
Michael Yang committed
1146

1147
1148
		// tag should never be masked
		models = append(models, api.ListModelResponse{
1149
1150
1151
1152
1153
1154
1155
			Model:       n.DisplayShortest(),
			Name:        n.DisplayShortest(),
			RemoteModel: cf.RemoteModel,
			RemoteHost:  cf.RemoteHost,
			Size:        m.Size(),
			Digest:      m.digest,
			ModifiedAt:  m.fi.ModTime(),
1156
1157
1158
1159
1160
1161
1162
			Details: api.ModelDetails{
				Format:            cf.ModelFormat,
				Family:            cf.ModelFamily,
				Families:          cf.ModelFamilies,
				ParameterSize:     cf.ModelType,
				QuantizationLevel: cf.FileType,
			},
1163
		})
Patrick Devine's avatar
Patrick Devine committed
1164
1165
	}

1166
	slices.SortStableFunc(models, func(i, j api.ListModelResponse) int {
1167
1168
1169
1170
		// most recently modified first
		return cmp.Compare(j.ModifiedAt.Unix(), i.ModifiedAt.Unix())
	})

Michael Yang's avatar
Michael Yang committed
1171
	c.JSON(http.StatusOK, api.ListResponse{Models: models})
Patrick Devine's avatar
Patrick Devine committed
1172
1173
}

1174
func (s *Server) CopyHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
1175
1176
	var r api.CopyRequest
	if err := c.ShouldBindJSON(&r); errors.Is(err, io.EOF) {
Michael Yang's avatar
Michael Yang committed
1177
1178
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
1179
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
1180
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Patrick Devine's avatar
Patrick Devine committed
1181
1182
1183
		return
	}

Michael Yang's avatar
Michael Yang committed
1184
1185
	src := model.ParseName(r.Source)
	if !src.IsValid() {
Michael Yang's avatar
Michael Yang committed
1186
1187
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("source %q is invalid", r.Source)})
		return
1188
	}
1189
1190
1191
1192
1193
	src, err := getExistingName(src)
	if err != nil {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}
1194

Michael Yang's avatar
Michael Yang committed
1195
1196
	dst := model.ParseName(r.Destination)
	if !dst.IsValid() {
1197
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("destination %q is invalid", r.Destination)})
Patrick Devine's avatar
Patrick Devine committed
1198
1199
		return
	}
1200
1201
	dst, err = getExistingName(dst)
	if err != nil {
1202
1203
1204
1205
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

Michael Yang's avatar
Michael Yang committed
1206
1207
1208
1209
1210
	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
1211
1212
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1213
func (s *Server) HeadBlobHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
	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
1225
	c.Status(http.StatusOK)
Michael Yang's avatar
Michael Yang committed
1226
1227
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1228
func (s *Server) CreateBlobHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
1229
1230
	if ib, ok := intermediateBlobs[c.Param("digest")]; ok {
		p, err := GetBlobsPath(ib)
1231
1232
1233
1234
1235
1236
		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
1237
1238
			slog.Info("evicting intermediate blob which no longer exists", "digest", ib)
			delete(intermediateBlobs, c.Param("digest"))
1239
1240
1241
1242
1243
1244
1245
1246
1247
		} else if err != nil {
			c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
			return
		} else {
			c.Status(http.StatusOK)
			return
		}
	}

1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
	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
	}

1266
	layer, err := NewLayer(c.Request.Body, "")
Michael Yang's avatar
Michael Yang committed
1267
1268
1269
1270
1271
	if err != nil {
		c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

1272
1273
	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
1274
1275
1276
		return
	}

Michael Yang's avatar
Michael Yang committed
1277
	c.Status(http.StatusCreated)
Michael Yang's avatar
Michael Yang committed
1278
1279
}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
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
}

1301
func allowedHost(host string) bool {
1302
1303
	host = strings.ToLower(host)

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1304
	if host == "" || host == "localhost" {
1305
1306
1307
		return true
	}

1308
	if hostname, err := os.Hostname(); err == nil && host == strings.ToLower(hostname) {
1309
1310
1311
		return true
	}

Michael Yang's avatar
lint  
Michael Yang committed
1312
	tlds := []string{
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1313
1314
1315
		"localhost",
		"local",
		"internal",
1316
	}
1317

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1318
	// check if the host is a local TLD
1319
1320
1321
1322
1323
1324
	for _, tld := range tlds {
		if strings.HasSuffix(host, "."+tld) {
			return true
		}
	}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1325
	return false
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1326
}
1327

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1328
1329
1330
func allowedHostsMiddleware(addr net.Addr) gin.HandlerFunc {
	return func(c *gin.Context) {
		if addr == nil {
1331
1332
1333
1334
			c.Next()
			return
		}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1335
		if addr, err := netip.ParseAddrPort(addr.String()); err == nil && !addr.Addr().IsLoopback() {
1336
1337
1338
1339
1340
1341
1342
1343
1344
			c.Next()
			return
		}

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

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1345
		if addr, err := netip.ParseAddr(host); err == nil {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1346
			if addr.IsLoopback() || addr.IsPrivate() || addr.IsUnspecified() || isLocalIP(addr) {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1347
1348
1349
1350
1351
				c.Next()
				return
			}
		}

1352
		if allowedHost(host) {
Michael Yang's avatar
lint  
Michael Yang committed
1353
			if c.Request.Method == http.MethodOptions {
1354
1355
1356
1357
				c.AbortWithStatus(http.StatusNoContent)
				return
			}

1358
1359
1360
1361
1362
1363
			c.Next()
			return
		}

		c.AbortWithStatus(http.StatusForbidden)
	}
1364
}
1365

1366
func (s *Server) GenerateRoutes(rc *ollama.Registry) (http.Handler, error) {
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
	corsConfig := cors.DefaultConfig()
	corsConfig.AllowWildcard = true
	corsConfig.AllowBrowserExtensions = true
	corsConfig.AllowHeaders = []string{
		"Authorization",
		"Content-Type",
		"User-Agent",
		"Accept",
		"X-Requested-With",

		// OpenAI compatibility headers
1378
1379
1380
1381
1382
		"OpenAI-Beta",
		"x-stainless-arch",
		"x-stainless-async",
		"x-stainless-custom-poll-interval",
		"x-stainless-helper-method",
1383
1384
		"x-stainless-lang",
		"x-stainless-os",
1385
1386
		"x-stainless-package-version",
		"x-stainless-poll-helper",
1387
1388
1389
1390
1391
1392
		"x-stainless-retry-count",
		"x-stainless-runtime",
		"x-stainless-runtime-version",
		"x-stainless-timeout",
	}
	corsConfig.AllowOrigins = envconfig.AllowedOrigins()
Michael Yang's avatar
Michael Yang committed
1393

Bruce MacDonald's avatar
Bruce MacDonald committed
1394
	r := gin.Default()
1395
	r.HandleMethodNotAllowed = true
1396
	r.Use(
1397
		cors.New(corsConfig),
1398
		allowedHostsMiddleware(s.addr),
1399
	)
Bruce MacDonald's avatar
Bruce MacDonald committed
1400

1401
1402
1403
1404
1405
1406
	// General
	r.HEAD("/", func(c *gin.Context) { c.String(http.StatusOK, "Ollama is running") })
	r.GET("/", func(c *gin.Context) { c.String(http.StatusOK, "Ollama is running") })
	r.HEAD("/api/version", func(c *gin.Context) { c.JSON(http.StatusOK, gin.H{"version": version.Version}) })
	r.GET("/api/version", func(c *gin.Context) { c.JSON(http.StatusOK, gin.H{"version": version.Version}) })

1407
	// Local model cache management (new implementation is at end of function)
1408
1409
	r.POST("/api/pull", s.PullHandler)
	r.POST("/api/push", s.PushHandler)
1410
1411
	r.HEAD("/api/tags", s.ListHandler)
	r.GET("/api/tags", s.ListHandler)
1412
	r.POST("/api/show", s.ShowHandler)
1413
	r.DELETE("/api/delete", s.DeleteHandler)
1414

1415
1416
1417
	r.DELETE("/api/user/keys/:encodedKey", s.SignoutHandler)
	r.POST("/api/me", s.WhoamiHandler)

1418
1419
	// Create
	r.POST("/api/create", s.CreateHandler)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1420
1421
	r.POST("/api/blobs/:digest", s.CreateBlobHandler)
	r.HEAD("/api/blobs/:digest", s.HeadBlobHandler)
1422
1423
1424
	r.POST("/api/copy", s.CopyHandler)

	// Inference
1425
	r.GET("/api/ps", s.PsHandler)
1426
1427
1428
1429
	r.POST("/api/generate", s.GenerateHandler)
	r.POST("/api/chat", s.ChatHandler)
	r.POST("/api/embed", s.EmbedHandler)
	r.POST("/api/embeddings", s.EmbeddingsHandler)
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1430

1431
	// Inference (OpenAI compatibility)
1432
	r.POST("/v1/chat/completions", openai.ChatMiddleware(), s.ChatHandler)
1433
	r.POST("/v1/completions", openai.CompletionsMiddleware(), s.GenerateHandler)
1434
	r.POST("/v1/embeddings", openai.EmbeddingsMiddleware(), s.EmbedHandler)
1435
1436
	r.GET("/v1/models", openai.ListMiddleware(), s.ListHandler)
	r.GET("/v1/models/:model", openai.RetrieveMiddleware(), s.ShowHandler)
1437

1438
1439
1440
1441
1442
1443
	if rc != nil {
		// wrap old with new
		rs := &registry.Local{
			Client:   rc,
			Logger:   slog.Default(), // TODO(bmizerany): Take a logger, do not use slog.Default()
			Fallback: r,
1444

1445
1446
1447
			Prune: PruneLayers,
		}
		return rs, nil
1448
1449
	}

1450
	return r, nil
1451
1452
1453
}

func Serve(ln net.Listener) error {
1454
	slog.SetDefault(logutil.NewLogger(os.Stderr, envconfig.LogLevel()))
1455
	slog.Info("server config", "env", envconfig.Values())
Michael Yang's avatar
Michael Yang committed
1456

1457
1458
1459
1460
1461
1462
1463
1464
	blobsDir, err := GetBlobsPath("")
	if err != nil {
		return err
	}
	if err := fixBlobs(blobsDir); err != nil {
		return err
	}

Michael Yang's avatar
bool  
Michael Yang committed
1465
	if !envconfig.NoPrune() {
1466
1467
1468
1469
1470
1471
1472
		if _, err := Manifests(false); err != nil {
			slog.Warn("corrupt manifests detected, skipping prune operation.  Re-pull or delete to clear", "error", err)
		} else {
			// clean up unused layers and manifests
			if err := PruneLayers(); err != nil {
				return err
			}
1473

1474
1475
1476
1477
			manifestsPath, err := GetManifestPath()
			if err != nil {
				return err
			}
1478

1479
1480
1481
			if err := PruneDirectory(manifestsPath); err != nil {
				return err
			}
1482
1483
1484
		}
	}

1485
1486
	s := &Server{addr: ln.Addr()}

1487
1488
1489
1490
1491
1492
1493
	var rc *ollama.Registry
	if useClient2 {
		var err error
		rc, err = ollama.DefaultRegistry()
		if err != nil {
			return err
		}
1494
1495
	}

1496
	h, err := s.GenerateRoutes(rc)
1497
1498
1499
	if err != nil {
		return err
	}
1500

1501
1502
	http.Handle("/", h)

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1503
	ctx, done := context.WithCancel(context.Background())
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1504
1505
	schedCtx, schedDone := context.WithCancel(ctx)
	sched := InitScheduler(schedCtx)
1506
	s.sched = sched
1507

1508
	slog.Info(fmt.Sprintf("Listening on %s (version %s)", ln.Addr(), version.Version))
1509
	srvr := &http.Server{
1510
1511
1512
1513
1514
1515
1516
1517
1518
		// 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
1519
1520
	}

1521
1522
	// listen for a ctrl+c and stop any loaded llm
	signals := make(chan os.Signal, 1)
1523
	signal.Notify(signals, syscall.SIGINT, syscall.SIGTERM)
1524
1525
	go func() {
		<-signals
1526
		srvr.Close()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1527
		schedDone()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1528
		sched.unloadAllRunners()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1529
		done()
1530
1531
	}()

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1532
	s.sched.Run(schedCtx)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1533

1534
1535
1536
1537
	// register the experimental webp decoder
	// so webp images can be used in multimodal inputs
	image.RegisterFormat("webp", "RIFF????WEBP", webp.Decode, webp.DecodeConfig)

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1538
1539
	// 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
1540
	gpus := discover.GetGPUInfo()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1541
	gpus.LogDetails()
1542

1543
1544
1545
1546
1547
1548
1549
1550
1551
	var totalVRAM uint64
	for _, gpu := range gpus {
		totalVRAM += gpu.TotalMemory - envconfig.GpuOverhead()
	}
	if totalVRAM < lowVRAMThreshold {
		s.lowVRAM = true
		slog.Info("entering low vram mode", "total vram", format.HumanBytes2(totalVRAM), "threshold", format.HumanBytes2(lowVRAMThreshold))
	}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1552
1553
1554
1555
1556
1557
1558
	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()
1559
	return nil
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1560
}
Michael Yang's avatar
Michael Yang committed
1561

1562
func waitForStream(c *gin.Context, ch chan any) {
1563
	c.Header("Content-Type", "application/json")
1564
	var latest api.ProgressResponse
1565
1566
1567
	for resp := range ch {
		switch r := resp.(type) {
		case api.ProgressResponse:
1568
			latest = r
1569
		case gin.H:
Josh's avatar
Josh committed
1570
1571
1572
1573
			status, ok := r["status"].(int)
			if !ok {
				status = http.StatusInternalServerError
			}
1574
1575
1576
			errorMsg, ok := r["error"].(string)
			if !ok {
				errorMsg = "unknown error"
1577
			}
1578
1579
			c.JSON(status, gin.H{"error": errorMsg})
			return
1580
		default:
1581
			c.JSON(http.StatusInternalServerError, gin.H{"error": "unknown message type"})
1582
1583
1584
			return
		}
	}
1585
1586

	c.JSON(http.StatusOK, latest)
1587
1588
}

Michael Yang's avatar
Michael Yang committed
1589
func streamResponse(c *gin.Context, ch chan any) {
1590
	c.Header("Content-Type", "application/x-ndjson")
Michael Yang's avatar
Michael Yang committed
1591
1592
1593
1594
1595
1596
1597
1598
	c.Stream(func(w io.Writer) bool {
		val, ok := <-ch
		if !ok {
			return false
		}

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

1603
		// Delineate chunks with new-line delimiter
Michael Yang's avatar
Michael Yang committed
1604
1605
		bts = append(bts, '\n')
		if _, err := w.Write(bts); err != nil {
1606
			slog.Info(fmt.Sprintf("streamResponse: w.Write failed with %s", err))
Michael Yang's avatar
Michael Yang committed
1607
1608
1609
1610
1611
1612
			return false
		}

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

1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
func (s *Server) WhoamiHandler(c *gin.Context) {
	// todo allow other hosts
	u, err := url.Parse("https://ollama.com")
	if err != nil {
		slog.Error(err.Error())
		c.JSON(http.StatusInternalServerError, gin.H{"error": "URL parse error"})
		return
	}

	client := api.NewClient(u, http.DefaultClient)
	user, err := client.Whoami(c)
	if err != nil {
		slog.Error(err.Error())
	}
	c.JSON(http.StatusOK, user)
}

func (s *Server) SignoutHandler(c *gin.Context) {
	encodedKey := c.Param("encodedKey")

	// todo allow other hosts
	u, err := url.Parse("https://ollama.com")
	if err != nil {
		slog.Error(err.Error())
		c.JSON(http.StatusInternalServerError, gin.H{"error": "URL parse error"})
		return
	}

	client := api.NewClient(u, http.DefaultClient)
	err = client.Signout(c, encodedKey)
	if err != nil {
		slog.Error(err.Error())
		if strings.Contains(err.Error(), "page not found") || strings.Contains(err.Error(), "invalid credentials") {
			c.JSON(http.StatusNotFound, gin.H{"error": "you are not currently signed in"})
			return
		}
		c.JSON(http.StatusInternalServerError, gin.H{"error": "there was an error signing out"})
		return
	}

	c.JSON(http.StatusOK, nil)
}

1657
func (s *Server) PsHandler(c *gin.Context) {
1658
	models := []api.ProcessModelResponse{}
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669

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

1670
		mr := api.ProcessModelResponse{
1671
1672
			Model:     model.ShortName,
			Name:      model.ShortName,
Jesse Gross's avatar
Jesse Gross committed
1673
1674
			Size:      int64(v.totalSize),
			SizeVRAM:  int64(v.vramSize),
1675
1676
1677
1678
			Digest:    model.Digest,
			Details:   modelDetails,
			ExpiresAt: v.expiresAt,
		}
1679
		if v.Options != nil {
Jesse Gross's avatar
Jesse Gross committed
1680
			mr.ContextLength = v.Options.NumCtx
1681
		}
1682
1683
1684
1685
1686
1687
1688
1689
		// 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)
		}

1690
1691
1692
		models = append(models, mr)
	}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1693
1694
1695
1696
1697
	slices.SortStableFunc(models, func(i, j api.ProcessModelResponse) int {
		// longest duration remaining listed first
		return cmp.Compare(j.ExpiresAt.Unix(), i.ExpiresAt.Unix())
	})

1698
	c.JSON(http.StatusOK, api.ProcessResponse{Models: models})
1699
1700
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1701
func (s *Server) ChatHandler(c *gin.Context) {
1702
1703
	checkpointStart := time.Now()

Bruce MacDonald's avatar
Bruce MacDonald committed
1704
	var req api.ChatRequest
Michael Yang's avatar
Michael Yang committed
1705
	if err := c.ShouldBindJSON(&req); errors.Is(err, io.EOF) {
Bruce MacDonald's avatar
Bruce MacDonald committed
1706
1707
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
1708
	} else if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1709
1710
1711
1712
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
	name := model.ParseName(req.Model)
	if !name.IsValid() {
		c.JSON(http.StatusBadRequest, gin.H{"error": "model is required"})
		return
	}

	name, err := getExistingName(name)
	if err != nil {
		c.JSON(http.StatusBadRequest, gin.H{"error": "model is required"})
		return
	}

	m, err := GetModel(req.Model)
	if err != nil {
		switch {
		case os.IsNotExist(err):
			c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found", req.Model)})
		case err.Error() == errtypes.InvalidModelNameErrMsg:
			c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		default:
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
Patrick Devine's avatar
Patrick Devine committed
1734
		}
1735
1736
1737
1738
1739
1740
		return
	}

	// expire the runner
	if len(req.Messages) == 0 && req.KeepAlive != nil && int(req.KeepAlive.Seconds()) == 0 {
		s.sched.expireRunner(m)
Patrick Devine's avatar
Patrick Devine committed
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751

		c.JSON(http.StatusOK, api.ChatResponse{
			Model:      req.Model,
			CreatedAt:  time.Now().UTC(),
			Message:    api.Message{Role: "assistant"},
			Done:       true,
			DoneReason: "unload",
		})
		return
	}

1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
	if m.Config.RemoteHost != "" && m.Config.RemoteModel != "" {
		origModel := req.Model

		remoteURL, err := url.Parse(m.Config.RemoteHost)
		if err != nil {
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
			return
		}

		if !slices.Contains(envconfig.Remotes(), remoteURL.Hostname()) {
			slog.Info("remote model", "remotes", envconfig.Remotes(), "remoteURL", m.Config.RemoteHost, "hostname", remoteURL.Hostname())
			c.JSON(http.StatusBadRequest, gin.H{"error": "this server cannot run this remote model"})
			return
		}

		req.Model = m.Config.RemoteModel
		if req.Options == nil {
			req.Options = map[string]any{}
		}

		msgs := append(m.Messages, req.Messages...)
		if req.Messages[0].Role != "system" && m.System != "" {
			msgs = append([]api.Message{{Role: "system", Content: m.System}}, msgs...)
		}
		msgs = filterThinkTags(msgs, m)
		req.Messages = msgs

		for k, v := range m.Options {
			if _, ok := req.Options[k]; !ok {
				req.Options[k] = v
			}
		}

		fn := func(resp api.ChatResponse) error {
			resp.Model = origModel
			resp.RemoteModel = m.Config.RemoteModel
			resp.RemoteHost = m.Config.RemoteHost

			data, err := json.Marshal(resp)
			if err != nil {
				return err
			}

			if _, err = c.Writer.Write(append(data, '\n')); err != nil {
				return err
			}
			c.Writer.Flush()
			return nil
		}

		client := api.NewClient(remoteURL, http.DefaultClient)
		err = client.Chat(c, &req, fn)
		if err != nil {
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
			var sErr api.AuthorizationError
			if errors.As(err, &sErr) && sErr.StatusCode == http.StatusUnauthorized {
				pk, pkErr := auth.GetPublicKey()
				if pkErr != nil {
					slog.Error("couldn't get public key", "error", pkErr)
					c.JSON(http.StatusUnauthorized, gin.H{"error": "error getting public key"})
					return
				}
				c.JSON(http.StatusUnauthorized, gin.H{
					"error":      "unauthorized",
					"public_key": pk,
				})
				return
			}
1819
1820
1821
1822
1823
1824
1825
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
			return
		}

		return
	}

1826
	caps := []model.Capability{model.CapabilityCompletion}
1827
	if len(req.Tools) > 0 {
1828
		caps = append(caps, model.CapabilityTools)
Michael Yang's avatar
tools  
Michael Yang committed
1829
	}
1830
	if req.Think != nil && req.Think.Bool() {
1831
1832
		caps = append(caps, model.CapabilityThinking)
	}
Michael Yang's avatar
tools  
Michael Yang committed
1833

1834
	r, m, opts, err := s.scheduleRunner(c.Request.Context(), name.String(), caps, req.Options, req.KeepAlive)
Michael Yang's avatar
Michael Yang committed
1835
1836
	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
1837
		return
Michael Yang's avatar
Michael Yang committed
1838
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
1839
		handleScheduleError(c, req.Model, err)
Bruce MacDonald's avatar
Bruce MacDonald committed
1840
1841
		return
	}
Michael Yang's avatar
Michael Yang committed
1842

1843
1844
	checkpointLoaded := time.Now()

Michael Yang's avatar
Michael Yang committed
1845
1846
	if len(req.Messages) == 0 {
		c.JSON(http.StatusOK, api.ChatResponse{
1847
			Model:      req.Model,
Michael Yang's avatar
Michael Yang committed
1848
1849
			CreatedAt:  time.Now().UTC(),
			Message:    api.Message{Role: "assistant"},
1850
1851
			Done:       true,
			DoneReason: "load",
Michael Yang's avatar
Michael Yang committed
1852
		})
1853
1854
1855
		return
	}

Michael Yang's avatar
Michael Yang committed
1856
	msgs := append(m.Messages, req.Messages...)
1857
	if req.Messages[0].Role != "system" && m.System != "" {
Michael Yang's avatar
Michael Yang committed
1858
		msgs = append([]api.Message{{Role: "system", Content: m.System}}, msgs...)
1859
	}
1860
	msgs = filterThinkTags(msgs, m)
1861

1862
1863
	if shouldUseHarmony(m) && m.Config.Parser == "" {
		m.Config.Parser = "harmony"
Devon Rifkin's avatar
Devon Rifkin committed
1864
1865
	}

1866
	var builtinParser parsers.Parser
1867
	processedTools := req.Tools
1868

1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
	if m.Config.Parser != "" {
		builtinParser = parsers.ParserForName(m.Config.Parser)
		if builtinParser != nil {
			// Determine last message for chat prefill
			var lastMessage *api.Message
			if len(msgs) > 0 {
				lastMessage = &msgs[len(msgs)-1]
			}
			// Initialize parser and get processed tools
			processedTools = builtinParser.Init(req.Tools, lastMessage)
1879
1880
1881
1882
		}
	}

	prompt, images, err := chatPrompt(c.Request.Context(), m, r.Tokenize, opts, msgs, processedTools, req.Think)
Michael Yang's avatar
Michael Yang committed
1883
	if err != nil {
1884
		slog.Error("chat prompt error", "error", err)
Michael Yang's avatar
Michael Yang committed
1885
1886
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
1887
1888
	}

1889
1890
	// If debug mode is enabled, return the rendered template instead of calling the model
	if req.DebugRenderOnly {
Devon Rifkin's avatar
Devon Rifkin committed
1891
		c.JSON(http.StatusOK, api.ChatResponse{
1892
1893
			Model:     req.Model,
			CreatedAt: time.Now().UTC(),
Devon Rifkin's avatar
Devon Rifkin committed
1894
			DebugInfo: &api.DebugInfo{
1895
1896
1897
1898
1899
1900
1901
				RenderedTemplate: prompt,
				ImageCount:       len(images),
			},
		})
		return
	}

1902
1903
	// Validate Think value: string values currently only allowed for harmony/gptoss models
	if req.Think != nil && req.Think.IsString() && m.Config.Parser != "harmony" {
1904
		c.JSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("think value %q is not supported for this model", req.Think.String())})
Michael Yang's avatar
Michael Yang committed
1905
1906
1907
		return
	}

1908
1909
	var thinkingState *thinking.Parser
	openingTag, closingTag := thinking.InferTags(m.Template.Template)
1910
	if req.Think != nil && req.Think.Bool() && openingTag != "" && closingTag != "" {
1911
		thinkingState = &thinking.Parser{
Devon Rifkin's avatar
Devon Rifkin committed
1912
1913
			OpeningTag: openingTag,
			ClosingTag: closingTag,
1914
		}
1915
1916
1917
1918

		if strings.HasSuffix(strings.TrimSpace(prompt), openingTag) {
			thinkingState.AddContent(openingTag)
		}
1919
1920
	}

1921
	var toolParser *tools.Parser
1922
	if len(req.Tools) > 0 && (builtinParser == nil || !builtinParser.HasToolSupport()) {
1923
		toolParser = tools.NewParser(m.Template.Template, req.Tools)
1924
1925
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
1926
1927
1928
	ch := make(chan any)
	go func() {
		defer close(ch)
1929

Michael Yang's avatar
Michael Yang committed
1930
		if err := r.Completion(c.Request.Context(), llm.CompletionRequest{
1931
1932
1933
1934
			Prompt:  prompt,
			Images:  images,
			Format:  req.Format,
			Options: opts,
Michael Yang's avatar
Michael Yang committed
1935
		}, func(r llm.CompletionResponse) {
1936
			res := api.ChatResponse{
1937
1938
				Model:     req.Model,
				CreatedAt: time.Now().UTC(),
1939
				Message:   api.Message{Role: "assistant", Content: r.Content},
1940
				Done:      r.Done,
Bruce MacDonald's avatar
Bruce MacDonald committed
1941
1942
1943
1944
1945
1946
1947
				Metrics: api.Metrics{
					PromptEvalCount:    r.PromptEvalCount,
					PromptEvalDuration: r.PromptEvalDuration,
					EvalCount:          r.EvalCount,
					EvalDuration:       r.EvalDuration,
				},
			}
Michael Yang's avatar
Michael Yang committed
1948
1949
1950
1951
1952
1953
			if r.Done {
				res.DoneReason = r.DoneReason.String()
				res.TotalDuration = time.Since(checkpointStart)
				res.LoadDuration = checkpointLoaded.Sub(checkpointStart)
			}

1954
			if builtinParser != nil {
Devon Rifkin's avatar
Devon Rifkin committed
1955
1956
				slog.Log(context.TODO(), logutil.LevelTrace, "builtin parser input", "parser", m.Config.Parser, "content", r.Content)

1957
				content, thinking, toolCalls, err := builtinParser.Add(r.Content, r.Done)
Devon Rifkin's avatar
Devon Rifkin committed
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
				if err != nil {
					ch <- gin.H{"error": err.Error()}
					return
				}

				res.Message.Content = content
				res.Message.Thinking = thinking
				res.Message.ToolCalls = toolCalls

				if res.Message.Content != "" || res.Message.Thinking != "" || len(res.Message.ToolCalls) > 0 || r.Done {
					slog.Log(context.TODO(), logutil.LevelTrace, "builtin parser output", "parser", m.Config.Parser, "content", content, "thinking", thinking, "toolCalls", toolCalls, "done", r.Done)
					ch <- res
				} else {
					slog.Log(context.TODO(), logutil.LevelTrace, "builtin parser empty output", "parser", m.Config.Parser)
				}

Michael Yang's avatar
Michael Yang committed
1974
1975
				return
			}
1976

1977
			if thinkingState != nil {
Devon Rifkin's avatar
Devon Rifkin committed
1978
				thinkingContent, remainingContent := thinkingState.AddContent(res.Message.Content)
1979
1980
1981
1982
1983
1984
1985
1986
				if thinkingContent == "" && remainingContent == "" && !r.Done {
					// need to accumulate more to decide what to send
					return
				}
				res.Message.Content = remainingContent
				res.Message.Thinking = thinkingContent
			}

1987
			if len(req.Tools) > 0 {
1988
				toolCalls, content := toolParser.Add(res.Message.Content)
1989
1990
1991
1992
1993
				if len(content) > 0 {
					res.Message.Content = content
				} else if len(toolCalls) > 0 {
					res.Message.ToolCalls = toolCalls
					res.Message.Content = ""
1994
1995
				} else if res.Message.Thinking != "" {
					// don't return
1996
1997
				} else {
					if r.Done {
1998
						res.Message.Content = toolParser.Content()
1999
2000
2001
						ch <- res
					}
					return
2002
2003
				}
			}
2004

2005
			ch <- res
Michael Yang's avatar
Michael Yang committed
2006
		}); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
2007
2008
2009
2010
2011
			ch <- gin.H{"error": err.Error()}
		}
	}()

	if req.Stream != nil && !*req.Stream {
Michael Yang's avatar
tools  
Michael Yang committed
2012
		var resp api.ChatResponse
2013
		var toolCalls []api.ToolCall
2014
2015
		var sbThinking strings.Builder
		var sbContent strings.Builder
Michael Yang's avatar
Michael Yang committed
2016
2017
		for rr := range ch {
			switch t := rr.(type) {
2018
			case api.ChatResponse:
2019
2020
				sbThinking.WriteString(t.Message.Thinking)
				sbContent.WriteString(t.Message.Content)
Michael Yang's avatar
tools  
Michael Yang committed
2021
				resp = t
2022
2023
2024
				if len(req.Tools) > 0 {
					toolCalls = append(toolCalls, t.Message.ToolCalls...)
				}
2025
			case gin.H:
Michael Yang's avatar
Michael Yang committed
2026
2027
2028
				msg, ok := t["error"].(string)
				if !ok {
					msg = "unexpected error format in response"
2029
				}
Michael Yang's avatar
Michael Yang committed
2030
2031
2032

				c.JSON(http.StatusInternalServerError, gin.H{"error": msg})
				return
2033
			default:
Michael Yang's avatar
Michael Yang committed
2034
				c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected response"})
2035
				return
Bruce MacDonald's avatar
Bruce MacDonald committed
2036
2037
			}
		}
2038

2039
2040
2041
		resp.Message.Content = sbContent.String()
		resp.Message.Thinking = sbThinking.String()

2042
2043
		if len(toolCalls) > 0 {
			resp.Message.ToolCalls = toolCalls
Michael Yang's avatar
tools  
Michael Yang committed
2044
2045
2046
		}

		c.JSON(http.StatusOK, resp)
Bruce MacDonald's avatar
Bruce MacDonald committed
2047
2048
2049
2050
2051
		return
	}

	streamResponse(c, ch)
}
2052

Michael Yang's avatar
Michael Yang committed
2053
func handleScheduleError(c *gin.Context, name string, err error) {
Michael Yang's avatar
Michael Yang committed
2054
	switch {
2055
	case errors.Is(err, errCapabilities), errors.Is(err, errRequired):
Michael Yang's avatar
Michael Yang committed
2056
		c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Michael Yang's avatar
Michael Yang committed
2057
	case errors.Is(err, context.Canceled):
2058
		c.JSON(499, gin.H{"error": "request canceled"})
Michael Yang's avatar
Michael Yang committed
2059
	case errors.Is(err, ErrMaxQueue):
2060
		c.JSON(http.StatusServiceUnavailable, gin.H{"error": err.Error()})
Michael Yang's avatar
Michael Yang committed
2061
2062
	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
2063
2064
	default:
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
2065
2066
	}
}
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078

func filterThinkTags(msgs []api.Message, m *Model) []api.Message {
	if m.Config.ModelFamily == "qwen3" || model.ParseName(m.Name).Model == "deepseek-r1" {
		finalUserIndex := -1
		for i, msg := range msgs {
			if msg.Role == "user" {
				finalUserIndex = i
			}
		}

		for i, msg := range msgs {
			if msg.Role == "assistant" && i < finalUserIndex {
2079
2080
2081
2082
2083
				// TODO(drifkin): this is from before we added proper thinking support.
				// However, even if thinking is not enabled (and therefore we shouldn't
				// change the user output), we should probably perform this filtering
				// for all thinking models (not just qwen3 & deepseek-r1) since it tends
				// to save tokens and improve quality.
2084
				thinkingState := &thinking.Parser{
Devon Rifkin's avatar
Devon Rifkin committed
2085
2086
					OpeningTag: "<think>",
					ClosingTag: "</think>",
2087
				}
Devon Rifkin's avatar
Devon Rifkin committed
2088
				_, content := thinkingState.AddContent(msg.Content)
2089
				msgs[i].Content = content
2090
2091
2092
2093
2094
			}
		}
	}
	return msgs
}