provider instead of model (#26)

* provider instead of model

* fix format

* fix

* bump version

* no bedrock when not ExAws

* refacto

Author: sonic182

README.md

@@ -27,8 +27,8 @@ Application.put_env(:llm_composer, :openai_key, "<your api key>")
 defmodule MyChat do
 
   @settings %LlmComposer.Settings{
-    model: LlmComposer.Models.OpenAI,
-    model_opts: [model: "gpt-4o-mini"],
+    provider: LlmComposer.Providers.OpenAI,
+    provider_opts: [model: "gpt-4o-mini"],
     system_prompt: "You are a helpful assistant."
   }
 
@@ -68,8 +68,8 @@ Application.put_env(:llm_composer, :openai_key, "<your api key>")
 defmodule MyCustomChat do
 
   @settings %LlmComposer.Settings{
-    model: LlmComposer.Models.OpenAI,
-    model_opts: [model: "gpt-4o-mini"],
+    provider: LlmComposer.Providers.OpenAI,
+    provider_opts: [model: "gpt-4o-mini"],
     system_prompt: "You are an assistant specialized in history.",
     auto_exec_functions: false,
     functions: []
@@ -117,8 +117,8 @@ Make sure to start the Ollama server first.
 defmodule MyChat do
 
   @settings %LlmComposer.Settings{
-    model: LlmComposer.Models.Ollama,
-    model_opts: [model: "llama3.1"],
+    provider: LlmComposer.Providers.Ollama,
+    provider_opts: [model: "llama3.1"],
     system_prompt: "You are a helpful assistant."
   }
 
@@ -169,9 +169,9 @@ Application.put_env(:llm_composer, :open_router_key, "<your openrouter api key>"
 
 defmodule MyOpenRouterChat do
   @settings %LlmComposer.Settings{
-    model: LlmComposer.Models.OpenRouter,
+    provider: LlmComposer.Providers.OpenRouter,
     # Use any model available on OpenRouter
-    model_opts: [
+    provider_opts: [
       model: "anthropic/claude-3-sonnet",
       models: ["openai/gpt-4o", "fallback-model2"],
       provider_routing: %{
@@ -223,9 +223,9 @@ config :ex_aws,
 
 defmodule MyBedrockChat do
   @settings %LlmComposer.Settings{
-    model: LlmComposer.Models.Bedrock,
+    provider: LlmComposer.Providers.Bedrock,
     # Use any model available Bedrock model
-    model_opts: [model: "eu.amazon.nova-lite-v1:0"],
+    provider_opts: [model: "eu.amazon.nova-lite-v1:0"],
     system_prompt: "You are an expert in Quantum Field Theory."
   }
 
@@ -258,8 +258,8 @@ Application.put_env(:llm_composer, :openai_key, "<your api key>")
 defmodule MyChat do
 
   @settings %LlmComposer.Settings{
-    model: LlmComposer.Models.OpenAI,
-    model_opts: [model: "gpt-4o-mini"],
+    provider: LlmComposer.Providers.OpenAI,
+    provider_opts: [model: "gpt-4o-mini"],
     system_prompt: "You are a helpful math assistant that assists with calculations.",
     auto_exec_functions: true,
     functions: [

lib/llm_composer.ex

@@ -11,8 +11,8 @@ defmodule LlmComposer do
   ```elixir
   # Define the settings for your LlmComposer instance
   settings = %LlmComposer.Settings{
-    model: LlmComposer.Models.OpenAI,
-    model_opts: [model: "gpt-4o-mini"],
+    provider: LlmComposer.Providers.OpenAI,
+    provider_opts: [model: "gpt-4o-mini"],
     system_prompt: "You are a helpful assistant.",
     user_prompt_prefix: "",
     auto_exec_functions: false,
@@ -84,11 +84,14 @@ defmodule LlmComposer do
   def run_completion(settings, messages, previous_response \\ nil) do
     system_msg = Message.new(:system, settings.system_prompt)
 
-    model_opts =
-      Keyword.merge(settings.model_opts, functions: settings.functions, api_key: settings.api_key)
+    provider_opts =
+      Keyword.merge(settings.provider_opts,
+        functions: settings.functions,
+        api_key: settings.api_key
+      )
 
     messages
-    |> settings.model.run(system_msg, model_opts)
+    |> settings.provider.run(system_msg, provider_opts)
     |> then(fn
       {:ok, res} ->
         # set previous response all the time

lib/llm_composer/models/bedrock.ex

@@ -1,4 +1,4 @@
-defmodule LlmComposer.Model do
+defmodule LlmComposer.Provider do
   @moduledoc """
   Behaviour definition for LLM models.
   """
@@ -9,5 +9,5 @@ defmodule LlmComposer.Model do
   @callback run([Message.t()], Message.t() | nil, keyword()) ::
               {:ok, LlmResponse.t()} | {:error, term()}
 
-  @callback model_id() :: atom
+  @callback name() :: atom
 end

lib/llm_composer/model.ex lib/llm_composer/provider.exlib/llm_composer/model.ex renamed to lib/llm_composer/provider.ex

@@ -0,0 +1,94 @@
+if Code.ensure_loaded?(ExAws) do
+  defmodule LlmComposer.Providers.Bedrock do
+    @moduledoc """
+    Model implementation for Amazon Bedrock.
+
+    Handles chat completion requests through Amazon Bedrock Converse API. Any
+    Bedrock compatible model can be used. To specify any model-specific options for
+    the request, you can pass them in the `request_params` option and they will
+    be merged into the base request that is prepared.
+    """
+    @behaviour LlmComposer.Provider
+
+    alias LlmComposer.LlmResponse
+    alias LlmComposer.Message
+    alias LlmComposer.Providers.Utils
+
+    @impl LlmComposer.Provider
+    def name, do: :bedrock
+
+    @impl LlmComposer.Provider
+    @doc """
+    Reference: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html
+    """
+    def run(messages, system_message, opts) do
+      model = Keyword.get(opts, :model)
+
+      if model do
+        messages
+        |> build_request(system_message, opts)
+        |> send_request(model)
+        |> handle_response()
+        |> LlmResponse.new(name())
+      else
+        {:error, :model_not_provided}
+      end
+    end
+
+    @spec build_request(list(Message.t()), Message.t(), keyword()) :: map()
+    defp build_request(messages, system_message, opts) do
+      base_request = %{
+        "messages" => Enum.map(messages, &format_message/1),
+        "system" => [format_message(system_message)]
+      }
+
+      req_params = Keyword.get(opts, :request_params, %{})
+
+      base_request
+      |> Map.merge(req_params)
+      |> Utils.cleanup_body()
+    end
+
+    @spec send_request(map(), String.t()) :: {:ok, map()} | {:error, term()}
+    defp send_request(payload, model) do
+      operation = %ExAws.Operation.JSON{
+        data: payload,
+        headers: [{"Content-Type", "application/json"}],
+        http_method: :post,
+        path: "/model/#{model}/converse",
+        service: :"bedrock-runtime"
+      }
+
+      config = [service_override: :bedrock]
+      ExAws.request(operation, config)
+    end
+
+    @spec format_message(Message.t()) :: map()
+    defp format_message(%Message{type: :system, content: content}) do
+      %{"text" => content}
+    end
+
+    defp format_message(%Message{type: role, content: content}) when is_binary(content) do
+      %{"role" => Atom.to_string(role), "content" => [%{"text" => content}]}
+    end
+
+    defp format_message(%Message{type: role, content: content}) do
+      %{"role" => Atom.to_string(role), "content" => content}
+    end
+
+    @spec handle_response({:ok, map()} | {:error, map()}) :: {:ok, map()} | {:error, term}
+    defp handle_response({:ok, %{"output" => %{"message" => _message}} = response}) do
+      {:ok,
+       %{
+         response: response,
+         actions: [],
+         input_tokens: get_in(response, ["usage", "inputTokens"]),
+         output_tokens: get_in(response, ["usage", "outputTokens"])
+       }}
+    end
+
+    defp handle_response({:error, resp}) do
+      {:error, resp}
+    end
+  end
+end

lib/llm_composer/providers/bedrock.ex

@@ -1,15 +1,15 @@
-defmodule LlmComposer.Models.Ollama do
+defmodule LlmComposer.Providers.Ollama do
   @moduledoc """
   Model implementation for Ollama
 
   Basically it calls the Ollama server api for getting the chat responses.
   """
-  @behaviour LlmComposer.Model
+  @behaviour LlmComposer.Provider
 
   use Tesla
 
   alias LlmComposer.LlmResponse
-  alias LlmComposer.Models.Utils
+  alias LlmComposer.Providers.Utils
 
   @uri Application.compile_env(:llm_composer, :ollama_uri, "http://localhost:11434")
 
@@ -28,10 +28,10 @@ defmodule LlmComposer.Models.Ollama do
     end
   )
 
-  @impl LlmComposer.Model
-  def model_id, do: :ollama
+  @impl LlmComposer.Provider
+  def name, do: :ollama
 
-  @impl LlmComposer.Model
+  @impl LlmComposer.Provider
   @doc """
   Reference: https://github.com/ollama/ollama/blob/main/docs/api.md#generate-a-chat-completion
   """
@@ -43,7 +43,7 @@ defmodule LlmComposer.Models.Ollama do
       |> build_request(system_message, model, opts)
       |> then(&post("/api/chat", &1))
       |> handle_response()
-      |> LlmResponse.new(model_id())
+      |> LlmResponse.new(name())
     else
       {:error, :model_not_provided}
     end

lib/llm_composer/models/ollama.ex lib/llm_composer/providers/ollama.exlib/llm_composer/models/ollama.ex renamed to lib/llm_composer/providers/ollama.ex

@@ -1,16 +1,16 @@
-defmodule LlmComposer.Models.OpenAI do
+defmodule LlmComposer.Providers.OpenAI do
   @moduledoc """
   Model implementation for OpenAI
 
   Basically it calls the OpenAI api for getting the chat responses.
   """
-  @behaviour LlmComposer.Model
+  @behaviour LlmComposer.Provider
 
   use Tesla
 
   alias LlmComposer.Errors.MissingKeyError
   alias LlmComposer.LlmResponse
-  alias LlmComposer.Models.Utils
+  alias LlmComposer.Providers.Utils
 
   @default_timeout 50_000
 
@@ -36,10 +36,10 @@ defmodule LlmComposer.Models.OpenAI do
     timeout: Application.get_env(:llm_composer, :timeout) || @default_timeout
   )
 
-  @impl LlmComposer.Model
-  def model_id, do: :open_ai
+  @impl LlmComposer.Provider
+  def name, do: :open_ai
 
-  @impl LlmComposer.Model
+  @impl LlmComposer.Provider
   @doc """
   Reference: https://platform.openai.com/docs/api-reference/chat/create
   """
@@ -56,7 +56,7 @@ defmodule LlmComposer.Models.OpenAI do
       |> build_request(system_message, model, opts)
       |> then(&post("/chat/completions", &1, headers: headers))
       |> handle_response()
-      |> LlmResponse.new(model_id())
+      |> LlmResponse.new(name())
     else
       {:error, :model_not_provided}
     end