routes.go 38 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514
  1. package server
  2. import (
  3. "bytes"
  4. "cmp"
  5. "context"
  6. "encoding/base64"
  7. "encoding/json"
  8. "errors"
  9. "fmt"
  10. "io"
  11. "log"
  12. "log/slog"
  13. "math"
  14. "net"
  15. "net/http"
  16. "net/netip"
  17. "os"
  18. "os/signal"
  19. "path/filepath"
  20. "slices"
  21. "strings"
  22. "syscall"
  23. "time"
  24. "github.com/gin-contrib/cors"
  25. "github.com/gin-gonic/gin"
  26. "golang.org/x/crypto/ssh"
  27. "github.com/ollama/ollama/api"
  28. "github.com/ollama/ollama/auth"
  29. "github.com/ollama/ollama/envconfig"
  30. "github.com/ollama/ollama/gpu"
  31. "github.com/ollama/ollama/llm"
  32. "github.com/ollama/ollama/openai"
  33. "github.com/ollama/ollama/parser"
  34. "github.com/ollama/ollama/template"
  35. "github.com/ollama/ollama/types/errtypes"
  36. "github.com/ollama/ollama/types/model"
  37. "github.com/ollama/ollama/version"
  38. )
  39. var mode string = gin.DebugMode
  40. type Server struct {
  41. addr net.Addr
  42. sched *Scheduler
  43. }
  44. func init() {
  45. switch mode {
  46. case gin.DebugMode:
  47. case gin.ReleaseMode:
  48. case gin.TestMode:
  49. default:
  50. mode = gin.DebugMode
  51. }
  52. gin.SetMode(mode)
  53. }
  54. var errRequired = errors.New("is required")
  55. var errBadTemplate = errors.New("template error")
  56. func modelOptions(model *Model, requestOpts map[string]interface{}) (api.Options, error) {
  57. opts := api.DefaultOptions()
  58. if err := opts.FromMap(model.Options); err != nil {
  59. return api.Options{}, err
  60. }
  61. if err := opts.FromMap(requestOpts); err != nil {
  62. return api.Options{}, err
  63. }
  64. return opts, nil
  65. }
  66. // scheduleRunner schedules a runner after validating inputs such as capabilities and model options.
  67. // It returns the allocated runner, model instance, and consolidated options if successful and error otherwise.
  68. func (s *Server) scheduleRunner(ctx context.Context, name string, caps []Capability, requestOpts map[string]any, keepAlive *api.Duration) (llm.LlamaServer, *Model, *api.Options, error) {
  69. if name == "" {
  70. return nil, nil, nil, fmt.Errorf("model %w", errRequired)
  71. }
  72. model, err := GetModel(name)
  73. if err != nil {
  74. return nil, nil, nil, err
  75. }
  76. if err := model.CheckCapabilities(caps...); err != nil {
  77. return nil, nil, nil, fmt.Errorf("%s %w", name, err)
  78. }
  79. opts, err := modelOptions(model, requestOpts)
  80. if err != nil {
  81. return nil, nil, nil, err
  82. }
  83. runnerCh, errCh := s.sched.GetRunner(ctx, model, opts, keepAlive)
  84. var runner *runnerRef
  85. select {
  86. case runner = <-runnerCh:
  87. case err = <-errCh:
  88. return nil, nil, nil, err
  89. }
  90. return runner.llama, model, &opts, nil
  91. }
  92. func (s *Server) GenerateHandler(c *gin.Context) {
  93. checkpointStart := time.Now()
  94. var req api.GenerateRequest
  95. if err := c.ShouldBindJSON(&req); errors.Is(err, io.EOF) {
  96. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
  97. return
  98. } else if err != nil {
  99. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
  100. return
  101. }
  102. if req.Format != "" && req.Format != "json" {
  103. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "format must be empty or \"json\""})
  104. return
  105. } else if req.Raw && (req.Template != "" || req.System != "" || len(req.Context) > 0) {
  106. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "raw mode does not support template, system, or context"})
  107. return
  108. }
  109. caps := []Capability{CapabilityCompletion}
  110. if req.Suffix != "" {
  111. caps = append(caps, CapabilityInsert)
  112. }
  113. r, m, opts, err := s.scheduleRunner(c.Request.Context(), req.Model, caps, req.Options, req.KeepAlive)
  114. if errors.Is(err, errCapabilityCompletion) {
  115. c.JSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("%q does not support generate", req.Model)})
  116. return
  117. } else if err != nil {
  118. handleScheduleError(c, req.Model, err)
  119. return
  120. }
  121. checkpointLoaded := time.Now()
  122. if req.Prompt == "" {
  123. c.JSON(http.StatusOK, api.GenerateResponse{
  124. Model: req.Model,
  125. CreatedAt: time.Now().UTC(),
  126. Done: true,
  127. DoneReason: "load",
  128. })
  129. return
  130. }
  131. images := make([]llm.ImageData, len(req.Images))
  132. for i := range req.Images {
  133. images[i] = llm.ImageData{ID: i, Data: req.Images[i]}
  134. }
  135. prompt := req.Prompt
  136. if !req.Raw {
  137. tmpl := m.Template
  138. if req.Template != "" {
  139. tmpl, err = template.Parse(req.Template)
  140. if err != nil {
  141. c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
  142. return
  143. }
  144. }
  145. var b bytes.Buffer
  146. if req.Context != nil {
  147. s, err := r.Detokenize(c.Request.Context(), req.Context)
  148. if err != nil {
  149. c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
  150. return
  151. }
  152. b.WriteString(s)
  153. }
  154. var values template.Values
  155. if req.Suffix != "" {
  156. values.Prompt = prompt
  157. values.Suffix = req.Suffix
  158. } else {
  159. var msgs []api.Message
  160. if req.System != "" {
  161. msgs = append(msgs, api.Message{Role: "system", Content: req.System})
  162. } else if m.System != "" {
  163. msgs = append(msgs, api.Message{Role: "system", Content: m.System})
  164. }
  165. for _, i := range images {
  166. msgs = append(msgs, api.Message{Role: "user", Content: fmt.Sprintf("[img-%d]", i.ID)})
  167. }
  168. values.Messages = append(msgs, api.Message{Role: "user", Content: req.Prompt})
  169. }
  170. if err := tmpl.Execute(&b, values); err != nil {
  171. c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
  172. return
  173. }
  174. prompt = b.String()
  175. }
  176. slog.Debug("generate request", "prompt", prompt, "images", images)
  177. ch := make(chan any)
  178. go func() {
  179. // TODO (jmorganca): avoid building the response twice both here and below
  180. var sb strings.Builder
  181. defer close(ch)
  182. if err := r.Completion(c.Request.Context(), llm.CompletionRequest{
  183. Prompt: prompt,
  184. Images: images,
  185. Format: req.Format,
  186. Options: opts,
  187. }, func(cr llm.CompletionResponse) {
  188. res := api.GenerateResponse{
  189. Model: req.Model,
  190. CreatedAt: time.Now().UTC(),
  191. Response: cr.Content,
  192. Done: cr.Done,
  193. DoneReason: cr.DoneReason,
  194. Metrics: api.Metrics{
  195. PromptEvalCount: cr.PromptEvalCount,
  196. PromptEvalDuration: cr.PromptEvalDuration,
  197. EvalCount: cr.EvalCount,
  198. EvalDuration: cr.EvalDuration,
  199. },
  200. }
  201. if _, err := sb.WriteString(cr.Content); err != nil {
  202. ch <- gin.H{"error": err.Error()}
  203. }
  204. if cr.Done {
  205. res.TotalDuration = time.Since(checkpointStart)
  206. res.LoadDuration = checkpointLoaded.Sub(checkpointStart)
  207. if !req.Raw {
  208. tokens, err := r.Tokenize(c.Request.Context(), prompt+sb.String())
  209. if err != nil {
  210. ch <- gin.H{"error": err.Error()}
  211. return
  212. }
  213. res.Context = append(req.Context, tokens...)
  214. }
  215. }
  216. ch <- res
  217. }); err != nil {
  218. ch <- gin.H{"error": err.Error()}
  219. }
  220. }()
  221. if req.Stream != nil && !*req.Stream {
  222. var r api.GenerateResponse
  223. var sb strings.Builder
  224. for rr := range ch {
  225. switch t := rr.(type) {
  226. case api.GenerateResponse:
  227. sb.WriteString(t.Response)
  228. r = t
  229. case gin.H:
  230. msg, ok := t["error"].(string)
  231. if !ok {
  232. msg = "unexpected error format in response"
  233. }
  234. c.JSON(http.StatusInternalServerError, gin.H{"error": msg})
  235. return
  236. default:
  237. c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected response"})
  238. return
  239. }
  240. }
  241. r.Response = sb.String()
  242. c.JSON(http.StatusOK, r)
  243. return
  244. }
  245. streamResponse(c, ch)
  246. }
  247. func (s *Server) EmbedHandler(c *gin.Context) {
  248. var req api.EmbedRequest
  249. err := c.ShouldBindJSON(&req)
  250. switch {
  251. case errors.Is(err, io.EOF):
  252. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
  253. return
  254. case err != nil:
  255. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
  256. return
  257. }
  258. truncate := true
  259. if req.Truncate != nil && !*req.Truncate {
  260. truncate = false
  261. }
  262. var input []string
  263. switch i := req.Input.(type) {
  264. case string:
  265. if len(i) > 0 {
  266. input = append(input, i)
  267. }
  268. case []any:
  269. for _, v := range i {
  270. if _, ok := v.(string); !ok {
  271. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "invalid input type"})
  272. return
  273. }
  274. input = append(input, v.(string))
  275. }
  276. default:
  277. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "invalid input type"})
  278. return
  279. }
  280. if len(input) == 0 {
  281. c.JSON(http.StatusOK, api.EmbedResponse{Model: req.Model, Embeddings: [][]float32{}})
  282. return
  283. }
  284. r, m, opts, err := s.scheduleRunner(c.Request.Context(), req.Model, []Capability{}, req.Options, req.KeepAlive)
  285. if err != nil {
  286. handleScheduleError(c, req.Model, err)
  287. return
  288. }
  289. kvData, err := getKVData(m.ModelPath, false)
  290. if err != nil {
  291. c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
  292. return
  293. }
  294. for i, s := range input {
  295. tokens, err := r.Tokenize(c.Request.Context(), s)
  296. if err != nil {
  297. c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
  298. return
  299. }
  300. ctxLen := min(opts.NumCtx, int(kvData.ContextLength()))
  301. if len(tokens) > ctxLen {
  302. if !truncate {
  303. c.JSON(http.StatusBadRequest, gin.H{"error": "input length exceeds maximum context length"})
  304. return
  305. }
  306. tokens = tokens[:ctxLen]
  307. s, err = r.Detokenize(c.Request.Context(), tokens)
  308. if err != nil {
  309. c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
  310. return
  311. }
  312. }
  313. input[i] = s
  314. }
  315. embeddings, err := r.Embed(c.Request.Context(), input)
  316. if err != nil {
  317. slog.Error("embedding generation failed", "error", err)
  318. c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to generate embedding"})
  319. return
  320. }
  321. for i, e := range embeddings {
  322. embeddings[i] = normalize(e)
  323. }
  324. resp := api.EmbedResponse{
  325. Model: req.Model,
  326. Embeddings: embeddings,
  327. }
  328. c.JSON(http.StatusOK, resp)
  329. }
  330. func normalize(vec []float32) []float32 {
  331. var sum float32
  332. for _, v := range vec {
  333. sum += v * v
  334. }
  335. norm := float32(0.0)
  336. if sum > 0 {
  337. norm = float32(1.0 / math.Sqrt(float64(sum)))
  338. }
  339. for i := range vec {
  340. vec[i] *= norm
  341. }
  342. return vec
  343. }
  344. func (s *Server) EmbeddingsHandler(c *gin.Context) {
  345. var req api.EmbeddingRequest
  346. if err := c.ShouldBindJSON(&req); errors.Is(err, io.EOF) {
  347. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
  348. return
  349. } else if err != nil {
  350. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
  351. return
  352. }
  353. r, _, _, err := s.scheduleRunner(c.Request.Context(), req.Model, []Capability{}, req.Options, req.KeepAlive)
  354. if err != nil {
  355. handleScheduleError(c, req.Model, err)
  356. return
  357. }
  358. // an empty request loads the model
  359. if req.Prompt == "" {
  360. c.JSON(http.StatusOK, api.EmbeddingResponse{Embedding: []float64{}})
  361. return
  362. }
  363. embeddings, err := r.Embed(c.Request.Context(), []string{req.Prompt})
  364. if err != nil {
  365. slog.Info(fmt.Sprintf("embedding generation failed: %v", err))
  366. c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to generate embedding"})
  367. return
  368. }
  369. embedding := make([]float64, len(embeddings[0]))
  370. for i, v := range embeddings[0] {
  371. embedding[i] = float64(v)
  372. }
  373. resp := api.EmbeddingResponse{
  374. Embedding: embedding,
  375. }
  376. c.JSON(http.StatusOK, resp)
  377. }
  378. func (s *Server) PullModelHandler(c *gin.Context) {
  379. var req api.PullRequest
  380. err := c.ShouldBindJSON(&req)
  381. switch {
  382. case errors.Is(err, io.EOF):
  383. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
  384. return
  385. case err != nil:
  386. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
  387. return
  388. }
  389. name := model.ParseName(cmp.Or(req.Model, req.Name))
  390. if !name.IsValid() {
  391. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "invalid model name"})
  392. return
  393. }
  394. if err := checkNameExists(name); err != nil {
  395. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
  396. return
  397. }
  398. ch := make(chan any)
  399. go func() {
  400. defer close(ch)
  401. fn := func(r api.ProgressResponse) {
  402. ch <- r
  403. }
  404. regOpts := &registryOptions{
  405. Insecure: req.Insecure,
  406. }
  407. ctx, cancel := context.WithCancel(c.Request.Context())
  408. defer cancel()
  409. if err := PullModel(ctx, name.DisplayShortest(), regOpts, fn); err != nil {
  410. ch <- gin.H{"error": err.Error()}
  411. }
  412. }()
  413. if req.Stream != nil && !*req.Stream {
  414. waitForStream(c, ch)
  415. return
  416. }
  417. streamResponse(c, ch)
  418. }
  419. func (s *Server) PushModelHandler(c *gin.Context) {
  420. var req api.PushRequest
  421. err := c.ShouldBindJSON(&req)
  422. switch {
  423. case errors.Is(err, io.EOF):
  424. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
  425. return
  426. case err != nil:
  427. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
  428. return
  429. }
  430. var model string
  431. if req.Model != "" {
  432. model = req.Model
  433. } else if req.Name != "" {
  434. model = req.Name
  435. } else {
  436. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
  437. return
  438. }
  439. ch := make(chan any)
  440. go func() {
  441. defer close(ch)
  442. fn := func(r api.ProgressResponse) {
  443. ch <- r
  444. }
  445. regOpts := &registryOptions{
  446. Insecure: req.Insecure,
  447. }
  448. ctx, cancel := context.WithCancel(c.Request.Context())
  449. defer cancel()
  450. if err := PushModel(ctx, model, regOpts, fn); err != nil {
  451. ch <- gin.H{"error": err.Error()}
  452. }
  453. }()
  454. if req.Stream != nil && !*req.Stream {
  455. waitForStream(c, ch)
  456. return
  457. }
  458. streamResponse(c, ch)
  459. }
  460. func checkNameExists(name model.Name) error {
  461. names, err := Manifests()
  462. if err != nil {
  463. return err
  464. }
  465. for n := range names {
  466. if strings.EqualFold(n.Filepath(), name.Filepath()) && n != name {
  467. return fmt.Errorf("a model with that name already exists")
  468. }
  469. }
  470. return nil
  471. }
  472. func (s *Server) CreateModelHandler(c *gin.Context) {
  473. var r api.CreateRequest
  474. if err := c.ShouldBindJSON(&r); errors.Is(err, io.EOF) {
  475. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
  476. return
  477. } else if err != nil {
  478. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
  479. return
  480. }
  481. name := model.ParseName(cmp.Or(r.Model, r.Name))
  482. if !name.IsValid() {
  483. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": errtypes.InvalidModelNameErrMsg})
  484. return
  485. }
  486. if err := checkNameExists(name); err != nil {
  487. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
  488. return
  489. }
  490. if r.Path == "" && r.Modelfile == "" {
  491. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "path or modelfile are required"})
  492. return
  493. }
  494. var sr io.Reader = strings.NewReader(r.Modelfile)
  495. if r.Path != "" && r.Modelfile == "" {
  496. f, err := os.Open(r.Path)
  497. if err != nil {
  498. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("error reading modelfile: %s", err)})
  499. return
  500. }
  501. defer f.Close()
  502. sr = f
  503. }
  504. f, err := parser.ParseFile(sr)
  505. if err != nil {
  506. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
  507. return
  508. }
  509. ch := make(chan any)
  510. go func() {
  511. defer close(ch)
  512. fn := func(resp api.ProgressResponse) {
  513. ch <- resp
  514. }
  515. ctx, cancel := context.WithCancel(c.Request.Context())
  516. defer cancel()
  517. quantization := cmp.Or(r.Quantize, r.Quantization)
  518. if err := CreateModel(ctx, name, filepath.Dir(r.Path), strings.ToUpper(quantization), f, fn); err != nil {
  519. if errors.Is(err, errBadTemplate) {
  520. ch <- gin.H{"error": err.Error(), "status": http.StatusBadRequest}
  521. }
  522. ch <- gin.H{"error": err.Error()}
  523. }
  524. }()
  525. if r.Stream != nil && !*r.Stream {
  526. waitForStream(c, ch)
  527. return
  528. }
  529. streamResponse(c, ch)
  530. }
  531. func (s *Server) DeleteModelHandler(c *gin.Context) {
  532. var r api.DeleteRequest
  533. if err := c.ShouldBindJSON(&r); errors.Is(err, io.EOF) {
  534. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
  535. return
  536. } else if err != nil {
  537. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
  538. return
  539. }
  540. n := model.ParseName(cmp.Or(r.Model, r.Name))
  541. if !n.IsValid() {
  542. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("name %q is invalid", cmp.Or(r.Model, r.Name))})
  543. return
  544. }
  545. m, err := ParseNamedManifest(n)
  546. if err != nil {
  547. c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
  548. return
  549. }
  550. if err := m.Remove(); err != nil {
  551. c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
  552. return
  553. }
  554. if err := m.RemoveLayers(); err != nil {
  555. c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
  556. return
  557. }
  558. }
  559. func (s *Server) ShowModelHandler(c *gin.Context) {
  560. var req api.ShowRequest
  561. err := c.ShouldBindJSON(&req)
  562. switch {
  563. case errors.Is(err, io.EOF):
  564. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
  565. return
  566. case err != nil:
  567. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
  568. return
  569. }
  570. if req.Model != "" {
  571. // noop
  572. } else if req.Name != "" {
  573. req.Model = req.Name
  574. } else {
  575. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
  576. return
  577. }
  578. resp, err := GetModelInfo(req)
  579. if err != nil {
  580. switch {
  581. case os.IsNotExist(err):
  582. c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found", req.Model)})
  583. case err.Error() == "invalid model name":
  584. c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
  585. default:
  586. c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
  587. }
  588. return
  589. }
  590. c.JSON(http.StatusOK, resp)
  591. }
  592. func GetModelInfo(req api.ShowRequest) (*api.ShowResponse, error) {
  593. m, err := GetModel(req.Model)
  594. if err != nil {
  595. return nil, err
  596. }
  597. modelDetails := api.ModelDetails{
  598. ParentModel: m.ParentModel,
  599. Format: m.Config.ModelFormat,
  600. Family: m.Config.ModelFamily,
  601. Families: m.Config.ModelFamilies,
  602. ParameterSize: m.Config.ModelType,
  603. QuantizationLevel: m.Config.FileType,
  604. }
  605. if req.System != "" {
  606. m.System = req.System
  607. }
  608. msgs := make([]api.Message, len(m.Messages))
  609. for i, msg := range m.Messages {
  610. msgs[i] = api.Message{Role: msg.Role, Content: msg.Content}
  611. }
  612. n := model.ParseName(req.Model)
  613. if !n.IsValid() {
  614. return nil, fmt.Errorf("invalid model name")
  615. }
  616. manifest, err := ParseNamedManifest(n)
  617. if err != nil {
  618. return nil, err
  619. }
  620. resp := &api.ShowResponse{
  621. License: strings.Join(m.License, "\n"),
  622. System: m.System,
  623. Template: m.Template.String(),
  624. Details: modelDetails,
  625. Messages: msgs,
  626. ModifiedAt: manifest.fi.ModTime(),
  627. }
  628. var params []string
  629. cs := 30
  630. for k, v := range m.Options {
  631. switch val := v.(type) {
  632. case []interface{}:
  633. for _, nv := range val {
  634. params = append(params, fmt.Sprintf("%-*s %#v", cs, k, nv))
  635. }
  636. default:
  637. params = append(params, fmt.Sprintf("%-*s %#v", cs, k, v))
  638. }
  639. }
  640. resp.Parameters = strings.Join(params, "\n")
  641. for k, v := range req.Options {
  642. if _, ok := req.Options[k]; ok {
  643. m.Options[k] = v
  644. }
  645. }
  646. var sb strings.Builder
  647. fmt.Fprintln(&sb, "# Modelfile generated by \"ollama show\"")
  648. fmt.Fprintln(&sb, "# To build a new Modelfile based on this, replace FROM with:")
  649. fmt.Fprintf(&sb, "# FROM %s\n\n", m.ShortName)
  650. fmt.Fprint(&sb, m.String())
  651. resp.Modelfile = sb.String()
  652. kvData, err := getKVData(m.ModelPath, req.Verbose)
  653. if err != nil {
  654. return nil, err
  655. }
  656. delete(kvData, "general.name")
  657. delete(kvData, "tokenizer.chat_template")
  658. resp.ModelInfo = kvData
  659. if len(m.ProjectorPaths) > 0 {
  660. projectorData, err := getKVData(m.ProjectorPaths[0], req.Verbose)
  661. if err != nil {
  662. return nil, err
  663. }
  664. resp.ProjectorInfo = projectorData
  665. }
  666. return resp, nil
  667. }
  668. func getKVData(digest string, verbose bool) (llm.KV, error) {
  669. maxArraySize := 0
  670. if verbose {
  671. maxArraySize = -1
  672. }
  673. kvData, err := llm.LoadModel(digest, maxArraySize)
  674. if err != nil {
  675. return nil, err
  676. }
  677. kv := kvData.KV()
  678. if !verbose {
  679. for k := range kv {
  680. if t, ok := kv[k].([]any); len(t) > 5 && ok {
  681. kv[k] = []any{}
  682. }
  683. }
  684. }
  685. return kv, nil
  686. }
  687. func (s *Server) ListModelsHandler(c *gin.Context) {
  688. ms, err := Manifests()
  689. if err != nil {
  690. c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
  691. return
  692. }
  693. models := []api.ListModelResponse{}
  694. for n, m := range ms {
  695. f, err := m.Config.Open()
  696. if err != nil {
  697. slog.Warn("bad manifest filepath", "name", n, "error", err)
  698. continue
  699. }
  700. defer f.Close()
  701. var cf ConfigV2
  702. if err := json.NewDecoder(f).Decode(&cf); err != nil {
  703. slog.Warn("bad manifest config", "name", n, "error", err)
  704. continue
  705. }
  706. // tag should never be masked
  707. models = append(models, api.ListModelResponse{
  708. Model: n.DisplayShortest(),
  709. Name: n.DisplayShortest(),
  710. Size: m.Size(),
  711. Digest: m.digest,
  712. ModifiedAt: m.fi.ModTime(),
  713. Details: api.ModelDetails{
  714. Format: cf.ModelFormat,
  715. Family: cf.ModelFamily,
  716. Families: cf.ModelFamilies,
  717. ParameterSize: cf.ModelType,
  718. QuantizationLevel: cf.FileType,
  719. },
  720. })
  721. }
  722. slices.SortStableFunc(models, func(i, j api.ListModelResponse) int {
  723. // most recently modified first
  724. return cmp.Compare(j.ModifiedAt.Unix(), i.ModifiedAt.Unix())
  725. })
  726. c.JSON(http.StatusOK, api.ListResponse{Models: models})
  727. }
  728. func (s *Server) CopyModelHandler(c *gin.Context) {
  729. var r api.CopyRequest
  730. if err := c.ShouldBindJSON(&r); errors.Is(err, io.EOF) {
  731. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
  732. return
  733. } else if err != nil {
  734. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
  735. return
  736. }
  737. src := model.ParseName(r.Source)
  738. if !src.IsValid() {
  739. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("source %q is invalid", r.Source)})
  740. return
  741. }
  742. dst := model.ParseName(r.Destination)
  743. if !dst.IsValid() {
  744. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("destination %q is invalid", r.Destination)})
  745. return
  746. }
  747. if err := checkNameExists(dst); err != nil {
  748. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
  749. return
  750. }
  751. if err := CopyModel(src, dst); errors.Is(err, os.ErrNotExist) {
  752. c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model %q not found", r.Source)})
  753. } else if err != nil {
  754. c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
  755. }
  756. }
  757. func (s *Server) HeadBlobHandler(c *gin.Context) {
  758. path, err := GetBlobsPath(c.Param("digest"))
  759. if err != nil {
  760. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
  761. return
  762. }
  763. if _, err := os.Stat(path); err != nil {
  764. c.AbortWithStatusJSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("blob %q not found", c.Param("digest"))})
  765. return
  766. }
  767. c.Status(http.StatusOK)
  768. }
  769. func (s *Server) CreateBlobHandler(c *gin.Context) {
  770. if ib, ok := intermediateBlobs[c.Param("digest")]; ok {
  771. p, err := GetBlobsPath(ib)
  772. if err != nil {
  773. c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
  774. return
  775. }
  776. if _, err := os.Stat(p); errors.Is(err, os.ErrNotExist) {
  777. slog.Info("evicting intermediate blob which no longer exists", "digest", ib)
  778. delete(intermediateBlobs, c.Param("digest"))
  779. } else if err != nil {
  780. c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
  781. return
  782. } else {
  783. c.Status(http.StatusOK)
  784. return
  785. }
  786. }
  787. fmt.Println("path2", c.Param("digest"))
  788. path, err := GetBlobsPath(c.Param("digest"))
  789. if err != nil {
  790. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
  791. return
  792. }
  793. fmt.Println("path1", path)
  794. _, err = os.Stat(path)
  795. switch {
  796. case errors.Is(err, os.ErrNotExist):
  797. // noop
  798. case err != nil:
  799. c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
  800. return
  801. default:
  802. c.Status(http.StatusOK)
  803. return
  804. }
  805. fmt.Println("hello")
  806. fmt.Println(s.IsLocal(c))
  807. if c.GetHeader("X-Redirect-Create") == "1" && s.IsLocal(c) {
  808. fmt.Println("entered redirect")
  809. c.Header("LocalLocation", path)
  810. c.Status(http.StatusTemporaryRedirect)
  811. return
  812. }
  813. layer, err := NewLayer(c.Request.Body, "")
  814. if err != nil {
  815. c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
  816. return
  817. }
  818. if layer.Digest != c.Param("digest") {
  819. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("digest mismatch, expected %q, got %q", c.Param("digest"), layer.Digest)})
  820. return
  821. }
  822. c.Status(http.StatusCreated)
  823. }
  824. func (s *Server) IsLocal(c *gin.Context) bool {
  825. fmt.Println("entered islocal")
  826. fmt.Println(c.GetHeader("Authorization"), " is authorization")
  827. if authz := c.GetHeader("Authorization"); authz != "" {
  828. parts := strings.Split(authz, ":")
  829. if len(parts) != 3 {
  830. fmt.Println("failed at lenParts")
  831. return false
  832. }
  833. clientPublicKey, _, _, _, err := ssh.ParseAuthorizedKey([]byte(fmt.Sprintf("ssh-ed25519 %s", parts[0])))
  834. if err != nil {
  835. fmt.Println("failed at parseAuthorizedKey")
  836. return false
  837. }
  838. // partialRequestData is formatted as http.Method,http.requestURI,timestamp,nonce
  839. requestData, err := base64.StdEncoding.DecodeString(parts[1])
  840. if err != nil {
  841. fmt.Println("failed at decodeString")
  842. return false
  843. }
  844. partialRequestDataParts := strings.Split(string(requestData), ",")
  845. if len(partialRequestDataParts) != 3 {
  846. fmt.Println("failed at lenPartialRequestDataParts")
  847. return false
  848. }
  849. /* timestamp, err := strconv.ParseInt(partialRequestDataParts[2], 10, 0)
  850. if err != nil {
  851. return false
  852. }
  853. t := time.Unix(timestamp, 0)
  854. if time.Since(t) > 5*time.Minute || time.Until(t) > 5*time.Minute {
  855. // token is invalid if timestamp +/- 5 minutes from current time
  856. return false
  857. } */
  858. /* nonce := partialRequestDataParts[3]
  859. if nonceCache.has(nonce) {
  860. return false
  861. }
  862. nonceCache.add(nonce, 5*time.Minute) */
  863. signature, err := base64.StdEncoding.DecodeString(parts[2])
  864. if err != nil {
  865. fmt.Println("failed at decodeString stdEncoding")
  866. return false
  867. }
  868. if err := clientPublicKey.Verify([]byte(requestData), &ssh.Signature{Format: clientPublicKey.Type(), Blob: signature}); err != nil {
  869. fmt.Println("failed at verify")
  870. fmt.Println(err)
  871. return false
  872. }
  873. serverPublicKey, err := auth.GetPublicKey()
  874. if err != nil {
  875. fmt.Println("failed at getPublicKey")
  876. log.Fatal(err)
  877. }
  878. if bytes.Equal(serverPublicKey.Marshal(), clientPublicKey.Marshal()) {
  879. fmt.Println("true")
  880. return true
  881. }
  882. c.AbortWithStatusJSON(http.StatusUnauthorized, gin.H{"error": "unauthorized"})
  883. return false
  884. }
  885. return false
  886. }
  887. func isLocalIP(ip netip.Addr) bool {
  888. if interfaces, err := net.Interfaces(); err == nil {
  889. for _, iface := range interfaces {
  890. addrs, err := iface.Addrs()
  891. if err != nil {
  892. continue
  893. }
  894. for _, a := range addrs {
  895. if parsed, _, err := net.ParseCIDR(a.String()); err == nil {
  896. if parsed.String() == ip.String() {
  897. return true
  898. }
  899. }
  900. }
  901. }
  902. }
  903. return false
  904. }
  905. func allowedHost(host string) bool {
  906. if host == "" || host == "localhost" {
  907. return true
  908. }
  909. if hostname, err := os.Hostname(); err == nil && host == hostname {
  910. return true
  911. }
  912. var tlds = []string{
  913. "localhost",
  914. "local",
  915. "internal",
  916. }
  917. // check if the host is a local TLD
  918. for _, tld := range tlds {
  919. if strings.HasSuffix(host, "."+tld) {
  920. return true
  921. }
  922. }
  923. return false
  924. }
  925. func allowedHostsMiddleware(addr net.Addr) gin.HandlerFunc {
  926. return func(c *gin.Context) {
  927. if addr == nil {
  928. c.Next()
  929. return
  930. }
  931. if addr, err := netip.ParseAddrPort(addr.String()); err == nil && !addr.Addr().IsLoopback() {
  932. c.Next()
  933. return
  934. }
  935. host, _, err := net.SplitHostPort(c.Request.Host)
  936. if err != nil {
  937. host = c.Request.Host
  938. }
  939. if addr, err := netip.ParseAddr(host); err == nil {
  940. if addr.IsLoopback() || addr.IsPrivate() || addr.IsUnspecified() || isLocalIP(addr) {
  941. c.Next()
  942. return
  943. }
  944. }
  945. if allowedHost(host) {
  946. if c.Request.Method == http.MethodOptions {
  947. c.AbortWithStatus(http.StatusNoContent)
  948. return
  949. }
  950. c.Next()
  951. return
  952. }
  953. c.AbortWithStatus(http.StatusForbidden)
  954. }
  955. }
  956. func (s *Server) GenerateRoutes() http.Handler {
  957. config := cors.DefaultConfig()
  958. config.AllowWildcard = true
  959. config.AllowBrowserExtensions = true
  960. config.AllowHeaders = []string{"Authorization", "Content-Type", "User-Agent", "Accept", "X-Requested-With"}
  961. openAIProperties := []string{"lang", "package-version", "os", "arch", "runtime", "runtime-version", "async"}
  962. for _, prop := range openAIProperties {
  963. config.AllowHeaders = append(config.AllowHeaders, "x-stainless-"+prop)
  964. }
  965. config.AllowOrigins = envconfig.AllowOrigins
  966. r := gin.Default()
  967. r.Use(
  968. cors.New(config),
  969. allowedHostsMiddleware(s.addr),
  970. )
  971. r.POST("/api/pull", s.PullModelHandler)
  972. r.POST("/api/generate", s.GenerateHandler)
  973. r.POST("/api/chat", s.ChatHandler)
  974. r.POST("/api/embed", s.EmbedHandler)
  975. r.POST("/api/embeddings", s.EmbeddingsHandler)
  976. r.POST("/api/create", s.CreateModelHandler)
  977. r.POST("/api/push", s.PushModelHandler)
  978. r.POST("/api/copy", s.CopyModelHandler)
  979. r.DELETE("/api/delete", s.DeleteModelHandler)
  980. r.POST("/api/show", s.ShowModelHandler)
  981. r.POST("/api/blobs/:digest", s.CreateBlobHandler)
  982. r.HEAD("/api/blobs/:digest", s.HeadBlobHandler)
  983. r.GET("/api/ps", s.ProcessHandler)
  984. // Compatibility endpoints
  985. r.POST("/v1/chat/completions", openai.ChatMiddleware(), s.ChatHandler)
  986. r.POST("/v1/completions", openai.CompletionsMiddleware(), s.GenerateHandler)
  987. r.POST("/v1/embeddings", openai.EmbeddingsMiddleware(), s.EmbedHandler)
  988. r.GET("/v1/models", openai.ListMiddleware(), s.ListModelsHandler)
  989. r.GET("/v1/models/:model", openai.RetrieveMiddleware(), s.ShowModelHandler)
  990. for _, method := range []string{http.MethodGet, http.MethodHead} {
  991. r.Handle(method, "/", func(c *gin.Context) {
  992. c.String(http.StatusOK, "Ollama is running")
  993. })
  994. r.Handle(method, "/api/tags", s.ListModelsHandler)
  995. r.Handle(method, "/api/version", func(c *gin.Context) {
  996. c.JSON(http.StatusOK, gin.H{"version": version.Version})
  997. })
  998. }
  999. return r
  1000. }
  1001. func Serve(ln net.Listener) error {
  1002. level := slog.LevelInfo
  1003. if envconfig.Debug {
  1004. level = slog.LevelDebug
  1005. }
  1006. slog.Info("server config", "env", envconfig.Values())
  1007. handler := slog.NewTextHandler(os.Stderr, &slog.HandlerOptions{
  1008. Level: level,
  1009. AddSource: true,
  1010. ReplaceAttr: func(_ []string, attr slog.Attr) slog.Attr {
  1011. if attr.Key == slog.SourceKey {
  1012. source := attr.Value.Any().(*slog.Source)
  1013. source.File = filepath.Base(source.File)
  1014. }
  1015. return attr
  1016. },
  1017. })
  1018. slog.SetDefault(slog.New(handler))
  1019. blobsDir, err := GetBlobsPath("")
  1020. if err != nil {
  1021. return err
  1022. }
  1023. if err := fixBlobs(blobsDir); err != nil {
  1024. return err
  1025. }
  1026. if !envconfig.NoPrune {
  1027. // clean up unused layers and manifests
  1028. if err := PruneLayers(); err != nil {
  1029. return err
  1030. }
  1031. manifestsPath, err := GetManifestPath()
  1032. if err != nil {
  1033. return err
  1034. }
  1035. if err := PruneDirectory(manifestsPath); err != nil {
  1036. return err
  1037. }
  1038. }
  1039. ctx, done := context.WithCancel(context.Background())
  1040. schedCtx, schedDone := context.WithCancel(ctx)
  1041. sched := InitScheduler(schedCtx)
  1042. s := &Server{addr: ln.Addr(), sched: sched}
  1043. http.Handle("/", s.GenerateRoutes())
  1044. slog.Info(fmt.Sprintf("Listening on %s (version %s)", ln.Addr(), version.Version))
  1045. srvr := &http.Server{
  1046. // Use http.DefaultServeMux so we get net/http/pprof for
  1047. // free.
  1048. //
  1049. // TODO(bmizerany): Decide if we want to make this
  1050. // configurable so it is not exposed by default, or allow
  1051. // users to bind it to a different port. This was a quick
  1052. // and easy way to get pprof, but it may not be the best
  1053. // way.
  1054. Handler: nil,
  1055. }
  1056. // listen for a ctrl+c and stop any loaded llm
  1057. signals := make(chan os.Signal, 1)
  1058. signal.Notify(signals, syscall.SIGINT, syscall.SIGTERM)
  1059. go func() {
  1060. <-signals
  1061. srvr.Close()
  1062. schedDone()
  1063. sched.unloadAllRunners()
  1064. gpu.Cleanup()
  1065. done()
  1066. }()
  1067. if err := llm.Init(); err != nil {
  1068. return fmt.Errorf("unable to initialize llm library %w", err)
  1069. }
  1070. s.sched.Run(schedCtx)
  1071. // At startup we retrieve GPU information so we can get log messages before loading a model
  1072. // This will log warnings to the log in case we have problems with detected GPUs
  1073. gpus := gpu.GetGPUInfo()
  1074. gpus.LogDetails()
  1075. err = srvr.Serve(ln)
  1076. // If server is closed from the signal handler, wait for the ctx to be done
  1077. // otherwise error out quickly
  1078. if !errors.Is(err, http.ErrServerClosed) {
  1079. return err
  1080. }
  1081. <-ctx.Done()
  1082. return nil
  1083. }
  1084. func waitForStream(c *gin.Context, ch chan interface{}) {
  1085. c.Header("Content-Type", "application/json")
  1086. for resp := range ch {
  1087. switch r := resp.(type) {
  1088. case api.ProgressResponse:
  1089. if r.Status == "success" {
  1090. c.JSON(http.StatusOK, r)
  1091. return
  1092. }
  1093. case gin.H:
  1094. status, ok := r["status"].(int)
  1095. if !ok {
  1096. status = http.StatusInternalServerError
  1097. }
  1098. if errorMsg, ok := r["error"].(string); ok {
  1099. c.JSON(status, gin.H{"error": errorMsg})
  1100. return
  1101. } else {
  1102. c.JSON(status, gin.H{"error": "unexpected error format in progress response"})
  1103. return
  1104. }
  1105. default:
  1106. c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected progress response"})
  1107. return
  1108. }
  1109. }
  1110. c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected end of progress response"})
  1111. }
  1112. func streamResponse(c *gin.Context, ch chan any) {
  1113. c.Header("Content-Type", "application/x-ndjson")
  1114. c.Stream(func(w io.Writer) bool {
  1115. val, ok := <-ch
  1116. if !ok {
  1117. return false
  1118. }
  1119. bts, err := json.Marshal(val)
  1120. if err != nil {
  1121. slog.Info(fmt.Sprintf("streamResponse: json.Marshal failed with %s", err))
  1122. return false
  1123. }
  1124. // Delineate chunks with new-line delimiter
  1125. bts = append(bts, '\n')
  1126. if _, err := w.Write(bts); err != nil {
  1127. slog.Info(fmt.Sprintf("streamResponse: w.Write failed with %s", err))
  1128. return false
  1129. }
  1130. return true
  1131. })
  1132. }
  1133. func (s *Server) ProcessHandler(c *gin.Context) {
  1134. models := []api.ProcessModelResponse{}
  1135. for _, v := range s.sched.loaded {
  1136. model := v.model
  1137. modelDetails := api.ModelDetails{
  1138. Format: model.Config.ModelFormat,
  1139. Family: model.Config.ModelFamily,
  1140. Families: model.Config.ModelFamilies,
  1141. ParameterSize: model.Config.ModelType,
  1142. QuantizationLevel: model.Config.FileType,
  1143. }
  1144. mr := api.ProcessModelResponse{
  1145. Model: model.ShortName,
  1146. Name: model.ShortName,
  1147. Size: int64(v.estimatedTotal),
  1148. SizeVRAM: int64(v.estimatedVRAM),
  1149. Digest: model.Digest,
  1150. Details: modelDetails,
  1151. ExpiresAt: v.expiresAt,
  1152. }
  1153. // The scheduler waits to set expiresAt, so if a model is loading it's
  1154. // possible that it will be set to the unix epoch. For those cases, just
  1155. // calculate the time w/ the sessionDuration instead.
  1156. var epoch time.Time
  1157. if v.expiresAt == epoch {
  1158. mr.ExpiresAt = time.Now().Add(v.sessionDuration)
  1159. }
  1160. models = append(models, mr)
  1161. }
  1162. slices.SortStableFunc(models, func(i, j api.ProcessModelResponse) int {
  1163. // longest duration remaining listed first
  1164. return cmp.Compare(j.ExpiresAt.Unix(), i.ExpiresAt.Unix())
  1165. })
  1166. c.JSON(http.StatusOK, api.ProcessResponse{Models: models})
  1167. }
  1168. func (s *Server) ChatHandler(c *gin.Context) {
  1169. checkpointStart := time.Now()
  1170. var req api.ChatRequest
  1171. if err := c.ShouldBindJSON(&req); errors.Is(err, io.EOF) {
  1172. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
  1173. return
  1174. } else if err != nil {
  1175. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
  1176. return
  1177. }
  1178. caps := []Capability{CapabilityCompletion}
  1179. if len(req.Tools) > 0 {
  1180. caps = append(caps, CapabilityTools)
  1181. }
  1182. r, m, opts, err := s.scheduleRunner(c.Request.Context(), req.Model, caps, req.Options, req.KeepAlive)
  1183. if errors.Is(err, errCapabilityCompletion) {
  1184. c.JSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("%q does not support chat", req.Model)})
  1185. return
  1186. } else if err != nil {
  1187. handleScheduleError(c, req.Model, err)
  1188. return
  1189. }
  1190. checkpointLoaded := time.Now()
  1191. if len(req.Messages) == 0 {
  1192. c.JSON(http.StatusOK, api.ChatResponse{
  1193. Model: req.Model,
  1194. CreatedAt: time.Now().UTC(),
  1195. Message: api.Message{Role: "assistant"},
  1196. Done: true,
  1197. DoneReason: "load",
  1198. })
  1199. return
  1200. }
  1201. if req.Messages[0].Role != "system" && m.System != "" {
  1202. req.Messages = append([]api.Message{{Role: "system", Content: m.System}}, req.Messages...)
  1203. }
  1204. prompt, images, err := chatPrompt(c.Request.Context(), m, r.Tokenize, opts, req.Messages, req.Tools)
  1205. if err != nil {
  1206. c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
  1207. return
  1208. }
  1209. slog.Debug("chat request", "images", len(images), "prompt", prompt)
  1210. ch := make(chan any)
  1211. go func() {
  1212. defer close(ch)
  1213. if err := r.Completion(c.Request.Context(), llm.CompletionRequest{
  1214. Prompt: prompt,
  1215. Images: images,
  1216. Format: req.Format,
  1217. Options: opts,
  1218. }, func(r llm.CompletionResponse) {
  1219. res := api.ChatResponse{
  1220. Model: req.Model,
  1221. CreatedAt: time.Now().UTC(),
  1222. Message: api.Message{Role: "assistant", Content: r.Content},
  1223. Done: r.Done,
  1224. DoneReason: r.DoneReason,
  1225. Metrics: api.Metrics{
  1226. PromptEvalCount: r.PromptEvalCount,
  1227. PromptEvalDuration: r.PromptEvalDuration,
  1228. EvalCount: r.EvalCount,
  1229. EvalDuration: r.EvalDuration,
  1230. },
  1231. }
  1232. if r.Done {
  1233. res.TotalDuration = time.Since(checkpointStart)
  1234. res.LoadDuration = checkpointLoaded.Sub(checkpointStart)
  1235. }
  1236. ch <- res
  1237. }); err != nil {
  1238. ch <- gin.H{"error": err.Error()}
  1239. }
  1240. }()
  1241. if req.Stream != nil && !*req.Stream {
  1242. var resp api.ChatResponse
  1243. var sb strings.Builder
  1244. for rr := range ch {
  1245. switch t := rr.(type) {
  1246. case api.ChatResponse:
  1247. sb.WriteString(t.Message.Content)
  1248. resp = t
  1249. case gin.H:
  1250. msg, ok := t["error"].(string)
  1251. if !ok {
  1252. msg = "unexpected error format in response"
  1253. }
  1254. c.JSON(http.StatusInternalServerError, gin.H{"error": msg})
  1255. return
  1256. default:
  1257. c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected response"})
  1258. return
  1259. }
  1260. }
  1261. resp.Message.Content = sb.String()
  1262. if len(req.Tools) > 0 {
  1263. if toolCalls, ok := m.parseToolCalls(sb.String()); ok {
  1264. resp.Message.ToolCalls = toolCalls
  1265. resp.Message.Content = ""
  1266. }
  1267. }
  1268. c.JSON(http.StatusOK, resp)
  1269. return
  1270. }
  1271. streamResponse(c, ch)
  1272. }
  1273. func handleScheduleError(c *gin.Context, name string, err error) {
  1274. switch {
  1275. case errors.Is(err, errCapabilities), errors.Is(err, errRequired):
  1276. c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
  1277. case errors.Is(err, context.Canceled):
  1278. c.JSON(499, gin.H{"error": "request canceled"})
  1279. case errors.Is(err, ErrMaxQueue):
  1280. c.JSON(http.StatusServiceUnavailable, gin.H{"error": err.Error()})
  1281. case errors.Is(err, os.ErrNotExist):
  1282. c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model %q not found, try pulling it first", name)})
  1283. default:
  1284. c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
  1285. }
  1286. }