llm.rb 0.16.0 → 0.16.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38502ab4a41dba8177cb7b21db68f3e0dd5492323ac8b132b1775926b46ffffc
-  data.tar.gz: ebe196962c43934ae979e298f80b4bc2e30a147ad0f42595eef59880be9fc01e
+  metadata.gz: c46802e2152430f164990a91499be669e928201e7793b162f8f62152349078af
+  data.tar.gz: 58269b584d08e9d236a3d85ac5728f4e4453a845ace9ebbf8c1ac22890609a1f
 SHA512:
-  metadata.gz: 5100d71b851771137a86e799bc2cadab360fc0ced297288b09fa701a8f434c671fe739427b889243e9704c5ae2a05b6b8761c85f0b0bea9268700bf770e80f13
-  data.tar.gz: 3aed0f826c229a37d30b2f0d41678976ba00df72216588a9302320c52e22d9d1b814df0b76bca8f6e713e105d73006339121a8bb900a73ac8896cc1f7c3f0051
+  metadata.gz: 9003c9cac451081ce0589f54acb2d72813e53a8708426e320e30732aa5842d99187af14f1c54bab69cfcc3bcc401529375377547a090f530aa1da140fd0a4b3f
+  data.tar.gz: 691e4ebfd80fcfa7af22f1ca26393256a69ddf6957be8960590eebddc5e20a1a30db3ba8cfc1ae65dba10491df6f2844fd72d3ca2444420cb23db357a0225e25

data/README.md

@@ -34,6 +34,25 @@ GitHub Copilot but for the terminal.
 * [llm-shell](https://github.com/llmrb/llm-shell) – a developer-oriented console for Large Language Model communication
 * [llm-spell](https://github.com/llmrb/llm-spell) – a utility that can correct spelling mistakes with a Large Language Model
 
+#### Show code
+
+A simple chatbot that maintains a conversation and streams
+responses in real-time:
+
+```ruby
+#!/usr/bin/env ruby
+require "llm"
+
+llm = LLM.openai(key: ENV["KEY"])
+bot = LLM::Bot.new(llm, stream: $stdout)
+loop do
+  print "> "
+  input = $stdin.gets&.chomp || break
+  bot.chat(input).flush
+  print "\n"
+end
+```
+
 ## Features
 
 #### General
@@ -129,9 +148,11 @@ and the gem should be installed separately:
 #!/usr/bin/env ruby
 require "llm"
 
-llm = LLM.openai(key: ENV["KEY"], persistent: true)
-res = llm.responses.create "Hello world"
-llm.responses.create "Adios", last_response_id: res.response_id
+llm  = LLM.openai(key: ENV["KEY"], persistent: true)
+res1 = llm.responses.create "message 1"
+res2 = llm.responses.create "message 2", previous_response_id: res1.response_id
+res3 = llm.responses.create "message 3", previous_response_id: res2.response_id
+print res3.output_text, "\n"
 ```
 
 ### Conversations
@@ -195,7 +216,7 @@ bot.chat(stream: $stdout) do |prompt|
   prompt.user ["Tell me about this URL", URI(url)]
   prompt.user ["Tell me about this PDF", File.open("handbook.pdf", "rb")]
   prompt.user "Are the URL and PDF similar to each other?"
-end.to_a
+end.flush
 ```
 
 ### Schema

data/lib/llm/bot.rb

@@ -123,5 +123,17 @@ module LLM
         .flat_map(&:functions)
         .select(&:pending?)
     end
+
+    ##
+    # @example
+    #   llm = LLM.openai(key: ENV["KEY"])
+    #   bot = LLM::Bot.new(llm, stream: $stdout)
+    #   bot.chat("Hello", role: :user).flush
+    # Drains the buffer and returns all messages as an array
+    # @return [Array<LLM::Message>]
+    def drain
+      messages.drain
+    end
+    alias_method :flush, :drain
   end
 end

data/lib/llm/buffer.rb

@@ -92,7 +92,8 @@ module LLM
     #   llm = LLM.openai(key: ENV["KEY"])
     #   bot = LLM::Bot.new(llm, stream: $stdout)
     #   bot.chat "Hello", role: :user
-    #   bot.messages.drain
+    #   bot.messages.flush
+    # @see LLM::Bot#drain
     # @note
     #   This method is especially useful when using the streaming API.
     # Drains the buffer and returns all messages as an array
@@ -100,6 +101,7 @@ module LLM
     def drain
       to_a
     end
+    alias_method :flush, :drain
 
     private
 

data/lib/llm/providers/openai/vector_stores.rb

@@ -8,8 +8,7 @@ class LLM::OpenAI
   # @example
   #  llm = LLM.openai(key: ENV["OPENAI_SECRET"])
   #  files = %w(foo.pdf bar.pdf).map { llm.files.create(file: _1) }
-  #  store = llm.vector_stores.create(name: "PDF Store", file_ids: files.map(&:id))
-  #  store = llm.vector_stores.poll(vector: store)
+  #  store = llm.vector_stores.create_and_poll(name: "PDF Store", file_ids: files.map(&:id))
   #  print "[-] store is ready", "\n"
   #  chunks = llm.vector_stores.search(vector: store, query: "What is Ruby?")
   #  chunks.each { |chunk| puts chunk }
@@ -50,6 +49,14 @@ class LLM::OpenAI
       LLM::Response.new(res)
     end
 
+    ##
+    # Create a vector store and poll until its status is "completed"
+    # @param (see LLM::OpenAI::VectorStores#create)
+    # @return (see LLM::OpenAI::VectorStores#poll)
+    def create_and_poll(...)
+      poll(vector: create(...))
+    end
+
     ##
     # Get a vector store
     # @param [String, #id] vector The ID of the vector store

data/lib/llm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LLM
-  VERSION = "0.16.0"
+  VERSION = "0.16.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: llm.rb
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.16.1
 platform: ruby
 authors:
 - Antar Azri