routes.go 42 KB

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