smart_prompt 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48814b17b9e142698d6cb49efd4ab15195bddce4fca7ac5f111b52e5e8b3e04b
-  data.tar.gz: c0e23945a97549403ab6b5d3225e3b281b0d2f6f6f6097f5158ae98edb70d722
+  metadata.gz: 846477d8ddb503119a9233f9ce85d2094c1755be52adcfc0515b0a7209524a3d
+  data.tar.gz: 4f165cedebc54e9d8ae292e3fd03329ec04150a8e0804fcb90234b7837135e6d
 SHA512:
-  metadata.gz: 1dac2c898d593345d1f1d8c9508faabda41c2954938171f99aa9999fbe4f34532124e441ad2ccbb265bc6ceb65fb188fd7b60d8e8f1439ad478f6d2d62a38018
-  data.tar.gz: 851707ebcac1db79aa0fc29a8a92dd9e1571dd0d1207d4cd9ac75fb5992ecfac1bac09eec8599594e247066e586d4bd48b6fddf3da073e168f2039823dcce747
+  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/llm_adapter.rb

@@ -18,8 +18,12 @@ 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
       )

data/lib/smart_prompt/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smart_prompt
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - zhuang biaowei
@@ -89,6 +89,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE.txt
+- README.cn.md
 - README.md
 - Rakefile
 - lib/smart_prompt.rb