smart_prompt 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5405e5a08476567f1737276d32ac24849eaa693c9ed302ca1c633a372e230996
-  data.tar.gz: f5720ede56fc9eff6afa79990e25538dd6749b67bf85638f23ed94527e302401
+  metadata.gz: 846477d8ddb503119a9233f9ce85d2094c1755be52adcfc0515b0a7209524a3d
+  data.tar.gz: 4f165cedebc54e9d8ae292e3fd03329ec04150a8e0804fcb90234b7837135e6d
 SHA512:
-  metadata.gz: a2cff6947e229493681d555ca407563d6aff0e9543d8fecb843fb1ee5c2f2534ff9e9994eb44a1ea4f9ddacdfc12a95da7b119aa2c2cd55ee638a65682a250c6
-  data.tar.gz: 96db920d1c87b839dadeecf3b2552e6e9179d6013d3867f72e5e23370d63294261d134b9d9eb13ad6aa51743e9282d3dceac4743333d35e2554dbb8138e50eca
+  metadata.gz: 7f3521861b4690b233c9b82d6f08123b9859c0fed28e40274fb4eaa014aa93b2df63121aff77451c9b1f5f93f9eeb683c5b044c94cef5e7d11a8e2151c5e97f8
+  data.tar.gz: 9c78f290101fd158403d2feb9e84312d8ffb90a22a32a57e91d96f5c287a38cfd8cb8c318817e860d7fb09bd5584310e6d397fce490deaa29ca52bafb3db7fba

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

@@ -8,14 +8,15 @@ module SmartPrompt
       @messages = []
       @engine = engine
       @adapters = engine.adapters
+      @llms = engine.llms
       @templates = engine.templates
       @current_adapter = engine.current_adapter
       @last_response = nil
     end
 
-    def use(adapter_name)
-      raise "Adapter #{adapter_name} not configured" unless @adapters.key?(adapter_name)
-      @current_adapter = adapter_name
+    def use(llm_name)
+      raise "Adapter #{adapter_name} not configured" unless @llms.key?(llm_name)
+      @current_llm = @llms[llm_name]
       self
     end
 
@@ -38,8 +39,8 @@ module SmartPrompt
     end
 
     def send_msg
-      raise "No adapter selected" if @current_adapter.nil?
-      @last_response = @adapters[@current_adapter].send_request(@messages, @model_name)
+      raise "No LLM selected" if @current_llm.nil?
+      @last_response = @current_llm.send_request(@messages, @model_name)
       @messages=[]
       @messages << { role: 'system', content: @sys_msg }
       @last_response

data/lib/smart_prompt/engine.rb

@@ -1,9 +1,10 @@
 module SmartPrompt
     class Engine
-      attr_reader :config_file, :config, :adapters, :current_adapter, :templates
+      attr_reader :config_file, :config, :adapters, :current_adapter, :llms, :templates
       def initialize(config_file)
         @config_file = config_file
         @adapters={}
+        @llms={}
         @templates={}
         load_config(config_file)
       end
@@ -11,13 +12,18 @@ module SmartPrompt
       def load_config(config_file)
         @config_file = config_file
         @config = YAML.load_file(config_file)
-        @config['adapters'].each do |adapter_name, adapter_config|
-          adapter_class = SmartPrompt.const_get("#{adapter_name.capitalize}Adapter")          
-          @adapters[adapter_name] = adapter_class.new(adapter_config)
+        @config['adapters'].each do |adapter_name, adapter_class|
+          adapter_class = SmartPrompt.const_get(adapter_class)
+          @adapters[adapter_name] = adapter_class
         end
-        @current_adapter = @config['default_adapter'] if @config['default_adapter']        
-        @config['templates'].each do |template_name, template_file|
-          @templates[template_name] = PromptTemplate.new(template_file)
+        @config['llms'].each do |llm_name,llm_config|
+          adapter_class = @adapters[llm_config['adapter']]
+          @llms[llm_name]=adapter_class.new(llm_config)
+        end
+        @current_llm = @config['default_llm'] if @config['default_llm']
+        Dir.glob(File.join(@config['template_path'], '*.erb')).each do |file|
+          template_name = file.gsub(@config['template_path']+"/","").gsub("\.erb","")
+          @templates[template_name] = PromptTemplate.new(file)
         end
         load_workers
       end

data/lib/smart_prompt/llm_adapter.rb

@@ -15,11 +15,15 @@ module SmartPrompt
     end
   end
 
-  class OpenaiAdapter < LLMAdapter
+  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
       )

data/lib/smart_prompt/version.rb

@@ -1,3 +1,3 @@
 module SmartPrompt
-  VERSION = "0.1.2"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_prompt
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - zhuang biaowei
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-09-30 00:00:00.000000000 Z
+date: 2024-10-02 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