routes.go 56.5 KB
Newer Older
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1
2
3
package server

import (
Michael Yang's avatar
Michael Yang committed
4
	"bytes"
Michael Yang's avatar
Michael Yang committed
5
	"cmp"
6
	"context"
Michael Yang's avatar
Michael Yang committed
7
	"encoding/json"
8
	"errors"
9
	"fmt"
10
	"image"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
11
	"io"
12
	"io/fs"
13
	"log/slog"
14
	"math"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
15
16
	"net"
	"net/http"
17
	"net/netip"
18
	"net/url"
19
	"os"
20
	"os/signal"
21
	"slices"
Michael Yang's avatar
Michael Yang committed
22
	"strings"
23
	"syscall"
24
	"time"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
25

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

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

52
53
54
55
56
57
58
59
60
61
62
63
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
}

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

var useClient2 = experimentEnabled("client2")

70
71
72
73
// 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
74
75
var mode string = gin.DebugMode

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

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

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

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

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

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

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

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

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

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

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

165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
	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
	}

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

194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
	if m.Config.RemoteHost != "" && m.Config.RemoteModel != "" {
		origModel := req.Model

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

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

		req.Model = m.Config.RemoteModel

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

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

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

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

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

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

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

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

		client := api.NewClient(remoteURL, http.DefaultClient)
		err = client.Generate(c, &req, fn)
		if err != nil {
			var sErr api.AuthorizationError
			if errors.As(err, &sErr) && sErr.StatusCode == http.StatusUnauthorized {
				pk, pkErr := auth.GetPublicKey()
				if pkErr != nil {
					slog.Error("couldn't get public key", "error", pkErr)
					c.JSON(http.StatusUnauthorized, gin.H{"error": "error getting public key"})
					return
				}
				c.JSON(http.StatusUnauthorized, gin.H{"public_key": pk})
				return
			}
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
			return
		}

		return
	}

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

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

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

291
292
293
	useHarmony := shouldUseHarmony(m) && !req.Raw
	var harmonyMessageHandler *harmony.HarmonyMessageHandler
	var harmonyToolParser *harmony.HarmonyToolCallAccumulator
Michael Yang's avatar
Michael Yang committed
294
	if useHarmony {
295
296
297
		harmonyMessageHandler = harmony.NewHarmonyMessageHandler()
		harmonyMessageHandler.HarmonyParser.AddImplicitStart()
		harmonyToolParser = harmonyMessageHandler.CreateToolParser()
Michael Yang's avatar
Michael Yang committed
298
299
300
301
	}

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

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

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

327
328
	checkpointLoaded := time.Now()

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

340
341
	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"})
342
343
344
		return
	}

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

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

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

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

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

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

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

		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
409
410
	}

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

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

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

Michael Yang's avatar
Michael Yang committed
462
			if useHarmony {
463
464
465
466
467
				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
468
				thinking, content := thinkingState.AddContent(cr.Content)
469
470
471
472
				res.Thinking = thinking
				res.Response = content
			}

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

			if cr.Done {
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
				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)

502
				if !req.Raw {
503
					tokens, err := r.Tokenize(c.Request.Context(), prompt+sb.String())
504
505
506
507
					if err != nil {
						ch <- gin.H{"error": err.Error()}
						return
					}
508
					res.Context = tokens
509
510
511
				}
			}

Michael Yang's avatar
Michael Yang committed
512
513
514
515
516
517
518
519
520
			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
			}

521
			ch <- res
Michael Yang's avatar
Michael Yang committed
522
		}); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
523
524
525
526
527
			ch <- gin.H{"error": err.Error()}
		}
	}()

	if req.Stream != nil && !*req.Stream {
Michael Yang's avatar
Michael Yang committed
528
		var r api.GenerateResponse
529
530
		var sbThinking strings.Builder
		var sbContent strings.Builder
Michael Yang's avatar
Michael Yang committed
531
532
		for rr := range ch {
			switch t := rr.(type) {
533
			case api.GenerateResponse:
534
535
				sbThinking.WriteString(t.Thinking)
				sbContent.WriteString(t.Response)
Michael Yang's avatar
Michael Yang committed
536
				r = t
537
			case gin.H:
Michael Yang's avatar
Michael Yang committed
538
539
540
				msg, ok := t["error"].(string)
				if !ok {
					msg = "unexpected error format in response"
541
				}
Michael Yang's avatar
Michael Yang committed
542
543
544

				c.JSON(http.StatusInternalServerError, gin.H{"error": msg})
				return
545
			default:
Michael Yang's avatar
Michael Yang committed
546
				c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected response"})
Bruce MacDonald's avatar
Bruce MacDonald committed
547
548
549
				return
			}
		}
550

551
552
553
		r.Thinking = sbThinking.String()
		r.Response = sbContent.String()

Michael Yang's avatar
Michael Yang committed
554
		c.JSON(http.StatusOK, r)
Bruce MacDonald's avatar
Bruce MacDonald committed
555
556
557
558
559
560
		return
	}

	streamResponse(c, ch)
}

561
func (s *Server) EmbedHandler(c *gin.Context) {
562
	checkpointStart := time.Now()
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
	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:
595
596
597
598
		if req.Input != nil {
			c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "invalid input type"})
			return
		}
599
600
	}

601
602
603
604
605
606
	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
	}

607
	r, m, opts, err := s.scheduleRunner(c.Request.Context(), name.String(), []model.Capability{}, req.Options, req.KeepAlive)
608
609
610
611
612
	if err != nil {
		handleScheduleError(c, req.Model, err)
		return
	}

613
614
	checkpointLoaded := time.Now()

615
616
617
618
619
	if len(input) == 0 {
		c.JSON(http.StatusOK, api.EmbedResponse{Model: req.Model, Embeddings: [][]float32{}})
		return
	}

620
	kvData, _, err := getModelData(m.ModelPath, false)
621
622
623
624
625
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

626
	var count int
627
628
629
630
631
632
633
634
635
636
	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 {
637
				c.JSON(http.StatusBadRequest, gin.H{"error": "input exceeds maximum context length"})
638
639
640
				return
			}

641
642
643
644
645
646
647
648
			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--
			}

649
650
651
652
653
654
655
			slog.Info("", "ctxLen", ctxLen, "tokenCount", len(tokens))
			if ctxLen <= 0 {
				// return error if the truncated input would be empty or just special tokens
				c.JSON(http.StatusBadRequest, gin.H{"error": "input after truncation exceeds maximum context length"})
				return
			}

656
			tokens = tokens[:ctxLen]
657

658
659
660
661
662
663
664
			s, err = r.Detokenize(c.Request.Context(), tokens)
			if err != nil {
				c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
				return
			}
		}

665
666
		count += len(tokens)

667
668
		input[i] = s
	}
669
670
671
672
673
674
675
676
677

	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
			}
678
679
680
681
682
683
			// 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
684
685
			return nil
		})
686
687
	}

688
	if err := g.Wait(); err != nil {
689
		c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": strings.TrimSpace(err.Error())})
690
		return
691
692
693
	}

	resp := api.EmbedResponse{
694
		Model:           req.Model,
695
		Embeddings:      embeddings,
696
697
		TotalDuration:   time.Since(checkpointStart),
		LoadDuration:    checkpointLoaded.Sub(checkpointStart),
698
		PromptEvalCount: count,
699
700
701
702
703
704
705
706
707
708
	}
	c.JSON(http.StatusOK, resp)
}

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

709
	norm := float32(1.0 / max(math.Sqrt(float64(sum)), 1e-12))
710
711
712
713
714
715
	for i := range vec {
		vec[i] *= norm
	}
	return vec
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
716
func (s *Server) EmbeddingsHandler(c *gin.Context) {
Bruce MacDonald's avatar
Bruce MacDonald committed
717
	var req api.EmbeddingRequest
Michael Yang's avatar
Michael Yang committed
718
	if err := c.ShouldBindJSON(&req); errors.Is(err, io.EOF) {
Bruce MacDonald's avatar
Bruce MacDonald committed
719
720
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
721
	} else if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
722
723
724
725
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

726
727
728
729
730
731
	name := model.ParseName(req.Model)
	if !name.IsValid() {
		c.JSON(http.StatusBadRequest, gin.H{"error": "model is required"})
		return
	}

732
	r, _, _, err := s.scheduleRunner(c.Request.Context(), name.String(), []model.Capability{}, req.Options, req.KeepAlive)
Bruce MacDonald's avatar
Bruce MacDonald committed
733
	if err != nil {
Michael Yang's avatar
Michael Yang committed
734
		handleScheduleError(c, req.Model, err)
Bruce MacDonald's avatar
Bruce MacDonald committed
735
736
737
		return
	}

738
739
740
	// an empty request loads the model
	if req.Prompt == "" {
		c.JSON(http.StatusOK, api.EmbeddingResponse{Embedding: []float64{}})
Bruce MacDonald's avatar
Bruce MacDonald committed
741
742
743
		return
	}

744
	embedding, err := r.Embedding(c.Request.Context(), req.Prompt)
Bruce MacDonald's avatar
Bruce MacDonald committed
745
	if err != nil {
746
		c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": strings.TrimSpace(err.Error())})
Bruce MacDonald's avatar
Bruce MacDonald committed
747
748
749
		return
	}

750
751
752
	var e []float64
	for _, v := range embedding {
		e = append(e, float64(v))
753
754
755
	}

	resp := api.EmbeddingResponse{
756
		Embedding: e,
757
758
	}
	c.JSON(http.StatusOK, resp)
Bruce MacDonald's avatar
Bruce MacDonald committed
759
760
}

761
func (s *Server) PullHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
762
	var req api.PullRequest
Michael Yang's avatar
Michael Yang committed
763
764
765
766
767
768
769
	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
770
771
772
		return
	}

773
774
	name := model.ParseName(cmp.Or(req.Model, req.Name))
	if !name.IsValid() {
775
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": errtypes.InvalidModelNameErrMsg})
776
777
778
		return
	}

779
780
	name, err = getExistingName(name)
	if err != nil {
781
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
782
783
784
		return
	}

785
786
787
	ch := make(chan any)
	go func() {
		defer close(ch)
788
789
		fn := func(r api.ProgressResponse) {
			ch <- r
790
		}
791

Michael Yang's avatar
Michael Yang committed
792
		regOpts := &registryOptions{
793
794
795
			Insecure: req.Insecure,
		}

796
797
798
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

799
		if err := PullModel(ctx, name.DisplayShortest(), regOpts, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
800
			ch <- gin.H{"error": err.Error()}
801
802
803
		}
	}()

804
805
806
807
808
	if req.Stream != nil && !*req.Stream {
		waitForStream(c, ch)
		return
	}

809
810
811
	streamResponse(c, ch)
}

812
func (s *Server) PushHandler(c *gin.Context) {
813
	var req api.PushRequest
Michael Yang's avatar
Michael Yang committed
814
815
816
817
818
819
820
	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
821
822
		return
	}
Michael Yang's avatar
Michael Yang committed
823

824
	var mname string
Michael Yang's avatar
Michael Yang committed
825
	if req.Model != "" {
826
		mname = req.Model
Michael Yang's avatar
Michael Yang committed
827
	} else if req.Name != "" {
828
		mname = req.Name
Michael Yang's avatar
Michael Yang committed
829
830
	} else {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
831
832
833
		return
	}

834
835
836
	ch := make(chan any)
	go func() {
		defer close(ch)
837
838
		fn := func(r api.ProgressResponse) {
			ch <- r
839
		}
840

Michael Yang's avatar
Michael Yang committed
841
		regOpts := &registryOptions{
842
843
844
			Insecure: req.Insecure,
		}

Michael Yang's avatar
Michael Yang committed
845
846
847
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

848
849
850
851
852
853
854
		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
855
			ch <- gin.H{"error": err.Error()}
856
857
858
		}
	}()

859
860
861
862
863
	if req.Stream != nil && !*req.Stream {
		waitForStream(c, ch)
		return
	}

864
865
866
	streamResponse(c, ch)
}

867
868
869
870
// 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.
871
872
873
func getExistingName(n model.Name) (model.Name, error) {
	var zero model.Name
	existing, err := Manifests(true)
874
	if err != nil {
875
		return zero, err
876
	}
877
	var set model.Name // tracks parts already canonicalized
878
	for e := range existing {
879
880
881
882
883
884
885
886
887
888
889
		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
890
891
		}
	}
892
	return n, nil
893
894
}

895
func (s *Server) DeleteHandler(c *gin.Context) {
896
897
	var r api.DeleteRequest
	if err := c.ShouldBindJSON(&r); errors.Is(err, io.EOF) {
Michael Yang's avatar
Michael Yang committed
898
899
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
900
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
901
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
902
903
904
		return
	}

905
906
907
	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))})
908
909
		return
	}
Michael Yang's avatar
Michael Yang committed
910

911
912
913
914
915
916
	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
	}

917
	m, err := ParseNamedManifest(n)
Michael Yang's avatar
Michael Yang committed
918
	if err != nil {
919
920
921
922
923
924
		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
925
926
927
		return
	}

928
	if err := m.Remove(); err != nil {
Michael Yang's avatar
Michael Yang committed
929
930
931
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}
932
933
934
935
936

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

939
func (s *Server) ShowHandler(c *gin.Context) {
Patrick Devine's avatar
Patrick Devine committed
940
	var req api.ShowRequest
Michael Yang's avatar
Michael Yang committed
941
942
943
944
945
946
947
	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
948
949
950
		return
	}

Michael Yang's avatar
Michael Yang committed
951
	if req.Model != "" {
Michael Yang's avatar
Michael Yang committed
952
		// noop
Michael Yang's avatar
Michael Yang committed
953
	} else if req.Name != "" {
Michael Yang's avatar
Michael Yang committed
954
		req.Model = req.Name
Michael Yang's avatar
Michael Yang committed
955
	} else {
956
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
957
958
959
		return
	}

960
	resp, err := GetModelInfo(req)
Patrick Devine's avatar
Patrick Devine committed
961
	if err != nil {
962
963
		switch {
		case os.IsNotExist(err):
Michael Yang's avatar
Michael Yang committed
964
			c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found", req.Model)})
965
		case err.Error() == errtypes.InvalidModelNameErrMsg:
966
967
			c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		default:
Patrick Devine's avatar
Patrick Devine committed
968
969
970
971
972
973
974
975
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		}
		return
	}

	c.JSON(http.StatusOK, resp)
}

976
func GetModelInfo(req api.ShowRequest) (*api.ShowResponse, error) {
977
978
	name := model.ParseName(req.Model)
	if !name.IsValid() {
CYJiang's avatar
CYJiang committed
979
		return nil, ErrModelPathInvalid
980
981
982
983
984
985
986
	}
	name, err := getExistingName(name)
	if err != nil {
		return nil, err
	}

	m, err := GetModel(name.String())
Patrick Devine's avatar
Patrick Devine committed
987
988
989
990
	if err != nil {
		return nil, err
	}

Patrick Devine's avatar
Patrick Devine committed
991
	modelDetails := api.ModelDetails{
992
993
994
995
996
997
		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
998
999
	}

1000
	if req.System != "" {
1001
		m.System = req.System
1002
1003
	}

Michael Yang's avatar
Michael Yang committed
1004
1005
1006
	msgs := make([]api.Message, len(m.Messages))
	for i, msg := range m.Messages {
		msgs[i] = api.Message{Role: msg.Role, Content: msg.Content}
1007
1008
	}

1009
	manifest, err := ParseNamedManifest(name)
1010
1011
1012
1013
	if err != nil {
		return nil, err
	}

Patrick Devine's avatar
Patrick Devine committed
1014
	resp := &api.ShowResponse{
1015
1016
1017
1018
1019
1020
1021
		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
1022
1023
	}

1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
	if m.Config.RemoteHost != "" {
		resp.RemoteHost = m.Config.RemoteHost
		resp.RemoteModel = m.Config.RemoteModel

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

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

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

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

Patrick Devine's avatar
Patrick Devine committed
1046
1047
	var params []string
	cs := 30
1048
	for k, v := range m.Options {
Patrick Devine's avatar
Patrick Devine committed
1049
		switch val := v.(type) {
1050
		case []any:
Patrick Devine's avatar
Patrick Devine committed
1051
			for _, nv := range val {
Patrick Devine's avatar
Patrick Devine committed
1052
				params = append(params, fmt.Sprintf("%-*s %#v", cs, k, nv))
Patrick Devine's avatar
Patrick Devine committed
1053
			}
Patrick Devine's avatar
Patrick Devine committed
1054
1055
		default:
			params = append(params, fmt.Sprintf("%-*s %#v", cs, k, v))
Patrick Devine's avatar
Patrick Devine committed
1056
1057
1058
1059
		}
	}
	resp.Parameters = strings.Join(params, "\n")

Patrick Devine's avatar
Patrick Devine committed
1060
1061
1062
1063
1064
	if len(req.Options) > 0 {
		if m.Options == nil {
			m.Options = make(map[string]any)
		}
		for k, v := range req.Options {
1065
			m.Options[k] = v
1066
1067
1068
		}
	}

1069
	var sb strings.Builder
1070
	fmt.Fprintln(&sb, "# Modelfile generated by \"ollama show\"")
1071
	fmt.Fprintln(&sb, "# To build a new Modelfile based on this, replace FROM with:")
1072
1073
	fmt.Fprintf(&sb, "# FROM %s\n\n", m.ShortName)
	fmt.Fprint(&sb, m.String())
1074
	resp.Modelfile = sb.String()
1075

1076
1077
1078
1079
1080
	// skip loading tensor information if this is a remote model
	if m.Config.RemoteHost != "" && m.Config.RemoteModel != "" {
		return resp, nil
	}

1081
	kvData, tensors, err := getModelData(m.ModelPath, req.Verbose)
1082
1083
1084
	if err != nil {
		return nil, err
	}
1085

1086
1087
1088
1089
	delete(kvData, "general.name")
	delete(kvData, "tokenizer.chat_template")
	resp.ModelInfo = kvData

1090
1091
1092
1093
1094
1095
	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

1096
	if len(m.ProjectorPaths) > 0 {
1097
		projectorData, _, err := getModelData(m.ProjectorPaths[0], req.Verbose)
1098
1099
1100
1101
1102
1103
		if err != nil {
			return nil, err
		}
		resp.ProjectorInfo = projectorData
	}

Patrick Devine's avatar
Patrick Devine committed
1104
1105
1106
	return resp, nil
}

1107
func getModelData(digest string, verbose bool) (ggml.KV, ggml.Tensors, error) {
1108
1109
1110
1111
	maxArraySize := 0
	if verbose {
		maxArraySize = -1
	}
1112
	data, err := llm.LoadModel(digest, maxArraySize)
1113
	if err != nil {
1114
		return nil, ggml.Tensors{}, err
1115
1116
	}

1117
	kv := data.KV()
1118
1119
1120
1121
1122
1123
1124
1125
1126

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

1127
	return kv, data.Tensors(), nil
1128
1129
}

1130
func (s *Server) ListHandler(c *gin.Context) {
1131
	ms, err := Manifests(true)
Patrick Devine's avatar
Patrick Devine committed
1132
1133
1134
1135
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}
Michael Yang's avatar
Michael Yang committed
1136

1137
	models := []api.ListModelResponse{}
1138
1139
	for n, m := range ms {
		var cf ConfigV2
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152

		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
1153
		}
Michael Yang's avatar
Michael Yang committed
1154

1155
1156
		// tag should never be masked
		models = append(models, api.ListModelResponse{
1157
1158
1159
1160
1161
1162
1163
			Model:       n.DisplayShortest(),
			Name:        n.DisplayShortest(),
			RemoteModel: cf.RemoteModel,
			RemoteHost:  cf.RemoteHost,
			Size:        m.Size(),
			Digest:      m.digest,
			ModifiedAt:  m.fi.ModTime(),
1164
1165
1166
1167
1168
1169
1170
			Details: api.ModelDetails{
				Format:            cf.ModelFormat,
				Family:            cf.ModelFamily,
				Families:          cf.ModelFamilies,
				ParameterSize:     cf.ModelType,
				QuantizationLevel: cf.FileType,
			},
1171
		})
Patrick Devine's avatar
Patrick Devine committed
1172
1173
	}

1174
	slices.SortStableFunc(models, func(i, j api.ListModelResponse) int {
1175
1176
1177
1178
		// most recently modified first
		return cmp.Compare(j.ModifiedAt.Unix(), i.ModifiedAt.Unix())
	})

Michael Yang's avatar
Michael Yang committed
1179
	c.JSON(http.StatusOK, api.ListResponse{Models: models})
Patrick Devine's avatar
Patrick Devine committed
1180
1181
}

1182
func (s *Server) CopyHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
1183
1184
	var r api.CopyRequest
	if err := c.ShouldBindJSON(&r); errors.Is(err, io.EOF) {
Michael Yang's avatar
Michael Yang committed
1185
1186
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
1187
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
1188
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Patrick Devine's avatar
Patrick Devine committed
1189
1190
1191
		return
	}

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

Michael Yang's avatar
Michael Yang committed
1203
1204
	dst := model.ParseName(r.Destination)
	if !dst.IsValid() {
1205
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("destination %q is invalid", r.Destination)})
Patrick Devine's avatar
Patrick Devine committed
1206
1207
		return
	}
1208
1209
	dst, err = getExistingName(dst)
	if err != nil {
1210
1211
1212
1213
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

Michael Yang's avatar
Michael Yang committed
1214
1215
1216
1217
1218
	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
1219
1220
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1221
func (s *Server) HeadBlobHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
	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
1233
	c.Status(http.StatusOK)
Michael Yang's avatar
Michael Yang committed
1234
1235
}

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

1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
	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
	}

1274
	layer, err := NewLayer(c.Request.Body, "")
Michael Yang's avatar
Michael Yang committed
1275
1276
1277
1278
1279
	if err != nil {
		c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

1280
1281
	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
1282
1283
1284
		return
	}

Michael Yang's avatar
Michael Yang committed
1285
	c.Status(http.StatusCreated)
Michael Yang's avatar
Michael Yang committed
1286
1287
}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
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
}

1309
func allowedHost(host string) bool {
1310
1311
	host = strings.ToLower(host)

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1312
	if host == "" || host == "localhost" {
1313
1314
1315
		return true
	}

1316
	if hostname, err := os.Hostname(); err == nil && host == strings.ToLower(hostname) {
1317
1318
1319
		return true
	}

Michael Yang's avatar
lint  
Michael Yang committed
1320
	tlds := []string{
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1321
1322
1323
		"localhost",
		"local",
		"internal",
1324
	}
1325

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1326
	// check if the host is a local TLD
1327
1328
1329
1330
1331
1332
	for _, tld := range tlds {
		if strings.HasSuffix(host, "."+tld) {
			return true
		}
	}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1333
	return false
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1334
}
1335

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1336
1337
1338
func allowedHostsMiddleware(addr net.Addr) gin.HandlerFunc {
	return func(c *gin.Context) {
		if addr == nil {
1339
1340
1341
1342
			c.Next()
			return
		}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1343
		if addr, err := netip.ParseAddrPort(addr.String()); err == nil && !addr.Addr().IsLoopback() {
1344
1345
1346
1347
1348
1349
1350
1351
1352
			c.Next()
			return
		}

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

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1353
		if addr, err := netip.ParseAddr(host); err == nil {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1354
			if addr.IsLoopback() || addr.IsPrivate() || addr.IsUnspecified() || isLocalIP(addr) {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1355
1356
1357
1358
1359
				c.Next()
				return
			}
		}

1360
		if allowedHost(host) {
Michael Yang's avatar
lint  
Michael Yang committed
1361
			if c.Request.Method == http.MethodOptions {
1362
1363
1364
1365
				c.AbortWithStatus(http.StatusNoContent)
				return
			}

1366
1367
1368
1369
1370
1371
			c.Next()
			return
		}

		c.AbortWithStatus(http.StatusForbidden)
	}
1372
}
1373

1374
func (s *Server) GenerateRoutes(rc *ollama.Registry) (http.Handler, error) {
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
	corsConfig := cors.DefaultConfig()
	corsConfig.AllowWildcard = true
	corsConfig.AllowBrowserExtensions = true
	corsConfig.AllowHeaders = []string{
		"Authorization",
		"Content-Type",
		"User-Agent",
		"Accept",
		"X-Requested-With",

		// OpenAI compatibility headers
1386
1387
1388
1389
1390
		"OpenAI-Beta",
		"x-stainless-arch",
		"x-stainless-async",
		"x-stainless-custom-poll-interval",
		"x-stainless-helper-method",
1391
1392
		"x-stainless-lang",
		"x-stainless-os",
1393
1394
		"x-stainless-package-version",
		"x-stainless-poll-helper",
1395
1396
1397
1398
1399
1400
		"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
1401

Bruce MacDonald's avatar
Bruce MacDonald committed
1402
	r := gin.Default()
1403
	r.HandleMethodNotAllowed = true
1404
	r.Use(
1405
		cors.New(corsConfig),
1406
		allowedHostsMiddleware(s.addr),
1407
	)
Bruce MacDonald's avatar
Bruce MacDonald committed
1408

1409
1410
1411
1412
1413
1414
	// 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}) })

1415
	// Local model cache management (new implementation is at end of function)
1416
1417
	r.POST("/api/pull", s.PullHandler)
	r.POST("/api/push", s.PushHandler)
1418
1419
	r.HEAD("/api/tags", s.ListHandler)
	r.GET("/api/tags", s.ListHandler)
1420
	r.POST("/api/show", s.ShowHandler)
1421
	r.DELETE("/api/delete", s.DeleteHandler)
1422

1423
1424
1425
	r.DELETE("/api/user/keys/:encodedKey", s.SignoutHandler)
	r.POST("/api/me", s.WhoamiHandler)

1426
1427
	// Create
	r.POST("/api/create", s.CreateHandler)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1428
1429
	r.POST("/api/blobs/:digest", s.CreateBlobHandler)
	r.HEAD("/api/blobs/:digest", s.HeadBlobHandler)
1430
1431
1432
	r.POST("/api/copy", s.CopyHandler)

	// Inference
1433
	r.GET("/api/ps", s.PsHandler)
1434
1435
1436
1437
	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
1438

1439
	// Inference (OpenAI compatibility)
1440
	r.POST("/v1/chat/completions", openai.ChatMiddleware(), s.ChatHandler)
1441
	r.POST("/v1/completions", openai.CompletionsMiddleware(), s.GenerateHandler)
1442
	r.POST("/v1/embeddings", openai.EmbeddingsMiddleware(), s.EmbedHandler)
1443
1444
	r.GET("/v1/models", openai.ListMiddleware(), s.ListHandler)
	r.GET("/v1/models/:model", openai.RetrieveMiddleware(), s.ShowHandler)
1445

1446
1447
1448
1449
1450
1451
	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,
1452

1453
1454
1455
			Prune: PruneLayers,
		}
		return rs, nil
1456
1457
	}

1458
	return r, nil
1459
1460
1461
}

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

1465
1466
1467
1468
1469
1470
1471
1472
	blobsDir, err := GetBlobsPath("")
	if err != nil {
		return err
	}
	if err := fixBlobs(blobsDir); err != nil {
		return err
	}

Michael Yang's avatar
bool  
Michael Yang committed
1473
	if !envconfig.NoPrune() {
1474
1475
1476
1477
1478
1479
1480
		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
			}
1481

1482
1483
1484
1485
			manifestsPath, err := GetManifestPath()
			if err != nil {
				return err
			}
1486

1487
1488
1489
			if err := PruneDirectory(manifestsPath); err != nil {
				return err
			}
1490
1491
1492
		}
	}

1493
1494
	s := &Server{addr: ln.Addr()}

1495
1496
1497
1498
1499
1500
1501
	var rc *ollama.Registry
	if useClient2 {
		var err error
		rc, err = ollama.DefaultRegistry()
		if err != nil {
			return err
		}
1502
1503
	}

1504
	h, err := s.GenerateRoutes(rc)
1505
1506
1507
	if err != nil {
		return err
	}
1508

1509
1510
	http.Handle("/", h)

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1511
	ctx, done := context.WithCancel(context.Background())
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1512
1513
	schedCtx, schedDone := context.WithCancel(ctx)
	sched := InitScheduler(schedCtx)
1514
	s.sched = sched
1515

1516
	slog.Info(fmt.Sprintf("Listening on %s (version %s)", ln.Addr(), version.Version))
1517
	srvr := &http.Server{
1518
1519
1520
1521
1522
1523
1524
1525
1526
		// 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
1527
1528
	}

1529
1530
	// listen for a ctrl+c and stop any loaded llm
	signals := make(chan os.Signal, 1)
1531
	signal.Notify(signals, syscall.SIGINT, syscall.SIGTERM)
1532
1533
	go func() {
		<-signals
1534
		srvr.Close()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1535
		schedDone()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1536
		sched.unloadAllRunners()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1537
		done()
1538
1539
	}()

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1540
	s.sched.Run(schedCtx)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1541

1542
1543
1544
1545
	// 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
1546
1547
	// 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
1548
	gpus := discover.GetGPUInfo()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1549
	gpus.LogDetails()
1550

1551
1552
1553
1554
1555
1556
1557
1558
1559
	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
1560
1561
1562
1563
1564
1565
1566
	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()
1567
	return nil
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1568
}
Michael Yang's avatar
Michael Yang committed
1569

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

	c.JSON(http.StatusOK, latest)
1595
1596
}

Michael Yang's avatar
Michael Yang committed
1597
func streamResponse(c *gin.Context, ch chan any) {
1598
	c.Header("Content-Type", "application/x-ndjson")
Michael Yang's avatar
Michael Yang committed
1599
1600
1601
1602
1603
1604
1605
1606
	c.Stream(func(w io.Writer) bool {
		val, ok := <-ch
		if !ok {
			return false
		}

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

1611
		// Delineate chunks with new-line delimiter
Michael Yang's avatar
Michael Yang committed
1612
1613
		bts = append(bts, '\n')
		if _, err := w.Write(bts); err != nil {
1614
			slog.Info(fmt.Sprintf("streamResponse: w.Write failed with %s", err))
Michael Yang's avatar
Michael Yang committed
1615
1616
1617
1618
1619
1620
			return false
		}

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

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

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

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

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

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

	c.JSON(http.StatusOK, nil)
}

1665
func (s *Server) PsHandler(c *gin.Context) {
1666
	models := []api.ProcessModelResponse{}
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677

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

1678
		mr := api.ProcessModelResponse{
1679
1680
			Model:     model.ShortName,
			Name:      model.ShortName,
Jesse Gross's avatar
Jesse Gross committed
1681
1682
			Size:      int64(v.totalSize),
			SizeVRAM:  int64(v.vramSize),
1683
1684
1685
1686
			Digest:    model.Digest,
			Details:   modelDetails,
			ExpiresAt: v.expiresAt,
		}
1687
		if v.Options != nil {
Jesse Gross's avatar
Jesse Gross committed
1688
			mr.ContextLength = v.Options.NumCtx
1689
		}
1690
1691
1692
1693
1694
1695
1696
1697
		// 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)
		}

1698
1699
1700
		models = append(models, mr)
	}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1701
1702
1703
1704
1705
	slices.SortStableFunc(models, func(i, j api.ProcessModelResponse) int {
		// longest duration remaining listed first
		return cmp.Compare(j.ExpiresAt.Unix(), i.ExpiresAt.Unix())
	})

1706
	c.JSON(http.StatusOK, api.ProcessResponse{Models: models})
1707
1708
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1709
func (s *Server) ChatHandler(c *gin.Context) {
1710
1711
	checkpointStart := time.Now()

Bruce MacDonald's avatar
Bruce MacDonald committed
1712
	var req api.ChatRequest
Michael Yang's avatar
Michael Yang committed
1713
	if err := c.ShouldBindJSON(&req); errors.Is(err, io.EOF) {
Bruce MacDonald's avatar
Bruce MacDonald committed
1714
1715
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
1716
	} else if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1717
1718
1719
1720
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
	name := model.ParseName(req.Model)
	if !name.IsValid() {
		c.JSON(http.StatusBadRequest, gin.H{"error": "model is required"})
		return
	}

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

	m, err := GetModel(req.Model)
	if err != nil {
		switch {
		case os.IsNotExist(err):
			c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found", req.Model)})
		case err.Error() == errtypes.InvalidModelNameErrMsg:
			c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		default:
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
Patrick Devine's avatar
Patrick Devine committed
1742
		}
1743
1744
1745
1746
1747
1748
		return
	}

	// expire the runner
	if len(req.Messages) == 0 && req.KeepAlive != nil && int(req.KeepAlive.Seconds()) == 0 {
		s.sched.expireRunner(m)
Patrick Devine's avatar
Patrick Devine committed
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759

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

1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
	if m.Config.RemoteHost != "" && m.Config.RemoteModel != "" {
		origModel := req.Model

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

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

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

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

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

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

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

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

		client := api.NewClient(remoteURL, http.DefaultClient)
		err = client.Chat(c, &req, fn)
		if err != nil {
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
			return
		}

		return
	}

1820
	caps := []model.Capability{model.CapabilityCompletion}
1821
	if len(req.Tools) > 0 {
1822
		caps = append(caps, model.CapabilityTools)
Michael Yang's avatar
tools  
Michael Yang committed
1823
	}
1824
	if req.Think != nil && req.Think.Bool() {
1825
1826
		caps = append(caps, model.CapabilityThinking)
	}
Michael Yang's avatar
tools  
Michael Yang committed
1827

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

1837
1838
	checkpointLoaded := time.Now()

Michael Yang's avatar
Michael Yang committed
1839
1840
	if len(req.Messages) == 0 {
		c.JSON(http.StatusOK, api.ChatResponse{
1841
			Model:      req.Model,
Michael Yang's avatar
Michael Yang committed
1842
1843
			CreatedAt:  time.Now().UTC(),
			Message:    api.Message{Role: "assistant"},
1844
1845
			Done:       true,
			DoneReason: "load",
Michael Yang's avatar
Michael Yang committed
1846
		})
1847
1848
1849
		return
	}

Michael Yang's avatar
Michael Yang committed
1850
	msgs := append(m.Messages, req.Messages...)
1851
	if req.Messages[0].Role != "system" && m.System != "" {
Michael Yang's avatar
Michael Yang committed
1852
		msgs = append([]api.Message{{Role: "system", Content: m.System}}, msgs...)
1853
	}
1854
	msgs = filterThinkTags(msgs, m)
1855

Devon Rifkin's avatar
Devon Rifkin committed
1856
	var builtinParser parsers.Parser
Devon Rifkin's avatar
Devon Rifkin committed
1857
1858
1859
1860
	if m.Config.Parser != "" {
		builtinParser = parsers.ParserForName(m.Config.Parser)
	}

1861
1862
1863
	var harmonyMessageHandler *harmony.HarmonyMessageHandler
	var harmonyToolParser *harmony.HarmonyToolCallAccumulator

Devon Rifkin's avatar
Devon Rifkin committed
1864
	useHarmony := shouldUseHarmony(m) || m.Config.Parser == "harmony"
1865
1866
1867

	processedTools := req.Tools
	if useHarmony {
1868
1869
1870
1871
1872
1873
1874
1875
		harmonyMessageHandler = harmony.NewHarmonyMessageHandler()
		var lastMessage *api.Message
		if len(msgs) > 0 {
			lastMessage = &msgs[len(msgs)-1]
		}
		harmonyMessageHandler.HarmonyParser.AddImplicitStartOrPrefill(lastMessage)
		harmonyToolParser = harmonyMessageHandler.CreateToolParser()

1876
1877
1878
1879
1880
		// 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 {
1881
			processedTools[i].Function.Name = harmonyMessageHandler.FunctionNameMap.ConvertAndAdd(tool.Function.Name)
1882
1883
1884
1885
		}
	}

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

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

Michael Yang's avatar
Michael Yang committed
1905
1906
	// Validate Think value: string values currently only allowed for gptoss models
	if req.Think != nil && req.Think.IsString() && !useHarmony {
1907
		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
1908
1909
1910
		return
	}

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

		if strings.HasSuffix(strings.TrimSpace(prompt), openingTag) {
			thinkingState.AddContent(openingTag)
		}
1922
1923
	}

1924
	var toolParser *tools.Parser
Michael Yang's avatar
Michael Yang committed
1925
	if len(req.Tools) > 0 && !useHarmony {
1926
		toolParser = tools.NewParser(m.Template.Template, req.Tools)
1927
1928
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
1929
1930
1931
	ch := make(chan any)
	go func() {
		defer close(ch)
1932

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

Devon Rifkin's avatar
Devon Rifkin committed
1957
			// TODO(drifkin): fold this as much as possibleinto the generic m.Config.Parser logic
Michael Yang's avatar
Michael Yang committed
1958
			if useHarmony {
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
				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
1977
				}
1978

Michael Yang's avatar
Michael Yang committed
1979
1980
1981
1982
				// 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
				}
1983

Devon Rifkin's avatar
Devon Rifkin committed
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
				return
			} else if builtinParser != nil {
				slog.Log(context.TODO(), logutil.LevelTrace, "builtin parser input", "parser", m.Config.Parser, "content", r.Content)

				content, thinking, toolCalls, err := builtinParser.Add(r.Content, req.Tools)
				if err != nil {
					ch <- gin.H{"error": err.Error()}
					return
				}

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

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

Michael Yang's avatar
Michael Yang committed
2005
2006
				return
			}
2007

2008
			if thinkingState != nil {
Devon Rifkin's avatar
Devon Rifkin committed
2009
				thinkingContent, remainingContent := thinkingState.AddContent(res.Message.Content)
2010
2011
2012
2013
2014
2015
2016
2017
				if thinkingContent == "" && remainingContent == "" && !r.Done {
					// need to accumulate more to decide what to send
					return
				}
				res.Message.Content = remainingContent
				res.Message.Thinking = thinkingContent
			}

2018
			if len(req.Tools) > 0 {
2019
				toolCalls, content := toolParser.Add(res.Message.Content)
2020
2021
2022
2023
2024
				if len(content) > 0 {
					res.Message.Content = content
				} else if len(toolCalls) > 0 {
					res.Message.ToolCalls = toolCalls
					res.Message.Content = ""
2025
2026
				} else if res.Message.Thinking != "" {
					// don't return
2027
2028
				} else {
					if r.Done {
2029
						res.Message.Content = toolParser.Content()
2030
2031
2032
						ch <- res
					}
					return
2033
2034
				}
			}
2035

2036
			ch <- res
Michael Yang's avatar
Michael Yang committed
2037
		}); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
2038
2039
2040
2041
2042
			ch <- gin.H{"error": err.Error()}
		}
	}()

	if req.Stream != nil && !*req.Stream {
Michael Yang's avatar
tools  
Michael Yang committed
2043
		var resp api.ChatResponse
2044
		var toolCalls []api.ToolCall
2045
2046
		var sbThinking strings.Builder
		var sbContent strings.Builder
Michael Yang's avatar
Michael Yang committed
2047
2048
		for rr := range ch {
			switch t := rr.(type) {
2049
			case api.ChatResponse:
2050
2051
				sbThinking.WriteString(t.Message.Thinking)
				sbContent.WriteString(t.Message.Content)
Michael Yang's avatar
tools  
Michael Yang committed
2052
				resp = t
2053
2054
2055
				if len(req.Tools) > 0 {
					toolCalls = append(toolCalls, t.Message.ToolCalls...)
				}
2056
			case gin.H:
Michael Yang's avatar
Michael Yang committed
2057
2058
2059
				msg, ok := t["error"].(string)
				if !ok {
					msg = "unexpected error format in response"
2060
				}
Michael Yang's avatar
Michael Yang committed
2061
2062
2063

				c.JSON(http.StatusInternalServerError, gin.H{"error": msg})
				return
2064
			default:
Michael Yang's avatar
Michael Yang committed
2065
				c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected response"})
2066
				return
Bruce MacDonald's avatar
Bruce MacDonald committed
2067
2068
			}
		}
2069

2070
2071
2072
		resp.Message.Content = sbContent.String()
		resp.Message.Thinking = sbThinking.String()

2073
2074
		if len(toolCalls) > 0 {
			resp.Message.ToolCalls = toolCalls
Michael Yang's avatar
tools  
Michael Yang committed
2075
2076
2077
		}

		c.JSON(http.StatusOK, resp)
Bruce MacDonald's avatar
Bruce MacDonald committed
2078
2079
2080
2081
2082
		return
	}

	streamResponse(c, ch)
}
2083

Michael Yang's avatar
Michael Yang committed
2084
func handleScheduleError(c *gin.Context, name string, err error) {
Michael Yang's avatar
Michael Yang committed
2085
	switch {
2086
	case errors.Is(err, errCapabilities), errors.Is(err, errRequired):
Michael Yang's avatar
Michael Yang committed
2087
		c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Michael Yang's avatar
Michael Yang committed
2088
	case errors.Is(err, context.Canceled):
2089
		c.JSON(499, gin.H{"error": "request canceled"})
Michael Yang's avatar
Michael Yang committed
2090
	case errors.Is(err, ErrMaxQueue):
2091
		c.JSON(http.StatusServiceUnavailable, gin.H{"error": err.Error()})
Michael Yang's avatar
Michael Yang committed
2092
2093
	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
2094
2095
	default:
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
2096
2097
	}
}
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109

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 {
2110
2111
2112
2113
2114
				// 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.
2115
				thinkingState := &thinking.Parser{
Devon Rifkin's avatar
Devon Rifkin committed
2116
2117
					OpeningTag: "<think>",
					ClosingTag: "</think>",
2118
				}
Devon Rifkin's avatar
Devon Rifkin committed
2119
				_, content := thinkingState.AddContent(msg.Content)
2120
				msgs[i].Content = content
2121
2122
2123
2124
2125
			}
		}
	}
	return msgs
}