routes.go 54.3 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
261
262
263
264
265
266
267
268
269
270
	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
				}
				c.JSON(http.StatusUnauthorized, gin.H{"public_key": pk})
				return
			}
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
			return
		}

		return
	}

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

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

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

290
291
292
293
294
295
296
297
298
299
300
	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
301
302
	}

303
304
	// Validate Think value: string values currently only allowed for harmony/gptoss models
	if req.Think != nil && req.Think.IsString() && m.Config.Parser != "harmony" {
305
		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
306
307
308
		return
	}

309
	caps := []model.Capability{model.CapabilityCompletion}
310
	if req.Suffix != "" {
311
		caps = append(caps, model.CapabilityInsert)
312
	}
313
	if req.Think != nil && req.Think.Bool() {
314
315
316
317
318
319
		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
	}
320

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

330
331
	checkpointLoaded := time.Now()

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

343
344
	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"})
345
346
347
		return
	}

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

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

364
365
366
367
368
369
370
371
372
373
374
375
		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
376
377
378
379
			if req.Context == nil {
				msgs = append(msgs, m.Messages...)
			}

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

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

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

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

		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
412
413
	}

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

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

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

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

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

			if cr.Done {
487
488
489
490
				res.DoneReason = cr.DoneReason.String()
				res.TotalDuration = time.Since(checkpointStart)
				res.LoadDuration = checkpointLoaded.Sub(checkpointStart)

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

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

				return
			}

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

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

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

540
541
542
		r.Thinking = sbThinking.String()
		r.Response = sbContent.String()

Michael Yang's avatar
Michael Yang committed
543
		c.JSON(http.StatusOK, r)
Bruce MacDonald's avatar
Bruce MacDonald committed
544
545
546
547
548
549
		return
	}

	streamResponse(c, ch)
}

550
func (s *Server) EmbedHandler(c *gin.Context) {
551
	checkpointStart := time.Now()
552
553
554
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
	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:
584
585
586
587
		if req.Input != nil {
			c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "invalid input type"})
			return
		}
588
589
	}

590
591
592
593
594
595
	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
	}

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

602
603
	checkpointLoaded := time.Now()

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

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

615
	var count int
616
617
618
619
620
621
622
623
624
625
	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 {
626
				c.JSON(http.StatusBadRequest, gin.H{"error": "input exceeds maximum context length"})
627
628
629
				return
			}

630
631
632
633
634
635
636
637
			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--
			}

638
639
640
641
642
643
644
			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
			}

645
			tokens = tokens[:ctxLen]
646

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

654
655
		count += len(tokens)

656
657
		input[i] = s
	}
658
659
660
661
662
663
664
665
666

	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
			}
667
668
669
670
671
672
			// 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
673
674
			return nil
		})
675
676
	}

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

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

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

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

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

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

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

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

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

739
740
741
	var e []float64
	for _, v := range embedding {
		e = append(e, float64(v))
742
743
744
	}

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

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

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

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

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

Michael Yang's avatar
Michael Yang committed
781
		regOpts := &registryOptions{
782
783
784
			Insecure: req.Insecure,
		}

785
786
787
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

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

793
794
795
796
797
	if req.Stream != nil && !*req.Stream {
		waitForStream(c, ch)
		return
	}

798
799
800
	streamResponse(c, ch)
}

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

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

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

Michael Yang's avatar
Michael Yang committed
830
		regOpts := &registryOptions{
831
832
833
			Insecure: req.Insecure,
		}

Michael Yang's avatar
Michael Yang committed
834
835
836
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

837
838
839
840
841
842
843
		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
844
			ch <- gin.H{"error": err.Error()}
845
846
847
		}
	}()

848
849
850
851
852
	if req.Stream != nil && !*req.Stream {
		waitForStream(c, ch)
		return
	}

853
854
855
	streamResponse(c, ch)
}

856
857
858
859
// 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.
860
861
862
func getExistingName(n model.Name) (model.Name, error) {
	var zero model.Name
	existing, err := Manifests(true)
863
	if err != nil {
864
		return zero, err
865
	}
866
	var set model.Name // tracks parts already canonicalized
867
	for e := range existing {
868
869
870
871
872
873
874
875
876
877
878
		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
879
880
		}
	}
881
	return n, nil
882
883
}

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

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

900
901
902
903
904
905
	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
	}

906
	m, err := ParseNamedManifest(n)
Michael Yang's avatar
Michael Yang committed
907
	if err != nil {
908
909
910
911
912
913
		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
914
915
916
		return
	}

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

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

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

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

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

	c.JSON(http.StatusOK, resp)
}

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

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

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

989
	if req.System != "" {
990
		m.System = req.System
991
992
	}

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

998
	manifest, err := ParseNamedManifest(name)
999
1000
1001
1002
	if err != nil {
		return nil, err
	}

Patrick Devine's avatar
Patrick Devine committed
1003
	resp := &api.ShowResponse{
1004
1005
1006
1007
1008
1009
1010
		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
1011
1012
	}

1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
	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
1035
1036
	var params []string
	cs := 30
1037
	for k, v := range m.Options {
Patrick Devine's avatar
Patrick Devine committed
1038
		switch val := v.(type) {
1039
		case []any:
Patrick Devine's avatar
Patrick Devine committed
1040
			for _, nv := range val {
Patrick Devine's avatar
Patrick Devine committed
1041
				params = append(params, fmt.Sprintf("%-*s %#v", cs, k, nv))
Patrick Devine's avatar
Patrick Devine committed
1042
			}
Patrick Devine's avatar
Patrick Devine committed
1043
1044
		default:
			params = append(params, fmt.Sprintf("%-*s %#v", cs, k, v))
Patrick Devine's avatar
Patrick Devine committed
1045
1046
1047
1048
		}
	}
	resp.Parameters = strings.Join(params, "\n")

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

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

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

1070
	kvData, tensors, err := getModelData(m.ModelPath, req.Verbose)
1071
1072
1073
	if err != nil {
		return nil, err
	}
1074

1075
1076
1077
1078
	delete(kvData, "general.name")
	delete(kvData, "tokenizer.chat_template")
	resp.ModelInfo = kvData

1079
1080
1081
1082
1083
1084
	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

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

Patrick Devine's avatar
Patrick Devine committed
1093
1094
1095
	return resp, nil
}

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

1106
	kv := data.KV()
1107
1108
1109
1110
1111
1112
1113
1114
1115

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

1116
	return kv, data.Tensors(), nil
1117
1118
}

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

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

		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
1142
		}
Michael Yang's avatar
Michael Yang committed
1143

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

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

Michael Yang's avatar
Michael Yang committed
1168
	c.JSON(http.StatusOK, api.ListResponse{Models: models})
Patrick Devine's avatar
Patrick Devine committed
1169
1170
}

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

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

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

Michael Yang's avatar
Michael Yang committed
1203
1204
1205
1206
1207
	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
1208
1209
}

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

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

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

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

1269
1270
	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
1271
1272
1273
		return
	}

Michael Yang's avatar
Michael Yang committed
1274
	c.Status(http.StatusCreated)
Michael Yang's avatar
Michael Yang committed
1275
1276
}

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

1298
func allowedHost(host string) bool {
1299
1300
	host = strings.ToLower(host)

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1301
	if host == "" || host == "localhost" {
1302
1303
1304
		return true
	}

1305
	if hostname, err := os.Hostname(); err == nil && host == strings.ToLower(hostname) {
1306
1307
1308
		return true
	}

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

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

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1322
	return false
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1323
}
1324

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

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

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

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

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

1355
1356
1357
1358
1359
1360
			c.Next()
			return
		}

		c.AbortWithStatus(http.StatusForbidden)
	}
1361
}
1362

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

		// OpenAI compatibility headers
1375
1376
1377
1378
1379
		"OpenAI-Beta",
		"x-stainless-arch",
		"x-stainless-async",
		"x-stainless-custom-poll-interval",
		"x-stainless-helper-method",
1380
1381
		"x-stainless-lang",
		"x-stainless-os",
1382
1383
		"x-stainless-package-version",
		"x-stainless-poll-helper",
1384
1385
1386
1387
1388
1389
		"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
1390

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

1398
1399
1400
1401
1402
1403
	// 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}) })

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

1412
1413
1414
	r.DELETE("/api/user/keys/:encodedKey", s.SignoutHandler)
	r.POST("/api/me", s.WhoamiHandler)

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

	// Inference
1422
	r.GET("/api/ps", s.PsHandler)
1423
1424
1425
1426
	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
1427

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

1435
1436
1437
1438
1439
1440
	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,
1441

1442
1443
1444
			Prune: PruneLayers,
		}
		return rs, nil
1445
1446
	}

1447
	return r, nil
1448
1449
1450
}

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

1454
1455
1456
1457
1458
1459
1460
1461
	blobsDir, err := GetBlobsPath("")
	if err != nil {
		return err
	}
	if err := fixBlobs(blobsDir); err != nil {
		return err
	}

Michael Yang's avatar
bool  
Michael Yang committed
1462
	if !envconfig.NoPrune() {
1463
1464
1465
1466
1467
1468
1469
		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
			}
1470

1471
1472
1473
1474
			manifestsPath, err := GetManifestPath()
			if err != nil {
				return err
			}
1475

1476
1477
1478
			if err := PruneDirectory(manifestsPath); err != nil {
				return err
			}
1479
1480
1481
		}
	}

1482
1483
	s := &Server{addr: ln.Addr()}

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

1493
	h, err := s.GenerateRoutes(rc)
1494
1495
1496
	if err != nil {
		return err
	}
1497

1498
1499
	http.Handle("/", h)

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1500
	ctx, done := context.WithCancel(context.Background())
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1501
1502
	schedCtx, schedDone := context.WithCancel(ctx)
	sched := InitScheduler(schedCtx)
1503
	s.sched = sched
1504

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

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

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1529
	s.sched.Run(schedCtx)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1530

1531
1532
1533
1534
	// 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
1535
1536
	// 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
1537
	gpus := discover.GetGPUInfo()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1538
	gpus.LogDetails()
1539

1540
1541
1542
1543
1544
1545
1546
1547
1548
	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
1549
1550
1551
1552
1553
1554
1555
	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()
1556
	return nil
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1557
}
Michael Yang's avatar
Michael Yang committed
1558

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

	c.JSON(http.StatusOK, latest)
1584
1585
}

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

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

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

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

1611
1612
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
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)
}

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

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

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

1687
1688
1689
		models = append(models, mr)
	}

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

1695
	c.JSON(http.StatusOK, api.ProcessResponse{Models: models})
1696
1697
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1698
func (s *Server) ChatHandler(c *gin.Context) {
1699
1700
	checkpointStart := time.Now()

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

1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
	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
1731
		}
1732
1733
1734
1735
1736
1737
		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
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748

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

1749
1750
1751
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
1805
1806
1807
1808
	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 {
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
			return
		}

		return
	}

1809
	caps := []model.Capability{model.CapabilityCompletion}
1810
	if len(req.Tools) > 0 {
1811
		caps = append(caps, model.CapabilityTools)
Michael Yang's avatar
tools  
Michael Yang committed
1812
	}
1813
	if req.Think != nil && req.Think.Bool() {
1814
1815
		caps = append(caps, model.CapabilityThinking)
	}
Michael Yang's avatar
tools  
Michael Yang committed
1816

1817
	r, m, opts, err := s.scheduleRunner(c.Request.Context(), name.String(), caps, req.Options, req.KeepAlive)
Michael Yang's avatar
Michael Yang committed
1818
1819
	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
1820
		return
Michael Yang's avatar
Michael Yang committed
1821
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
1822
		handleScheduleError(c, req.Model, err)
Bruce MacDonald's avatar
Bruce MacDonald committed
1823
1824
		return
	}
Michael Yang's avatar
Michael Yang committed
1825

1826
1827
	checkpointLoaded := time.Now()

Michael Yang's avatar
Michael Yang committed
1828
1829
	if len(req.Messages) == 0 {
		c.JSON(http.StatusOK, api.ChatResponse{
1830
			Model:      req.Model,
Michael Yang's avatar
Michael Yang committed
1831
1832
			CreatedAt:  time.Now().UTC(),
			Message:    api.Message{Role: "assistant"},
1833
1834
			Done:       true,
			DoneReason: "load",
Michael Yang's avatar
Michael Yang committed
1835
		})
1836
1837
1838
		return
	}

Michael Yang's avatar
Michael Yang committed
1839
	msgs := append(m.Messages, req.Messages...)
1840
	if req.Messages[0].Role != "system" && m.System != "" {
Michael Yang's avatar
Michael Yang committed
1841
		msgs = append([]api.Message{{Role: "system", Content: m.System}}, msgs...)
1842
	}
1843
	msgs = filterThinkTags(msgs, m)
1844

1845
1846
	if shouldUseHarmony(m) && m.Config.Parser == "" {
		m.Config.Parser = "harmony"
Devon Rifkin's avatar
Devon Rifkin committed
1847
1848
	}

1849
	var builtinParser parsers.Parser
1850
	processedTools := req.Tools
1851

1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
	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)
1862
1863
1864
1865
		}
	}

	prompt, images, err := chatPrompt(c.Request.Context(), m, r.Tokenize, opts, msgs, processedTools, req.Think)
Michael Yang's avatar
Michael Yang committed
1866
	if err != nil {
1867
		slog.Error("chat prompt error", "error", err)
Michael Yang's avatar
Michael Yang committed
1868
1869
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
1870
1871
	}

1872
1873
	// If debug mode is enabled, return the rendered template instead of calling the model
	if req.DebugRenderOnly {
Devon Rifkin's avatar
Devon Rifkin committed
1874
		c.JSON(http.StatusOK, api.ChatResponse{
1875
1876
			Model:     req.Model,
			CreatedAt: time.Now().UTC(),
Devon Rifkin's avatar
Devon Rifkin committed
1877
			DebugInfo: &api.DebugInfo{
1878
1879
1880
1881
1882
1883
1884
				RenderedTemplate: prompt,
				ImageCount:       len(images),
			},
		})
		return
	}

1885
1886
	// Validate Think value: string values currently only allowed for harmony/gptoss models
	if req.Think != nil && req.Think.IsString() && m.Config.Parser != "harmony" {
1887
		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
1888
1889
1890
		return
	}

1891
1892
	var thinkingState *thinking.Parser
	openingTag, closingTag := thinking.InferTags(m.Template.Template)
1893
	if req.Think != nil && req.Think.Bool() && openingTag != "" && closingTag != "" {
1894
		thinkingState = &thinking.Parser{
Devon Rifkin's avatar
Devon Rifkin committed
1895
1896
			OpeningTag: openingTag,
			ClosingTag: closingTag,
1897
		}
1898
1899
1900
1901

		if strings.HasSuffix(strings.TrimSpace(prompt), openingTag) {
			thinkingState.AddContent(openingTag)
		}
1902
1903
	}

1904
	var toolParser *tools.Parser
1905
	if len(req.Tools) > 0 && (builtinParser == nil || !builtinParser.HasToolSupport()) {
1906
		toolParser = tools.NewParser(m.Template.Template, req.Tools)
1907
1908
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
1909
1910
1911
	ch := make(chan any)
	go func() {
		defer close(ch)
1912

Michael Yang's avatar
Michael Yang committed
1913
		if err := r.Completion(c.Request.Context(), llm.CompletionRequest{
1914
1915
1916
1917
			Prompt:  prompt,
			Images:  images,
			Format:  req.Format,
			Options: opts,
Michael Yang's avatar
Michael Yang committed
1918
		}, func(r llm.CompletionResponse) {
1919
			res := api.ChatResponse{
1920
1921
				Model:     req.Model,
				CreatedAt: time.Now().UTC(),
1922
				Message:   api.Message{Role: "assistant", Content: r.Content},
1923
				Done:      r.Done,
Bruce MacDonald's avatar
Bruce MacDonald committed
1924
1925
1926
1927
1928
1929
1930
				Metrics: api.Metrics{
					PromptEvalCount:    r.PromptEvalCount,
					PromptEvalDuration: r.PromptEvalDuration,
					EvalCount:          r.EvalCount,
					EvalDuration:       r.EvalDuration,
				},
			}
Michael Yang's avatar
Michael Yang committed
1931
1932
1933
1934
1935
1936
			if r.Done {
				res.DoneReason = r.DoneReason.String()
				res.TotalDuration = time.Since(checkpointStart)
				res.LoadDuration = checkpointLoaded.Sub(checkpointStart)
			}

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

1940
				content, thinking, toolCalls, err := builtinParser.Add(r.Content, r.Done)
Devon Rifkin's avatar
Devon Rifkin committed
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
				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
1957
1958
				return
			}
1959

1960
			if thinkingState != nil {
Devon Rifkin's avatar
Devon Rifkin committed
1961
				thinkingContent, remainingContent := thinkingState.AddContent(res.Message.Content)
1962
1963
1964
1965
1966
1967
1968
1969
				if thinkingContent == "" && remainingContent == "" && !r.Done {
					// need to accumulate more to decide what to send
					return
				}
				res.Message.Content = remainingContent
				res.Message.Thinking = thinkingContent
			}

1970
			if len(req.Tools) > 0 {
1971
				toolCalls, content := toolParser.Add(res.Message.Content)
1972
1973
1974
1975
1976
				if len(content) > 0 {
					res.Message.Content = content
				} else if len(toolCalls) > 0 {
					res.Message.ToolCalls = toolCalls
					res.Message.Content = ""
1977
1978
				} else if res.Message.Thinking != "" {
					// don't return
1979
1980
				} else {
					if r.Done {
1981
						res.Message.Content = toolParser.Content()
1982
1983
1984
						ch <- res
					}
					return
1985
1986
				}
			}
1987

1988
			ch <- res
Michael Yang's avatar
Michael Yang committed
1989
		}); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1990
1991
1992
1993
1994
			ch <- gin.H{"error": err.Error()}
		}
	}()

	if req.Stream != nil && !*req.Stream {
Michael Yang's avatar
tools  
Michael Yang committed
1995
		var resp api.ChatResponse
1996
		var toolCalls []api.ToolCall
1997
1998
		var sbThinking strings.Builder
		var sbContent strings.Builder
Michael Yang's avatar
Michael Yang committed
1999
2000
		for rr := range ch {
			switch t := rr.(type) {
2001
			case api.ChatResponse:
2002
2003
				sbThinking.WriteString(t.Message.Thinking)
				sbContent.WriteString(t.Message.Content)
Michael Yang's avatar
tools  
Michael Yang committed
2004
				resp = t
2005
2006
2007
				if len(req.Tools) > 0 {
					toolCalls = append(toolCalls, t.Message.ToolCalls...)
				}
2008
			case gin.H:
Michael Yang's avatar
Michael Yang committed
2009
2010
2011
				msg, ok := t["error"].(string)
				if !ok {
					msg = "unexpected error format in response"
2012
				}
Michael Yang's avatar
Michael Yang committed
2013
2014
2015

				c.JSON(http.StatusInternalServerError, gin.H{"error": msg})
				return
2016
			default:
Michael Yang's avatar
Michael Yang committed
2017
				c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected response"})
2018
				return
Bruce MacDonald's avatar
Bruce MacDonald committed
2019
2020
			}
		}
2021

2022
2023
2024
		resp.Message.Content = sbContent.String()
		resp.Message.Thinking = sbThinking.String()

2025
2026
		if len(toolCalls) > 0 {
			resp.Message.ToolCalls = toolCalls
Michael Yang's avatar
tools  
Michael Yang committed
2027
2028
2029
		}

		c.JSON(http.StatusOK, resp)
Bruce MacDonald's avatar
Bruce MacDonald committed
2030
2031
2032
2033
2034
		return
	}

	streamResponse(c, ch)
}
2035

Michael Yang's avatar
Michael Yang committed
2036
func handleScheduleError(c *gin.Context, name string, err error) {
Michael Yang's avatar
Michael Yang committed
2037
	switch {
2038
	case errors.Is(err, errCapabilities), errors.Is(err, errRequired):
Michael Yang's avatar
Michael Yang committed
2039
		c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Michael Yang's avatar
Michael Yang committed
2040
	case errors.Is(err, context.Canceled):
2041
		c.JSON(499, gin.H{"error": "request canceled"})
Michael Yang's avatar
Michael Yang committed
2042
	case errors.Is(err, ErrMaxQueue):
2043
		c.JSON(http.StatusServiceUnavailable, gin.H{"error": err.Error()})
Michael Yang's avatar
Michael Yang committed
2044
2045
	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
2046
2047
	default:
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
2048
2049
	}
}
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061

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 {
2062
2063
2064
2065
2066
				// 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.
2067
				thinkingState := &thinking.Parser{
Devon Rifkin's avatar
Devon Rifkin committed
2068
2069
					OpeningTag: "<think>",
					ClosingTag: "</think>",
2070
				}
Devon Rifkin's avatar
Devon Rifkin committed
2071
				_, content := thinkingState.AddContent(msg.Content)
2072
				msgs[i].Content = content
2073
2074
2075
2076
2077
			}
		}
	}
	return msgs
}