routes.go 33 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370
  1. package server
  2. import (
  3. "context"
  4. "encoding/json"
  5. "errors"
  6. "fmt"
  7. "io"
  8. "io/fs"
  9. "log/slog"
  10. "math"
  11. "net"
  12. "net/http"
  13. "net/netip"
  14. "os"
  15. "os/signal"
  16. "path/filepath"
  17. "strconv"
  18. "strings"
  19. "syscall"
  20. "time"
  21. "github.com/gin-contrib/cors"
  22. "github.com/gin-gonic/gin"
  23. "golang.org/x/exp/slices"
  24. "github.com/ollama/ollama/api"
  25. "github.com/ollama/ollama/gpu"
  26. "github.com/ollama/ollama/llm"
  27. "github.com/ollama/ollama/openai"
  28. "github.com/ollama/ollama/parser"
  29. "github.com/ollama/ollama/types/model"
  30. "github.com/ollama/ollama/version"
  31. )
  32. var mode string = gin.DebugMode
  33. type Server struct {
  34. addr net.Addr
  35. sched *Scheduler
  36. }
  37. func init() {
  38. switch mode {
  39. case gin.DebugMode:
  40. case gin.ReleaseMode:
  41. case gin.TestMode:
  42. default:
  43. mode = gin.DebugMode
  44. }
  45. gin.SetMode(mode)
  46. }
  47. var defaultSessionDuration = 5 * time.Minute
  48. func modelOptions(model *Model, requestOpts map[string]interface{}) (api.Options, error) {
  49. opts := api.DefaultOptions()
  50. if err := opts.FromMap(model.Options); err != nil {
  51. return api.Options{}, err
  52. }
  53. if err := opts.FromMap(requestOpts); err != nil {
  54. return api.Options{}, err
  55. }
  56. return opts, nil
  57. }
  58. func isSupportedImageType(image []byte) bool {
  59. contentType := http.DetectContentType(image)
  60. allowedTypes := []string{"image/jpeg", "image/jpg", "image/png"}
  61. return slices.Contains(allowedTypes, contentType)
  62. }
  63. func (s *Server) GenerateHandler(c *gin.Context) {
  64. checkpointStart := time.Now()
  65. var req api.GenerateRequest
  66. err := c.ShouldBindJSON(&req)
  67. switch {
  68. case errors.Is(err, io.EOF):
  69. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
  70. return
  71. case err != nil:
  72. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
  73. return
  74. }
  75. // validate the request
  76. switch {
  77. case req.Model == "":
  78. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
  79. return
  80. case len(req.Format) > 0 && req.Format != "json":
  81. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "format must be json"})
  82. return
  83. case req.Raw && (req.Template != "" || req.System != "" || len(req.Context) > 0):
  84. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "raw mode does not support template, system, or context"})
  85. return
  86. }
  87. for _, img := range req.Images {
  88. if !isSupportedImageType(img) {
  89. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "unsupported image format"})
  90. return
  91. }
  92. }
  93. model, err := GetModel(req.Model)
  94. if err != nil {
  95. var pErr *fs.PathError
  96. if errors.As(err, &pErr) {
  97. c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found, try pulling it first", req.Model)})
  98. return
  99. }
  100. c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
  101. return
  102. }
  103. if model.IsEmbedding() {
  104. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "embedding models do not support generate"})
  105. return
  106. }
  107. opts, err := modelOptions(model, req.Options)
  108. if err != nil {
  109. if errors.Is(err, api.ErrInvalidOpts) {
  110. c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
  111. return
  112. }
  113. c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
  114. return
  115. }
  116. var sessionDuration time.Duration
  117. if req.KeepAlive == nil {
  118. sessionDuration = getDefaultSessionDuration()
  119. } else {
  120. sessionDuration = req.KeepAlive.Duration
  121. }
  122. rCh, eCh := s.sched.GetRunner(c.Request.Context(), model, opts, sessionDuration)
  123. var runner *runnerRef
  124. select {
  125. case runner = <-rCh:
  126. case err = <-eCh:
  127. if errors.Is(err, context.Canceled) {
  128. c.JSON(499, gin.H{"error": "request canceled"})
  129. return
  130. }
  131. c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
  132. return
  133. }
  134. // an empty request loads the model
  135. // note: for a short while template was used in lieu
  136. // of `raw` mode so we need to check for it too
  137. if req.Prompt == "" && req.Template == "" && req.System == "" {
  138. c.JSON(http.StatusOK, api.GenerateResponse{
  139. CreatedAt: time.Now().UTC(),
  140. Model: req.Model,
  141. Done: true,
  142. })
  143. return
  144. }
  145. checkpointLoaded := time.Now()
  146. var prompt string
  147. switch {
  148. case req.Raw:
  149. prompt = req.Prompt
  150. case req.Prompt != "":
  151. if req.Template == "" {
  152. req.Template = model.Template
  153. }
  154. if req.System == "" {
  155. req.System = model.System
  156. }
  157. slog.Debug("generate handler", "prompt", req.Prompt)
  158. slog.Debug("generate handler", "template", req.Template)
  159. slog.Debug("generate handler", "system", req.System)
  160. var sb strings.Builder
  161. for i := range req.Images {
  162. fmt.Fprintf(&sb, "[img-%d] ", i)
  163. }
  164. sb.WriteString(req.Prompt)
  165. p, err := Prompt(req.Template, req.System, sb.String(), "", true)
  166. if err != nil {
  167. c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
  168. return
  169. }
  170. sb.Reset()
  171. if req.Context != nil {
  172. prev, err := runner.llama.Detokenize(c.Request.Context(), req.Context)
  173. if err != nil {
  174. c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
  175. return
  176. }
  177. sb.WriteString(prev)
  178. }
  179. sb.WriteString(p)
  180. prompt = sb.String()
  181. }
  182. slog.Debug("generate handler", "prompt", prompt)
  183. ch := make(chan any)
  184. var generated strings.Builder
  185. go func() {
  186. defer close(ch)
  187. fn := func(r llm.CompletionResponse) {
  188. // Build up the full response
  189. if _, err := generated.WriteString(r.Content); err != nil {
  190. ch <- gin.H{"error": err.Error()}
  191. return
  192. }
  193. resp := api.GenerateResponse{
  194. Model: req.Model,
  195. CreatedAt: time.Now().UTC(),
  196. Done: r.Done,
  197. Response: r.Content,
  198. Metrics: api.Metrics{
  199. PromptEvalCount: r.PromptEvalCount,
  200. PromptEvalDuration: r.PromptEvalDuration,
  201. EvalCount: r.EvalCount,
  202. EvalDuration: r.EvalDuration,
  203. },
  204. }
  205. if r.Done {
  206. resp.TotalDuration = time.Since(checkpointStart)
  207. resp.LoadDuration = checkpointLoaded.Sub(checkpointStart)
  208. if !req.Raw {
  209. p, err := Prompt(req.Template, req.System, req.Prompt, generated.String(), false)
  210. if err != nil {
  211. c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
  212. return
  213. }
  214. // TODO (jmorganca): encode() should not strip special tokens
  215. tokens, err := runner.llama.Tokenize(c.Request.Context(), p)
  216. if err != nil {
  217. ch <- gin.H{"error": err.Error()}
  218. return
  219. }
  220. resp.Context = append(req.Context, tokens...)
  221. }
  222. }
  223. ch <- resp
  224. }
  225. var images []llm.ImageData
  226. for i := range req.Images {
  227. images = append(images, llm.ImageData{
  228. ID: i,
  229. Data: req.Images[i],
  230. })
  231. }
  232. // Start prediction
  233. req := llm.CompletionRequest{
  234. Prompt: prompt,
  235. Format: req.Format,
  236. Images: images,
  237. Options: opts,
  238. }
  239. if err := runner.llama.Completion(c.Request.Context(), req, fn); err != nil {
  240. ch <- gin.H{"error": err.Error()}
  241. }
  242. }()
  243. if req.Stream != nil && !*req.Stream {
  244. // Accumulate responses into the final response
  245. var final api.GenerateResponse
  246. var sb strings.Builder
  247. for resp := range ch {
  248. switch r := resp.(type) {
  249. case api.GenerateResponse:
  250. sb.WriteString(r.Response)
  251. final = r
  252. case gin.H:
  253. if errorMsg, ok := r["error"].(string); ok {
  254. c.JSON(http.StatusInternalServerError, gin.H{"error": errorMsg})
  255. return
  256. } else {
  257. c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected error format in response"})
  258. return
  259. }
  260. default:
  261. c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected error"})
  262. return
  263. }
  264. }
  265. final.Response = sb.String()
  266. c.JSON(http.StatusOK, final)
  267. return
  268. }
  269. streamResponse(c, ch)
  270. }
  271. func getDefaultSessionDuration() time.Duration {
  272. if t, exists := os.LookupEnv("OLLAMA_KEEP_ALIVE"); exists {
  273. v, err := strconv.Atoi(t)
  274. if err != nil {
  275. d, err := time.ParseDuration(t)
  276. if err != nil {
  277. return defaultSessionDuration
  278. }
  279. if d < 0 {
  280. return time.Duration(math.MaxInt64)
  281. }
  282. return d
  283. }
  284. d := time.Duration(v) * time.Second
  285. if d < 0 {
  286. return time.Duration(math.MaxInt64)
  287. }
  288. return d
  289. }
  290. return defaultSessionDuration
  291. }
  292. func (s *Server) EmbeddingsHandler(c *gin.Context) {
  293. var req api.EmbeddingRequest
  294. err := c.ShouldBindJSON(&req)
  295. switch {
  296. case errors.Is(err, io.EOF):
  297. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
  298. return
  299. case err != nil:
  300. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
  301. return
  302. }
  303. if req.Model == "" {
  304. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
  305. return
  306. }
  307. model, err := GetModel(req.Model)
  308. if err != nil {
  309. var pErr *fs.PathError
  310. if errors.As(err, &pErr) {
  311. c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found, try pulling it first", req.Model)})
  312. return
  313. }
  314. c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
  315. return
  316. }
  317. opts, err := modelOptions(model, req.Options)
  318. if err != nil {
  319. if errors.Is(err, api.ErrInvalidOpts) {
  320. c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
  321. return
  322. }
  323. c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
  324. return
  325. }
  326. var sessionDuration time.Duration
  327. if req.KeepAlive == nil {
  328. sessionDuration = getDefaultSessionDuration()
  329. } else {
  330. sessionDuration = req.KeepAlive.Duration
  331. }
  332. rCh, eCh := s.sched.GetRunner(c.Request.Context(), model, opts, sessionDuration)
  333. var runner *runnerRef
  334. select {
  335. case runner = <-rCh:
  336. case err = <-eCh:
  337. if errors.Is(err, context.Canceled) {
  338. c.JSON(499, gin.H{"error": "request canceled"})
  339. return
  340. }
  341. c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
  342. return
  343. }
  344. switch {
  345. // single embedding
  346. case len(req.Prompt) > 0:
  347. embeddings, err := runner.llama.Embeddings(c.Request.Context(), []string{req.Prompt})
  348. if err != nil {
  349. slog.Info(fmt.Sprintf("embedding generation failed: %v", err))
  350. c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to generate embedding"})
  351. return
  352. }
  353. resp := api.EmbeddingResponse{Embedding: embeddings[0]}
  354. c.JSON(http.StatusOK, resp)
  355. // batch embeddings
  356. case len(req.PromptBatch) > 0:
  357. embeddings, err := runner.llama.Embeddings(c.Request.Context(), req.PromptBatch)
  358. if err != nil {
  359. slog.Info(fmt.Sprintf("batch embedding generation failed: %v", err))
  360. c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to generate embedding"})
  361. return
  362. }
  363. resp := api.EmbeddingResponse{EmbeddingBatch: embeddings}
  364. c.JSON(http.StatusOK, resp)
  365. // empty prompt loads the model
  366. default:
  367. if req.PromptBatch != nil {
  368. c.JSON(http.StatusOK, api.EmbeddingResponse{EmbeddingBatch: [][]float64{}})
  369. } else {
  370. c.JSON(http.StatusOK, api.EmbeddingResponse{Embedding: []float64{}})
  371. }
  372. }
  373. }
  374. func (s *Server) PullModelHandler(c *gin.Context) {
  375. var req api.PullRequest
  376. err := c.ShouldBindJSON(&req)
  377. switch {
  378. case errors.Is(err, io.EOF):
  379. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
  380. return
  381. case err != nil:
  382. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
  383. return
  384. }
  385. var model string
  386. if req.Model != "" {
  387. model = req.Model
  388. } else if req.Name != "" {
  389. model = req.Name
  390. } else {
  391. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
  392. return
  393. }
  394. ch := make(chan any)
  395. go func() {
  396. defer close(ch)
  397. fn := func(r api.ProgressResponse) {
  398. ch <- r
  399. }
  400. regOpts := &registryOptions{
  401. Insecure: req.Insecure,
  402. }
  403. ctx, cancel := context.WithCancel(c.Request.Context())
  404. defer cancel()
  405. if err := PullModel(ctx, model, regOpts, fn); err != nil {
  406. ch <- gin.H{"error": err.Error()}
  407. }
  408. }()
  409. if req.Stream != nil && !*req.Stream {
  410. waitForStream(c, ch)
  411. return
  412. }
  413. streamResponse(c, ch)
  414. }
  415. func (s *Server) PushModelHandler(c *gin.Context) {
  416. var req api.PushRequest
  417. err := c.ShouldBindJSON(&req)
  418. switch {
  419. case errors.Is(err, io.EOF):
  420. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
  421. return
  422. case err != nil:
  423. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
  424. return
  425. }
  426. var model string
  427. if req.Model != "" {
  428. model = req.Model
  429. } else if req.Name != "" {
  430. model = req.Name
  431. } else {
  432. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
  433. return
  434. }
  435. ch := make(chan any)
  436. go func() {
  437. defer close(ch)
  438. fn := func(r api.ProgressResponse) {
  439. ch <- r
  440. }
  441. regOpts := &registryOptions{
  442. Insecure: req.Insecure,
  443. }
  444. ctx, cancel := context.WithCancel(c.Request.Context())
  445. defer cancel()
  446. if err := PushModel(ctx, model, regOpts, fn); err != nil {
  447. ch <- gin.H{"error": err.Error()}
  448. }
  449. }()
  450. if req.Stream != nil && !*req.Stream {
  451. waitForStream(c, ch)
  452. return
  453. }
  454. streamResponse(c, ch)
  455. }
  456. func (s *Server) CreateModelHandler(c *gin.Context) {
  457. var req api.CreateRequest
  458. err := c.ShouldBindJSON(&req)
  459. switch {
  460. case errors.Is(err, io.EOF):
  461. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
  462. return
  463. case err != nil:
  464. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
  465. return
  466. }
  467. var model string
  468. if req.Model != "" {
  469. model = req.Model
  470. } else if req.Name != "" {
  471. model = req.Name
  472. } else {
  473. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
  474. return
  475. }
  476. if err := ParseModelPath(model).Validate(); err != nil {
  477. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
  478. return
  479. }
  480. if req.Path == "" && req.Modelfile == "" {
  481. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "path or modelfile are required"})
  482. return
  483. }
  484. var modelfile io.Reader = strings.NewReader(req.Modelfile)
  485. if req.Path != "" && req.Modelfile == "" {
  486. mf, err := os.Open(req.Path)
  487. if err != nil {
  488. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("error reading modelfile: %s", err)})
  489. return
  490. }
  491. defer mf.Close()
  492. modelfile = mf
  493. }
  494. commands, err := parser.Parse(modelfile)
  495. if err != nil {
  496. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
  497. return
  498. }
  499. ch := make(chan any)
  500. go func() {
  501. defer close(ch)
  502. fn := func(resp api.ProgressResponse) {
  503. ch <- resp
  504. }
  505. ctx, cancel := context.WithCancel(c.Request.Context())
  506. defer cancel()
  507. if err := CreateModel(ctx, model, filepath.Dir(req.Path), req.Quantization, commands, fn); err != nil {
  508. ch <- gin.H{"error": err.Error()}
  509. }
  510. }()
  511. if req.Stream != nil && !*req.Stream {
  512. waitForStream(c, ch)
  513. return
  514. }
  515. streamResponse(c, ch)
  516. }
  517. func (s *Server) DeleteModelHandler(c *gin.Context) {
  518. var req api.DeleteRequest
  519. err := c.ShouldBindJSON(&req)
  520. switch {
  521. case errors.Is(err, io.EOF):
  522. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
  523. return
  524. case err != nil:
  525. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
  526. return
  527. }
  528. var model string
  529. if req.Model != "" {
  530. model = req.Model
  531. } else if req.Name != "" {
  532. model = req.Name
  533. } else {
  534. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
  535. return
  536. }
  537. if err := DeleteModel(model); err != nil {
  538. if os.IsNotExist(err) {
  539. c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found", model)})
  540. } else {
  541. c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
  542. }
  543. return
  544. }
  545. manifestsPath, err := GetManifestPath()
  546. if err != nil {
  547. c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
  548. return
  549. }
  550. if err := PruneDirectory(manifestsPath); err != nil {
  551. c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
  552. return
  553. }
  554. c.JSON(http.StatusOK, nil)
  555. }
  556. func (s *Server) ShowModelHandler(c *gin.Context) {
  557. var req api.ShowRequest
  558. err := c.ShouldBindJSON(&req)
  559. switch {
  560. case errors.Is(err, io.EOF):
  561. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
  562. return
  563. case err != nil:
  564. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
  565. return
  566. }
  567. if req.Model != "" {
  568. // noop
  569. } else if req.Name != "" {
  570. req.Model = req.Name
  571. } else {
  572. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
  573. return
  574. }
  575. resp, err := GetModelInfo(req)
  576. if err != nil {
  577. if os.IsNotExist(err) {
  578. c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found", req.Model)})
  579. } else {
  580. c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
  581. }
  582. return
  583. }
  584. c.JSON(http.StatusOK, resp)
  585. }
  586. func GetModelInfo(req api.ShowRequest) (*api.ShowResponse, error) {
  587. model, err := GetModel(req.Model)
  588. if err != nil {
  589. return nil, err
  590. }
  591. modelDetails := api.ModelDetails{
  592. ParentModel: model.ParentModel,
  593. Format: model.Config.ModelFormat,
  594. Family: model.Config.ModelFamily,
  595. Families: model.Config.ModelFamilies,
  596. ParameterSize: model.Config.ModelType,
  597. QuantizationLevel: model.Config.FileType,
  598. }
  599. if req.System != "" {
  600. model.System = req.System
  601. }
  602. if req.Template != "" {
  603. model.Template = req.Template
  604. }
  605. msgs := make([]api.Message, 0)
  606. for _, msg := range model.Messages {
  607. msgs = append(msgs, api.Message{Role: msg.Role, Content: msg.Content})
  608. }
  609. resp := &api.ShowResponse{
  610. License: strings.Join(model.License, "\n"),
  611. System: model.System,
  612. Template: model.Template,
  613. Details: modelDetails,
  614. Messages: msgs,
  615. }
  616. var params []string
  617. cs := 30
  618. for k, v := range model.Options {
  619. switch val := v.(type) {
  620. case []interface{}:
  621. for _, nv := range val {
  622. params = append(params, fmt.Sprintf("%-*s %#v", cs, k, nv))
  623. }
  624. default:
  625. params = append(params, fmt.Sprintf("%-*s %#v", cs, k, v))
  626. }
  627. }
  628. resp.Parameters = strings.Join(params, "\n")
  629. for k, v := range req.Options {
  630. if _, ok := req.Options[k]; ok {
  631. model.Options[k] = v
  632. }
  633. }
  634. mf, err := ShowModelfile(model)
  635. if err != nil {
  636. return nil, err
  637. }
  638. resp.Modelfile = mf
  639. return resp, nil
  640. }
  641. func (s *Server) ListModelsHandler(c *gin.Context) {
  642. models := make([]api.ModelResponse, 0)
  643. manifestsPath, err := GetManifestPath()
  644. if err != nil {
  645. c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
  646. return
  647. }
  648. modelResponse := func(modelName string) (api.ModelResponse, error) {
  649. model, err := GetModel(modelName)
  650. if err != nil {
  651. return api.ModelResponse{}, err
  652. }
  653. modelDetails := api.ModelDetails{
  654. Format: model.Config.ModelFormat,
  655. Family: model.Config.ModelFamily,
  656. Families: model.Config.ModelFamilies,
  657. ParameterSize: model.Config.ModelType,
  658. QuantizationLevel: model.Config.FileType,
  659. }
  660. return api.ModelResponse{
  661. Model: model.ShortName,
  662. Name: model.ShortName,
  663. Size: model.Size,
  664. Digest: model.Digest,
  665. Details: modelDetails,
  666. }, nil
  667. }
  668. walkFunc := func(path string, info os.FileInfo, _ error) error {
  669. if !info.IsDir() {
  670. path, tag := filepath.Split(path)
  671. model := strings.Trim(strings.TrimPrefix(path, manifestsPath), string(os.PathSeparator))
  672. modelPath := strings.Join([]string{model, tag}, ":")
  673. canonicalModelPath := strings.ReplaceAll(modelPath, string(os.PathSeparator), "/")
  674. resp, err := modelResponse(canonicalModelPath)
  675. if err != nil {
  676. slog.Info(fmt.Sprintf("skipping file: %s", canonicalModelPath))
  677. // nolint: nilerr
  678. return nil
  679. }
  680. resp.ModifiedAt = info.ModTime()
  681. models = append(models, resp)
  682. }
  683. return nil
  684. }
  685. if err := filepath.Walk(manifestsPath, walkFunc); err != nil {
  686. c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
  687. return
  688. }
  689. c.JSON(http.StatusOK, api.ListResponse{Models: models})
  690. }
  691. func (s *Server) CopyModelHandler(c *gin.Context) {
  692. var r api.CopyRequest
  693. if err := c.ShouldBindJSON(&r); errors.Is(err, io.EOF) {
  694. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
  695. return
  696. } else if err != nil {
  697. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
  698. return
  699. }
  700. src := model.ParseName(r.Source)
  701. if !src.IsValid() {
  702. _ = c.Error(fmt.Errorf("source %q is invalid", r.Source))
  703. }
  704. dst := model.ParseName(r.Destination)
  705. if !dst.IsValid() {
  706. _ = c.Error(fmt.Errorf("destination %q is invalid", r.Destination))
  707. }
  708. if len(c.Errors) > 0 {
  709. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": c.Errors.Errors()})
  710. return
  711. }
  712. if err := CopyModel(src, dst); errors.Is(err, os.ErrNotExist) {
  713. c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model %q not found", r.Source)})
  714. } else if err != nil {
  715. c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
  716. }
  717. }
  718. func (s *Server) HeadBlobHandler(c *gin.Context) {
  719. path, err := GetBlobsPath(c.Param("digest"))
  720. if err != nil {
  721. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
  722. return
  723. }
  724. if _, err := os.Stat(path); err != nil {
  725. c.AbortWithStatusJSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("blob %q not found", c.Param("digest"))})
  726. return
  727. }
  728. c.Status(http.StatusOK)
  729. }
  730. func (s *Server) CreateBlobHandler(c *gin.Context) {
  731. path, err := GetBlobsPath(c.Param("digest"))
  732. if err != nil {
  733. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
  734. return
  735. }
  736. _, err = os.Stat(path)
  737. switch {
  738. case errors.Is(err, os.ErrNotExist):
  739. // noop
  740. case err != nil:
  741. c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
  742. return
  743. default:
  744. c.Status(http.StatusOK)
  745. return
  746. }
  747. layer, err := NewLayer(c.Request.Body, "")
  748. if err != nil {
  749. c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
  750. return
  751. }
  752. if layer.Digest != c.Param("digest") {
  753. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("digest mismatch, expected %q, got %q", c.Param("digest"), layer.Digest)})
  754. return
  755. }
  756. if _, err := layer.Commit(); err != nil {
  757. c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
  758. return
  759. }
  760. c.Status(http.StatusCreated)
  761. }
  762. var defaultAllowOrigins = []string{
  763. "localhost",
  764. "127.0.0.1",
  765. "0.0.0.0",
  766. }
  767. func isLocalIP(ip netip.Addr) bool {
  768. if interfaces, err := net.Interfaces(); err == nil {
  769. for _, iface := range interfaces {
  770. addrs, err := iface.Addrs()
  771. if err != nil {
  772. continue
  773. }
  774. for _, a := range addrs {
  775. if parsed, _, err := net.ParseCIDR(a.String()); err == nil {
  776. if parsed.String() == ip.String() {
  777. return true
  778. }
  779. }
  780. }
  781. }
  782. }
  783. return false
  784. }
  785. func allowedHost(host string) bool {
  786. if host == "" || host == "localhost" {
  787. return true
  788. }
  789. if hostname, err := os.Hostname(); err == nil && host == hostname {
  790. return true
  791. }
  792. var tlds = []string{
  793. "localhost",
  794. "local",
  795. "internal",
  796. }
  797. // check if the host is a local TLD
  798. for _, tld := range tlds {
  799. if strings.HasSuffix(host, "."+tld) {
  800. return true
  801. }
  802. }
  803. return false
  804. }
  805. func allowedHostsMiddleware(addr net.Addr) gin.HandlerFunc {
  806. return func(c *gin.Context) {
  807. if addr == nil {
  808. c.Next()
  809. return
  810. }
  811. if addr, err := netip.ParseAddrPort(addr.String()); err == nil && !addr.Addr().IsLoopback() {
  812. c.Next()
  813. return
  814. }
  815. host, _, err := net.SplitHostPort(c.Request.Host)
  816. if err != nil {
  817. host = c.Request.Host
  818. }
  819. if addr, err := netip.ParseAddr(host); err == nil {
  820. if addr.IsLoopback() || addr.IsPrivate() || addr.IsUnspecified() || isLocalIP(addr) {
  821. c.Next()
  822. return
  823. }
  824. }
  825. if allowedHost(host) {
  826. c.Next()
  827. return
  828. }
  829. c.AbortWithStatus(http.StatusForbidden)
  830. }
  831. }
  832. func (s *Server) GenerateRoutes() http.Handler {
  833. config := cors.DefaultConfig()
  834. config.AllowWildcard = true
  835. config.AllowBrowserExtensions = true
  836. if allowedOrigins := strings.Trim(os.Getenv("OLLAMA_ORIGINS"), "\"'"); allowedOrigins != "" {
  837. config.AllowOrigins = strings.Split(allowedOrigins, ",")
  838. }
  839. for _, allowOrigin := range defaultAllowOrigins {
  840. config.AllowOrigins = append(config.AllowOrigins,
  841. fmt.Sprintf("http://%s", allowOrigin),
  842. fmt.Sprintf("https://%s", allowOrigin),
  843. fmt.Sprintf("http://%s:*", allowOrigin),
  844. fmt.Sprintf("https://%s:*", allowOrigin),
  845. )
  846. }
  847. r := gin.Default()
  848. r.Use(
  849. cors.New(config),
  850. allowedHostsMiddleware(s.addr),
  851. )
  852. r.POST("/api/pull", s.PullModelHandler)
  853. r.POST("/api/generate", s.GenerateHandler)
  854. r.POST("/api/chat", s.ChatHandler)
  855. r.POST("/api/embeddings", s.EmbeddingsHandler)
  856. r.POST("/api/create", s.CreateModelHandler)
  857. r.POST("/api/push", s.PushModelHandler)
  858. r.POST("/api/copy", s.CopyModelHandler)
  859. r.DELETE("/api/delete", s.DeleteModelHandler)
  860. r.POST("/api/show", s.ShowModelHandler)
  861. r.POST("/api/blobs/:digest", s.CreateBlobHandler)
  862. r.HEAD("/api/blobs/:digest", s.HeadBlobHandler)
  863. // Compatibility endpoints
  864. r.POST("/v1/chat/completions", openai.Middleware(), s.ChatHandler)
  865. for _, method := range []string{http.MethodGet, http.MethodHead} {
  866. r.Handle(method, "/", func(c *gin.Context) {
  867. c.String(http.StatusOK, "Ollama is running")
  868. })
  869. r.Handle(method, "/api/tags", s.ListModelsHandler)
  870. r.Handle(method, "/api/version", func(c *gin.Context) {
  871. c.JSON(http.StatusOK, gin.H{"version": version.Version})
  872. })
  873. }
  874. return r
  875. }
  876. func Serve(ln net.Listener) error {
  877. level := slog.LevelInfo
  878. if debug := os.Getenv("OLLAMA_DEBUG"); debug != "" {
  879. level = slog.LevelDebug
  880. }
  881. handler := slog.NewTextHandler(os.Stderr, &slog.HandlerOptions{
  882. Level: level,
  883. AddSource: true,
  884. ReplaceAttr: func(_ []string, attr slog.Attr) slog.Attr {
  885. if attr.Key == slog.SourceKey {
  886. source := attr.Value.Any().(*slog.Source)
  887. source.File = filepath.Base(source.File)
  888. }
  889. return attr
  890. },
  891. })
  892. slog.SetDefault(slog.New(handler))
  893. blobsDir, err := GetBlobsPath("")
  894. if err != nil {
  895. return err
  896. }
  897. if err := fixBlobs(blobsDir); err != nil {
  898. return err
  899. }
  900. if noprune := os.Getenv("OLLAMA_NOPRUNE"); noprune == "" {
  901. // clean up unused layers and manifests
  902. if err := PruneLayers(); err != nil {
  903. return err
  904. }
  905. manifestsPath, err := GetManifestPath()
  906. if err != nil {
  907. return err
  908. }
  909. if err := PruneDirectory(manifestsPath); err != nil {
  910. return err
  911. }
  912. }
  913. ctx, done := context.WithCancel(context.Background())
  914. sched := InitScheduler(ctx)
  915. s := &Server{addr: ln.Addr(), sched: sched}
  916. r := s.GenerateRoutes()
  917. slog.Info(fmt.Sprintf("Listening on %s (version %s)", ln.Addr(), version.Version))
  918. srvr := &http.Server{
  919. Handler: r,
  920. }
  921. // listen for a ctrl+c and stop any loaded llm
  922. signals := make(chan os.Signal, 1)
  923. signal.Notify(signals, syscall.SIGINT, syscall.SIGTERM)
  924. go func() {
  925. <-signals
  926. done()
  927. sched.unloadAllRunners()
  928. gpu.Cleanup()
  929. os.Exit(0)
  930. }()
  931. if err := llm.Init(); err != nil {
  932. return fmt.Errorf("unable to initialize llm library %w", err)
  933. }
  934. s.sched.Run(ctx)
  935. // At startup we retrieve GPU information so we can get log messages before loading a model
  936. // This will log warnings to the log in case we have problems with detected GPUs
  937. _ = gpu.GetGPUInfo()
  938. return srvr.Serve(ln)
  939. }
  940. func waitForStream(c *gin.Context, ch chan interface{}) {
  941. c.Header("Content-Type", "application/json")
  942. for resp := range ch {
  943. switch r := resp.(type) {
  944. case api.ProgressResponse:
  945. if r.Status == "success" {
  946. c.JSON(http.StatusOK, r)
  947. return
  948. }
  949. case gin.H:
  950. if errorMsg, ok := r["error"].(string); ok {
  951. c.JSON(http.StatusInternalServerError, gin.H{"error": errorMsg})
  952. return
  953. } else {
  954. c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected error format in progress response"})
  955. return
  956. }
  957. default:
  958. c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected progress response"})
  959. return
  960. }
  961. }
  962. c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected end of progress response"})
  963. }
  964. func streamResponse(c *gin.Context, ch chan any) {
  965. c.Header("Content-Type", "application/x-ndjson")
  966. c.Stream(func(w io.Writer) bool {
  967. val, ok := <-ch
  968. if !ok {
  969. return false
  970. }
  971. bts, err := json.Marshal(val)
  972. if err != nil {
  973. slog.Info(fmt.Sprintf("streamResponse: json.Marshal failed with %s", err))
  974. return false
  975. }
  976. // Delineate chunks with new-line delimiter
  977. bts = append(bts, '\n')
  978. if _, err := w.Write(bts); err != nil {
  979. slog.Info(fmt.Sprintf("streamResponse: w.Write failed with %s", err))
  980. return false
  981. }
  982. return true
  983. })
  984. }
  985. // ChatPrompt builds up a prompt from a series of messages for the currently `loaded` model
  986. func chatPrompt(ctx context.Context, runner *runnerRef, template string, messages []api.Message, numCtx int) (string, error) {
  987. encode := func(s string) ([]int, error) {
  988. return runner.llama.Tokenize(ctx, s)
  989. }
  990. prompt, err := ChatPrompt(template, messages, numCtx, encode)
  991. if err != nil {
  992. return "", err
  993. }
  994. return prompt, nil
  995. }
  996. func (s *Server) ChatHandler(c *gin.Context) {
  997. checkpointStart := time.Now()
  998. var req api.ChatRequest
  999. err := c.ShouldBindJSON(&req)
  1000. switch {
  1001. case errors.Is(err, io.EOF):
  1002. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "missing request body"})
  1003. return
  1004. case err != nil:
  1005. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
  1006. return
  1007. }
  1008. // validate the request
  1009. switch {
  1010. case req.Model == "":
  1011. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "model is required"})
  1012. return
  1013. case len(req.Format) > 0 && req.Format != "json":
  1014. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "format must be json"})
  1015. return
  1016. }
  1017. model, err := GetModel(req.Model)
  1018. if err != nil {
  1019. var pErr *fs.PathError
  1020. if errors.As(err, &pErr) {
  1021. c.JSON(http.StatusNotFound, gin.H{"error": fmt.Sprintf("model '%s' not found, try pulling it first", req.Model)})
  1022. return
  1023. }
  1024. c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
  1025. return
  1026. }
  1027. if model.IsEmbedding() {
  1028. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "embedding models do not support chat"})
  1029. return
  1030. }
  1031. opts, err := modelOptions(model, req.Options)
  1032. if err != nil {
  1033. if errors.Is(err, api.ErrInvalidOpts) {
  1034. c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
  1035. return
  1036. }
  1037. c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
  1038. return
  1039. }
  1040. var sessionDuration time.Duration
  1041. if req.KeepAlive == nil {
  1042. sessionDuration = getDefaultSessionDuration()
  1043. } else {
  1044. sessionDuration = req.KeepAlive.Duration
  1045. }
  1046. rCh, eCh := s.sched.GetRunner(c.Request.Context(), model, opts, sessionDuration)
  1047. var runner *runnerRef
  1048. select {
  1049. case runner = <-rCh:
  1050. case err = <-eCh:
  1051. if errors.Is(err, context.Canceled) {
  1052. c.JSON(499, gin.H{"error": "request canceled"})
  1053. return
  1054. }
  1055. c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
  1056. return
  1057. }
  1058. checkpointLoaded := time.Now()
  1059. // if the first message is not a system message, then add the model's default system message
  1060. if len(req.Messages) > 0 && req.Messages[0].Role != "system" {
  1061. req.Messages = append([]api.Message{
  1062. {
  1063. Role: "system",
  1064. Content: model.System,
  1065. },
  1066. }, req.Messages...)
  1067. }
  1068. prompt, err := chatPrompt(c.Request.Context(), runner, model.Template, req.Messages, opts.NumCtx)
  1069. if err != nil {
  1070. c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
  1071. return
  1072. }
  1073. // an empty request loads the model
  1074. if len(req.Messages) == 0 || prompt == "" {
  1075. resp := api.ChatResponse{
  1076. CreatedAt: time.Now().UTC(),
  1077. Model: req.Model,
  1078. Done: true,
  1079. Message: api.Message{Role: "assistant"},
  1080. }
  1081. c.JSON(http.StatusOK, resp)
  1082. return
  1083. }
  1084. // only send images that are in the prompt
  1085. var i int
  1086. var images []llm.ImageData
  1087. for _, m := range req.Messages {
  1088. for _, img := range m.Images {
  1089. if !isSupportedImageType(img) {
  1090. c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "unsupported image format"})
  1091. return
  1092. }
  1093. if strings.Contains(prompt, fmt.Sprintf("[img-%d]", i)) {
  1094. images = append(images, llm.ImageData{Data: img, ID: i})
  1095. }
  1096. i += 1
  1097. }
  1098. }
  1099. slog.Debug("chat handler", "prompt", prompt, "images", len(images))
  1100. ch := make(chan any)
  1101. go func() {
  1102. defer close(ch)
  1103. fn := func(r llm.CompletionResponse) {
  1104. resp := api.ChatResponse{
  1105. Model: req.Model,
  1106. CreatedAt: time.Now().UTC(),
  1107. Message: api.Message{Role: "assistant", Content: r.Content},
  1108. Done: r.Done,
  1109. Metrics: api.Metrics{
  1110. PromptEvalCount: r.PromptEvalCount,
  1111. PromptEvalDuration: r.PromptEvalDuration,
  1112. EvalCount: r.EvalCount,
  1113. EvalDuration: r.EvalDuration,
  1114. },
  1115. }
  1116. if r.Done {
  1117. resp.TotalDuration = time.Since(checkpointStart)
  1118. resp.LoadDuration = checkpointLoaded.Sub(checkpointStart)
  1119. }
  1120. ch <- resp
  1121. }
  1122. if err := runner.llama.Completion(c.Request.Context(), llm.CompletionRequest{
  1123. Prompt: prompt,
  1124. Format: req.Format,
  1125. Images: images,
  1126. Options: opts,
  1127. }, fn); err != nil {
  1128. ch <- gin.H{"error": err.Error()}
  1129. }
  1130. }()
  1131. if req.Stream != nil && !*req.Stream {
  1132. // Accumulate responses into the final response
  1133. var final api.ChatResponse
  1134. var sb strings.Builder
  1135. for resp := range ch {
  1136. switch r := resp.(type) {
  1137. case api.ChatResponse:
  1138. sb.WriteString(r.Message.Content)
  1139. final = r
  1140. case gin.H:
  1141. if errorMsg, ok := r["error"].(string); ok {
  1142. c.JSON(http.StatusInternalServerError, gin.H{"error": errorMsg})
  1143. return
  1144. } else {
  1145. c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected error format in response"})
  1146. return
  1147. }
  1148. default:
  1149. c.JSON(http.StatusInternalServerError, gin.H{"error": "unexpected error"})
  1150. return
  1151. }
  1152. }
  1153. final.Message = api.Message{Role: "assistant", Content: sb.String()}
  1154. c.JSON(http.StatusOK, final)
  1155. return
  1156. }
  1157. streamResponse(c, ch)
  1158. }