routes.go 42 KB

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