smart_prompt 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48814b17b9e142698d6cb49efd4ab15195bddce4fca7ac5f111b52e5e8b3e04b
-  data.tar.gz: c0e23945a97549403ab6b5d3225e3b281b0d2f6f6f6097f5158ae98edb70d722
+  metadata.gz: 844c87d47dccd945bedcab69c58377ae144238ac9087b49219041382db539146
+  data.tar.gz: 3e70f88fbe8d26a0a15408e73ae9060b9f711a18e6b44eb561910b90156ca14b
 SHA512:
-  metadata.gz: 1dac2c898d593345d1f1d8c9508faabda41c2954938171f99aa9999fbe4f34532124e441ad2ccbb265bc6ceb65fb188fd7b60d8e8f1439ad478f6d2d62a38018
-  data.tar.gz: 851707ebcac1db79aa0fc29a8a92dd9e1571dd0d1207d4cd9ac75fb5992ecfac1bac09eec8599594e247066e586d4bd48b6fddf3da073e168f2039823dcce747
+  metadata.gz: 398854ce070f96f794ae944cc656a10d2f4752268cb35b4f9a857fcd8a722489b3ee112de97e5cdfe1cc1efb75cf92e4cd4a9b36cb338cbd8de6e22f1d6cc7dc
+  data.tar.gz: babac8b7d0479eb376df22b00cd693e6e657293e6b28b654aaa6b2ef4f9fcfdccb9709d6f1dd0b066cb6f22c07eed0173426816121061a80c91fc9afdd62ba06

data/README.cn.md

@@ -0,0 +1,113 @@
+# SmartPrompt
+
+SmartPrompt 是一个强大的 Ruby gem，提供了一种领域特定语言（DSL），使其他 Ruby 程序能够更加方便、自然地调用各种大型语言模型（LLM）的能力。
+
+## 主要特性
+
+- 灵活的任务组合：以特定服务提供商 + 特定 LLM + 特定 prompt 的方式组合各种任务
+- 子任务嵌套：支持以 DSL 形式组合调用其他子任务
+- 性能优化：在保证质量的同时，提供性能最优或成本最低的解决方案
+
+## 安装
+
+将 gem 安装并添加到应用程序的 Gemfile 中，执行以下命令：
+
+```
+$ bundle add smart_prompt
+```
+
+如果不使用 bundler 来管理依赖，可以通过执行以下命令来安装 gem：
+
+```
+$ gem install smart_prompt
+```
+
+## 用法
+
+以下是一些基本用法示例：
+
+### 配置文件
+
+```
+adapters:
+  openai: OpenAIAdapter
+  ollama: OllamaAdapter
+llms:
+  siliconflow:
+    adapter: openai
+    url: https://api.siliconflow.cn/v1/
+    api_key: ENV["APIKey"]
+    default_model: Qwen/Qwen2.5-7B-Instruct
+  llamacpp:
+    adapter: openai
+    url: http://localhost:8080/    
+  ollama:
+    adapter: ollama
+    url: http://localhost:11434/
+    default_model: qwen2.5
+default_llm: siliconflow
+worker_path: "./workers"
+template_path: "./templates"
+```
+
+### 基本使用
+
+```
+require 'smart_prompt'
+engine = SmartPrompt::Engine.new('./config/llm_config.yml')
+result = engine.call_worker(:daily_report, {location: "Shanghai"}) 
+puts result
+```
+
+### workers/daily_report.rb
+
+```
+SmartPrompt.define_worker :daily_report do
+    use "ollama"
+    model "gemma2"
+    system "You are a helpful report writer."
+    weather = call_worker(:weather_summary, { location: params[:location], date: "today" })
+    prompt :daily_report, { weather: weather, location: params[:location] }
+    send_msg
+end
+```
+
+### workers/weather_summary.rb
+
+```
+SmartPrompt.define_worker :weather_summary do
+  use "ollama"
+  model "gemma2"
+  sys_msg "You are a helpful weather assistant."
+  prompt :weather, { location: params[:location], date: params[:date] }
+  weather_info = send_msg
+  prompt :summarize, { text: weather_info }
+  send_msg
+end
+```
+
+### templates/daily_report.erb
+
+```
+Please create a brief daily report for <%= location %> based on the following weather information:
+
+<%= weather %>
+
+The report should include:
+1. A summary of the weather
+2. Any notable events or conditions
+3. Recommendations for residents
+```
+### templates/weather.erb
+
+```
+What's the weather like in <%= location %> <%= date %>? Please provide a brief description including temperature and general conditions.
+```
+
+### templates/summarize.erb
+
+```
+Please summarize the following text in one sentence:
+
+<%= text %>
+```

data/README.md

@@ -1,36 +1,115 @@
+EN | [中文](./README.cn.md)
+
 # SmartPrompt
 
-SmartPrompt 是一个强大的 Ruby gem，提供了一种领域特定语言（DSL），使其他 Ruby 程序能够更加方便、自然地调用各种大型语言模型（LLM）的能力。
+SmartPrompt is a powerful Ruby gem that provides a domain-specific language (DSL), enabling other Ruby programs to conveniently and naturally call upon the capabilities of various large language models (LLMs).
 
-## 主要特性
+## Key Features
 
-- 灵活的任务组合：以特定服务提供商 + 特定 LLM + 特定 prompt 的方式组合各种任务
-- 子任务嵌套：支持以 DSL 形式组合调用其他子任务
-- 性能优化：在保证质量的同时，提供性能最优或成本最低的解决方案
+- Flexible task composition: Combine various tasks using specific service providers + specific LLMs + specific prompts
+- Nested subtasks: Support for composing and calling other subtasks in DSL form
+- Performance optimization: Provide performance-optimal or cost-effective solutions while ensuring quality
 
-## 安装
+## Installation
 
-将 gem 安装并添加到应用程序的 Gemfile 中，执行以下命令：
+To install the gem and add it to your application's Gemfile, execute the following command:
 
 ```
 $ bundle add smart_prompt
 ```
 
-如果不使用 bundler 来管理依赖，可以通过执行以下命令来安装 gem：
+If you don't use a bundler to manage dependencies, you can install the gem by executing the following command:
 
 ```
 $ gem install smart_prompt
 ```
 
-## 用法
+## Usage
 
-以下是一些基本用法示例：
+The following are some examples of basic usage:
 
-### 基本使用
+### llm_config.yml
+
+```
+adapters:
+  openai: OpenAIAdapter
+  ollama: OllamaAdapter
+llms:
+  siliconflow:
+    adapter: openai
+    url: https://api.siliconflow.cn/v1/
+    api_key: ENV["APIKey"]
+    default_model: Qwen/Qwen2.5-7B-Instruct
+  llamacpp:
+    adapter: openai
+    url: http://localhost:8080/    
+  ollama:
+    adapter: ollama
+    url: http://localhost:11434/
+    default_model: qwen2.5
+default_llm: siliconflow
+worker_path: "./workers"
+template_path: "./templates"
+```
+
+### Basic usage
 
 ```
 require 'smart_prompt'
 engine = SmartPrompt::Engine.new('./config/llm_config.yml')
 result = engine.call_worker(:daily_report, {location: "Shanghai"}) 
 puts result
+```
+
+### workers/daily_report.rb
+
+```
+SmartPrompt.define_worker :daily_report do
+    use "ollama"
+    model "gemma2"
+    system "You are a helpful report writer."
+    weather = call_worker(:weather_summary, { location: params[:location], date: "today" })
+    prompt :daily_report, { weather: weather, location: params[:location] }
+    send_msg
+end
+```
+
+### workers/weather_summary.rb
+
+```
+SmartPrompt.define_worker :weather_summary do
+  use "ollama"
+  model "gemma2"
+  sys_msg "You are a helpful weather assistant."
+  prompt :weather, { location: params[:location], date: params[:date] }
+  weather_info = send_msg
+  prompt :summarize, { text: weather_info }
+  send_msg
+end
+```
+
+### templates/daily_report.erb
+
+```
+Please create a brief daily report for <%= location %> based on the following weather information:
+
+<%= weather %>
+
+The report should include:
+1. A summary of the weather
+2. Any notable events or conditions
+3. Recommendations for residents
+```
+### templates/weather.erb
+
+```
+What's the weather like in <%= location %> <%= date %>? Please provide a brief description including temperature and general conditions.
+```
+
+### templates/summarize.erb
+
+```
+Please summarize the following text in one sentence:
+
+<%= text %>
 ```

data/lib/smart_prompt/conversation.rb

@@ -5,6 +5,7 @@ module SmartPrompt
     attr_reader :messages, :last_response, :config_file
 
     def initialize(engine)
+      SmartPrompt.logger.info "Create Conversation"
       @messages = []
       @engine = engine
       @adapters = engine.adapters
@@ -26,6 +27,7 @@ module SmartPrompt
 
     def prompt(template_name, params = {})
       template_name = template_name.to_s
+      SmartPrompt.logger.info "Use template #{template_name}"
       raise "Template #{template_name} not found" unless @templates.key?(template_name)
       content = @templates[template_name].render(params)
       @messages << { role: 'user', content: content }

data/lib/smart_prompt/engine.rb

@@ -2,6 +2,7 @@ module SmartPrompt
     class Engine
       attr_reader :config_file, :config, :adapters, :current_adapter, :llms, :templates
       def initialize(config_file)
+        SmartPrompt.logger.info "Start create the SmartPrompt engine."
         @config_file = config_file
         @adapters={}
         @llms={}
@@ -10,6 +11,7 @@ module SmartPrompt
       end
 
       def load_config(config_file)
+        SmartPrompt.logger.info "Loading configuration from file: #{config_file}"
         @config_file = config_file
         @config = YAML.load_file(config_file)
         @config['adapters'].each do |adapter_name, adapter_class|
@@ -35,14 +37,25 @@ module SmartPrompt
       end
         
       def call_worker(worker_name, params = {})
+        SmartPrompt.logger.info "Calling worker: #{worker_name} with params: #{params}"
         worker = get_worker(worker_name)
-        worker.execute(params)
+        
+        begin
+          result = worker.execute(params)
+          SmartPrompt.logger.info "Worker #{worker_name} executed successfully"
+          result
+        rescue => e
+          SmartPrompt.logger.error "Error executing worker #{worker_name}: #{e.message}"
+          SmartPrompt.logger.debug e.backtrace.join("\n")
+          raise
+        end
       end
   
       private
   
       def get_worker(worker_name)
-        worker = Worker.new(worker_name, self)
+        SmartPrompt.logger.info "Creating worker instance for: #{worker_name}"
+        Worker.new(worker_name, self)
       end
     end
   end

data/lib/smart_prompt/llm_adapter.rb

@@ -7,10 +7,12 @@ require 'ollama-ai'
 module SmartPrompt
   class LLMAdapter
     def initialize(config)
+      SmartPrompt.logger.info "Start create the SmartPrompt LLMAdapter."
       @config = config
     end
 
     def send_request(messages)
+      SmartPrompt.logger.error "LLMAdapter: Subclasses must implement send_request"
       raise NotImplementedError, "Subclasses must implement send_request"
     end
   end
@@ -18,19 +20,25 @@ module SmartPrompt
   class OpenAIAdapter < LLMAdapter
     def initialize(config)
       super
+      api_key = @config['api_key']
+      if api_key.is_a?(String) && api_key.start_with?('ENV[') && api_key.end_with?(']')
+        api_key = eval(api_key)
+      end      
       @client = OpenAI::Client.new(
-        access_token: @config['api_key'],
+        access_token: api_key,
         uri_base: @config['url'],
         request_timeout: 240
       )
     end
 
     def send_request(messages, model=nil)
+      SmartPrompt.logger.info "OpenAIAdapter: Sending request to OpenAI"
       if model
         model_name = model
       else
         model_name = @config['model']        
       end
+      SmartPrompt.logger.info "OpenAIAdapter: Using model #{model_name}"
       response = @client.chat(
         parameters: {
           model: model_name,
@@ -38,6 +46,7 @@ module SmartPrompt
           temperature: @config['temperature'] || 0.7
         }
       )
+      SmartPrompt.logger.info "OpenAIAdapter: Received response from OpenAI"
       response.dig("choices", 0, "message", "content")
     end
   end
@@ -50,12 +59,14 @@ module SmartPrompt
       )
     end
     def send_request(messages, model=nil)
+      SmartPrompt.logger.info "LlamacppAdapter: Sending request to Llamacpp"
       response = @client.chat(
         parameters: {
           messages: messages,
           temperature: @config['temperature'] || 0.7
         }
       )
+      SmartPrompt.logger.info "LlamacppAdapter: Received response from Llamacpp"
       response.dig("choices", 0, "message", "content")
     end
   end
@@ -67,11 +78,13 @@ module SmartPrompt
     end
 
     def send_request(messages, model=nil)
+      SmartPrompt.logger.info "OllamaAdapter: Sending request to Ollama"
       if model
         model_name = model
       else
         model_name = @config['model']        
       end
+      SmartPrompt.logger.info "OllamaAdapter: Using model #{model_name}"
       response = @client.generate(
         {
           model: model_name,
@@ -79,6 +92,7 @@ module SmartPrompt
           stream: false
         }
       )
+      SmartPrompt.logger.info "OllamaAdapter: Received response from Ollama"
       return response[0]["response"]
     end
   end

data/lib/smart_prompt/version.rb

@@ -1,3 +1,3 @@
 module SmartPrompt
-  VERSION = "0.1.3"
+  VERSION = "0.1.5"
 end

data/lib/smart_prompt/worker.rb

@@ -3,6 +3,7 @@ module SmartPrompt
     attr_reader :name, :config_file
 
     def initialize(name, engine)
+      SmartPrompt.logger.info "Create worker's name is #{name}"
       @name = name
       @engine = engine
       @config = engine.config

data/lib/smart_prompt.rb

@@ -7,6 +7,7 @@ require File.expand_path('../smart_prompt/worker', __FILE__)
 
 module SmartPrompt
   class Error < StandardError; end
+  attr_writer :logger
 
   def self.define_worker(name, &block)
     Worker.define(name, &block)
@@ -16,4 +17,10 @@ module SmartPrompt
     worker = Worker.new(name, config_file)
     worker.execute(params)
   end
+  
+  def self.logger
+    @logger ||= Logger.new($stdout).tap do |log|
+      log.progname = self.name
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_prompt
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - zhuang biaowei
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-10-02 00:00:00.000000000 Z
+date: 2024-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yaml
@@ -89,6 +89,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE.txt
+- README.cn.md
 - README.md
 - Rakefile
 - lib/smart_prompt.rb