routes.go 49.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
	"os"
19
	"os/signal"
20
	"slices"
Michael Yang's avatar
Michael Yang committed
21
	"strings"
22
	"syscall"
23
	"time"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
24

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

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

49
50
51
52
53
54
55
56
57
58
59
60
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
}

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

var useClient2 = experimentEnabled("client2")

67
68
69
70
// 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
71
72
var mode string = gin.DebugMode

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

Michael Yang's avatar
Michael Yang committed
79
80
81
82
83
84
85
86
87
88
89
90
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
91
92
93
94
var (
	errRequired    = errors.New("is required")
	errBadTemplate = errors.New("template error")
)
Michael Yang's avatar
Michael Yang committed
95

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

Michael Yang's avatar
Michael Yang committed
109
110
// 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.
111
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
112
	if name == "" {
Michael Yang's avatar
Michael Yang committed
113
		return nil, nil, nil, fmt.Errorf("model %w", errRequired)
Bruce MacDonald's avatar
Bruce MacDonald committed
114
115
	}

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

121
122
123
124
	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
125
	if err := model.CheckCapabilities(caps...); err != nil {
Michael Yang's avatar
Michael Yang committed
126
		return nil, nil, nil, fmt.Errorf("%s %w", name, err)
127
128
	}

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

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

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

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

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

162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
	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
	}

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

Patrick Devine's avatar
Patrick Devine committed
191
	// expire the runner
Michael Yang's avatar
Michael Yang committed
192
	if req.Prompt == "" && req.KeepAlive != nil && req.KeepAlive.Duration == 0 {
193
		s.sched.expireRunner(m)
Patrick Devine's avatar
Patrick Devine committed
194
195
196
197
198
199
200
201
202
203
204

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

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

210
211
212
	useHarmony := shouldUseHarmony(m) && !req.Raw
	var harmonyMessageHandler *harmony.HarmonyMessageHandler
	var harmonyToolParser *harmony.HarmonyToolCallAccumulator
Michael Yang's avatar
Michael Yang committed
213
	if useHarmony {
214
215
216
		harmonyMessageHandler = harmony.NewHarmonyMessageHandler()
		harmonyMessageHandler.HarmonyParser.AddImplicitStart()
		harmonyToolParser = harmonyMessageHandler.CreateToolParser()
Michael Yang's avatar
Michael Yang committed
217
218
219
220
	}

	// Validate Think value: string values currently only allowed for gptoss models
	if req.Think != nil && req.Think.IsString() && !useHarmony {
221
		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
222
223
224
		return
	}

225
	caps := []model.Capability{model.CapabilityCompletion}
226
	if req.Suffix != "" {
227
		caps = append(caps, model.CapabilityInsert)
228
	}
229
	if req.Think != nil && req.Think.Bool() {
230
231
232
233
234
235
		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
	}
236

237
	r, m, opts, err := s.scheduleRunner(c.Request.Context(), name.String(), caps, req.Options, req.KeepAlive)
Michael Yang's avatar
Michael Yang committed
238
239
240
241
	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
242
243
244
245
		handleScheduleError(c, req.Model, err)
		return
	}

246
247
	checkpointLoaded := time.Now()

248
	// load the model
Michael Yang's avatar
Michael Yang committed
249
250
251
252
253
254
255
	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
256
257
		return
	}
Bruce MacDonald's avatar
Bruce MacDonald committed
258

259
260
	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"})
261
262
263
		return
	}

Michael Yang's avatar
Michael Yang committed
264
265
	images := make([]llm.ImageData, len(req.Images))
	for i := range req.Images {
266
		images[i] = llm.ImageData{ID: i, Data: req.Images[i]}
Michael Yang's avatar
Michael Yang committed
267
	}
Bruce MacDonald's avatar
Bruce MacDonald committed
268

Michael Yang's avatar
Michael Yang committed
269
270
	prompt := req.Prompt
	if !req.Raw {
Michael Yang's avatar
Michael Yang committed
271
		tmpl := m.Template
Michael Yang's avatar
Michael Yang committed
272
273
274
275
276
277
278
279
		if req.Template != "" {
			tmpl, err = template.Parse(req.Template)
			if err != nil {
				c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
				return
			}
		}

280
281
282
283
284
285
286
287
288
289
290
291
		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
292
293
294
295
			if req.Context == nil {
				msgs = append(msgs, m.Messages...)
			}

296
			for _, i := range images {
297
298
				imgPrompt := ""
				msgs = append(msgs, api.Message{Role: "user", Content: fmt.Sprintf("[img-%d]"+imgPrompt, i.ID)})
299
300
301
302
303
			}

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

304
		values.Think = req.Think != nil && req.Think.Bool()
Michael Yang's avatar
Michael Yang committed
305
306
		values.ThinkLevel = ""
		if req.Think != nil {
307
			values.ThinkLevel = req.Think.String()
Michael Yang's avatar
Michael Yang committed
308
		}
309
310
		values.IsThinkSet = req.Think != nil

Michael Yang's avatar
Michael Yang committed
311
312
		var b bytes.Buffer
		if req.Context != nil {
313
			slog.Warn("the context field is deprecated and will be removed in a future version of Ollama")
314
			s, err := r.Detokenize(c.Request.Context(), req.Context)
Michael Yang's avatar
Michael Yang committed
315
316
317
318
			if err != nil {
				c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
				return
			}
319
			b.WriteString(s)
Michael Yang's avatar
Michael Yang committed
320
		}
321
322
323
324
325
326
327

		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
328
329
	}

330
331
332
333
334
335
336
337
338
339
340
341
342
	// If debug mode is enabled, return the rendered template instead of calling the model
	if req.DebugRenderOnly {
		c.JSON(http.StatusOK, api.DebugTemplateResponse{
			Model:     req.Model,
			CreatedAt: time.Now().UTC(),
			DebugInfo: api.DebugInfo{
				RenderedTemplate: prompt,
				ImageCount:       len(images),
			},
		})
		return
	}

343
	var thinkingState *thinking.Parser
Michael Yang's avatar
Michael Yang committed
344
345
	if !useHarmony {
		openingTag, closingTag := thinking.InferTags(m.Template.Template)
346
		if req.Think != nil && req.Think.Bool() && openingTag != "" && closingTag != "" {
Michael Yang's avatar
Michael Yang committed
347
348
349
350
			thinkingState = &thinking.Parser{
				OpeningTag: openingTag,
				ClosingTag: closingTag,
			}
351
352
353
		}
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
354
355
	ch := make(chan any)
	go func() {
356
357
		// TODO (jmorganca): avoid building the response twice both here and below
		var sb strings.Builder
Bruce MacDonald's avatar
Bruce MacDonald committed
358
		defer close(ch)
Michael Yang's avatar
Michael Yang committed
359
		if err := r.Completion(c.Request.Context(), llm.CompletionRequest{
360
361
362
363
			Prompt:  prompt,
			Images:  images,
			Format:  req.Format,
			Options: opts,
364
365
		}, func(cr llm.CompletionResponse) {
			res := api.GenerateResponse{
366
367
368
369
				Model:     req.Model,
				CreatedAt: time.Now().UTC(),
				Response:  cr.Content,
				Done:      cr.Done,
Bruce MacDonald's avatar
Bruce MacDonald committed
370
				Metrics: api.Metrics{
371
372
373
374
					PromptEvalCount:    cr.PromptEvalCount,
					PromptEvalDuration: cr.PromptEvalDuration,
					EvalCount:          cr.EvalCount,
					EvalDuration:       cr.EvalDuration,
Bruce MacDonald's avatar
Bruce MacDonald committed
375
				},
Bruce MacDonald's avatar
Bruce MacDonald committed
376
			}
377

Michael Yang's avatar
Michael Yang committed
378
			if useHarmony {
379
380
381
382
383
				content, thinking, toolContent := harmonyMessageHandler.AddContent(cr.Content, harmonyToolParser)
				res.Response = content
				res.Thinking = thinking
				harmonyToolParser.Add(toolContent)
			} else if thinkingState != nil {
Devon Rifkin's avatar
Devon Rifkin committed
384
				thinking, content := thinkingState.AddContent(cr.Content)
385
386
387
388
				res.Thinking = thinking
				res.Response = content
			}

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

			if cr.Done {
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
				if useHarmony {
					toolName, toolContent := harmonyToolParser.Drain()
					if toolName != nil {
						*toolName = strings.TrimPrefix(*toolName, "functions.")
						var args api.ToolCallFunctionArguments
						if err := json.Unmarshal([]byte(toolContent), &args); err != nil {
							errStr := fmt.Sprintf("error parsing tool call: raw='%s', err=%s", toolContent, err.Error())
							ch <- gin.H{"error": errStr}
							return
						}

						res.ToolCalls = append(res.ToolCalls, api.ToolCall{
							Function: api.ToolCallFunction{
								Name:      *toolName,
								Arguments: args,
							},
						})
					}
				}

				res.DoneReason = cr.DoneReason.String()
				res.TotalDuration = time.Since(checkpointStart)
				res.LoadDuration = checkpointLoaded.Sub(checkpointStart)

418
				if !req.Raw {
419
					tokens, err := r.Tokenize(c.Request.Context(), prompt+sb.String())
420
421
422
423
					if err != nil {
						ch <- gin.H{"error": err.Error()}
						return
					}
424
					res.Context = tokens
425
426
427
				}
			}

Michael Yang's avatar
Michael Yang committed
428
429
430
431
432
433
434
435
436
			if useHarmony {
				// only send messages with meaningful content (empty messages confuse clients)
				if res.Response != "" || res.Thinking != "" || res.Done || len(res.ToolCalls) > 0 {
					ch <- res
				}

				return
			}

437
			ch <- res
Michael Yang's avatar
Michael Yang committed
438
		}); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
439
440
441
442
443
			ch <- gin.H{"error": err.Error()}
		}
	}()

	if req.Stream != nil && !*req.Stream {
Michael Yang's avatar
Michael Yang committed
444
		var r api.GenerateResponse
445
446
		var sbThinking strings.Builder
		var sbContent strings.Builder
Michael Yang's avatar
Michael Yang committed
447
448
		for rr := range ch {
			switch t := rr.(type) {
449
			case api.GenerateResponse:
450
451
				sbThinking.WriteString(t.Thinking)
				sbContent.WriteString(t.Response)
Michael Yang's avatar
Michael Yang committed
452
				r = t
453
			case gin.H:
Michael Yang's avatar
Michael Yang committed
454
455
456
				msg, ok := t["error"].(string)
				if !ok {
					msg = "unexpected error format in response"
457
				}
Michael Yang's avatar
Michael Yang committed
458
459
460

				c.JSON(http.StatusInternalServerError, gin.H{"error": msg})
				return
461
			default:
Michael Yang's avatar
Michael Yang committed
462
				c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected response"})
Bruce MacDonald's avatar
Bruce MacDonald committed
463
464
465
				return
			}
		}
466

467
468
469
		r.Thinking = sbThinking.String()
		r.Response = sbContent.String()

Michael Yang's avatar
Michael Yang committed
470
		c.JSON(http.StatusOK, r)
Bruce MacDonald's avatar
Bruce MacDonald committed
471
472
473
474
475
476
		return
	}

	streamResponse(c, ch)
}

477
func (s *Server) EmbedHandler(c *gin.Context) {
478
	checkpointStart := time.Now()
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
	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:
511
512
513
514
		if req.Input != nil {
			c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "invalid input type"})
			return
		}
515
516
	}

517
518
519
520
521
522
	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
	}

523
	r, m, opts, err := s.scheduleRunner(c.Request.Context(), name.String(), []model.Capability{}, req.Options, req.KeepAlive)
524
525
526
527
528
	if err != nil {
		handleScheduleError(c, req.Model, err)
		return
	}

529
530
	checkpointLoaded := time.Now()

531
532
533
534
535
	if len(input) == 0 {
		c.JSON(http.StatusOK, api.EmbedResponse{Model: req.Model, Embeddings: [][]float32{}})
		return
	}

536
	kvData, _, err := getModelData(m.ModelPath, false)
537
538
539
540
541
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

542
	var count int
543
544
545
546
547
548
549
550
551
552
553
554
555
556
	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 {
				c.JSON(http.StatusBadRequest, gin.H{"error": "input length exceeds maximum context length"})
				return
			}

557
558
559
560
561
562
563
564
			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--
			}

565
			tokens = tokens[:ctxLen]
566

567
568
569
570
571
572
573
			s, err = r.Detokenize(c.Request.Context(), tokens)
			if err != nil {
				c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
				return
			}
		}

574
575
		count += len(tokens)

576
577
		input[i] = s
	}
578
579
580
581
582
583
584
585
586

	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
			}
587
588
589
590
591
592
			// 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
593
594
			return nil
		})
595
596
	}

597
	if err := g.Wait(); err != nil {
598
		c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": strings.TrimSpace(err.Error())})
599
		return
600
601
602
	}

	resp := api.EmbedResponse{
603
		Model:           req.Model,
604
		Embeddings:      embeddings,
605
606
		TotalDuration:   time.Since(checkpointStart),
		LoadDuration:    checkpointLoaded.Sub(checkpointStart),
607
		PromptEvalCount: count,
608
609
610
611
612
613
614
615
616
617
	}
	c.JSON(http.StatusOK, resp)
}

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

618
	norm := float32(1.0 / max(math.Sqrt(float64(sum)), 1e-12))
619
620
621
622
623
624
	for i := range vec {
		vec[i] *= norm
	}
	return vec
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
625
func (s *Server) EmbeddingsHandler(c *gin.Context) {
Bruce MacDonald's avatar
Bruce MacDonald committed
626
	var req api.EmbeddingRequest
Michael Yang's avatar
Michael Yang committed
627
	if err := c.ShouldBindJSON(&req); errors.Is(err, io.EOF) {
Bruce MacDonald's avatar
Bruce MacDonald committed
628
629
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
630
	} else if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
631
632
633
634
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

635
636
637
638
639
640
	name := model.ParseName(req.Model)
	if !name.IsValid() {
		c.JSON(http.StatusBadRequest, gin.H{"error": "model is required"})
		return
	}

641
	r, _, _, err := s.scheduleRunner(c.Request.Context(), name.String(), []model.Capability{}, req.Options, req.KeepAlive)
Bruce MacDonald's avatar
Bruce MacDonald committed
642
	if err != nil {
Michael Yang's avatar
Michael Yang committed
643
		handleScheduleError(c, req.Model, err)
Bruce MacDonald's avatar
Bruce MacDonald committed
644
645
646
		return
	}

647
648
649
	// an empty request loads the model
	if req.Prompt == "" {
		c.JSON(http.StatusOK, api.EmbeddingResponse{Embedding: []float64{}})
Bruce MacDonald's avatar
Bruce MacDonald committed
650
651
652
		return
	}

653
	embedding, err := r.Embedding(c.Request.Context(), req.Prompt)
Bruce MacDonald's avatar
Bruce MacDonald committed
654
	if err != nil {
655
		c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": strings.TrimSpace(err.Error())})
Bruce MacDonald's avatar
Bruce MacDonald committed
656
657
658
		return
	}

659
660
661
	var e []float64
	for _, v := range embedding {
		e = append(e, float64(v))
662
663
664
	}

	resp := api.EmbeddingResponse{
665
		Embedding: e,
666
667
	}
	c.JSON(http.StatusOK, resp)
Bruce MacDonald's avatar
Bruce MacDonald committed
668
669
}

670
func (s *Server) PullHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
671
	var req api.PullRequest
Michael Yang's avatar
Michael Yang committed
672
673
674
675
676
677
678
	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
679
680
681
		return
	}

682
683
	name := model.ParseName(cmp.Or(req.Model, req.Name))
	if !name.IsValid() {
684
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": errtypes.InvalidModelNameErrMsg})
685
686
687
		return
	}

688
689
	name, err = getExistingName(name)
	if err != nil {
690
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
691
692
693
		return
	}

694
695
696
	ch := make(chan any)
	go func() {
		defer close(ch)
697
698
		fn := func(r api.ProgressResponse) {
			ch <- r
699
		}
700

Michael Yang's avatar
Michael Yang committed
701
		regOpts := &registryOptions{
702
703
704
			Insecure: req.Insecure,
		}

705
706
707
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

708
		if err := PullModel(ctx, name.DisplayShortest(), regOpts, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
709
			ch <- gin.H{"error": err.Error()}
710
711
712
		}
	}()

713
714
715
716
717
	if req.Stream != nil && !*req.Stream {
		waitForStream(c, ch)
		return
	}

718
719
720
	streamResponse(c, ch)
}

721
func (s *Server) PushHandler(c *gin.Context) {
722
	var req api.PushRequest
Michael Yang's avatar
Michael Yang committed
723
724
725
726
727
728
729
	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
730
731
		return
	}
Michael Yang's avatar
Michael Yang committed
732

733
	var mname string
Michael Yang's avatar
Michael Yang committed
734
	if req.Model != "" {
735
		mname = req.Model
Michael Yang's avatar
Michael Yang committed
736
	} else if req.Name != "" {
737
		mname = req.Name
Michael Yang's avatar
Michael Yang committed
738
739
	} else {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
740
741
742
		return
	}

743
744
745
	ch := make(chan any)
	go func() {
		defer close(ch)
746
747
		fn := func(r api.ProgressResponse) {
			ch <- r
748
		}
749

Michael Yang's avatar
Michael Yang committed
750
		regOpts := &registryOptions{
751
752
753
			Insecure: req.Insecure,
		}

Michael Yang's avatar
Michael Yang committed
754
755
756
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

757
758
759
760
761
762
763
		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
764
			ch <- gin.H{"error": err.Error()}
765
766
767
		}
	}()

768
769
770
771
772
	if req.Stream != nil && !*req.Stream {
		waitForStream(c, ch)
		return
	}

773
774
775
	streamResponse(c, ch)
}

776
777
778
779
// 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.
780
781
782
func getExistingName(n model.Name) (model.Name, error) {
	var zero model.Name
	existing, err := Manifests(true)
783
	if err != nil {
784
		return zero, err
785
	}
786
	var set model.Name // tracks parts already canonicalized
787
	for e := range existing {
788
789
790
791
792
793
794
795
796
797
798
		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
799
800
		}
	}
801
	return n, nil
802
803
}

804
func (s *Server) DeleteHandler(c *gin.Context) {
805
806
	var r api.DeleteRequest
	if err := c.ShouldBindJSON(&r); errors.Is(err, io.EOF) {
Michael Yang's avatar
Michael Yang committed
807
808
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
809
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
810
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
811
812
813
		return
	}

814
815
816
	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))})
817
818
		return
	}
Michael Yang's avatar
Michael Yang committed
819

820
821
822
823
824
825
	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
	}

826
	m, err := ParseNamedManifest(n)
Michael Yang's avatar
Michael Yang committed
827
	if err != nil {
828
829
830
831
832
833
		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
834
835
836
		return
	}

837
	if err := m.Remove(); err != nil {
Michael Yang's avatar
Michael Yang committed
838
839
840
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}
841
842
843
844
845

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

848
func (s *Server) ShowHandler(c *gin.Context) {
Patrick Devine's avatar
Patrick Devine committed
849
	var req api.ShowRequest
Michael Yang's avatar
Michael Yang committed
850
851
852
853
854
855
856
	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
857
858
859
		return
	}

Michael Yang's avatar
Michael Yang committed
860
	if req.Model != "" {
Michael Yang's avatar
Michael Yang committed
861
		// noop
Michael Yang's avatar
Michael Yang committed
862
	} else if req.Name != "" {
Michael Yang's avatar
Michael Yang committed
863
		req.Model = req.Name
Michael Yang's avatar
Michael Yang committed
864
	} else {
865
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
866
867
868
		return
	}

869
	resp, err := GetModelInfo(req)
Patrick Devine's avatar
Patrick Devine committed
870
	if err != nil {
871
872
		switch {
		case os.IsNotExist(err):
Michael Yang's avatar
Michael Yang committed
873
			c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found", req.Model)})
874
		case err.Error() == errtypes.InvalidModelNameErrMsg:
875
876
			c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		default:
Patrick Devine's avatar
Patrick Devine committed
877
878
879
880
881
882
883
884
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		}
		return
	}

	c.JSON(http.StatusOK, resp)
}

885
func GetModelInfo(req api.ShowRequest) (*api.ShowResponse, error) {
886
887
	name := model.ParseName(req.Model)
	if !name.IsValid() {
CYJiang's avatar
CYJiang committed
888
		return nil, ErrModelPathInvalid
889
890
891
892
893
894
895
	}
	name, err := getExistingName(name)
	if err != nil {
		return nil, err
	}

	m, err := GetModel(name.String())
Patrick Devine's avatar
Patrick Devine committed
896
897
898
899
	if err != nil {
		return nil, err
	}

Patrick Devine's avatar
Patrick Devine committed
900
	modelDetails := api.ModelDetails{
901
902
903
904
905
906
		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
907
908
	}

909
	if req.System != "" {
910
		m.System = req.System
911
912
	}

Michael Yang's avatar
Michael Yang committed
913
914
915
	msgs := make([]api.Message, len(m.Messages))
	for i, msg := range m.Messages {
		msgs[i] = api.Message{Role: msg.Role, Content: msg.Content}
916
917
	}

918
	manifest, err := ParseNamedManifest(name)
919
920
921
922
	if err != nil {
		return nil, err
	}

Patrick Devine's avatar
Patrick Devine committed
923
	resp := &api.ShowResponse{
924
925
926
927
928
929
930
		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
931
932
933
934
	}

	var params []string
	cs := 30
935
	for k, v := range m.Options {
Patrick Devine's avatar
Patrick Devine committed
936
		switch val := v.(type) {
937
		case []any:
Patrick Devine's avatar
Patrick Devine committed
938
			for _, nv := range val {
Patrick Devine's avatar
Patrick Devine committed
939
				params = append(params, fmt.Sprintf("%-*s %#v", cs, k, nv))
Patrick Devine's avatar
Patrick Devine committed
940
			}
Patrick Devine's avatar
Patrick Devine committed
941
942
		default:
			params = append(params, fmt.Sprintf("%-*s %#v", cs, k, v))
Patrick Devine's avatar
Patrick Devine committed
943
944
945
946
		}
	}
	resp.Parameters = strings.Join(params, "\n")

Patrick Devine's avatar
Patrick Devine committed
947
948
949
950
951
	if len(req.Options) > 0 {
		if m.Options == nil {
			m.Options = make(map[string]any)
		}
		for k, v := range req.Options {
952
			m.Options[k] = v
953
954
955
		}
	}

956
	var sb strings.Builder
957
	fmt.Fprintln(&sb, "# Modelfile generated by \"ollama show\"")
958
	fmt.Fprintln(&sb, "# To build a new Modelfile based on this, replace FROM with:")
959
960
	fmt.Fprintf(&sb, "# FROM %s\n\n", m.ShortName)
	fmt.Fprint(&sb, m.String())
961
	resp.Modelfile = sb.String()
962

963
	kvData, tensors, err := getModelData(m.ModelPath, req.Verbose)
964
965
966
	if err != nil {
		return nil, err
	}
967

968
969
970
971
	delete(kvData, "general.name")
	delete(kvData, "tokenizer.chat_template")
	resp.ModelInfo = kvData

972
973
974
975
976
977
	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

978
	if len(m.ProjectorPaths) > 0 {
979
		projectorData, _, err := getModelData(m.ProjectorPaths[0], req.Verbose)
980
981
982
983
984
985
		if err != nil {
			return nil, err
		}
		resp.ProjectorInfo = projectorData
	}

Patrick Devine's avatar
Patrick Devine committed
986
987
988
	return resp, nil
}

989
func getModelData(digest string, verbose bool) (ggml.KV, ggml.Tensors, error) {
990
991
992
993
	maxArraySize := 0
	if verbose {
		maxArraySize = -1
	}
994
	data, err := llm.LoadModel(digest, maxArraySize)
995
	if err != nil {
996
		return nil, ggml.Tensors{}, err
997
998
	}

999
	kv := data.KV()
1000
1001
1002
1003
1004
1005
1006
1007
1008

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

1009
	return kv, data.Tensors(), nil
1010
1011
}

1012
func (s *Server) ListHandler(c *gin.Context) {
1013
	ms, err := Manifests(true)
Patrick Devine's avatar
Patrick Devine committed
1014
1015
1016
1017
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}
Michael Yang's avatar
Michael Yang committed
1018

1019
	models := []api.ListModelResponse{}
1020
1021
	for n, m := range ms {
		var cf ConfigV2
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034

		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
1035
		}
Michael Yang's avatar
Michael Yang committed
1036

1037
1038
		// tag should never be masked
		models = append(models, api.ListModelResponse{
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
			Model:      n.DisplayShortest(),
			Name:       n.DisplayShortest(),
			Size:       m.Size(),
			Digest:     m.digest,
			ModifiedAt: m.fi.ModTime(),
			Details: api.ModelDetails{
				Format:            cf.ModelFormat,
				Family:            cf.ModelFamily,
				Families:          cf.ModelFamilies,
				ParameterSize:     cf.ModelType,
				QuantizationLevel: cf.FileType,
			},
1051
		})
Patrick Devine's avatar
Patrick Devine committed
1052
1053
	}

1054
	slices.SortStableFunc(models, func(i, j api.ListModelResponse) int {
1055
1056
1057
1058
		// most recently modified first
		return cmp.Compare(j.ModifiedAt.Unix(), i.ModifiedAt.Unix())
	})

Michael Yang's avatar
Michael Yang committed
1059
	c.JSON(http.StatusOK, api.ListResponse{Models: models})
Patrick Devine's avatar
Patrick Devine committed
1060
1061
}

1062
func (s *Server) CopyHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
1063
1064
	var r api.CopyRequest
	if err := c.ShouldBindJSON(&r); errors.Is(err, io.EOF) {
Michael Yang's avatar
Michael Yang committed
1065
1066
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
1067
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
1068
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Patrick Devine's avatar
Patrick Devine committed
1069
1070
1071
		return
	}

Michael Yang's avatar
Michael Yang committed
1072
1073
	src := model.ParseName(r.Source)
	if !src.IsValid() {
Michael Yang's avatar
Michael Yang committed
1074
1075
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("source %q is invalid", r.Source)})
		return
1076
	}
1077
1078
1079
1080
1081
	src, err := getExistingName(src)
	if err != nil {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}
1082

Michael Yang's avatar
Michael Yang committed
1083
1084
	dst := model.ParseName(r.Destination)
	if !dst.IsValid() {
1085
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("destination %q is invalid", r.Destination)})
Patrick Devine's avatar
Patrick Devine committed
1086
1087
		return
	}
1088
1089
	dst, err = getExistingName(dst)
	if err != nil {
1090
1091
1092
1093
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

Michael Yang's avatar
Michael Yang committed
1094
1095
1096
1097
1098
	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
1099
1100
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1101
func (s *Server) HeadBlobHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
	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
1113
	c.Status(http.StatusOK)
Michael Yang's avatar
Michael Yang committed
1114
1115
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1116
func (s *Server) CreateBlobHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
1117
1118
	if ib, ok := intermediateBlobs[c.Param("digest")]; ok {
		p, err := GetBlobsPath(ib)
1119
1120
1121
1122
1123
1124
		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
1125
1126
			slog.Info("evicting intermediate blob which no longer exists", "digest", ib)
			delete(intermediateBlobs, c.Param("digest"))
1127
1128
1129
1130
1131
1132
1133
1134
1135
		} else if err != nil {
			c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
			return
		} else {
			c.Status(http.StatusOK)
			return
		}
	}

1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
	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
	}

1154
	layer, err := NewLayer(c.Request.Body, "")
Michael Yang's avatar
Michael Yang committed
1155
1156
1157
1158
1159
	if err != nil {
		c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

1160
1161
	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
1162
1163
1164
		return
	}

Michael Yang's avatar
Michael Yang committed
1165
	c.Status(http.StatusCreated)
Michael Yang's avatar
Michael Yang committed
1166
1167
}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
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
}

1189
func allowedHost(host string) bool {
1190
1191
	host = strings.ToLower(host)

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1192
	if host == "" || host == "localhost" {
1193
1194
1195
		return true
	}

1196
	if hostname, err := os.Hostname(); err == nil && host == strings.ToLower(hostname) {
1197
1198
1199
		return true
	}

Michael Yang's avatar
lint  
Michael Yang committed
1200
	tlds := []string{
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1201
1202
1203
		"localhost",
		"local",
		"internal",
1204
	}
1205

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1206
	// check if the host is a local TLD
1207
1208
1209
1210
1211
1212
	for _, tld := range tlds {
		if strings.HasSuffix(host, "."+tld) {
			return true
		}
	}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1213
	return false
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1214
}
1215

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1216
1217
1218
func allowedHostsMiddleware(addr net.Addr) gin.HandlerFunc {
	return func(c *gin.Context) {
		if addr == nil {
1219
1220
1221
1222
			c.Next()
			return
		}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1223
		if addr, err := netip.ParseAddrPort(addr.String()); err == nil && !addr.Addr().IsLoopback() {
1224
1225
1226
1227
1228
1229
1230
1231
1232
			c.Next()
			return
		}

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

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1233
		if addr, err := netip.ParseAddr(host); err == nil {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1234
			if addr.IsLoopback() || addr.IsPrivate() || addr.IsUnspecified() || isLocalIP(addr) {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1235
1236
1237
1238
1239
				c.Next()
				return
			}
		}

1240
		if allowedHost(host) {
Michael Yang's avatar
lint  
Michael Yang committed
1241
			if c.Request.Method == http.MethodOptions {
1242
1243
1244
1245
				c.AbortWithStatus(http.StatusNoContent)
				return
			}

1246
1247
1248
1249
1250
1251
			c.Next()
			return
		}

		c.AbortWithStatus(http.StatusForbidden)
	}
1252
}
1253

1254
func (s *Server) GenerateRoutes(rc *ollama.Registry) (http.Handler, error) {
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
	corsConfig := cors.DefaultConfig()
	corsConfig.AllowWildcard = true
	corsConfig.AllowBrowserExtensions = true
	corsConfig.AllowHeaders = []string{
		"Authorization",
		"Content-Type",
		"User-Agent",
		"Accept",
		"X-Requested-With",

		// OpenAI compatibility headers
1266
1267
1268
1269
1270
		"OpenAI-Beta",
		"x-stainless-arch",
		"x-stainless-async",
		"x-stainless-custom-poll-interval",
		"x-stainless-helper-method",
1271
1272
		"x-stainless-lang",
		"x-stainless-os",
1273
1274
		"x-stainless-package-version",
		"x-stainless-poll-helper",
1275
1276
1277
1278
1279
1280
		"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
1281

Bruce MacDonald's avatar
Bruce MacDonald committed
1282
	r := gin.Default()
1283
	r.HandleMethodNotAllowed = true
1284
	r.Use(
1285
		cors.New(corsConfig),
1286
		allowedHostsMiddleware(s.addr),
1287
	)
Bruce MacDonald's avatar
Bruce MacDonald committed
1288

1289
1290
1291
1292
1293
1294
	// 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}) })

1295
	// Local model cache management (new implementation is at end of function)
1296
1297
	r.POST("/api/pull", s.PullHandler)
	r.POST("/api/push", s.PushHandler)
1298
1299
	r.HEAD("/api/tags", s.ListHandler)
	r.GET("/api/tags", s.ListHandler)
1300
	r.POST("/api/show", s.ShowHandler)
1301
	r.DELETE("/api/delete", s.DeleteHandler)
1302
1303
1304

	// Create
	r.POST("/api/create", s.CreateHandler)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1305
1306
	r.POST("/api/blobs/:digest", s.CreateBlobHandler)
	r.HEAD("/api/blobs/:digest", s.HeadBlobHandler)
1307
1308
1309
	r.POST("/api/copy", s.CopyHandler)

	// Inference
1310
	r.GET("/api/ps", s.PsHandler)
1311
1312
1313
1314
	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
1315

1316
	// Inference (OpenAI compatibility)
1317
	r.POST("/v1/chat/completions", openai.ChatMiddleware(), s.ChatHandler)
1318
	r.POST("/v1/completions", openai.CompletionsMiddleware(), s.GenerateHandler)
1319
	r.POST("/v1/embeddings", openai.EmbeddingsMiddleware(), s.EmbedHandler)
1320
1321
	r.GET("/v1/models", openai.ListMiddleware(), s.ListHandler)
	r.GET("/v1/models/:model", openai.RetrieveMiddleware(), s.ShowHandler)
1322

1323
1324
1325
1326
1327
1328
	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,
1329

1330
1331
1332
			Prune: PruneLayers,
		}
		return rs, nil
1333
1334
	}

1335
	return r, nil
1336
1337
1338
}

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

1342
1343
1344
1345
1346
1347
1348
1349
	blobsDir, err := GetBlobsPath("")
	if err != nil {
		return err
	}
	if err := fixBlobs(blobsDir); err != nil {
		return err
	}

Michael Yang's avatar
bool  
Michael Yang committed
1350
	if !envconfig.NoPrune() {
1351
1352
1353
1354
1355
1356
1357
		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
			}
1358

1359
1360
1361
1362
			manifestsPath, err := GetManifestPath()
			if err != nil {
				return err
			}
1363

1364
1365
1366
			if err := PruneDirectory(manifestsPath); err != nil {
				return err
			}
1367
1368
1369
		}
	}

1370
1371
	s := &Server{addr: ln.Addr()}

1372
1373
1374
1375
1376
1377
1378
	var rc *ollama.Registry
	if useClient2 {
		var err error
		rc, err = ollama.DefaultRegistry()
		if err != nil {
			return err
		}
1379
1380
	}

1381
	h, err := s.GenerateRoutes(rc)
1382
1383
1384
	if err != nil {
		return err
	}
1385

1386
1387
	http.Handle("/", h)

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1388
	ctx, done := context.WithCancel(context.Background())
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1389
1390
	schedCtx, schedDone := context.WithCancel(ctx)
	sched := InitScheduler(schedCtx)
1391
	s.sched = sched
1392

1393
	slog.Info(fmt.Sprintf("Listening on %s (version %s)", ln.Addr(), version.Version))
1394
	srvr := &http.Server{
1395
1396
1397
1398
1399
1400
1401
1402
1403
		// 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
1404
1405
	}

1406
1407
	// listen for a ctrl+c and stop any loaded llm
	signals := make(chan os.Signal, 1)
1408
	signal.Notify(signals, syscall.SIGINT, syscall.SIGTERM)
1409
1410
	go func() {
		<-signals
1411
		srvr.Close()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1412
		schedDone()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1413
		sched.unloadAllRunners()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1414
		done()
1415
1416
	}()

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1417
	s.sched.Run(schedCtx)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1418

1419
1420
1421
1422
	// 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
1423
1424
	// 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
1425
	gpus := discover.GetGPUInfo()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1426
	gpus.LogDetails()
1427

1428
1429
1430
1431
1432
1433
1434
1435
1436
	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
1437
1438
1439
1440
1441
1442
1443
	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()
1444
	return nil
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1445
}
Michael Yang's avatar
Michael Yang committed
1446

1447
func waitForStream(c *gin.Context, ch chan any) {
1448
	c.Header("Content-Type", "application/json")
1449
	var latest api.ProgressResponse
1450
1451
1452
	for resp := range ch {
		switch r := resp.(type) {
		case api.ProgressResponse:
1453
			latest = r
1454
		case gin.H:
Josh's avatar
Josh committed
1455
1456
1457
1458
			status, ok := r["status"].(int)
			if !ok {
				status = http.StatusInternalServerError
			}
1459
1460
1461
			errorMsg, ok := r["error"].(string)
			if !ok {
				errorMsg = "unknown error"
1462
			}
1463
1464
			c.JSON(status, gin.H{"error": errorMsg})
			return
1465
		default:
1466
			c.JSON(http.StatusInternalServerError, gin.H{"error": "unknown message type"})
1467
1468
1469
			return
		}
	}
1470
1471

	c.JSON(http.StatusOK, latest)
1472
1473
}

Michael Yang's avatar
Michael Yang committed
1474
func streamResponse(c *gin.Context, ch chan any) {
1475
	c.Header("Content-Type", "application/x-ndjson")
Michael Yang's avatar
Michael Yang committed
1476
1477
1478
1479
1480
1481
1482
1483
	c.Stream(func(w io.Writer) bool {
		val, ok := <-ch
		if !ok {
			return false
		}

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

1488
		// Delineate chunks with new-line delimiter
Michael Yang's avatar
Michael Yang committed
1489
1490
		bts = append(bts, '\n')
		if _, err := w.Write(bts); err != nil {
1491
			slog.Info(fmt.Sprintf("streamResponse: w.Write failed with %s", err))
Michael Yang's avatar
Michael Yang committed
1492
1493
1494
1495
1496
1497
			return false
		}

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

1499
func (s *Server) PsHandler(c *gin.Context) {
1500
	models := []api.ProcessModelResponse{}
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511

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

1512
		mr := api.ProcessModelResponse{
1513
1514
			Model:     model.ShortName,
			Name:      model.ShortName,
Jesse Gross's avatar
Jesse Gross committed
1515
1516
			Size:      int64(v.totalSize),
			SizeVRAM:  int64(v.vramSize),
1517
1518
1519
1520
			Digest:    model.Digest,
			Details:   modelDetails,
			ExpiresAt: v.expiresAt,
		}
1521
		if v.Options != nil {
Jesse Gross's avatar
Jesse Gross committed
1522
			mr.ContextLength = v.Options.NumCtx
1523
		}
1524
1525
1526
1527
1528
1529
1530
1531
		// 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)
		}

1532
1533
1534
		models = append(models, mr)
	}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1535
1536
1537
1538
1539
	slices.SortStableFunc(models, func(i, j api.ProcessModelResponse) int {
		// longest duration remaining listed first
		return cmp.Compare(j.ExpiresAt.Unix(), i.ExpiresAt.Unix())
	})

1540
	c.JSON(http.StatusOK, api.ProcessResponse{Models: models})
1541
1542
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1543
func (s *Server) ChatHandler(c *gin.Context) {
1544
1545
	checkpointStart := time.Now()

Bruce MacDonald's avatar
Bruce MacDonald committed
1546
	var req api.ChatRequest
Michael Yang's avatar
Michael Yang committed
1547
	if err := c.ShouldBindJSON(&req); errors.Is(err, io.EOF) {
Bruce MacDonald's avatar
Bruce MacDonald committed
1548
1549
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
1550
	} else if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1551
1552
1553
1554
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

Patrick Devine's avatar
Patrick Devine committed
1555
	// expire the runner
Michael Yang's avatar
Michael Yang committed
1556
	if len(req.Messages) == 0 && req.KeepAlive != nil && req.KeepAlive.Duration == 0 {
Patrick Devine's avatar
Patrick Devine committed
1557
1558
1559
1560
1561
		model, 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)})
1562
			case err.Error() == errtypes.InvalidModelNameErrMsg:
Patrick Devine's avatar
Patrick Devine committed
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
				c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
			default:
				c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
			}
			return
		}
		s.sched.expireRunner(model)

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

1581
	caps := []model.Capability{model.CapabilityCompletion}
1582
	if len(req.Tools) > 0 {
1583
		caps = append(caps, model.CapabilityTools)
Michael Yang's avatar
tools  
Michael Yang committed
1584
	}
1585
	if req.Think != nil && req.Think.Bool() {
1586
1587
		caps = append(caps, model.CapabilityThinking)
	}
Michael Yang's avatar
tools  
Michael Yang committed
1588

1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
	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
	}

	r, m, opts, err := s.scheduleRunner(c.Request.Context(), name.String(), caps, req.Options, req.KeepAlive)
Michael Yang's avatar
Michael Yang committed
1601
1602
	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
1603
		return
Michael Yang's avatar
Michael Yang committed
1604
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
1605
		handleScheduleError(c, req.Model, err)
Bruce MacDonald's avatar
Bruce MacDonald committed
1606
1607
		return
	}
Michael Yang's avatar
Michael Yang committed
1608

1609
1610
	checkpointLoaded := time.Now()

Michael Yang's avatar
Michael Yang committed
1611
1612
	if len(req.Messages) == 0 {
		c.JSON(http.StatusOK, api.ChatResponse{
1613
			Model:      req.Model,
Michael Yang's avatar
Michael Yang committed
1614
1615
			CreatedAt:  time.Now().UTC(),
			Message:    api.Message{Role: "assistant"},
1616
1617
			Done:       true,
			DoneReason: "load",
Michael Yang's avatar
Michael Yang committed
1618
		})
1619
1620
1621
		return
	}

Michael Yang's avatar
Michael Yang committed
1622
	msgs := append(m.Messages, req.Messages...)
1623
	if req.Messages[0].Role != "system" && m.System != "" {
Michael Yang's avatar
Michael Yang committed
1624
		msgs = append([]api.Message{{Role: "system", Content: m.System}}, msgs...)
1625
	}
1626
	msgs = filterThinkTags(msgs, m)
1627

1628
1629
1630
1631
	var harmonyMessageHandler *harmony.HarmonyMessageHandler
	var harmonyToolParser *harmony.HarmonyToolCallAccumulator

	useHarmony := shouldUseHarmony(m)
1632
1633
1634

	processedTools := req.Tools
	if useHarmony {
1635
1636
1637
1638
1639
1640
1641
1642
		harmonyMessageHandler = harmony.NewHarmonyMessageHandler()
		var lastMessage *api.Message
		if len(msgs) > 0 {
			lastMessage = &msgs[len(msgs)-1]
		}
		harmonyMessageHandler.HarmonyParser.AddImplicitStartOrPrefill(lastMessage)
		harmonyToolParser = harmonyMessageHandler.CreateToolParser()

1643
1644
1645
1646
1647
		// make a copy of tools to pass to the chat prompt. Function names may be
		// renamed to be valid Harmony function names.
		processedTools = make([]api.Tool, len(req.Tools))
		copy(processedTools, req.Tools)
		for i, tool := range processedTools {
1648
			processedTools[i].Function.Name = harmonyMessageHandler.FunctionNameMap.ConvertAndAdd(tool.Function.Name)
1649
1650
1651
1652
		}
	}

	prompt, images, err := chatPrompt(c.Request.Context(), m, r.Tokenize, opts, msgs, processedTools, req.Think)
Michael Yang's avatar
Michael Yang committed
1653
	if err != nil {
1654
		slog.Error("chat prompt error", "error", err)
Michael Yang's avatar
Michael Yang committed
1655
1656
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
1657
1658
	}

1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
	// If debug mode is enabled, return the rendered template instead of calling the model
	if req.DebugRenderOnly {
		c.JSON(http.StatusOK, api.DebugTemplateResponse{
			Model:     req.Model,
			CreatedAt: time.Now().UTC(),
			DebugInfo: api.DebugInfo{
				RenderedTemplate: prompt,
				ImageCount:       len(images),
			},
		})
		return
	}

Michael Yang's avatar
Michael Yang committed
1672
1673
	// Validate Think value: string values currently only allowed for gptoss models
	if req.Think != nil && req.Think.IsString() && !useHarmony {
1674
		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
1675
1676
1677
		return
	}

1678
1679
	var thinkingState *thinking.Parser
	openingTag, closingTag := thinking.InferTags(m.Template.Template)
1680
	if req.Think != nil && req.Think.Bool() && openingTag != "" && closingTag != "" {
1681
		thinkingState = &thinking.Parser{
Devon Rifkin's avatar
Devon Rifkin committed
1682
1683
			OpeningTag: openingTag,
			ClosingTag: closingTag,
1684
		}
1685
1686
1687
1688

		if strings.HasSuffix(strings.TrimSpace(prompt), openingTag) {
			thinkingState.AddContent(openingTag)
		}
1689
1690
	}

1691
	var toolParser *tools.Parser
Michael Yang's avatar
Michael Yang committed
1692
	if len(req.Tools) > 0 && !useHarmony {
1693
		toolParser = tools.NewParser(m.Template.Template, req.Tools)
1694
1695
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
1696
1697
1698
	ch := make(chan any)
	go func() {
		defer close(ch)
1699

Michael Yang's avatar
Michael Yang committed
1700
		if err := r.Completion(c.Request.Context(), llm.CompletionRequest{
1701
1702
1703
1704
			Prompt:  prompt,
			Images:  images,
			Format:  req.Format,
			Options: opts,
Michael Yang's avatar
Michael Yang committed
1705
		}, func(r llm.CompletionResponse) {
1706
			res := api.ChatResponse{
1707
1708
				Model:     req.Model,
				CreatedAt: time.Now().UTC(),
1709
				Message:   api.Message{Role: "assistant", Content: r.Content},
1710
				Done:      r.Done,
Bruce MacDonald's avatar
Bruce MacDonald committed
1711
1712
1713
1714
1715
1716
1717
				Metrics: api.Metrics{
					PromptEvalCount:    r.PromptEvalCount,
					PromptEvalDuration: r.PromptEvalDuration,
					EvalCount:          r.EvalCount,
					EvalDuration:       r.EvalDuration,
				},
			}
Michael Yang's avatar
Michael Yang committed
1718
1719
1720
1721
1722
1723
1724
			if r.Done {
				res.DoneReason = r.DoneReason.String()
				res.TotalDuration = time.Since(checkpointStart)
				res.LoadDuration = checkpointLoaded.Sub(checkpointStart)
			}

			if useHarmony {
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
				content, thinking, toolContent := harmonyMessageHandler.AddContent(r.Content, harmonyToolParser)
				res.Message.Content = content
				res.Message.Thinking = thinking
				harmonyToolParser.Add(toolContent)

				if r.Done {
					toolName, toolContent := harmonyToolParser.Drain()
					if toolName != nil {
						*toolName = strings.TrimPrefix(*toolName, "functions.")
						*toolName = harmonyMessageHandler.FunctionNameMap.OriginalFromConverted(*toolName)
						var args api.ToolCallFunctionArguments
						if err := json.Unmarshal([]byte(toolContent), &args); err != nil {
							errStr := fmt.Sprintf("error parsing tool call: raw='%s', err=%s", toolContent, err.Error())
							ch <- gin.H{"error": errStr}
							return
						}
						res.Message.ToolCalls = []api.ToolCall{{Function: api.ToolCallFunction{Name: *toolName, Arguments: args}}}
					}
Michael Yang's avatar
Michael Yang committed
1743
				}
1744

Michael Yang's avatar
Michael Yang committed
1745
1746
1747
1748
				// only send messages with meaningful content (empty messages confuse clients)
				if res.Message.Content != "" || res.Message.Thinking != "" || len(res.Message.ToolCalls) > 0 || res.Done {
					ch <- res
				}
1749

Michael Yang's avatar
Michael Yang committed
1750
1751
				return
			}
1752

1753
			if thinkingState != nil {
Devon Rifkin's avatar
Devon Rifkin committed
1754
				thinkingContent, remainingContent := thinkingState.AddContent(res.Message.Content)
1755
1756
1757
1758
1759
1760
1761
1762
				if thinkingContent == "" && remainingContent == "" && !r.Done {
					// need to accumulate more to decide what to send
					return
				}
				res.Message.Content = remainingContent
				res.Message.Thinking = thinkingContent
			}

1763
			if len(req.Tools) > 0 {
1764
				toolCalls, content := toolParser.Add(res.Message.Content)
1765
1766
1767
1768
1769
				if len(content) > 0 {
					res.Message.Content = content
				} else if len(toolCalls) > 0 {
					res.Message.ToolCalls = toolCalls
					res.Message.Content = ""
1770
1771
				} else if res.Message.Thinking != "" {
					// don't return
1772
1773
				} else {
					if r.Done {
1774
						res.Message.Content = toolParser.Content()
1775
1776
1777
						ch <- res
					}
					return
1778
1779
				}
			}
1780

1781
			ch <- res
Michael Yang's avatar
Michael Yang committed
1782
		}); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1783
1784
1785
1786
1787
			ch <- gin.H{"error": err.Error()}
		}
	}()

	if req.Stream != nil && !*req.Stream {
Michael Yang's avatar
tools  
Michael Yang committed
1788
		var resp api.ChatResponse
1789
		var toolCalls []api.ToolCall
1790
1791
		var sbThinking strings.Builder
		var sbContent strings.Builder
Michael Yang's avatar
Michael Yang committed
1792
1793
		for rr := range ch {
			switch t := rr.(type) {
1794
			case api.ChatResponse:
1795
1796
				sbThinking.WriteString(t.Message.Thinking)
				sbContent.WriteString(t.Message.Content)
Michael Yang's avatar
tools  
Michael Yang committed
1797
				resp = t
1798
1799
1800
				if len(req.Tools) > 0 {
					toolCalls = append(toolCalls, t.Message.ToolCalls...)
				}
1801
			case gin.H:
Michael Yang's avatar
Michael Yang committed
1802
1803
1804
				msg, ok := t["error"].(string)
				if !ok {
					msg = "unexpected error format in response"
1805
				}
Michael Yang's avatar
Michael Yang committed
1806
1807
1808

				c.JSON(http.StatusInternalServerError, gin.H{"error": msg})
				return
1809
			default:
Michael Yang's avatar
Michael Yang committed
1810
				c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected response"})
1811
				return
Bruce MacDonald's avatar
Bruce MacDonald committed
1812
1813
			}
		}
1814

1815
1816
1817
		resp.Message.Content = sbContent.String()
		resp.Message.Thinking = sbThinking.String()

1818
1819
		if len(toolCalls) > 0 {
			resp.Message.ToolCalls = toolCalls
Michael Yang's avatar
tools  
Michael Yang committed
1820
1821
1822
		}

		c.JSON(http.StatusOK, resp)
Bruce MacDonald's avatar
Bruce MacDonald committed
1823
1824
1825
1826
1827
		return
	}

	streamResponse(c, ch)
}
1828

Michael Yang's avatar
Michael Yang committed
1829
func handleScheduleError(c *gin.Context, name string, err error) {
Michael Yang's avatar
Michael Yang committed
1830
	switch {
1831
	case errors.Is(err, errCapabilities), errors.Is(err, errRequired):
Michael Yang's avatar
Michael Yang committed
1832
		c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Michael Yang's avatar
Michael Yang committed
1833
	case errors.Is(err, context.Canceled):
1834
		c.JSON(499, gin.H{"error": "request canceled"})
Michael Yang's avatar
Michael Yang committed
1835
	case errors.Is(err, ErrMaxQueue):
1836
		c.JSON(http.StatusServiceUnavailable, gin.H{"error": err.Error()})
Michael Yang's avatar
Michael Yang committed
1837
1838
	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
1839
1840
	default:
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
1841
1842
	}
}
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854

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 {
1855
1856
1857
1858
1859
				// 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.
1860
				thinkingState := &thinking.Parser{
Devon Rifkin's avatar
Devon Rifkin committed
1861
1862
					OpeningTag: "<think>",
					ClosingTag: "</think>",
1863
				}
Devon Rifkin's avatar
Devon Rifkin committed
1864
				_, content := thinkingState.AddContent(msg.Content)
1865
				msgs[i].Content = content
1866
1867
1868
1869
1870
			}
		}
	}
	return msgs
}