routes.go 47.4 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
func experimentEnabled(name string) bool {
	return slices.Contains(strings.Split(os.Getenv("OLLAMA_EXPERIMENT"), ","), name)
}

var useClient2 = experimentEnabled("client2")

55
56
57
58
// 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
59
60
var mode string = gin.DebugMode

61
type Server struct {
62
63
64
	addr    net.Addr
	sched   *Scheduler
	lowVRAM bool
65
66
}

Michael Yang's avatar
Michael Yang committed
67
68
69
70
71
72
73
74
75
76
77
78
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
79
80
81
82
var (
	errRequired    = errors.New("is required")
	errBadTemplate = errors.New("template error")
)
Michael Yang's avatar
Michael Yang committed
83

84
func modelOptions(model *Model, requestOpts map[string]any) (api.Options, error) {
85
86
87
88
89
90
91
92
93
94
	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
95
96
}

Michael Yang's avatar
Michael Yang committed
97
98
// 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.
99
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
100
	if name == "" {
Michael Yang's avatar
Michael Yang committed
101
		return nil, nil, nil, fmt.Errorf("model %w", errRequired)
Bruce MacDonald's avatar
Bruce MacDonald committed
102
103
	}

Michael Yang's avatar
Michael Yang committed
104
	model, err := GetModel(name)
Bruce MacDonald's avatar
Bruce MacDonald committed
105
	if err != nil {
Michael Yang's avatar
Michael Yang committed
106
		return nil, nil, nil, err
107
108
	}

109
110
111
112
	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
113
	if err := model.CheckCapabilities(caps...); err != nil {
Michael Yang's avatar
Michael Yang committed
114
		return nil, nil, nil, fmt.Errorf("%s %w", name, err)
115
116
	}

Michael Yang's avatar
Michael Yang committed
117
	opts, err := modelOptions(model, requestOpts)
118
	if err != nil {
Michael Yang's avatar
Michael Yang committed
119
		return nil, nil, nil, err
120
121
	}

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

Michael Yang's avatar
Michael Yang committed
128
	runnerCh, errCh := s.sched.GetRunner(ctx, model, opts, keepAlive)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
129
130
	var runner *runnerRef
	select {
Michael Yang's avatar
Michael Yang committed
131
132
	case runner = <-runnerCh:
	case err = <-errCh:
Michael Yang's avatar
Michael Yang committed
133
		return nil, nil, nil, err
Bruce MacDonald's avatar
Bruce MacDonald committed
134
135
	}

Michael Yang's avatar
Michael Yang committed
136
	return runner.llama, model, &opts, nil
Michael Yang's avatar
Michael Yang committed
137
138
139
}

func (s *Server) GenerateHandler(c *gin.Context) {
140
	checkpointStart := time.Now()
Michael Yang's avatar
Michael Yang committed
141
142
143
144
145
146
	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
147
148
149
		return
	}

150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
	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
	}

166
	m, err := GetModel(name.String())
167
168
	if err != nil {
		switch {
169
		case errors.Is(err, fs.ErrNotExist):
170
			c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found", req.Model)})
171
		case err.Error() == errtypes.InvalidModelNameErrMsg:
172
173
174
175
176
177
178
			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
179
	// expire the runner
Michael Yang's avatar
Michael Yang committed
180
	if req.Prompt == "" && req.KeepAlive != nil && req.KeepAlive.Duration == 0 {
181
		s.sched.expireRunner(m)
Patrick Devine's avatar
Patrick Devine committed
182
183
184
185
186
187
188
189
190
191
192

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

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

198
199
200
	useHarmony := harmony.ShouldUseHarmony(m.Config.ModelFamily, m.Template) && !req.Raw
	var functionNameMap *harmony.FunctionNameMap

Michael Yang's avatar
Michael Yang committed
201
	if useHarmony {
202
		functionNameMap = harmony.NewFunctionNameMap()
Michael Yang's avatar
Michael Yang committed
203
204
205
206
	}

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

211
	caps := []model.Capability{model.CapabilityCompletion}
212
	if req.Suffix != "" {
213
		caps = append(caps, model.CapabilityInsert)
214
	}
215
	if req.Think != nil && req.Think.Bool() {
216
217
218
219
220
221
		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
	}
222

223
	r, m, opts, err := s.scheduleRunner(c.Request.Context(), name.String(), caps, req.Options, req.KeepAlive)
Michael Yang's avatar
Michael Yang committed
224
225
226
227
	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
228
229
230
231
		handleScheduleError(c, req.Model, err)
		return
	}

232
233
	checkpointLoaded := time.Now()

234
	// load the model
Michael Yang's avatar
Michael Yang committed
235
236
237
238
239
240
241
	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
242
243
		return
	}
Bruce MacDonald's avatar
Bruce MacDonald committed
244

245
246
	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"})
247
248
249
		return
	}

Michael Yang's avatar
Michael Yang committed
250
251
	images := make([]llm.ImageData, len(req.Images))
	for i := range req.Images {
252
		images[i] = llm.ImageData{ID: i, Data: req.Images[i]}
Michael Yang's avatar
Michael Yang committed
253
	}
Bruce MacDonald's avatar
Bruce MacDonald committed
254

Michael Yang's avatar
Michael Yang committed
255
256
	prompt := req.Prompt
	if !req.Raw {
Michael Yang's avatar
Michael Yang committed
257
		tmpl := m.Template
Michael Yang's avatar
Michael Yang committed
258
259
260
261
262
263
264
265
		if req.Template != "" {
			tmpl, err = template.Parse(req.Template)
			if err != nil {
				c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
				return
			}
		}

266
267
268
269
270
271
272
273
274
275
276
277
		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
278
279
280
281
			if req.Context == nil {
				msgs = append(msgs, m.Messages...)
			}

282
			for _, i := range images {
283
284
				imgPrompt := ""
				msgs = append(msgs, api.Message{Role: "user", Content: fmt.Sprintf("[img-%d]"+imgPrompt, i.ID)})
285
286
287
288
289
			}

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

290
		values.Think = req.Think != nil && req.Think.Bool()
Michael Yang's avatar
Michael Yang committed
291
292
		values.ThinkLevel = ""
		if req.Think != nil {
293
			values.ThinkLevel = req.Think.String()
Michael Yang's avatar
Michael Yang committed
294
		}
295
296
		values.IsThinkSet = req.Think != nil

Michael Yang's avatar
Michael Yang committed
297
298
		var b bytes.Buffer
		if req.Context != nil {
299
			slog.Warn("the context field is deprecated and will be removed in a future version of Ollama")
300
			s, err := r.Detokenize(c.Request.Context(), req.Context)
Michael Yang's avatar
Michael Yang committed
301
302
303
304
			if err != nil {
				c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
				return
			}
305
			b.WriteString(s)
Michael Yang's avatar
Michael Yang committed
306
		}
307
308
309
310
311
312
313

		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
314
315
	}

316
317
318
319
320
321
322
323
324
325
326
327
328
	// 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
	}

329
	var thinkingState *thinking.Parser
Michael Yang's avatar
Michael Yang committed
330
331
	if !useHarmony {
		openingTag, closingTag := thinking.InferTags(m.Template.Template)
332
		if req.Think != nil && req.Think.Bool() && openingTag != "" && closingTag != "" {
Michael Yang's avatar
Michael Yang committed
333
334
335
336
			thinkingState = &thinking.Parser{
				OpeningTag: openingTag,
				ClosingTag: closingTag,
			}
337
338
339
		}
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
340
341
	ch := make(chan any)
	go func() {
342
343
		// TODO (jmorganca): avoid building the response twice both here and below
		var sb strings.Builder
Bruce MacDonald's avatar
Bruce MacDonald committed
344
		defer close(ch)
Michael Yang's avatar
Michael Yang committed
345
		if err := r.Completion(c.Request.Context(), llm.CompletionRequest{
346
347
348
349
			Prompt:     prompt,
			Images:     images,
			Format:     req.Format,
			Options:    opts,
350
			UseHarmony: useHarmony,
351
352
		}, func(cr llm.CompletionResponse) {
			res := api.GenerateResponse{
353
354
355
356
				Model:     req.Model,
				CreatedAt: time.Now().UTC(),
				Response:  cr.Content,
				Done:      cr.Done,
357
358
				Thinking:  cr.Thinking,
				ToolCalls: cr.ToolCalls,
Bruce MacDonald's avatar
Bruce MacDonald committed
359
				Metrics: api.Metrics{
360
361
362
363
					PromptEvalCount:    cr.PromptEvalCount,
					PromptEvalDuration: cr.PromptEvalDuration,
					EvalCount:          cr.EvalCount,
					EvalDuration:       cr.EvalDuration,
Bruce MacDonald's avatar
Bruce MacDonald committed
364
				},
Bruce MacDonald's avatar
Bruce MacDonald committed
365
			}
366

367
368
369
370
371
372
			if res.Done {
				res.DoneReason = cr.DoneReason.String()
				res.TotalDuration = time.Since(checkpointStart)
				res.LoadDuration = checkpointLoaded.Sub(checkpointStart)
			}

Michael Yang's avatar
Michael Yang committed
373
			if useHarmony {
374
375
376
377
378
379
380
381
382
				for i, tool := range res.ToolCalls {
					res.ToolCalls[i].Function.Name = functionNameMap.OriginalFromConverted(tool.Function.Name)
				}
				if res.Response != "" || res.Thinking != "" || len(res.ToolCalls) > 0 || res.Done {
					ch <- res
				}
				return
			}
			if thinkingState != nil {
Devon Rifkin's avatar
Devon Rifkin committed
383
				thinking, content := thinkingState.AddContent(cr.Content)
384
385
386
387
				res.Thinking = thinking
				res.Response = content
			}

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

			if cr.Done {
				if !req.Raw {
394
					tokens, err := r.Tokenize(c.Request.Context(), prompt+sb.String())
395
396
397
398
					if err != nil {
						ch <- gin.H{"error": err.Error()}
						return
					}
399
					res.Context = tokens
400
401
402
				}
			}

Michael Yang's avatar
Michael Yang committed
403
404
405
406
407
408
409
410
411
			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
			}

412
			ch <- res
Michael Yang's avatar
Michael Yang committed
413
		}); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
414
415
416
417
418
			ch <- gin.H{"error": err.Error()}
		}
	}()

	if req.Stream != nil && !*req.Stream {
Michael Yang's avatar
Michael Yang committed
419
		var r api.GenerateResponse
420
421
		var sbThinking strings.Builder
		var sbContent strings.Builder
Michael Yang's avatar
Michael Yang committed
422
423
		for rr := range ch {
			switch t := rr.(type) {
424
			case api.GenerateResponse:
425
426
				sbThinking.WriteString(t.Thinking)
				sbContent.WriteString(t.Response)
Michael Yang's avatar
Michael Yang committed
427
				r = t
428
			case gin.H:
Michael Yang's avatar
Michael Yang committed
429
430
431
				msg, ok := t["error"].(string)
				if !ok {
					msg = "unexpected error format in response"
432
				}
Michael Yang's avatar
Michael Yang committed
433
434
435

				c.JSON(http.StatusInternalServerError, gin.H{"error": msg})
				return
436
			default:
Michael Yang's avatar
Michael Yang committed
437
				c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected response"})
Bruce MacDonald's avatar
Bruce MacDonald committed
438
439
440
				return
			}
		}
441

442
443
444
		r.Thinking = sbThinking.String()
		r.Response = sbContent.String()

Michael Yang's avatar
Michael Yang committed
445
		c.JSON(http.StatusOK, r)
Bruce MacDonald's avatar
Bruce MacDonald committed
446
447
448
449
450
451
		return
	}

	streamResponse(c, ch)
}

452
func (s *Server) EmbedHandler(c *gin.Context) {
453
	checkpointStart := time.Now()
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
	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:
487
488
489
490
		if req.Input != nil {
			c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "invalid input type"})
			return
		}
491
492
	}

493
494
495
496
497
498
	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
	}

499
	r, m, opts, err := s.scheduleRunner(c.Request.Context(), name.String(), []model.Capability{}, req.Options, req.KeepAlive)
500
501
502
503
504
	if err != nil {
		handleScheduleError(c, req.Model, err)
		return
	}

505
506
	checkpointLoaded := time.Now()

507
508
509
510
511
	if len(input) == 0 {
		c.JSON(http.StatusOK, api.EmbedResponse{Model: req.Model, Embeddings: [][]float32{}})
		return
	}

512
	kvData, _, err := getModelData(m.ModelPath, false)
513
514
515
516
517
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

518
	var count int
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
	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
			}

			tokens = tokens[:ctxLen]
			s, err = r.Detokenize(c.Request.Context(), tokens)
			if err != nil {
				c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
				return
			}
		}

541
542
		count += len(tokens)

543
544
		input[i] = s
	}
545
546
547
548
549
550
551
552
553

	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
			}
554
555
556
557
558
559
			// 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
560
561
			return nil
		})
562
563
	}

564
	if err := g.Wait(); err != nil {
565
		c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": strings.TrimSpace(err.Error())})
566
		return
567
568
569
	}

	resp := api.EmbedResponse{
570
		Model:           req.Model,
571
		Embeddings:      embeddings,
572
573
		TotalDuration:   time.Since(checkpointStart),
		LoadDuration:    checkpointLoaded.Sub(checkpointStart),
574
		PromptEvalCount: count,
575
576
577
578
579
580
581
582
583
584
	}
	c.JSON(http.StatusOK, resp)
}

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

585
	norm := float32(1.0 / max(math.Sqrt(float64(sum)), 1e-12))
586
587
588
589
590
591
	for i := range vec {
		vec[i] *= norm
	}
	return vec
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
592
func (s *Server) EmbeddingsHandler(c *gin.Context) {
Bruce MacDonald's avatar
Bruce MacDonald committed
593
	var req api.EmbeddingRequest
Michael Yang's avatar
Michael Yang committed
594
	if err := c.ShouldBindJSON(&req); errors.Is(err, io.EOF) {
Bruce MacDonald's avatar
Bruce MacDonald committed
595
596
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
597
	} else if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
598
599
600
601
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

602
603
604
605
606
607
	name := model.ParseName(req.Model)
	if !name.IsValid() {
		c.JSON(http.StatusBadRequest, gin.H{"error": "model is required"})
		return
	}

608
	r, _, _, err := s.scheduleRunner(c.Request.Context(), name.String(), []model.Capability{}, req.Options, req.KeepAlive)
Bruce MacDonald's avatar
Bruce MacDonald committed
609
	if err != nil {
Michael Yang's avatar
Michael Yang committed
610
		handleScheduleError(c, req.Model, err)
Bruce MacDonald's avatar
Bruce MacDonald committed
611
612
613
		return
	}

614
615
616
	// an empty request loads the model
	if req.Prompt == "" {
		c.JSON(http.StatusOK, api.EmbeddingResponse{Embedding: []float64{}})
Bruce MacDonald's avatar
Bruce MacDonald committed
617
618
619
		return
	}

620
	embedding, err := r.Embedding(c.Request.Context(), req.Prompt)
Bruce MacDonald's avatar
Bruce MacDonald committed
621
	if err != nil {
622
		c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": strings.TrimSpace(err.Error())})
Bruce MacDonald's avatar
Bruce MacDonald committed
623
624
625
		return
	}

626
627
628
	var e []float64
	for _, v := range embedding {
		e = append(e, float64(v))
629
630
631
	}

	resp := api.EmbeddingResponse{
632
		Embedding: e,
633
634
	}
	c.JSON(http.StatusOK, resp)
Bruce MacDonald's avatar
Bruce MacDonald committed
635
636
}

637
func (s *Server) PullHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
638
	var req api.PullRequest
Michael Yang's avatar
Michael Yang committed
639
640
641
642
643
644
645
	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
646
647
648
		return
	}

649
650
	name := model.ParseName(cmp.Or(req.Model, req.Name))
	if !name.IsValid() {
651
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": errtypes.InvalidModelNameErrMsg})
652
653
654
		return
	}

655
656
	name, err = getExistingName(name)
	if err != nil {
657
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
658
659
660
		return
	}

661
662
663
	ch := make(chan any)
	go func() {
		defer close(ch)
664
665
		fn := func(r api.ProgressResponse) {
			ch <- r
666
		}
667

Michael Yang's avatar
Michael Yang committed
668
		regOpts := &registryOptions{
669
670
671
			Insecure: req.Insecure,
		}

672
673
674
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

675
		if err := PullModel(ctx, name.DisplayShortest(), regOpts, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
676
			ch <- gin.H{"error": err.Error()}
677
678
679
		}
	}()

680
681
682
683
684
	if req.Stream != nil && !*req.Stream {
		waitForStream(c, ch)
		return
	}

685
686
687
	streamResponse(c, ch)
}

688
func (s *Server) PushHandler(c *gin.Context) {
689
	var req api.PushRequest
Michael Yang's avatar
Michael Yang committed
690
691
692
693
694
695
696
	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
697
698
		return
	}
Michael Yang's avatar
Michael Yang committed
699

700
	var mname string
Michael Yang's avatar
Michael Yang committed
701
	if req.Model != "" {
702
		mname = req.Model
Michael Yang's avatar
Michael Yang committed
703
	} else if req.Name != "" {
704
		mname = req.Name
Michael Yang's avatar
Michael Yang committed
705
706
	} else {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
707
708
709
		return
	}

710
711
712
	ch := make(chan any)
	go func() {
		defer close(ch)
713
714
		fn := func(r api.ProgressResponse) {
			ch <- r
715
		}
716

Michael Yang's avatar
Michael Yang committed
717
		regOpts := &registryOptions{
718
719
720
			Insecure: req.Insecure,
		}

Michael Yang's avatar
Michael Yang committed
721
722
723
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

724
725
726
727
728
729
730
		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
731
			ch <- gin.H{"error": err.Error()}
732
733
734
		}
	}()

735
736
737
738
739
	if req.Stream != nil && !*req.Stream {
		waitForStream(c, ch)
		return
	}

740
741
742
	streamResponse(c, ch)
}

743
744
745
746
// 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.
747
748
749
func getExistingName(n model.Name) (model.Name, error) {
	var zero model.Name
	existing, err := Manifests(true)
750
	if err != nil {
751
		return zero, err
752
	}
753
	var set model.Name // tracks parts already canonicalized
754
	for e := range existing {
755
756
757
758
759
760
761
762
763
764
765
		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
766
767
		}
	}
768
	return n, nil
769
770
}

771
func (s *Server) DeleteHandler(c *gin.Context) {
772
773
	var r api.DeleteRequest
	if err := c.ShouldBindJSON(&r); errors.Is(err, io.EOF) {
Michael Yang's avatar
Michael Yang committed
774
775
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
776
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
777
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
778
779
780
		return
	}

781
782
783
	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))})
784
785
		return
	}
Michael Yang's avatar
Michael Yang committed
786

787
788
789
790
791
792
	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
	}

793
	m, err := ParseNamedManifest(n)
Michael Yang's avatar
Michael Yang committed
794
	if err != nil {
795
796
797
798
799
800
		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
801
802
803
		return
	}

804
	if err := m.Remove(); err != nil {
Michael Yang's avatar
Michael Yang committed
805
806
807
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}
808
809
810
811
812

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

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

Michael Yang's avatar
Michael Yang committed
827
	if req.Model != "" {
Michael Yang's avatar
Michael Yang committed
828
		// noop
Michael Yang's avatar
Michael Yang committed
829
	} else if req.Name != "" {
Michael Yang's avatar
Michael Yang committed
830
		req.Model = req.Name
Michael Yang's avatar
Michael Yang committed
831
	} else {
832
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
833
834
835
		return
	}

836
	resp, err := GetModelInfo(req)
Patrick Devine's avatar
Patrick Devine committed
837
	if err != nil {
838
839
		switch {
		case os.IsNotExist(err):
Michael Yang's avatar
Michael Yang committed
840
			c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found", req.Model)})
841
		case err.Error() == errtypes.InvalidModelNameErrMsg:
842
843
			c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		default:
Patrick Devine's avatar
Patrick Devine committed
844
845
846
847
848
849
850
851
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		}
		return
	}

	c.JSON(http.StatusOK, resp)
}

852
func GetModelInfo(req api.ShowRequest) (*api.ShowResponse, error) {
853
854
	name := model.ParseName(req.Model)
	if !name.IsValid() {
CYJiang's avatar
CYJiang committed
855
		return nil, ErrModelPathInvalid
856
857
858
859
860
861
862
	}
	name, err := getExistingName(name)
	if err != nil {
		return nil, err
	}

	m, err := GetModel(name.String())
Patrick Devine's avatar
Patrick Devine committed
863
864
865
866
	if err != nil {
		return nil, err
	}

Patrick Devine's avatar
Patrick Devine committed
867
	modelDetails := api.ModelDetails{
868
869
870
871
872
873
		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
874
875
	}

876
	if req.System != "" {
877
		m.System = req.System
878
879
	}

Michael Yang's avatar
Michael Yang committed
880
881
882
	msgs := make([]api.Message, len(m.Messages))
	for i, msg := range m.Messages {
		msgs[i] = api.Message{Role: msg.Role, Content: msg.Content}
883
884
	}

885
	manifest, err := ParseNamedManifest(name)
886
887
888
889
	if err != nil {
		return nil, err
	}

Patrick Devine's avatar
Patrick Devine committed
890
	resp := &api.ShowResponse{
891
892
893
894
895
896
897
		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
898
899
900
901
	}

	var params []string
	cs := 30
902
	for k, v := range m.Options {
Patrick Devine's avatar
Patrick Devine committed
903
		switch val := v.(type) {
904
		case []any:
Patrick Devine's avatar
Patrick Devine committed
905
			for _, nv := range val {
Patrick Devine's avatar
Patrick Devine committed
906
				params = append(params, fmt.Sprintf("%-*s %#v", cs, k, nv))
Patrick Devine's avatar
Patrick Devine committed
907
			}
Patrick Devine's avatar
Patrick Devine committed
908
909
		default:
			params = append(params, fmt.Sprintf("%-*s %#v", cs, k, v))
Patrick Devine's avatar
Patrick Devine committed
910
911
912
913
		}
	}
	resp.Parameters = strings.Join(params, "\n")

Patrick Devine's avatar
Patrick Devine committed
914
915
916
917
918
	if len(req.Options) > 0 {
		if m.Options == nil {
			m.Options = make(map[string]any)
		}
		for k, v := range req.Options {
919
			m.Options[k] = v
920
921
922
		}
	}

923
	var sb strings.Builder
924
	fmt.Fprintln(&sb, "# Modelfile generated by \"ollama show\"")
925
	fmt.Fprintln(&sb, "# To build a new Modelfile based on this, replace FROM with:")
926
927
	fmt.Fprintf(&sb, "# FROM %s\n\n", m.ShortName)
	fmt.Fprint(&sb, m.String())
928
	resp.Modelfile = sb.String()
929

930
	kvData, tensors, err := getModelData(m.ModelPath, req.Verbose)
931
932
933
	if err != nil {
		return nil, err
	}
934

935
936
937
938
	delete(kvData, "general.name")
	delete(kvData, "tokenizer.chat_template")
	resp.ModelInfo = kvData

939
940
941
942
943
944
	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

945
	if len(m.ProjectorPaths) > 0 {
946
		projectorData, _, err := getModelData(m.ProjectorPaths[0], req.Verbose)
947
948
949
950
951
952
		if err != nil {
			return nil, err
		}
		resp.ProjectorInfo = projectorData
	}

Patrick Devine's avatar
Patrick Devine committed
953
954
955
	return resp, nil
}

956
func getModelData(digest string, verbose bool) (ggml.KV, ggml.Tensors, error) {
957
958
959
960
	maxArraySize := 0
	if verbose {
		maxArraySize = -1
	}
961
	data, err := llm.LoadModel(digest, maxArraySize)
962
	if err != nil {
963
		return nil, ggml.Tensors{}, err
964
965
	}

966
	kv := data.KV()
967
968
969
970
971
972
973
974
975

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

976
	return kv, data.Tensors(), nil
977
978
}

979
func (s *Server) ListHandler(c *gin.Context) {
980
	ms, err := Manifests(true)
Patrick Devine's avatar
Patrick Devine committed
981
982
983
984
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}
Michael Yang's avatar
Michael Yang committed
985

986
	models := []api.ListModelResponse{}
987
988
	for n, m := range ms {
		var cf ConfigV2
989
990
991
992
993
994
995
996
997
998
999
1000
1001

		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
1002
		}
Michael Yang's avatar
Michael Yang committed
1003

1004
1005
		// tag should never be masked
		models = append(models, api.ListModelResponse{
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
			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,
			},
1018
		})
Patrick Devine's avatar
Patrick Devine committed
1019
1020
	}

1021
	slices.SortStableFunc(models, func(i, j api.ListModelResponse) int {
1022
1023
1024
1025
		// most recently modified first
		return cmp.Compare(j.ModifiedAt.Unix(), i.ModifiedAt.Unix())
	})

Michael Yang's avatar
Michael Yang committed
1026
	c.JSON(http.StatusOK, api.ListResponse{Models: models})
Patrick Devine's avatar
Patrick Devine committed
1027
1028
}

1029
func (s *Server) CopyHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
1030
1031
	var r api.CopyRequest
	if err := c.ShouldBindJSON(&r); errors.Is(err, io.EOF) {
Michael Yang's avatar
Michael Yang committed
1032
1033
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
1034
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
1035
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Patrick Devine's avatar
Patrick Devine committed
1036
1037
1038
		return
	}

Michael Yang's avatar
Michael Yang committed
1039
1040
	src := model.ParseName(r.Source)
	if !src.IsValid() {
Michael Yang's avatar
Michael Yang committed
1041
1042
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("source %q is invalid", r.Source)})
		return
1043
	}
1044
1045
1046
1047
1048
	src, err := getExistingName(src)
	if err != nil {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}
1049

Michael Yang's avatar
Michael Yang committed
1050
1051
	dst := model.ParseName(r.Destination)
	if !dst.IsValid() {
1052
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("destination %q is invalid", r.Destination)})
Patrick Devine's avatar
Patrick Devine committed
1053
1054
		return
	}
1055
1056
	dst, err = getExistingName(dst)
	if err != nil {
1057
1058
1059
1060
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

Michael Yang's avatar
Michael Yang committed
1061
1062
1063
1064
1065
	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
1066
1067
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1068
func (s *Server) HeadBlobHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
	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
1080
	c.Status(http.StatusOK)
Michael Yang's avatar
Michael Yang committed
1081
1082
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1083
func (s *Server) CreateBlobHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
1084
1085
	if ib, ok := intermediateBlobs[c.Param("digest")]; ok {
		p, err := GetBlobsPath(ib)
1086
1087
1088
1089
1090
1091
		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
1092
1093
			slog.Info("evicting intermediate blob which no longer exists", "digest", ib)
			delete(intermediateBlobs, c.Param("digest"))
1094
1095
1096
1097
1098
1099
1100
1101
1102
		} else if err != nil {
			c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
			return
		} else {
			c.Status(http.StatusOK)
			return
		}
	}

1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
	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
	}

1121
	layer, err := NewLayer(c.Request.Body, "")
Michael Yang's avatar
Michael Yang committed
1122
1123
1124
1125
1126
	if err != nil {
		c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

1127
1128
	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
1129
1130
1131
		return
	}

Michael Yang's avatar
Michael Yang committed
1132
	c.Status(http.StatusCreated)
Michael Yang's avatar
Michael Yang committed
1133
1134
}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
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
}

1156
func allowedHost(host string) bool {
1157
1158
	host = strings.ToLower(host)

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1159
	if host == "" || host == "localhost" {
1160
1161
1162
		return true
	}

1163
	if hostname, err := os.Hostname(); err == nil && host == strings.ToLower(hostname) {
1164
1165
1166
		return true
	}

Michael Yang's avatar
lint  
Michael Yang committed
1167
	tlds := []string{
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1168
1169
1170
		"localhost",
		"local",
		"internal",
1171
	}
1172

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1173
	// check if the host is a local TLD
1174
1175
1176
1177
1178
1179
	for _, tld := range tlds {
		if strings.HasSuffix(host, "."+tld) {
			return true
		}
	}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1180
	return false
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1181
}
1182

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1183
1184
1185
func allowedHostsMiddleware(addr net.Addr) gin.HandlerFunc {
	return func(c *gin.Context) {
		if addr == nil {
1186
1187
1188
1189
			c.Next()
			return
		}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1190
		if addr, err := netip.ParseAddrPort(addr.String()); err == nil && !addr.Addr().IsLoopback() {
1191
1192
1193
1194
1195
1196
1197
1198
1199
			c.Next()
			return
		}

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

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1200
		if addr, err := netip.ParseAddr(host); err == nil {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1201
			if addr.IsLoopback() || addr.IsPrivate() || addr.IsUnspecified() || isLocalIP(addr) {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1202
1203
1204
1205
1206
				c.Next()
				return
			}
		}

1207
		if allowedHost(host) {
Michael Yang's avatar
lint  
Michael Yang committed
1208
			if c.Request.Method == http.MethodOptions {
1209
1210
1211
1212
				c.AbortWithStatus(http.StatusNoContent)
				return
			}

1213
1214
1215
1216
1217
1218
			c.Next()
			return
		}

		c.AbortWithStatus(http.StatusForbidden)
	}
1219
}
1220

1221
func (s *Server) GenerateRoutes(rc *ollama.Registry) (http.Handler, error) {
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
	corsConfig := cors.DefaultConfig()
	corsConfig.AllowWildcard = true
	corsConfig.AllowBrowserExtensions = true
	corsConfig.AllowHeaders = []string{
		"Authorization",
		"Content-Type",
		"User-Agent",
		"Accept",
		"X-Requested-With",

		// OpenAI compatibility headers
1233
1234
1235
1236
1237
		"OpenAI-Beta",
		"x-stainless-arch",
		"x-stainless-async",
		"x-stainless-custom-poll-interval",
		"x-stainless-helper-method",
1238
1239
		"x-stainless-lang",
		"x-stainless-os",
1240
1241
		"x-stainless-package-version",
		"x-stainless-poll-helper",
1242
1243
1244
1245
1246
1247
		"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
1248

Bruce MacDonald's avatar
Bruce MacDonald committed
1249
	r := gin.Default()
1250
	r.HandleMethodNotAllowed = true
1251
	r.Use(
1252
		cors.New(corsConfig),
1253
		allowedHostsMiddleware(s.addr),
1254
	)
Bruce MacDonald's avatar
Bruce MacDonald committed
1255

1256
1257
1258
1259
1260
1261
	// 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}) })

1262
	// Local model cache management (new implementation is at end of function)
1263
1264
	r.POST("/api/pull", s.PullHandler)
	r.POST("/api/push", s.PushHandler)
1265
1266
	r.HEAD("/api/tags", s.ListHandler)
	r.GET("/api/tags", s.ListHandler)
1267
	r.POST("/api/show", s.ShowHandler)
1268
	r.DELETE("/api/delete", s.DeleteHandler)
1269
1270
1271

	// Create
	r.POST("/api/create", s.CreateHandler)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1272
1273
	r.POST("/api/blobs/:digest", s.CreateBlobHandler)
	r.HEAD("/api/blobs/:digest", s.HeadBlobHandler)
1274
1275
1276
	r.POST("/api/copy", s.CopyHandler)

	// Inference
1277
	r.GET("/api/ps", s.PsHandler)
1278
1279
1280
1281
	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
1282

1283
	// Inference (OpenAI compatibility)
1284
	r.POST("/v1/chat/completions", openai.ChatMiddleware(), s.ChatHandler)
1285
	r.POST("/v1/completions", openai.CompletionsMiddleware(), s.GenerateHandler)
1286
	r.POST("/v1/embeddings", openai.EmbeddingsMiddleware(), s.EmbedHandler)
1287
1288
	r.GET("/v1/models", openai.ListMiddleware(), s.ListHandler)
	r.GET("/v1/models/:model", openai.RetrieveMiddleware(), s.ShowHandler)
1289

1290
1291
1292
1293
1294
1295
	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,
1296

1297
1298
1299
			Prune: PruneLayers,
		}
		return rs, nil
1300
1301
	}

1302
	return r, nil
1303
1304
1305
}

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

1309
1310
1311
1312
1313
1314
1315
1316
	blobsDir, err := GetBlobsPath("")
	if err != nil {
		return err
	}
	if err := fixBlobs(blobsDir); err != nil {
		return err
	}

Michael Yang's avatar
bool  
Michael Yang committed
1317
	if !envconfig.NoPrune() {
1318
1319
1320
1321
1322
1323
1324
		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
			}
1325

1326
1327
1328
1329
			manifestsPath, err := GetManifestPath()
			if err != nil {
				return err
			}
1330

1331
1332
1333
			if err := PruneDirectory(manifestsPath); err != nil {
				return err
			}
1334
1335
1336
		}
	}

1337
1338
	s := &Server{addr: ln.Addr()}

1339
1340
1341
1342
1343
1344
1345
	var rc *ollama.Registry
	if useClient2 {
		var err error
		rc, err = ollama.DefaultRegistry()
		if err != nil {
			return err
		}
1346
1347
	}

1348
	h, err := s.GenerateRoutes(rc)
1349
1350
1351
	if err != nil {
		return err
	}
1352

1353
1354
	http.Handle("/", h)

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1355
	ctx, done := context.WithCancel(context.Background())
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1356
1357
	schedCtx, schedDone := context.WithCancel(ctx)
	sched := InitScheduler(schedCtx)
1358
	s.sched = sched
1359

1360
	slog.Info(fmt.Sprintf("Listening on %s (version %s)", ln.Addr(), version.Version))
1361
	srvr := &http.Server{
1362
1363
1364
1365
1366
1367
1368
1369
1370
		// 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
1371
1372
	}

1373
1374
	// listen for a ctrl+c and stop any loaded llm
	signals := make(chan os.Signal, 1)
1375
	signal.Notify(signals, syscall.SIGINT, syscall.SIGTERM)
1376
1377
	go func() {
		<-signals
1378
		srvr.Close()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1379
		schedDone()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1380
		sched.unloadAllRunners()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1381
		done()
1382
1383
	}()

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1384
	s.sched.Run(schedCtx)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1385

1386
1387
1388
1389
	// 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
1390
1391
	// 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
1392
	gpus := discover.GetGPUInfo()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1393
	gpus.LogDetails()
1394

1395
1396
1397
1398
1399
1400
1401
1402
1403
	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
1404
1405
1406
1407
1408
1409
1410
	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()
1411
	return nil
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1412
}
Michael Yang's avatar
Michael Yang committed
1413

1414
func waitForStream(c *gin.Context, ch chan any) {
1415
	c.Header("Content-Type", "application/json")
1416
	var latest api.ProgressResponse
1417
1418
1419
	for resp := range ch {
		switch r := resp.(type) {
		case api.ProgressResponse:
1420
			latest = r
1421
		case gin.H:
Josh's avatar
Josh committed
1422
1423
1424
1425
			status, ok := r["status"].(int)
			if !ok {
				status = http.StatusInternalServerError
			}
1426
1427
1428
			errorMsg, ok := r["error"].(string)
			if !ok {
				errorMsg = "unknown error"
1429
			}
1430
1431
			c.JSON(status, gin.H{"error": errorMsg})
			return
1432
		default:
1433
			c.JSON(http.StatusInternalServerError, gin.H{"error": "unknown message type"})
1434
1435
1436
			return
		}
	}
1437
1438

	c.JSON(http.StatusOK, latest)
1439
1440
}

Michael Yang's avatar
Michael Yang committed
1441
func streamResponse(c *gin.Context, ch chan any) {
1442
	c.Header("Content-Type", "application/x-ndjson")
Michael Yang's avatar
Michael Yang committed
1443
1444
1445
1446
1447
1448
1449
1450
	c.Stream(func(w io.Writer) bool {
		val, ok := <-ch
		if !ok {
			return false
		}

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

1455
		// Delineate chunks with new-line delimiter
Michael Yang's avatar
Michael Yang committed
1456
1457
		bts = append(bts, '\n')
		if _, err := w.Write(bts); err != nil {
1458
			slog.Info(fmt.Sprintf("streamResponse: w.Write failed with %s", err))
Michael Yang's avatar
Michael Yang committed
1459
1460
1461
1462
1463
1464
			return false
		}

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

1466
func (s *Server) PsHandler(c *gin.Context) {
1467
	models := []api.ProcessModelResponse{}
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478

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

1479
		mr := api.ProcessModelResponse{
1480
1481
			Model:     model.ShortName,
			Name:      model.ShortName,
Jesse Gross's avatar
Jesse Gross committed
1482
1483
			Size:      int64(v.totalSize),
			SizeVRAM:  int64(v.vramSize),
1484
1485
1486
1487
			Digest:    model.Digest,
			Details:   modelDetails,
			ExpiresAt: v.expiresAt,
		}
1488
		if v.Options != nil {
Jesse Gross's avatar
Jesse Gross committed
1489
			mr.ContextLength = v.Options.NumCtx
1490
		}
1491
1492
1493
1494
1495
1496
1497
1498
		// 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)
		}

1499
1500
1501
		models = append(models, mr)
	}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1502
1503
1504
1505
1506
	slices.SortStableFunc(models, func(i, j api.ProcessModelResponse) int {
		// longest duration remaining listed first
		return cmp.Compare(j.ExpiresAt.Unix(), i.ExpiresAt.Unix())
	})

1507
	c.JSON(http.StatusOK, api.ProcessResponse{Models: models})
1508
1509
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1510
func (s *Server) ChatHandler(c *gin.Context) {
1511
1512
	checkpointStart := time.Now()

Bruce MacDonald's avatar
Bruce MacDonald committed
1513
	var req api.ChatRequest
Michael Yang's avatar
Michael Yang committed
1514
	if err := c.ShouldBindJSON(&req); errors.Is(err, io.EOF) {
Bruce MacDonald's avatar
Bruce MacDonald committed
1515
1516
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
1517
	} else if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1518
1519
1520
1521
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

Patrick Devine's avatar
Patrick Devine committed
1522
	// expire the runner
Michael Yang's avatar
Michael Yang committed
1523
	if len(req.Messages) == 0 && req.KeepAlive != nil && req.KeepAlive.Duration == 0 {
Patrick Devine's avatar
Patrick Devine committed
1524
1525
1526
1527
1528
		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)})
1529
			case err.Error() == errtypes.InvalidModelNameErrMsg:
Patrick Devine's avatar
Patrick Devine committed
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
				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
	}

1548
	caps := []model.Capability{model.CapabilityCompletion}
1549
	if len(req.Tools) > 0 {
1550
		caps = append(caps, model.CapabilityTools)
Michael Yang's avatar
tools  
Michael Yang committed
1551
	}
1552
	if req.Think != nil && req.Think.Bool() {
1553
1554
		caps = append(caps, model.CapabilityThinking)
	}
Michael Yang's avatar
tools  
Michael Yang committed
1555

1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
	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
1568
1569
	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
1570
		return
Michael Yang's avatar
Michael Yang committed
1571
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
1572
		handleScheduleError(c, req.Model, err)
Bruce MacDonald's avatar
Bruce MacDonald committed
1573
1574
		return
	}
Michael Yang's avatar
Michael Yang committed
1575

1576
1577
	checkpointLoaded := time.Now()

Michael Yang's avatar
Michael Yang committed
1578
1579
	if len(req.Messages) == 0 {
		c.JSON(http.StatusOK, api.ChatResponse{
1580
			Model:      req.Model,
Michael Yang's avatar
Michael Yang committed
1581
1582
			CreatedAt:  time.Now().UTC(),
			Message:    api.Message{Role: "assistant"},
1583
1584
			Done:       true,
			DoneReason: "load",
Michael Yang's avatar
Michael Yang committed
1585
		})
1586
1587
1588
		return
	}

Michael Yang's avatar
Michael Yang committed
1589
	msgs := append(m.Messages, req.Messages...)
1590
	if req.Messages[0].Role != "system" && m.System != "" {
Michael Yang's avatar
Michael Yang committed
1591
		msgs = append([]api.Message{{Role: "system", Content: m.System}}, msgs...)
1592
	}
1593
	msgs = filterThinkTags(msgs, m)
1594

1595
	useHarmony := harmony.ShouldUseHarmony(m.Config.ModelFamily, m.Template)
1596
1597

	processedTools := req.Tools
1598
1599
1600
	var functionNameMap *harmony.FunctionNameMap
	var prefillString string
	// TODO(parthsareen): this can be abstracted to not be model specific and potentially moved to the runner
1601
	if useHarmony {
1602
1603
		prefillString = harmony.Prefill(msgs[len(msgs)-1])
		functionNameMap = harmony.NewFunctionNameMap()
1604
1605
1606
1607
1608
		// 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 {
1609
			processedTools[i].Function.Name = functionNameMap.ConvertAndAdd(tool.Function.Name)
1610
1611
1612
1613
		}
	}

	prompt, images, err := chatPrompt(c.Request.Context(), m, r.Tokenize, opts, msgs, processedTools, req.Think)
Michael Yang's avatar
Michael Yang committed
1614
	if err != nil {
1615
		slog.Error("chat prompt error", "error", err)
Michael Yang's avatar
Michael Yang committed
1616
1617
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
1618
1619
	}

1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
	// 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
1633
1634
	// Validate Think value: string values currently only allowed for gptoss models
	if req.Think != nil && req.Think.IsString() && !useHarmony {
1635
		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
1636
1637
1638
		return
	}

1639
1640
	var thinkingState *thinking.Parser
	openingTag, closingTag := thinking.InferTags(m.Template.Template)
1641
	if req.Think != nil && req.Think.Bool() && openingTag != "" && closingTag != "" {
1642
		thinkingState = &thinking.Parser{
Devon Rifkin's avatar
Devon Rifkin committed
1643
1644
			OpeningTag: openingTag,
			ClosingTag: closingTag,
1645
		}
1646
1647
1648
1649

		if strings.HasSuffix(strings.TrimSpace(prompt), openingTag) {
			thinkingState.AddContent(openingTag)
		}
1650
1651
	}

1652
	var toolParser *tools.Parser
Michael Yang's avatar
Michael Yang committed
1653
	if len(req.Tools) > 0 && !useHarmony {
1654
		toolParser = tools.NewParser(m.Template.Template, req.Tools)
1655
1656
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
1657
1658
1659
	ch := make(chan any)
	go func() {
		defer close(ch)
1660

Michael Yang's avatar
Michael Yang committed
1661
		if err := r.Completion(c.Request.Context(), llm.CompletionRequest{
1662
1663
1664
1665
			Prompt:        prompt,
			Images:        images,
			Format:        req.Format,
			Options:       opts,
1666
			UseHarmony:    useHarmony,
1667
			PrefillString: prefillString,
Michael Yang's avatar
Michael Yang committed
1668
		}, func(r llm.CompletionResponse) {
1669
			res := api.ChatResponse{
1670
1671
				Model:     req.Model,
				CreatedAt: time.Now().UTC(),
1672
				Message:   api.Message{Role: "assistant", Content: r.Content, Thinking: r.Thinking, ToolCalls: r.ToolCalls},
1673
				Done:      r.Done,
Bruce MacDonald's avatar
Bruce MacDonald committed
1674
1675
1676
1677
1678
1679
1680
				Metrics: api.Metrics{
					PromptEvalCount:    r.PromptEvalCount,
					PromptEvalDuration: r.PromptEvalDuration,
					EvalCount:          r.EvalCount,
					EvalDuration:       r.EvalDuration,
				},
			}
Michael Yang's avatar
Michael Yang committed
1681
1682
1683
1684
1685
1686
1687
			if r.Done {
				res.DoneReason = r.DoneReason.String()
				res.TotalDuration = time.Since(checkpointStart)
				res.LoadDuration = checkpointLoaded.Sub(checkpointStart)
			}

			if useHarmony {
1688
1689
				for i, tool := range res.Message.ToolCalls {
					res.Message.ToolCalls[i].Function.Name = functionNameMap.OriginalFromConverted(tool.Function.Name)
Michael Yang's avatar
Michael Yang committed
1690
1691
1692
1693
1694
1695
1696
				}
				// 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
				}
				return
			}
1697

1698
			if thinkingState != nil {
Devon Rifkin's avatar
Devon Rifkin committed
1699
				thinkingContent, remainingContent := thinkingState.AddContent(res.Message.Content)
1700
1701
1702
1703
1704
1705
1706
1707
				if thinkingContent == "" && remainingContent == "" && !r.Done {
					// need to accumulate more to decide what to send
					return
				}
				res.Message.Content = remainingContent
				res.Message.Thinking = thinkingContent
			}

1708
			if len(req.Tools) > 0 {
1709
				toolCalls, content := toolParser.Add(res.Message.Content)
1710
1711
1712
1713
1714
				if len(content) > 0 {
					res.Message.Content = content
				} else if len(toolCalls) > 0 {
					res.Message.ToolCalls = toolCalls
					res.Message.Content = ""
1715
1716
				} else if res.Message.Thinking != "" {
					// don't return
1717
1718
				} else {
					if r.Done {
1719
						res.Message.Content = toolParser.Content()
1720
1721
1722
						ch <- res
					}
					return
1723
1724
				}
			}
1725

1726
			ch <- res
Michael Yang's avatar
Michael Yang committed
1727
		}); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1728
1729
1730
1731
1732
			ch <- gin.H{"error": err.Error()}
		}
	}()

	if req.Stream != nil && !*req.Stream {
Michael Yang's avatar
tools  
Michael Yang committed
1733
		var resp api.ChatResponse
1734
		var toolCalls []api.ToolCall
1735
1736
		var sbThinking strings.Builder
		var sbContent strings.Builder
Michael Yang's avatar
Michael Yang committed
1737
1738
		for rr := range ch {
			switch t := rr.(type) {
1739
			case api.ChatResponse:
1740
1741
				sbThinking.WriteString(t.Message.Thinking)
				sbContent.WriteString(t.Message.Content)
Michael Yang's avatar
tools  
Michael Yang committed
1742
				resp = t
1743
1744
1745
				if len(req.Tools) > 0 {
					toolCalls = append(toolCalls, t.Message.ToolCalls...)
				}
1746
			case gin.H:
Michael Yang's avatar
Michael Yang committed
1747
1748
1749
				msg, ok := t["error"].(string)
				if !ok {
					msg = "unexpected error format in response"
1750
				}
Michael Yang's avatar
Michael Yang committed
1751
1752
1753

				c.JSON(http.StatusInternalServerError, gin.H{"error": msg})
				return
1754
			default:
Michael Yang's avatar
Michael Yang committed
1755
				c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected response"})
1756
				return
Bruce MacDonald's avatar
Bruce MacDonald committed
1757
1758
			}
		}
1759

1760
1761
1762
		resp.Message.Content = sbContent.String()
		resp.Message.Thinking = sbThinking.String()

1763
1764
		if len(toolCalls) > 0 {
			resp.Message.ToolCalls = toolCalls
Michael Yang's avatar
tools  
Michael Yang committed
1765
1766
1767
		}

		c.JSON(http.StatusOK, resp)
Bruce MacDonald's avatar
Bruce MacDonald committed
1768
1769
1770
1771
1772
		return
	}

	streamResponse(c, ch)
}
1773

Michael Yang's avatar
Michael Yang committed
1774
func handleScheduleError(c *gin.Context, name string, err error) {
Michael Yang's avatar
Michael Yang committed
1775
	switch {
1776
	case errors.Is(err, errCapabilities), errors.Is(err, errRequired):
Michael Yang's avatar
Michael Yang committed
1777
		c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Michael Yang's avatar
Michael Yang committed
1778
	case errors.Is(err, context.Canceled):
1779
		c.JSON(499, gin.H{"error": "request canceled"})
Michael Yang's avatar
Michael Yang committed
1780
	case errors.Is(err, ErrMaxQueue):
1781
		c.JSON(http.StatusServiceUnavailable, gin.H{"error": err.Error()})
Michael Yang's avatar
Michael Yang committed
1782
1783
	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
1784
1785
	default:
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
1786
1787
	}
}
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799

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 {
1800
1801
1802
1803
1804
				// 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.
1805
				thinkingState := &thinking.Parser{
Devon Rifkin's avatar
Devon Rifkin committed
1806
1807
					OpeningTag: "<think>",
					ClosingTag: "</think>",
1808
				}
Devon Rifkin's avatar
Devon Rifkin committed
1809
				_, content := thinkingState.AddContent(msg.Content)
1810
				msgs[i].Content = content
1811
1812
1813
1814
1815
			}
		}
	}
	return msgs
}