smart_prompt 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 426b1977292513d846008ab4152b5dec906ea2bd873aad06cb18ec761e71a409
+  data.tar.gz: 598c08216f9c84c99e15884d2b04efa3c480f27efa9cc54d676ac68a9f866d86
+SHA512:
+  metadata.gz: 0c25152f944e0bc7cb92825045efb645668b71bf7efa3c4fd5d8fc78fb1c67cbda7f05abe1f2483a04df528bdcf54e651f98d0cf8e6f21e314f26837103a59a9
+  data.tar.gz: 93af52707e43b9da0da55f2f1873bc7ad487350140617a97929e4a867062b2387469c84631f1696081d8f4e5dfeb28d3f017e5235879565b92e9da3355cd71ac

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 zhuang biaowei
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,36 @@
+# SmartPrompt
+
+SmartPrompt 是一个强大的 Ruby gem，提供了一种领域特定语言（DSL），使其他 Ruby 程序能够更加方便、自然地调用各种大型语言模型（LLM）的能力。
+
+## 主要特性
+
+- 灵活的任务组合：以特定服务提供商 + 特定 LLM + 特定 prompt 的方式组合各种任务
+- 子任务嵌套：支持以 DSL 形式组合调用其他子任务
+- 性能优化：在保证质量的同时，提供性能最优或成本最低的解决方案
+
+## 安装
+
+将 gem 安装并添加到应用程序的 Gemfile 中，执行以下命令：
+
+```
+$ bundle add smart_prompt
+```
+
+如果不使用 bundler 来管理依赖，可以通过执行以下命令来安装 gem：
+
+```
+$ gem install smart_prompt
+```
+
+## 用法
+
+以下是一些基本用法示例：
+
+### 基本使用
+
+```
+require 'smart_prompt'
+engine = SmartPrompt::Engine.new('./config/llm_config.yml')
+result = engine.call_worker(:daily_report, {location: "Shanghai"}) 
+puts result
+```

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/lib/smart_prompt/conversation.rb

@@ -0,0 +1,48 @@
+require 'yaml'
+
+module SmartPrompt
+  class Conversation
+    attr_reader :messages, :last_response, :config_file
+
+    def initialize(engine)
+      @messages = []
+      @engine = engine
+      @adapters = engine.adapters
+      @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
+      self
+    end
+
+    def model(model_name)
+      @model_name = model_name
+    end
+
+    def prompt(template_name, params = {})
+      template_name = template_name.to_s
+      raise "Template #{template_name} not found" unless @templates.key?(template_name)
+      content = @templates[template_name].render(params)
+      @messages << { role: 'user', content: content }
+      self
+    end
+
+    def sys_msg(message)
+      @sys_msg = message
+      @messages << { role: 'system', content: message }
+      self
+    end
+
+    def send_msg
+      raise "No adapter selected" if @current_adapter.nil?
+      @last_response = @adapters[@current_adapter].send_request(@messages, @model_name)
+      @messages=[]
+      @messages << { role: 'system', content: @sys_msg }
+      @last_response
+    end
+  end
+end

data/lib/smart_prompt/engine.rb

@@ -0,0 +1,42 @@
+module SmartPrompt
+    class Engine
+      attr_reader :config_file, :config, :adapters, :current_adapter, :templates
+      def initialize(config_file)
+        @config_file = config_file
+        @adapters={}
+        @templates={}
+        load_config(config_file)
+      end
+
+      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)
+        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)
+        end
+        load_workers
+      end
+
+      def load_workers
+        Dir.glob(File.join(@config['worker_path'], '*.rb')).each do |file|
+          require(file)
+        end
+      end
+        
+      def call_worker(worker_name, params = {})
+        worker = get_worker(worker_name)
+        worker.execute(params)
+      end
+  
+      private
+  
+      def get_worker(worker_name)
+        worker = Worker.new(worker_name, self)
+      end
+    end
+  end

data/lib/smart_prompt/llm_adapter.rb

@@ -0,0 +1,92 @@
+require 'net/http'
+require 'json'
+require 'uri'
+require 'openai'
+require 'ollama-ai'
+
+module SmartPrompt
+  class LLMAdapter
+    def initialize(config)
+      @config = config
+    end
+
+    def send_request(messages)
+      raise NotImplementedError, "Subclasses must implement send_request"
+    end
+  end
+
+  class OpenaiAdapter < LLMAdapter
+    def initialize(config)
+      super
+      @client = OpenAI::Client.new(
+        access_token: @config['api_key'],
+        uri_base: @config['url'],
+        request_timeout: 240
+      )
+    end
+
+    def send_request(messages, model=nil)
+      if model
+        model_name = model
+      else
+        model_name = @config['model']        
+      end
+      response = @client.chat(
+        parameters: {
+          model: model_name,
+          messages: messages,
+          temperature: @config['temperature'] || 0.7
+        }
+      )
+      response.dig("choices", 0, "message", "content")
+    end
+  end
+
+  class LlamacppAdapter < LLMAdapter
+    def initialize(config)
+      super
+      @client = OpenAI::Client.new(
+        uri_base: @config['url']
+      )
+    end
+    def send_request(messages, model=nil)
+      response = @client.chat(
+        parameters: {
+          messages: messages,
+          temperature: @config['temperature'] || 0.7
+        }
+      )
+      response.dig("choices", 0, "message", "content")
+    end
+  end
+
+  class OllamaAdapter < LLMAdapter
+    def initialize(config)
+      super
+      @client = Ollama.new(credentials: { address: @config['url'] })
+    end
+
+    def send_request(messages, model=nil)
+      if model
+        model_name = model
+      else
+        model_name = @config['model']        
+      end
+      response = @client.generate(
+        {
+          model: model_name,
+          prompt: messages.to_s,
+          stream: false
+        }
+      )
+      return response[0]["response"]
+    end
+  end
+
+  class MockAdapter < LLMAdapter
+    def send_request(messages)
+      puts "Mock adapter received #{messages.length} messages"
+      "This is a mock response from the LLM adapter."
+    end
+  end
+end

data/lib/smart_prompt/prompt_template.rb

@@ -0,0 +1,52 @@
+require 'erb'
+
+module SmartPrompt
+  class PromptTemplate
+    def initialize(template_file)
+      @template_file = template_file
+      @template = File.read(template_file)
+    end
+
+    def render(params = {})
+      ERB.new(@template, trim_mode: '-').result(binding_with_params(params))
+    end
+
+    def reload
+      @template = File.read(@template_file)
+    end
+
+    private
+
+    def binding_with_params(params)
+      params_binding = binding
+      params.each do |key, value|
+        params_binding.local_variable_set(key, value)
+      end
+      params_binding
+    end
+
+    class << self
+      def load_templates(template_dir)
+        templates = {}
+        Dir.glob(File.join(template_dir, '*.erb')).each do |file|
+          name = File.basename(file, '.erb')
+          templates[name] = new(file)
+        end
+        templates
+      end
+
+      def create(name, content)
+        File.write(File.join(template_dir, "#{name}.erb"), content)
+        new(File.join(template_dir, "#{name}.erb"))
+      end
+
+      def template_dir
+        @template_dir ||= 'templates'
+      end
+
+      def template_dir=(dir)
+        @template_dir = dir
+      end
+    end
+  end
+end

data/lib/smart_prompt/version.rb

@@ -0,0 +1,3 @@
+module SmartPrompt
+  VERSION = "0.1.0"
+end

data/lib/smart_prompt/worker.rb

@@ -0,0 +1,57 @@
+module SmartPrompt
+  class Worker
+    attr_reader :name, :config_file
+
+    def initialize(name, engine)
+      @name = name
+      @engine = engine
+      @config = engine.config
+      @code = self.class.workers[name]
+    end
+
+    def execute(params = {})
+      conversation = Conversation.new(@engine)
+      context = WorkerContext.new(conversation, params, @engine)
+      context.instance_eval(&@code)
+    end
+
+    class << self
+      def workers
+        @workers ||= {}
+      end
+
+      def define(name, &block)
+        workers[name] = block
+      end
+    end
+  end
+
+  class WorkerContext
+    def initialize(conversation, params, engine)
+      @conversation = conversation
+      @params = params
+      @engine = engine
+    end
+
+    def method_missing(method, *args, &block)
+      if @conversation.respond_to?(method)
+        @conversation.send(method, *args, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method, include_private = false)
+      @conversation.respond_to?(method) || super
+    end
+
+    def params
+      @params
+    end
+
+    def call_worker(worker_name, params = {})
+      worker = Worker.new(worker_name, @engine)
+      worker.execute(params)
+    end
+  end
+end

data/lib/smart_prompt.rb

@@ -0,0 +1,19 @@
+require File.expand_path('../smart_prompt/version', __FILE__)
+require File.expand_path('../smart_prompt/engine', __FILE__)
+require File.expand_path('../smart_prompt/conversation', __FILE__)
+require File.expand_path('../smart_prompt/llm_adapter', __FILE__)
+require File.expand_path('../smart_prompt/prompt_template', __FILE__)
+require File.expand_path('../smart_prompt/worker', __FILE__)
+
+module SmartPrompt
+  class Error < StandardError; end
+
+  def self.define_worker(name, &block)
+    Worker.define(name, &block)
+  end
+
+  def self.run_worker(name, config_file, params = {})
+    worker = Worker.new(name, config_file)
+    worker.execute(params)
+  end
+end

data/sig/smart_prompt.rbs

@@ -0,0 +1,4 @@
+module SmartPrompt
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: smart_prompt
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- zhuang biaowei
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-09-29 00:00:00.000000000 Z
+dependencies: []
+description: SmartPrompt provides a flexible DSL for managing prompts, interacting
+  with multiple LLMs, and creating composable task workers.
+email:
+- zbw@kaiyuanshe.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/smart_prompt.rb
+- lib/smart_prompt/conversation.rb
+- lib/smart_prompt/engine.rb
+- lib/smart_prompt/llm_adapter.rb
+- lib/smart_prompt/prompt_template.rb
+- lib/smart_prompt/version.rb
+- lib/smart_prompt/worker.rb
+- sig/smart_prompt.rbs
+homepage: https://github.com/zhuangbiaowei/smart_prompt
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/zhuangbiaowei/smart_prompt
+  source_code_uri: https://github.com/zhuangbiaowei/smart_prompt
+  changelog_uri: https://github.com/zhuangbiaowei/smart_prompt/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.18
+signing_key: 
+specification_version: 4
+summary: A smart prompt management and LLM interaction gem
+test_files: []