routes.go 44 KB

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