routes.go 38 KB

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