Getting Started with Ollixir

Copy Markdown View Source

This guide walks you through your first steps with the Ollixir Elixir client.

Prerequisites

  1. Install Ollama

    Download Ollama from https://ollama.com/download.

  2. Start Ollama Server

    ollama serve

  3. Pull a Model

    ollama pull llama3.2

    Browse models at https://ollama.com/search.

    For examples, also pull:

    ollama pull nomic-embed-text
ollama pull llava
ollama pull deepseek-r1:1.5b

Add to Your Project

# mix.exs
def deps do
  [{:ollixir, "~> 0.1.1"}]
end

Your First Chat

# Start iex -S mix
iex> client = Ollixir.init()
iex> {:ok, response} = Ollixir.chat(client,
...>   model: "llama3.2",
...>   messages: [%{role: "user", content: "Hello!"}]
...> )
iex> response["message"]["content"]
"Hello! How can I help you today?"

Understanding Responses

Chat responses include:

FieldDescription
messageThe assistant's response
doneWhether generation is complete
modelModel used
total_durationTotal time in nanoseconds
eval_countTokens generated

Typed Responses (Optional)

If you prefer response structs instead of maps:

{:ok, response} = Ollixir.chat(client,
  model: "llama3.2",
  messages: [%{role: "user", content: "Hello!"}],
  response_format: :struct
)

IO.puts(response.message.content)

Next Steps