luo 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 294891b56e33b9a8537542538325ad107f1cead832dc6f86e25f087fd9883fc7
-  data.tar.gz: 861361be7def0711a6525b1f99378f4a4217e876f236ddb1e628f6458efc53e1
+  metadata.gz: 185d14b9e236adfe8d72b9fdd12dc037834a2eafb4586567139983983d26f149
+  data.tar.gz: 0d5bc502984155f26ea2e134ca9d97f6951dc7ea064bcc76f1feb3cbf63d2b9f
 SHA512:
-  metadata.gz: b35623a4f996d28253dac61a920bbb2ff4b6978f882eff9e514be33dd1fdcd46fe7f3d7d19f8f40c9069ed6605a6ce1f37753b84e61ad23c6a597cdac760ea8c
-  data.tar.gz: e665f6f8a38cfaeb001765e624e3e83071c9745723130eeb49fa087dc8eb3c7e06c05e31f973ecf251eb89e2dc19598bd6f79eb0a0426a2d7987eac78f3d615d
+  metadata.gz: d50c9aaa841bb065bb85ea4270987065ef14aa220f8e6968eb4baa443fbf8808c1edecf95b0f28df567baaf52a778adb1298ea66deb9879cf37a8cc372dc54ff
+  data.tar.gz: bbc35c28a3d02ff1d55adc30a4a635bae6c9c3b7ddb23422861bf4a6a11943732d1f50a189bacf6ad49f32b1d203899389adb5eb230c280b4c0cc50d77e60f68

data/README.md

@@ -1,34 +1,101 @@
 # Luo
-
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/luo`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-## Installation
-
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
-
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/luo.
-
-ENV.fetch('OPENAI_HOST', 'https://api.openai.com')
-ENV.fetch('OPENAI_ACCESS_TOKEN')
+是一款基于大模型的开发框架（面向产品经理），当前支持大模型提供商有: OpenAI、星火大模型。通过DSL能够快速创作并且测试大模型的效果。
+
+## 安装
+```
+gem install luo
+```
+
+## 环境变量说明
+```Bash
+OPENAI_ACCESS_TOKEN= # OpenAI的访问令牌
+OPENAI_TEMPERATURE= # OpenAI的温度
+OPENAI_LIMIT_HISTORY= # OpenAI的历史限制
+AIUI_APP_KEY= # AIUI的AppKey
+AIUI_APP_ID= # AIUI的AppId
+XINGHUO_ACCESS_TOKEN= # 星火大模型的访问令牌
+```
+可以写在项目中的.env也可以放到系统环境变量中。
+
+## 使用
+
+### Hello World
+1. mkdir demo
+2. cd demo
+3. luo init
+4. 修改 .env 的环境变量
+5. ruby application.rb
+
+### Messages 说明
+```ruby
+# 创建一个 Messages 实例
+messages = Luo::Messages.create
+
+# 添加用户消息，包含文本内容和提示信息
+messages.user(text: "Hello, world!", prompt: TTY::Prompt.new.ask("What's your name?"))
+
+# 添加助手消息，来自文件
+messages.assistant(file: 'welcome.md')
+
+# 添加系统消息，包含文本内容和上下文信息
+messages.system(text: "User logged in", context: { user_id: 123 })
+
+# 将消息转换为数组并打印出来
+puts messages.to_a.inspect
+
+# 输出
+[
+  {:role=>"system", :content=>"User logged in"},
+  {:role=>"user", :content=>"Hello, world!"},
+  {:role=>"assistant", :content=>"Welcome to our app!\n"}
+]
+```
+注意：星火大模型的消息类型只支持：user、assistant
+
+## History
+Luo 内置了 MemoryHistory 用于处理用户历史对话记录
+```ruby
+history = Luo::MemoryHistory.new
+history.user("Hello, world!")
+history.assistant("Welcome to our app!")
+puts history.to_a.inspect
+
+# 输出
+[
+  {:role=>"user", :content=>"Hello, world!"},
+  {:role=>"assistant", :content=>"Welcome to our app!"}
+]
+
+# 可以在 Messages 使用
+messages = Luo::Messages.create(history: history)
+```
+
+## Helpers
+`Luo::Helpers` 模块是一个包含了一些辅助方法的模块，可以在不同的上下文中重用这些方法。其中，包括了 `print_md` 和 `load_test` 两个方法。
+
+`print_md` 方法用于将 Markdown 格式的文本转换为终端友好的格式，并打印出来。这个方法接受一个参数 `text`，表示需要转换和打印的 Markdown 格式的文本。使用 `print_md` 方法的示例代码如下：
+
+```ruby
+text = "# Hello, world!\n\nThis is a **Markdown** text."
+Luo::Helpers.print_md(text)
+```
+
+在上面的示例中，首先定义了一个 Markdown 格式的文本 `text`，然后使用 `print_md` 方法将其转换为终端友好的格式，并打印出来。
+
+`load_test` 方法用于从 YAML 格式的文件中加载测试数据，并对每个测试数据执行指定的块。这个方法接受两个参数：`path` 和块 `block`。其中 `path` 表示 YAML 文件的路径，块 `block` 表示对每个测试数据要执行的操作。使用 `load_test` 方法的示例代码如下：
+
+```ruby
+Luo::Helpers.load_test('tests.yml') do |test_data|
+  # 对每个测试数据执行的操作
+  puts test_data.inspect
+end
+```
+在上面的示例中，我们使用 `load_test` 方法从 `tests.yml` 文件中加载测试数据，并使用块对每个测试数据进行操作。在这个示例中，我们只是简单地使用 `puts` 方法打印出每个测试数据的内容。实际使用中，块 `block` 可以根据需要执行更复杂的操作，例如执行测试用例、生成报告等。
+
+## 补充资源
+1. 基于embedding的知识库对话机器人：https://github.com/ankane/neighbor#openai-embeddings
+```ruby
+def fetch_embeddings(input)
+  Luo::OpenAI.new.create_embeddings(input)
+end
+```

data/README.zh.md

@@ -20,7 +20,77 @@ XINGHUO_ACCESS_TOKEN= # 星火大模型的访问令牌
 ## 使用
 
 ### Hello World
+1. mkdir demo
+2. cd demo
+3. luo init
+4. 修改 .env 的环境变量
+5. ruby application.rb
 
+### Messages 说明
+```ruby
+# 创建一个 Messages 实例
+messages = Luo::Messages.create
+
+# 添加用户消息，包含文本内容和提示信息
+messages.user(text: "Hello, world!", prompt: TTY::Prompt.new.ask("What's your name?"))
+
+# 添加助手消息，来自文件
+messages.assistant(file: 'welcome.md')
+
+# 添加系统消息，包含文本内容和上下文信息
+messages.system(text: "User logged in", context: { user_id: 123 })
+
+# 将消息转换为数组并打印出来
+puts messages.to_a.inspect
+
+# 输出
+[
+  {:role=>"system", :content=>"User logged in"},
+  {:role=>"user", :content=>"Hello, world!"},
+  {:role=>"assistant", :content=>"Welcome to our app!\n"}
+]
+```
+注意：星火大模型的消息类型只支持：user、assistant
+
+## History
+Luo 内置了 MemoryHistory 用于处理用户历史对话记录
+```ruby
+history = Luo::MemoryHistory.new
+history.user("Hello, world!")
+history.assistant("Welcome to our app!")
+puts history.to_a.inspect
+
+# 输出
+[
+  {:role=>"user", :content=>"Hello, world!"},
+  {:role=>"assistant", :content=>"Welcome to our app!"}
+]
+
+# 可以在 Messages 使用
+messages = Luo::Messages.create(history: history)
+```
+
+## Helpers
+`Luo::Helpers` 模块是一个包含了一些辅助方法的模块，可以在不同的上下文中重用这些方法。其中，包括了 `print_md` 和 `load_test` 两个方法。
+
+`print_md` 方法用于将 Markdown 格式的文本转换为终端友好的格式，并打印出来。这个方法接受一个参数 `text`，表示需要转换和打印的 Markdown 格式的文本。使用 `print_md` 方法的示例代码如下：
+
+```ruby
+text = "# Hello, world!\n\nThis is a **Markdown** text."
+Luo::Helpers.print_md(text)
+```
+
+在上面的示例中，首先定义了一个 Markdown 格式的文本 `text`，然后使用 `print_md` 方法将其转换为终端友好的格式，并打印出来。
+
+`load_test` 方法用于从 YAML 格式的文件中加载测试数据，并对每个测试数据执行指定的块。这个方法接受两个参数：`path` 和块 `block`。其中 `path` 表示 YAML 文件的路径，块 `block` 表示对每个测试数据要执行的操作。使用 `load_test` 方法的示例代码如下：
+
+```ruby
+Luo::Helpers.load_test('tests.yml') do |test_data|
+  # 对每个测试数据执行的操作
+  puts test_data.inspect
+end
+```
+在上面的示例中，我们使用 `load_test` 方法从 `tests.yml` 文件中加载测试数据，并使用块对每个测试数据进行操作。在这个示例中，我们只是简单地使用 `puts` 方法打印出每个测试数据的内容。实际使用中，块 `block` 可以根据需要执行更复杂的操作，例如执行测试用例、生成报告等。
 
 ## 补充资源
 1. 基于embedding的知识库对话机器人：https://github.com/ankane/neighbor#openai-embeddings

data/lib/luo/agent.rb

@@ -34,6 +34,8 @@ module Luo
         end
       end
 
+      alias_method :on_call_with_fallback, :on_call_with_final_result
+      
       def self.create_parameter_method(method_name, not_provided = Object.new, &block)
         define_method(method_name.to_sym) do |content = not_provided|
           if content === not_provided

data/lib/luo/helpers.rb

@@ -9,10 +9,14 @@ module Luo
     end
 
     def load_test(path, &block)
-      YAML.load_file(path).each do |value|
-        yield(value)
+      data = YAML.load_file(path)
+      if data.is_a?(Array)
+        data.each do |value|
+          yield(value)
+        end
+      else
+        yield(data)
       end
     end
-
   end
 end

data/lib/luo/init_project.rb

@@ -9,10 +9,14 @@ module Luo
     end
     def create_bundle_file()
       puts "create Gemfile"
+      version = Luo::VERSION
       unless File.exist?('Gemfile')
+        gemfile = <<-GEMFILE
+        source 'https://rubygems.org'
+        gem 'luo', '~> #{version}'
+        GEMFILE
         File.open('Gemfile', 'w') do |file|
-          file.puts("source 'https://rubygems.org'")
-          file.puts("gem 'luo', '~> 0.1.5'")
+          file.write(gemfile)
         end
       end
     end

data/lib/luo/projects/time_agent.rb

@@ -2,7 +2,7 @@ class TimeAgent < Agent
   agent_name '时间查询'
   agent_desc '查询当前时间'
 
-  on_call_with_final_result do
+  on_call_with_fallback do
     Helpers.print_md "** call aiui time **"
     messages = Luo::Messages.create.user(text: context.user_input)
     response = Luo::AIUI.new.chat(messages)

data/lib/luo/projects/weather_agent.rb

@@ -4,7 +4,7 @@ class WeatherAgent < Agent
   agent_name '天气查询'
   agent_desc '查询城市的天气情况，穿衣指数，空气质量等'
 
-  on_call_with_final_result do
+  on_call_with_fallback do
     Helpers.print_md "** call aiui weather **"
     messages = Luo::Messages.create.user(text: context.user_input)
     response = Luo::AIUI.new.chat(messages)

data/lib/luo/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Luo
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

data/sig/luo/agent_runner_context.rbs

@@ -12,6 +12,8 @@ module Luo
     attr_accessor retries: Integer
     attr_accessor user_input: String
 
+    def client: -> untyped
+
     def have_running_agents: -> Set[Agent]
 
     def histories: -> MemoryHistory

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: luo
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - MJ
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-09 00:00:00.000000000 Z
+date: 2023-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk