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

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

32
	"github.com/ollama/ollama/api"
33
	"github.com/ollama/ollama/auth"
34
	"github.com/ollama/ollama/discover"
35
	"github.com/ollama/ollama/envconfig"
36
	"github.com/ollama/ollama/format"
Michael Yang's avatar
Michael Yang committed
37
	"github.com/ollama/ollama/fs/ggml"
38
	"github.com/ollama/ollama/llm"
39
	"github.com/ollama/ollama/logutil"
40
	"github.com/ollama/ollama/middleware"
Devon Rifkin's avatar
Devon Rifkin committed
41
	"github.com/ollama/ollama/model/parsers"
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
const signinURLStr = "https://ollama.com/connect?name=%s&key=%s"

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

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

var useClient2 = experimentEnabled("client2")

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

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

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

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

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

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

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

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

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

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

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

156
157
158
159
160
161
162
163
164
165
166
func signinURL() (string, error) {
	pubKey, err := auth.GetPublicKey()
	if err != nil {
		return "", err
	}

	encKey := base64.RawURLEncoding.EncodeToString([]byte(pubKey))
	h, _ := os.Hostname()
	return fmt.Sprintf(signinURLStr, url.PathEscape(h), encKey), nil
}

Michael Yang's avatar
Michael Yang committed
167
func (s *Server) GenerateHandler(c *gin.Context) {
168
	checkpointStart := time.Now()
Michael Yang's avatar
Michael Yang committed
169
170
171
172
173
174
	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
175
176
177
		return
	}

178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
	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
	}

194
	m, err := GetModel(name.String())
195
196
	if err != nil {
		switch {
197
		case errors.Is(err, fs.ErrNotExist):
198
			c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found", req.Model)})
199
		case err.Error() == errtypes.InvalidModelNameErrMsg:
200
201
202
203
204
205
206
			c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		default:
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		}
		return
	}

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
	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 {
267
268
269
270
271
272
			var authError api.AuthorizationError
			if errors.As(err, &authError) {
				sURL, sErr := signinURL()
				if sErr != nil {
					slog.Error(sErr.Error())
					c.JSON(http.StatusInternalServerError, gin.H{"error": "error getting authorization details"})
273
274
					return
				}
275
276
277
278
279
280
281

				c.JSON(authError.StatusCode, gin.H{"error": "unauthorized", "signin_url": sURL})
				return
			}
			var apiError api.StatusError
			if errors.As(err, &apiError) {
				c.JSON(apiError.StatusCode, apiError)
282
283
284
285
286
287
288
289
290
				return
			}
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
			return
		}

		return
	}

Patrick Devine's avatar
Patrick Devine committed
291
	// expire the runner
Michael Yang's avatar
Michael Yang committed
292
	if req.Prompt == "" && req.KeepAlive != nil && req.KeepAlive.Duration == 0 {
293
		s.sched.expireRunner(m)
Patrick Devine's avatar
Patrick Devine committed
294
295
296
297
298
299
300
301
302
303
304

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

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

310
311
312
313
314
315
316
317
318
319
320
	var builtinParser parsers.Parser
	if shouldUseHarmony(m) && m.Config.Parser == "" {
		m.Config.Parser = "harmony"
	}

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

323
324
	// Validate Think value: string values currently only allowed for harmony/gptoss models
	if req.Think != nil && req.Think.IsString() && m.Config.Parser != "harmony" {
325
		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
326
327
328
		return
	}

329
	caps := []model.Capability{model.CapabilityCompletion}
330
	if req.Suffix != "" {
331
		caps = append(caps, model.CapabilityInsert)
332
	}
333
	if req.Think != nil && req.Think.Bool() {
334
335
336
337
338
339
		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
	}
340

341
	r, m, opts, err := s.scheduleRunner(c.Request.Context(), name.String(), caps, req.Options, req.KeepAlive)
Michael Yang's avatar
Michael Yang committed
342
343
344
345
	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
346
347
348
349
		handleScheduleError(c, req.Model, err)
		return
	}

350
351
	checkpointLoaded := time.Now()

352
	// load the model
Michael Yang's avatar
Michael Yang committed
353
354
355
356
357
358
359
	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
360
361
		return
	}
Bruce MacDonald's avatar
Bruce MacDonald committed
362

363
364
	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"})
365
366
367
		return
	}

Michael Yang's avatar
Michael Yang committed
368
369
	images := make([]llm.ImageData, len(req.Images))
	for i := range req.Images {
370
		images[i] = llm.ImageData{ID: i, Data: req.Images[i]}
Michael Yang's avatar
Michael Yang committed
371
	}
Bruce MacDonald's avatar
Bruce MacDonald committed
372

Michael Yang's avatar
Michael Yang committed
373
374
	prompt := req.Prompt
	if !req.Raw {
Michael Yang's avatar
Michael Yang committed
375
		tmpl := m.Template
Michael Yang's avatar
Michael Yang committed
376
377
378
379
380
381
382
383
		if req.Template != "" {
			tmpl, err = template.Parse(req.Template)
			if err != nil {
				c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
				return
			}
		}

384
385
386
387
388
389
390
391
392
393
394
395
		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
396
397
398
399
			if req.Context == nil {
				msgs = append(msgs, m.Messages...)
			}

400
			for _, i := range images {
401
402
				imgPrompt := ""
				msgs = append(msgs, api.Message{Role: "user", Content: fmt.Sprintf("[img-%d]"+imgPrompt, i.ID)})
403
404
405
406
407
			}

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

408
		values.Think = req.Think != nil && req.Think.Bool()
Michael Yang's avatar
Michael Yang committed
409
410
		values.ThinkLevel = ""
		if req.Think != nil {
411
			values.ThinkLevel = req.Think.String()
Michael Yang's avatar
Michael Yang committed
412
		}
413
414
		values.IsThinkSet = req.Think != nil

Michael Yang's avatar
Michael Yang committed
415
416
		var b bytes.Buffer
		if req.Context != nil {
417
			slog.Warn("the context field is deprecated and will be removed in a future version of Ollama")
418
			s, err := r.Detokenize(c.Request.Context(), req.Context)
Michael Yang's avatar
Michael Yang committed
419
420
421
422
			if err != nil {
				c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
				return
			}
423
			b.WriteString(s)
Michael Yang's avatar
Michael Yang committed
424
		}
425
426
427
428
429
430
431

		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
432
433
	}

434
435
	// If debug mode is enabled, return the rendered template instead of calling the model
	if req.DebugRenderOnly {
Devon Rifkin's avatar
Devon Rifkin committed
436
		c.JSON(http.StatusOK, api.GenerateResponse{
437
438
			Model:     req.Model,
			CreatedAt: time.Now().UTC(),
Devon Rifkin's avatar
Devon Rifkin committed
439
			DebugInfo: &api.DebugInfo{
440
441
442
443
444
445
446
				RenderedTemplate: prompt,
				ImageCount:       len(images),
			},
		})
		return
	}

447
	var thinkingState *thinking.Parser
448
	if builtinParser == nil {
Michael Yang's avatar
Michael Yang committed
449
		openingTag, closingTag := thinking.InferTags(m.Template.Template)
450
		if req.Think != nil && req.Think.Bool() && openingTag != "" && closingTag != "" {
Michael Yang's avatar
Michael Yang committed
451
452
453
454
			thinkingState = &thinking.Parser{
				OpeningTag: openingTag,
				ClosingTag: closingTag,
			}
455
456
457
			if strings.HasSuffix(strings.TrimSpace(prompt), openingTag) {
				thinkingState.AddContent(openingTag)
			}
458
459
460
		}
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
461
462
	ch := make(chan any)
	go func() {
463
464
		// TODO (jmorganca): avoid building the response twice both here and below
		var sb strings.Builder
Bruce MacDonald's avatar
Bruce MacDonald committed
465
		defer close(ch)
Michael Yang's avatar
Michael Yang committed
466
		if err := r.Completion(c.Request.Context(), llm.CompletionRequest{
467
468
469
470
			Prompt:  prompt,
			Images:  images,
			Format:  req.Format,
			Options: opts,
471
472
		}, func(cr llm.CompletionResponse) {
			res := api.GenerateResponse{
473
474
475
476
				Model:     req.Model,
				CreatedAt: time.Now().UTC(),
				Response:  cr.Content,
				Done:      cr.Done,
Bruce MacDonald's avatar
Bruce MacDonald committed
477
				Metrics: api.Metrics{
478
479
480
481
					PromptEvalCount:    cr.PromptEvalCount,
					PromptEvalDuration: cr.PromptEvalDuration,
					EvalCount:          cr.EvalCount,
					EvalDuration:       cr.EvalDuration,
Bruce MacDonald's avatar
Bruce MacDonald committed
482
				},
Bruce MacDonald's avatar
Bruce MacDonald committed
483
			}
484

485
486
487
488
489
490
			if builtinParser != nil {
				content, thinking, toolCalls, err := builtinParser.Add(cr.Content, cr.Done)
				if err != nil {
					ch <- gin.H{"error": err.Error()}
					return
				}
491
492
				res.Response = content
				res.Thinking = thinking
493
494
495
				if cr.Done && len(toolCalls) > 0 {
					res.ToolCalls = toolCalls
				}
496
			} else if thinkingState != nil {
Devon Rifkin's avatar
Devon Rifkin committed
497
				thinking, content := thinkingState.AddContent(cr.Content)
498
499
500
501
				res.Thinking = thinking
				res.Response = content
			}

502
503
504
505
506
			if _, err := sb.WriteString(cr.Content); err != nil {
				ch <- gin.H{"error": err.Error()}
			}

			if cr.Done {
507
508
509
510
				res.DoneReason = cr.DoneReason.String()
				res.TotalDuration = time.Since(checkpointStart)
				res.LoadDuration = checkpointLoaded.Sub(checkpointStart)

511
				if !req.Raw {
512
					tokens, err := r.Tokenize(c.Request.Context(), prompt+sb.String())
513
514
515
516
					if err != nil {
						ch <- gin.H{"error": err.Error()}
						return
					}
517
					res.Context = tokens
518
519
520
				}
			}

521
			if builtinParser != nil {
Michael Yang's avatar
Michael Yang committed
522
523
524
525
526
527
528
529
				// only send messages with meaningful content (empty messages confuse clients)
				if res.Response != "" || res.Thinking != "" || res.Done || len(res.ToolCalls) > 0 {
					ch <- res
				}

				return
			}

530
			ch <- res
Michael Yang's avatar
Michael Yang committed
531
		}); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
532
533
534
535
536
			ch <- gin.H{"error": err.Error()}
		}
	}()

	if req.Stream != nil && !*req.Stream {
Michael Yang's avatar
Michael Yang committed
537
		var r api.GenerateResponse
538
539
		var sbThinking strings.Builder
		var sbContent strings.Builder
Michael Yang's avatar
Michael Yang committed
540
541
		for rr := range ch {
			switch t := rr.(type) {
542
			case api.GenerateResponse:
543
544
				sbThinking.WriteString(t.Thinking)
				sbContent.WriteString(t.Response)
Michael Yang's avatar
Michael Yang committed
545
				r = t
546
			case gin.H:
Michael Yang's avatar
Michael Yang committed
547
548
549
				msg, ok := t["error"].(string)
				if !ok {
					msg = "unexpected error format in response"
550
				}
Michael Yang's avatar
Michael Yang committed
551
552
553

				c.JSON(http.StatusInternalServerError, gin.H{"error": msg})
				return
554
			default:
Michael Yang's avatar
Michael Yang committed
555
				c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected response"})
Bruce MacDonald's avatar
Bruce MacDonald committed
556
557
558
				return
			}
		}
559

560
561
562
		r.Thinking = sbThinking.String()
		r.Response = sbContent.String()

Michael Yang's avatar
Michael Yang committed
563
		c.JSON(http.StatusOK, r)
Bruce MacDonald's avatar
Bruce MacDonald committed
564
565
566
567
568
569
		return
	}

	streamResponse(c, ch)
}

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

610
611
612
613
614
615
	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
	}

616
	r, m, opts, err := s.scheduleRunner(c.Request.Context(), name.String(), []model.Capability{}, req.Options, req.KeepAlive)
617
618
619
620
621
	if err != nil {
		handleScheduleError(c, req.Model, err)
		return
	}

622
623
	checkpointLoaded := time.Now()

624
625
626
627
628
	if len(input) == 0 {
		c.JSON(http.StatusOK, api.EmbedResponse{Model: req.Model, Embeddings: [][]float32{}})
		return
	}

629
	kvData, _, err := getModelData(m.ModelPath, false)
630
631
632
633
634
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

635
	var count int
636
637
638
639
640
641
642
643
644
645
	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 {
646
				c.JSON(http.StatusBadRequest, gin.H{"error": "input exceeds maximum context length"})
647
648
649
				return
			}

650
651
652
653
654
655
656
657
			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--
			}

658
659
660
661
662
663
664
			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
			}

665
			tokens = tokens[:ctxLen]
666

667
668
669
670
671
672
673
			s, err = r.Detokenize(c.Request.Context(), tokens)
			if err != nil {
				c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
				return
			}
		}

674
675
		count += len(tokens)

676
677
		input[i] = s
	}
678
679
680
681
682
683
684
685
686

	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
			}
687
688
689
690
691
692
			// 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
693
694
			return nil
		})
695
696
	}

697
	if err := g.Wait(); err != nil {
698
		c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": strings.TrimSpace(err.Error())})
699
		return
700
701
702
	}

	resp := api.EmbedResponse{
703
		Model:           req.Model,
704
		Embeddings:      embeddings,
705
706
		TotalDuration:   time.Since(checkpointStart),
		LoadDuration:    checkpointLoaded.Sub(checkpointStart),
707
		PromptEvalCount: count,
708
709
710
711
712
713
714
715
716
717
	}
	c.JSON(http.StatusOK, resp)
}

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

718
	norm := float32(1.0 / max(math.Sqrt(float64(sum)), 1e-12))
719
720
721
722
723
724
	for i := range vec {
		vec[i] *= norm
	}
	return vec
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
725
func (s *Server) EmbeddingsHandler(c *gin.Context) {
Bruce MacDonald's avatar
Bruce MacDonald committed
726
	var req api.EmbeddingRequest
Michael Yang's avatar
Michael Yang committed
727
	if err := c.ShouldBindJSON(&req); errors.Is(err, io.EOF) {
Bruce MacDonald's avatar
Bruce MacDonald committed
728
729
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
730
	} else if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
731
732
733
734
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

735
736
737
738
739
740
	name := model.ParseName(req.Model)
	if !name.IsValid() {
		c.JSON(http.StatusBadRequest, gin.H{"error": "model is required"})
		return
	}

741
	r, _, _, err := s.scheduleRunner(c.Request.Context(), name.String(), []model.Capability{}, req.Options, req.KeepAlive)
Bruce MacDonald's avatar
Bruce MacDonald committed
742
	if err != nil {
Michael Yang's avatar
Michael Yang committed
743
		handleScheduleError(c, req.Model, err)
Bruce MacDonald's avatar
Bruce MacDonald committed
744
745
746
		return
	}

747
748
749
	// an empty request loads the model
	if req.Prompt == "" {
		c.JSON(http.StatusOK, api.EmbeddingResponse{Embedding: []float64{}})
Bruce MacDonald's avatar
Bruce MacDonald committed
750
751
752
		return
	}

753
	embedding, err := r.Embedding(c.Request.Context(), req.Prompt)
Bruce MacDonald's avatar
Bruce MacDonald committed
754
	if err != nil {
755
		c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": strings.TrimSpace(err.Error())})
Bruce MacDonald's avatar
Bruce MacDonald committed
756
757
758
		return
	}

759
760
761
	var e []float64
	for _, v := range embedding {
		e = append(e, float64(v))
762
763
764
	}

	resp := api.EmbeddingResponse{
765
		Embedding: e,
766
767
	}
	c.JSON(http.StatusOK, resp)
Bruce MacDonald's avatar
Bruce MacDonald committed
768
769
}

770
func (s *Server) PullHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
771
	var req api.PullRequest
Michael Yang's avatar
Michael Yang committed
772
773
774
775
776
777
778
	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
779
780
781
		return
	}

782
783
	name := model.ParseName(cmp.Or(req.Model, req.Name))
	if !name.IsValid() {
784
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": errtypes.InvalidModelNameErrMsg})
785
786
787
		return
	}

788
789
	name, err = getExistingName(name)
	if err != nil {
790
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
791
792
793
		return
	}

794
795
796
	ch := make(chan any)
	go func() {
		defer close(ch)
797
798
		fn := func(r api.ProgressResponse) {
			ch <- r
799
		}
800

Michael Yang's avatar
Michael Yang committed
801
		regOpts := &registryOptions{
802
803
804
			Insecure: req.Insecure,
		}

805
806
807
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

808
		if err := PullModel(ctx, name.DisplayShortest(), regOpts, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
809
			ch <- gin.H{"error": err.Error()}
810
811
812
		}
	}()

813
814
815
816
817
	if req.Stream != nil && !*req.Stream {
		waitForStream(c, ch)
		return
	}

818
819
820
	streamResponse(c, ch)
}

821
func (s *Server) PushHandler(c *gin.Context) {
822
	var req api.PushRequest
Michael Yang's avatar
Michael Yang committed
823
824
825
826
827
828
829
	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
830
831
		return
	}
Michael Yang's avatar
Michael Yang committed
832

833
	var mname string
Michael Yang's avatar
Michael Yang committed
834
	if req.Model != "" {
835
		mname = req.Model
Michael Yang's avatar
Michael Yang committed
836
	} else if req.Name != "" {
837
		mname = req.Name
Michael Yang's avatar
Michael Yang committed
838
839
	} else {
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
840
841
842
		return
	}

843
844
845
	ch := make(chan any)
	go func() {
		defer close(ch)
846
847
		fn := func(r api.ProgressResponse) {
			ch <- r
848
		}
849

Michael Yang's avatar
Michael Yang committed
850
		regOpts := &registryOptions{
851
852
853
			Insecure: req.Insecure,
		}

Michael Yang's avatar
Michael Yang committed
854
855
856
		ctx, cancel := context.WithCancel(c.Request.Context())
		defer cancel()

857
858
859
860
861
862
863
		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
864
			ch <- gin.H{"error": err.Error()}
865
866
867
		}
	}()

868
869
870
871
872
	if req.Stream != nil && !*req.Stream {
		waitForStream(c, ch)
		return
	}

873
874
875
	streamResponse(c, ch)
}

876
877
878
879
// 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.
880
881
882
func getExistingName(n model.Name) (model.Name, error) {
	var zero model.Name
	existing, err := Manifests(true)
883
	if err != nil {
884
		return zero, err
885
	}
886
	var set model.Name // tracks parts already canonicalized
887
	for e := range existing {
888
889
890
891
892
893
894
895
896
897
898
		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
899
900
		}
	}
901
	return n, nil
902
903
}

904
func (s *Server) DeleteHandler(c *gin.Context) {
905
906
	var r api.DeleteRequest
	if err := c.ShouldBindJSON(&r); errors.Is(err, io.EOF) {
Michael Yang's avatar
Michael Yang committed
907
908
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
909
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
910
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
911
912
913
		return
	}

914
915
916
	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))})
917
918
		return
	}
Michael Yang's avatar
Michael Yang committed
919

920
921
922
923
924
925
	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
	}

926
	m, err := ParseNamedManifest(n)
Michael Yang's avatar
Michael Yang committed
927
	if err != nil {
928
929
930
931
932
933
		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
934
935
936
		return
	}

937
	if err := m.Remove(); err != nil {
Michael Yang's avatar
Michael Yang committed
938
939
940
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}
941
942
943
944
945

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

948
func (s *Server) ShowHandler(c *gin.Context) {
Patrick Devine's avatar
Patrick Devine committed
949
	var req api.ShowRequest
Michael Yang's avatar
Michael Yang committed
950
951
952
953
954
955
956
	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
957
958
959
		return
	}

Michael Yang's avatar
Michael Yang committed
960
	if req.Model != "" {
Michael Yang's avatar
Michael Yang committed
961
		// noop
Michael Yang's avatar
Michael Yang committed
962
	} else if req.Name != "" {
Michael Yang's avatar
Michael Yang committed
963
		req.Model = req.Name
Michael Yang's avatar
Michael Yang committed
964
	} else {
965
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
966
967
968
		return
	}

969
	resp, err := GetModelInfo(req)
Patrick Devine's avatar
Patrick Devine committed
970
	if err != nil {
971
972
		switch {
		case os.IsNotExist(err):
Michael Yang's avatar
Michael Yang committed
973
			c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found", req.Model)})
974
		case err.Error() == errtypes.InvalidModelNameErrMsg:
975
976
			c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		default:
Patrick Devine's avatar
Patrick Devine committed
977
978
979
980
981
982
983
984
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		}
		return
	}

	c.JSON(http.StatusOK, resp)
}

985
func GetModelInfo(req api.ShowRequest) (*api.ShowResponse, error) {
986
987
	name := model.ParseName(req.Model)
	if !name.IsValid() {
CYJiang's avatar
CYJiang committed
988
		return nil, ErrModelPathInvalid
989
990
991
992
993
994
995
	}
	name, err := getExistingName(name)
	if err != nil {
		return nil, err
	}

	m, err := GetModel(name.String())
Patrick Devine's avatar
Patrick Devine committed
996
997
998
999
	if err != nil {
		return nil, err
	}

Patrick Devine's avatar
Patrick Devine committed
1000
	modelDetails := api.ModelDetails{
1001
1002
1003
1004
1005
1006
		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
1007
1008
	}

1009
	if req.System != "" {
1010
		m.System = req.System
1011
1012
	}

Michael Yang's avatar
Michael Yang committed
1013
1014
1015
	msgs := make([]api.Message, len(m.Messages))
	for i, msg := range m.Messages {
		msgs[i] = api.Message{Role: msg.Role, Content: msg.Content}
1016
1017
	}

1018
	manifest, err := ParseNamedManifest(name)
1019
1020
1021
1022
	if err != nil {
		return nil, err
	}

Patrick Devine's avatar
Patrick Devine committed
1023
	resp := &api.ShowResponse{
1024
1025
1026
1027
1028
1029
1030
		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
1031
1032
	}

1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
	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
1055
1056
	var params []string
	cs := 30
1057
	for k, v := range m.Options {
Patrick Devine's avatar
Patrick Devine committed
1058
		switch val := v.(type) {
1059
		case []any:
Patrick Devine's avatar
Patrick Devine committed
1060
			for _, nv := range val {
Patrick Devine's avatar
Patrick Devine committed
1061
				params = append(params, fmt.Sprintf("%-*s %#v", cs, k, nv))
Patrick Devine's avatar
Patrick Devine committed
1062
			}
Patrick Devine's avatar
Patrick Devine committed
1063
1064
		default:
			params = append(params, fmt.Sprintf("%-*s %#v", cs, k, v))
Patrick Devine's avatar
Patrick Devine committed
1065
1066
1067
1068
		}
	}
	resp.Parameters = strings.Join(params, "\n")

Patrick Devine's avatar
Patrick Devine committed
1069
1070
1071
1072
1073
	if len(req.Options) > 0 {
		if m.Options == nil {
			m.Options = make(map[string]any)
		}
		for k, v := range req.Options {
1074
			m.Options[k] = v
1075
1076
1077
		}
	}

1078
	var sb strings.Builder
1079
	fmt.Fprintln(&sb, "# Modelfile generated by \"ollama show\"")
1080
	fmt.Fprintln(&sb, "# To build a new Modelfile based on this, replace FROM with:")
1081
1082
	fmt.Fprintf(&sb, "# FROM %s\n\n", m.ShortName)
	fmt.Fprint(&sb, m.String())
1083
	resp.Modelfile = sb.String()
1084

1085
1086
1087
1088
1089
	// skip loading tensor information if this is a remote model
	if m.Config.RemoteHost != "" && m.Config.RemoteModel != "" {
		return resp, nil
	}

1090
	kvData, tensors, err := getModelData(m.ModelPath, req.Verbose)
1091
1092
1093
	if err != nil {
		return nil, err
	}
1094

1095
1096
1097
1098
	delete(kvData, "general.name")
	delete(kvData, "tokenizer.chat_template")
	resp.ModelInfo = kvData

1099
1100
1101
1102
1103
1104
	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

1105
	if len(m.ProjectorPaths) > 0 {
1106
		projectorData, _, err := getModelData(m.ProjectorPaths[0], req.Verbose)
1107
1108
1109
1110
1111
1112
		if err != nil {
			return nil, err
		}
		resp.ProjectorInfo = projectorData
	}

Patrick Devine's avatar
Patrick Devine committed
1113
1114
1115
	return resp, nil
}

1116
func getModelData(digest string, verbose bool) (ggml.KV, ggml.Tensors, error) {
1117
1118
1119
1120
	maxArraySize := 0
	if verbose {
		maxArraySize = -1
	}
1121
	data, err := llm.LoadModel(digest, maxArraySize)
1122
	if err != nil {
1123
		return nil, ggml.Tensors{}, err
1124
1125
	}

1126
	kv := data.KV()
1127
1128
1129
1130
1131
1132
1133
1134
1135

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

1136
	return kv, data.Tensors(), nil
1137
1138
}

1139
func (s *Server) ListHandler(c *gin.Context) {
1140
	ms, err := Manifests(true)
Patrick Devine's avatar
Patrick Devine committed
1141
1142
1143
1144
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}
Michael Yang's avatar
Michael Yang committed
1145

1146
	models := []api.ListModelResponse{}
1147
1148
	for n, m := range ms {
		var cf ConfigV2
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161

		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
1162
		}
Michael Yang's avatar
Michael Yang committed
1163

1164
1165
		// tag should never be masked
		models = append(models, api.ListModelResponse{
1166
1167
1168
1169
1170
1171
1172
			Model:       n.DisplayShortest(),
			Name:        n.DisplayShortest(),
			RemoteModel: cf.RemoteModel,
			RemoteHost:  cf.RemoteHost,
			Size:        m.Size(),
			Digest:      m.digest,
			ModifiedAt:  m.fi.ModTime(),
1173
1174
1175
1176
1177
1178
1179
			Details: api.ModelDetails{
				Format:            cf.ModelFormat,
				Family:            cf.ModelFamily,
				Families:          cf.ModelFamilies,
				ParameterSize:     cf.ModelType,
				QuantizationLevel: cf.FileType,
			},
1180
		})
Patrick Devine's avatar
Patrick Devine committed
1181
1182
	}

1183
	slices.SortStableFunc(models, func(i, j api.ListModelResponse) int {
1184
1185
1186
1187
		// most recently modified first
		return cmp.Compare(j.ModifiedAt.Unix(), i.ModifiedAt.Unix())
	})

Michael Yang's avatar
Michael Yang committed
1188
	c.JSON(http.StatusOK, api.ListResponse{Models: models})
Patrick Devine's avatar
Patrick Devine committed
1189
1190
}

1191
func (s *Server) CopyHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
1192
1193
	var r api.CopyRequest
	if err := c.ShouldBindJSON(&r); errors.Is(err, io.EOF) {
Michael Yang's avatar
Michael Yang committed
1194
1195
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
1196
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
1197
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Patrick Devine's avatar
Patrick Devine committed
1198
1199
1200
		return
	}

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

Michael Yang's avatar
Michael Yang committed
1212
1213
	dst := model.ParseName(r.Destination)
	if !dst.IsValid() {
1214
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("destination %q is invalid", r.Destination)})
Patrick Devine's avatar
Patrick Devine committed
1215
1216
		return
	}
1217
1218
	dst, err = getExistingName(dst)
	if err != nil {
1219
1220
1221
1222
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

Michael Yang's avatar
Michael Yang committed
1223
1224
1225
1226
1227
	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
1228
1229
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1230
func (s *Server) HeadBlobHandler(c *gin.Context) {
Michael Yang's avatar
Michael Yang committed
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
	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
1242
	c.Status(http.StatusOK)
Michael Yang's avatar
Michael Yang committed
1243
1244
}

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

1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
	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
	}

1283
	layer, err := NewLayer(c.Request.Body, "")
Michael Yang's avatar
Michael Yang committed
1284
1285
1286
1287
1288
	if err != nil {
		c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

1289
1290
	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
1291
1292
1293
		return
	}

Michael Yang's avatar
Michael Yang committed
1294
	c.Status(http.StatusCreated)
Michael Yang's avatar
Michael Yang committed
1295
1296
}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
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
}

1318
func allowedHost(host string) bool {
1319
1320
	host = strings.ToLower(host)

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1321
	if host == "" || host == "localhost" {
1322
1323
1324
		return true
	}

1325
	if hostname, err := os.Hostname(); err == nil && host == strings.ToLower(hostname) {
1326
1327
1328
		return true
	}

Michael Yang's avatar
lint  
Michael Yang committed
1329
	tlds := []string{
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1330
1331
1332
		"localhost",
		"local",
		"internal",
1333
	}
1334

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1335
	// check if the host is a local TLD
1336
1337
1338
1339
1340
1341
	for _, tld := range tlds {
		if strings.HasSuffix(host, "."+tld) {
			return true
		}
	}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1342
	return false
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1343
}
1344

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1345
1346
1347
func allowedHostsMiddleware(addr net.Addr) gin.HandlerFunc {
	return func(c *gin.Context) {
		if addr == nil {
1348
1349
1350
1351
			c.Next()
			return
		}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1352
		if addr, err := netip.ParseAddrPort(addr.String()); err == nil && !addr.Addr().IsLoopback() {
1353
1354
1355
1356
1357
1358
1359
1360
1361
			c.Next()
			return
		}

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

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1362
		if addr, err := netip.ParseAddr(host); err == nil {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1363
			if addr.IsLoopback() || addr.IsPrivate() || addr.IsUnspecified() || isLocalIP(addr) {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1364
1365
1366
1367
1368
				c.Next()
				return
			}
		}

1369
		if allowedHost(host) {
Michael Yang's avatar
lint  
Michael Yang committed
1370
			if c.Request.Method == http.MethodOptions {
1371
1372
1373
1374
				c.AbortWithStatus(http.StatusNoContent)
				return
			}

1375
1376
1377
1378
1379
1380
			c.Next()
			return
		}

		c.AbortWithStatus(http.StatusForbidden)
	}
1381
}
1382

1383
func (s *Server) GenerateRoutes(rc *ollama.Registry) (http.Handler, error) {
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
	corsConfig := cors.DefaultConfig()
	corsConfig.AllowWildcard = true
	corsConfig.AllowBrowserExtensions = true
	corsConfig.AllowHeaders = []string{
		"Authorization",
		"Content-Type",
		"User-Agent",
		"Accept",
		"X-Requested-With",

		// OpenAI compatibility headers
1395
1396
1397
1398
1399
		"OpenAI-Beta",
		"x-stainless-arch",
		"x-stainless-async",
		"x-stainless-custom-poll-interval",
		"x-stainless-helper-method",
1400
1401
		"x-stainless-lang",
		"x-stainless-os",
1402
1403
		"x-stainless-package-version",
		"x-stainless-poll-helper",
1404
1405
1406
1407
1408
1409
		"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
1410

Bruce MacDonald's avatar
Bruce MacDonald committed
1411
	r := gin.Default()
1412
	r.HandleMethodNotAllowed = true
1413
	r.Use(
1414
		cors.New(corsConfig),
1415
		allowedHostsMiddleware(s.addr),
1416
	)
Bruce MacDonald's avatar
Bruce MacDonald committed
1417

1418
1419
1420
1421
1422
1423
	// 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}) })

1424
	// Local model cache management (new implementation is at end of function)
1425
1426
	r.POST("/api/pull", s.PullHandler)
	r.POST("/api/push", s.PushHandler)
1427
1428
	r.HEAD("/api/tags", s.ListHandler)
	r.GET("/api/tags", s.ListHandler)
1429
	r.POST("/api/show", s.ShowHandler)
1430
	r.DELETE("/api/delete", s.DeleteHandler)
1431

1432
1433
	r.POST("/api/me", s.WhoamiHandler)

1434
1435
1436
1437
	r.POST("/api/signout", s.SignoutHandler)
	// deprecated
	r.DELETE("/api/user/keys/:encodedKey", s.SignoutHandler)

1438
1439
	// Create
	r.POST("/api/create", s.CreateHandler)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1440
1441
	r.POST("/api/blobs/:digest", s.CreateBlobHandler)
	r.HEAD("/api/blobs/:digest", s.HeadBlobHandler)
1442
1443
1444
	r.POST("/api/copy", s.CopyHandler)

	// Inference
1445
	r.GET("/api/ps", s.PsHandler)
1446
1447
1448
1449
	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
1450

1451
	// Inference (OpenAI compatibility)
1452
1453
1454
1455
1456
	r.POST("/v1/chat/completions", middleware.ChatMiddleware(), s.ChatHandler)
	r.POST("/v1/completions", middleware.CompletionsMiddleware(), s.GenerateHandler)
	r.POST("/v1/embeddings", middleware.EmbeddingsMiddleware(), s.EmbedHandler)
	r.GET("/v1/models", middleware.ListMiddleware(), s.ListHandler)
	r.GET("/v1/models/:model", middleware.RetrieveMiddleware(), s.ShowHandler)
1457

1458
1459
1460
1461
1462
1463
	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,
1464

1465
1466
1467
			Prune: PruneLayers,
		}
		return rs, nil
1468
1469
	}

1470
	return r, nil
1471
1472
1473
}

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

1477
1478
1479
1480
1481
1482
1483
1484
	blobsDir, err := GetBlobsPath("")
	if err != nil {
		return err
	}
	if err := fixBlobs(blobsDir); err != nil {
		return err
	}

Michael Yang's avatar
bool  
Michael Yang committed
1485
	if !envconfig.NoPrune() {
1486
1487
1488
1489
1490
1491
1492
		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
			}
1493

1494
1495
1496
1497
			manifestsPath, err := GetManifestPath()
			if err != nil {
				return err
			}
1498

1499
1500
1501
			if err := PruneDirectory(manifestsPath); err != nil {
				return err
			}
1502
1503
1504
		}
	}

1505
1506
	s := &Server{addr: ln.Addr()}

1507
1508
1509
1510
1511
1512
1513
	var rc *ollama.Registry
	if useClient2 {
		var err error
		rc, err = ollama.DefaultRegistry()
		if err != nil {
			return err
		}
1514
1515
	}

1516
	h, err := s.GenerateRoutes(rc)
1517
1518
1519
	if err != nil {
		return err
	}
1520

1521
1522
	http.Handle("/", h)

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1523
	ctx, done := context.WithCancel(context.Background())
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1524
1525
	schedCtx, schedDone := context.WithCancel(ctx)
	sched := InitScheduler(schedCtx)
1526
	s.sched = sched
1527

1528
	slog.Info(fmt.Sprintf("Listening on %s (version %s)", ln.Addr(), version.Version))
1529
	srvr := &http.Server{
1530
1531
1532
1533
1534
1535
1536
1537
1538
		// 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
1539
1540
	}

1541
1542
	// listen for a ctrl+c and stop any loaded llm
	signals := make(chan os.Signal, 1)
1543
	signal.Notify(signals, syscall.SIGINT, syscall.SIGTERM)
1544
1545
	go func() {
		<-signals
1546
		srvr.Close()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1547
		schedDone()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1548
		sched.unloadAllRunners()
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1549
		done()
1550
1551
	}()

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1552
	s.sched.Run(schedCtx)
Daniel Hiltgen's avatar
Daniel Hiltgen committed
1553

1554
1555
1556
1557
	// 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
1558
1559
	// 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
1560
1561
	gpus := discover.GPUDevices(ctx, nil)
	discover.LogDetails(gpus)
1562

1563
1564
1565
1566
1567
1568
1569
1570
1571
	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
1572
1573
1574
1575
1576
1577
1578
	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()
1579
	return nil
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1580
}
Michael Yang's avatar
Michael Yang committed
1581

1582
func waitForStream(c *gin.Context, ch chan any) {
1583
	c.Header("Content-Type", "application/json")
1584
	var latest api.ProgressResponse
1585
1586
1587
	for resp := range ch {
		switch r := resp.(type) {
		case api.ProgressResponse:
1588
			latest = r
1589
		case gin.H:
Josh's avatar
Josh committed
1590
1591
1592
1593
			status, ok := r["status"].(int)
			if !ok {
				status = http.StatusInternalServerError
			}
1594
1595
1596
			errorMsg, ok := r["error"].(string)
			if !ok {
				errorMsg = "unknown error"
1597
			}
1598
1599
			c.JSON(status, gin.H{"error": errorMsg})
			return
1600
		default:
1601
			c.JSON(http.StatusInternalServerError, gin.H{"error": "unknown message type"})
1602
1603
1604
			return
		}
	}
1605
1606

	c.JSON(http.StatusOK, latest)
1607
1608
}

Michael Yang's avatar
Michael Yang committed
1609
func streamResponse(c *gin.Context, ch chan any) {
1610
	c.Header("Content-Type", "application/x-ndjson")
Michael Yang's avatar
Michael Yang committed
1611
1612
1613
1614
1615
1616
1617
1618
	c.Stream(func(w io.Writer) bool {
		val, ok := <-ch
		if !ok {
			return false
		}

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

1623
		// Delineate chunks with new-line delimiter
Michael Yang's avatar
Michael Yang committed
1624
1625
		bts = append(bts, '\n')
		if _, err := w.Write(bts); err != nil {
1626
			slog.Info(fmt.Sprintf("streamResponse: w.Write failed with %s", err))
Michael Yang's avatar
Michael Yang committed
1627
1628
1629
1630
1631
1632
			return false
		}

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

1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
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())
	}
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661

	// user isn't signed in
	if user != nil && user.Name == "" {
		sURL, sErr := signinURL()
		if sErr != nil {
			slog.Error(sErr.Error())
			c.JSON(http.StatusInternalServerError, gin.H{"error": "error getting authorization details"})
			return
		}

		c.JSON(http.StatusUnauthorized, gin.H{"error": "unauthorized", "signin_url": sURL})
		return
	}

1662
1663
1664
1665
	c.JSON(http.StatusOK, user)
}

func (s *Server) SignoutHandler(c *gin.Context) {
1666
1667
1668
1669
1670
1671
1672
1673
	pubKey, err := auth.GetPublicKey()
	if err != nil {
		slog.Error("couldn't get public key", "error", err)
		c.JSON(http.StatusInternalServerError, gin.H{"error": "there was an error signing out"})
		return
	}

	encKey := base64.RawURLEncoding.EncodeToString([]byte(pubKey))
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683

	// 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)
1684
	err = client.Disconnect(c, encKey)
1685
	if err != nil {
1686
1687
1688
		var authError api.AuthorizationError
		if errors.As(err, &authError) {
			c.JSON(http.StatusUnauthorized, gin.H{"error": "you are not currently signed in"})
1689
1690
1691
1692
1693
1694
1695
1696
1697
			return
		}
		c.JSON(http.StatusInternalServerError, gin.H{"error": "there was an error signing out"})
		return
	}

	c.JSON(http.StatusOK, nil)
}

1698
func (s *Server) PsHandler(c *gin.Context) {
1699
	models := []api.ProcessModelResponse{}
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710

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

1711
		mr := api.ProcessModelResponse{
1712
1713
			Model:     model.ShortName,
			Name:      model.ShortName,
Jesse Gross's avatar
Jesse Gross committed
1714
1715
			Size:      int64(v.totalSize),
			SizeVRAM:  int64(v.vramSize),
1716
1717
1718
1719
			Digest:    model.Digest,
			Details:   modelDetails,
			ExpiresAt: v.expiresAt,
		}
1720
		if v.Options != nil {
Jesse Gross's avatar
Jesse Gross committed
1721
			mr.ContextLength = v.Options.NumCtx
1722
		}
1723
1724
1725
1726
1727
1728
1729
1730
		// 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)
		}

1731
1732
1733
		models = append(models, mr)
	}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1734
1735
1736
1737
1738
	slices.SortStableFunc(models, func(i, j api.ProcessModelResponse) int {
		// longest duration remaining listed first
		return cmp.Compare(j.ExpiresAt.Unix(), i.ExpiresAt.Unix())
	})

1739
	c.JSON(http.StatusOK, api.ProcessResponse{Models: models})
1740
1741
}

Daniel Hiltgen's avatar
Daniel Hiltgen committed
1742
func (s *Server) ChatHandler(c *gin.Context) {
1743
1744
	checkpointStart := time.Now()

Bruce MacDonald's avatar
Bruce MacDonald committed
1745
	var req api.ChatRequest
Michael Yang's avatar
Michael Yang committed
1746
	if err := c.ShouldBindJSON(&req); errors.Is(err, io.EOF) {
Bruce MacDonald's avatar
Bruce MacDonald committed
1747
1748
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
		return
Michael Yang's avatar
Michael Yang committed
1749
	} else if err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1750
1751
1752
1753
		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
	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
1775
		}
1776
1777
1778
1779
		return
	}

	// expire the runner
Michael Yang's avatar
Michael Yang committed
1780
	if len(req.Messages) == 0 && req.KeepAlive != nil && req.KeepAlive.Duration == 0 {
1781
		s.sched.expireRunner(m)
Patrick Devine's avatar
Patrick Devine committed
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792

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

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
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
	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 {
1846
1847
1848
1849
1850
1851
			var authError api.AuthorizationError
			if errors.As(err, &authError) {
				sURL, sErr := signinURL()
				if sErr != nil {
					slog.Error(sErr.Error())
					c.JSON(http.StatusInternalServerError, gin.H{"error": "error getting authorization details"})
1852
1853
					return
				}
1854
1855
1856
1857
1858
1859
1860

				c.JSON(authError.StatusCode, gin.H{"error": "unauthorized", "signin_url": sURL})
				return
			}
			var apiError api.StatusError
			if errors.As(err, &apiError) {
				c.JSON(apiError.StatusCode, apiError)
1861
1862
				return
			}
1863
1864
1865
1866
1867
1868
1869
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
			return
		}

		return
	}

1870
	caps := []model.Capability{model.CapabilityCompletion}
1871
	if len(req.Tools) > 0 {
1872
		caps = append(caps, model.CapabilityTools)
Michael Yang's avatar
tools  
Michael Yang committed
1873
	}
1874
	if req.Think != nil && req.Think.Bool() {
1875
1876
		caps = append(caps, model.CapabilityThinking)
	}
Michael Yang's avatar
tools  
Michael Yang committed
1877

1878
	r, m, opts, err := s.scheduleRunner(c.Request.Context(), name.String(), caps, req.Options, req.KeepAlive)
Michael Yang's avatar
Michael Yang committed
1879
1880
	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
1881
		return
Michael Yang's avatar
Michael Yang committed
1882
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
1883
		handleScheduleError(c, req.Model, err)
Bruce MacDonald's avatar
Bruce MacDonald committed
1884
1885
		return
	}
Michael Yang's avatar
Michael Yang committed
1886

1887
1888
	checkpointLoaded := time.Now()

Michael Yang's avatar
Michael Yang committed
1889
1890
	if len(req.Messages) == 0 {
		c.JSON(http.StatusOK, api.ChatResponse{
1891
			Model:      req.Model,
Michael Yang's avatar
Michael Yang committed
1892
1893
			CreatedAt:  time.Now().UTC(),
			Message:    api.Message{Role: "assistant"},
1894
1895
			Done:       true,
			DoneReason: "load",
Michael Yang's avatar
Michael Yang committed
1896
		})
1897
1898
1899
		return
	}

Michael Yang's avatar
Michael Yang committed
1900
	msgs := append(m.Messages, req.Messages...)
1901
	if req.Messages[0].Role != "system" && m.System != "" {
Michael Yang's avatar
Michael Yang committed
1902
		msgs = append([]api.Message{{Role: "system", Content: m.System}}, msgs...)
1903
	}
1904
	msgs = filterThinkTags(msgs, m)
1905

1906
1907
	if shouldUseHarmony(m) && m.Config.Parser == "" {
		m.Config.Parser = "harmony"
Devon Rifkin's avatar
Devon Rifkin committed
1908
1909
	}

1910
	var builtinParser parsers.Parser
1911
	processedTools := req.Tools
1912

1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
	if m.Config.Parser != "" {
		builtinParser = parsers.ParserForName(m.Config.Parser)
		if builtinParser != nil {
			// Determine last message for chat prefill
			var lastMessage *api.Message
			if len(msgs) > 0 {
				lastMessage = &msgs[len(msgs)-1]
			}
			// Initialize parser and get processed tools
			processedTools = builtinParser.Init(req.Tools, lastMessage)
1923
1924
1925
1926
		}
	}

	prompt, images, err := chatPrompt(c.Request.Context(), m, r.Tokenize, opts, msgs, processedTools, req.Think)
Michael Yang's avatar
Michael Yang committed
1927
	if err != nil {
1928
		slog.Error("chat prompt error", "error", err)
Michael Yang's avatar
Michael Yang committed
1929
1930
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
1931
1932
	}

1933
1934
	// If debug mode is enabled, return the rendered template instead of calling the model
	if req.DebugRenderOnly {
Devon Rifkin's avatar
Devon Rifkin committed
1935
		c.JSON(http.StatusOK, api.ChatResponse{
1936
1937
			Model:     req.Model,
			CreatedAt: time.Now().UTC(),
Devon Rifkin's avatar
Devon Rifkin committed
1938
			DebugInfo: &api.DebugInfo{
1939
1940
1941
1942
1943
1944
1945
				RenderedTemplate: prompt,
				ImageCount:       len(images),
			},
		})
		return
	}

1946
1947
	// Validate Think value: string values currently only allowed for harmony/gptoss models
	if req.Think != nil && req.Think.IsString() && m.Config.Parser != "harmony" {
1948
		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
1949
1950
1951
		return
	}

1952
1953
	var thinkingState *thinking.Parser
	openingTag, closingTag := thinking.InferTags(m.Template.Template)
1954
	if req.Think != nil && req.Think.Bool() && openingTag != "" && closingTag != "" {
1955
		thinkingState = &thinking.Parser{
Devon Rifkin's avatar
Devon Rifkin committed
1956
1957
			OpeningTag: openingTag,
			ClosingTag: closingTag,
1958
		}
1959
1960
1961
1962

		if strings.HasSuffix(strings.TrimSpace(prompt), openingTag) {
			thinkingState.AddContent(openingTag)
		}
1963
1964
	}

1965
	var toolParser *tools.Parser
1966
	if len(req.Tools) > 0 && (builtinParser == nil || !builtinParser.HasToolSupport()) {
1967
		toolParser = tools.NewParser(m.Template.Template, req.Tools)
1968
1969
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
1970
1971
1972
	ch := make(chan any)
	go func() {
		defer close(ch)
1973

Michael Yang's avatar
Michael Yang committed
1974
		if err := r.Completion(c.Request.Context(), llm.CompletionRequest{
1975
1976
1977
1978
			Prompt:  prompt,
			Images:  images,
			Format:  req.Format,
			Options: opts,
Michael Yang's avatar
Michael Yang committed
1979
		}, func(r llm.CompletionResponse) {
1980
			res := api.ChatResponse{
1981
1982
				Model:     req.Model,
				CreatedAt: time.Now().UTC(),
1983
				Message:   api.Message{Role: "assistant", Content: r.Content},
1984
				Done:      r.Done,
Bruce MacDonald's avatar
Bruce MacDonald committed
1985
1986
1987
1988
1989
1990
1991
				Metrics: api.Metrics{
					PromptEvalCount:    r.PromptEvalCount,
					PromptEvalDuration: r.PromptEvalDuration,
					EvalCount:          r.EvalCount,
					EvalDuration:       r.EvalDuration,
				},
			}
Michael Yang's avatar
Michael Yang committed
1992
1993
1994
1995
1996
1997
			if r.Done {
				res.DoneReason = r.DoneReason.String()
				res.TotalDuration = time.Since(checkpointStart)
				res.LoadDuration = checkpointLoaded.Sub(checkpointStart)
			}

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

2001
				content, thinking, toolCalls, err := builtinParser.Add(r.Content, r.Done)
Devon Rifkin's avatar
Devon Rifkin committed
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
				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
2018
2019
				return
			}
2020

2021
			if thinkingState != nil {
Devon Rifkin's avatar
Devon Rifkin committed
2022
				thinkingContent, remainingContent := thinkingState.AddContent(res.Message.Content)
2023
2024
2025
2026
2027
2028
2029
2030
				if thinkingContent == "" && remainingContent == "" && !r.Done {
					// need to accumulate more to decide what to send
					return
				}
				res.Message.Content = remainingContent
				res.Message.Thinking = thinkingContent
			}

2031
			if len(req.Tools) > 0 {
2032
				toolCalls, content := toolParser.Add(res.Message.Content)
2033
2034
2035
2036
2037
				if len(content) > 0 {
					res.Message.Content = content
				} else if len(toolCalls) > 0 {
					res.Message.ToolCalls = toolCalls
					res.Message.Content = ""
2038
2039
				} else if res.Message.Thinking != "" {
					// don't return
2040
2041
				} else {
					if r.Done {
2042
						res.Message.Content = toolParser.Content()
2043
2044
2045
						ch <- res
					}
					return
2046
2047
				}
			}
2048

2049
			ch <- res
Michael Yang's avatar
Michael Yang committed
2050
		}); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
2051
2052
2053
2054
2055
			ch <- gin.H{"error": err.Error()}
		}
	}()

	if req.Stream != nil && !*req.Stream {
Michael Yang's avatar
tools  
Michael Yang committed
2056
		var resp api.ChatResponse
2057
		var toolCalls []api.ToolCall
2058
2059
		var sbThinking strings.Builder
		var sbContent strings.Builder
Michael Yang's avatar
Michael Yang committed
2060
2061
		for rr := range ch {
			switch t := rr.(type) {
2062
			case api.ChatResponse:
2063
2064
				sbThinking.WriteString(t.Message.Thinking)
				sbContent.WriteString(t.Message.Content)
Michael Yang's avatar
tools  
Michael Yang committed
2065
				resp = t
2066
2067
2068
				if len(req.Tools) > 0 {
					toolCalls = append(toolCalls, t.Message.ToolCalls...)
				}
2069
			case gin.H:
Michael Yang's avatar
Michael Yang committed
2070
2071
2072
				msg, ok := t["error"].(string)
				if !ok {
					msg = "unexpected error format in response"
2073
				}
Michael Yang's avatar
Michael Yang committed
2074
2075
2076

				c.JSON(http.StatusInternalServerError, gin.H{"error": msg})
				return
2077
			default:
Michael Yang's avatar
Michael Yang committed
2078
				c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected response"})
2079
				return
Bruce MacDonald's avatar
Bruce MacDonald committed
2080
2081
			}
		}
2082

2083
2084
2085
		resp.Message.Content = sbContent.String()
		resp.Message.Thinking = sbThinking.String()

2086
2087
		if len(toolCalls) > 0 {
			resp.Message.ToolCalls = toolCalls
Michael Yang's avatar
tools  
Michael Yang committed
2088
2089
2090
		}

		c.JSON(http.StatusOK, resp)
Bruce MacDonald's avatar
Bruce MacDonald committed
2091
2092
2093
2094
2095
		return
	}

	streamResponse(c, ch)
}
2096

Michael Yang's avatar
Michael Yang committed
2097
func handleScheduleError(c *gin.Context, name string, err error) {
Michael Yang's avatar
Michael Yang committed
2098
	switch {
2099
	case errors.Is(err, errCapabilities), errors.Is(err, errRequired):
Michael Yang's avatar
Michael Yang committed
2100
		c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
Michael Yang's avatar
Michael Yang committed
2101
	case errors.Is(err, context.Canceled):
2102
		c.JSON(499, gin.H{"error": "request canceled"})
Michael Yang's avatar
Michael Yang committed
2103
	case errors.Is(err, ErrMaxQueue):
2104
		c.JSON(http.StatusServiceUnavailable, gin.H{"error": err.Error()})
Michael Yang's avatar
Michael Yang committed
2105
2106
	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
2107
2108
	default:
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
2109
2110
	}
}
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122

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 {
2123
2124
2125
2126
2127
				// 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.
2128
				thinkingState := &thinking.Parser{
Devon Rifkin's avatar
Devon Rifkin committed
2129
2130
					OpeningTag: "<think>",
					ClosingTag: "</think>",
2131
				}
Devon Rifkin's avatar
Devon Rifkin committed
2132
				_, content := thinkingState.AddContent(msg.Content)
2133
				msgs[i].Content = content
2134
2135
2136
2137
2138
			}
		}
	}
	return msgs
}