ruby_llm 0.1.0.pre38 → 0.1.0.pre40

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efcf5aa8692558d9214d82dbb6c053727b1b6c5e810fcd7cd224e9a909ae38ff
-  data.tar.gz: 4910f4d7dade64d20696f5af971e968ce31abf0d98eae14fa7c874efe6ac03ce
+  metadata.gz: db95ae0d7103334e7760659d58200e1cc882b970a2d3f67f56180a9879bad976
+  data.tar.gz: f2a95fb00c476cbea2bf060ff5502c4fb61ed2d652578133cf7eee6ff4c7297f
 SHA512:
-  metadata.gz: 31679bff69003430d7f662dfa822a640ea6863087bf9e2260b0555f7341c41d3368a2e07d7c515c78255f5b1b400a05b08c631a80ee4ed7871fd0ceedb330ca2
-  data.tar.gz: 306fbf3cc3f35688b03b73995abe962152ddcde8d438093f4b4879d8c0b271187e4c7c26b10b8393f80556b955e1c631a8b30fdd693605712353cd7d6aa5e9cb
+  metadata.gz: 3a3624f1c5d8184d5f36aca807528b4bc627a66aebe3829ff9e90bb62348a12863b764352d4b466931c0ef3469c1d952832a1b7726f93231b72324b13228ffb1
+  data.tar.gz: 4bef0ae0373be0c2cd8d4702ddfc2f7a76883fe7c60e5ae5ef501c6f808744328919fba3f16dedf075d6f1cb1585120f46103415579a046306fd1a4d1c81f20b

data/.github/workflows/cicd.yml

@@ -3,6 +3,12 @@ name: CI
 on:
   push:
     branches: [ "main" ]
+    paths:
+      - 'lib/**'
+      - 'spec/**'
+      - 'Gemfile'
+      - 'Rakefile'
+      - 'ruby_llm.gemspec'
   pull_request:
     branches: [ "main" ]
   workflow_call:

data/README.md

@@ -20,6 +20,8 @@ A delightful Ruby way to work with AI. Chat in text, analyze and generate images
   <a href="https://codecov.io/gh/crmne/ruby_llm"><img src="https://codecov.io/gh/crmne/ruby_llm/branch/main/graph/badge.svg" alt="codecov" /></a>
 </p>
 
+🤺 Battle tested at [💬  Chat with Work](https://chatwithwork.com)
+
 ## Features
 
 - 💬 **Beautiful Chat Interface** - Converse with AI models as easily as `RubyLLM.chat.ask "teach me Ruby"`

data/lib/ruby_llm/provider.rb

@@ -143,11 +143,20 @@ module RubyLLM
       maybe_json
     end
 
-    def parse_error(response)
+    def parse_error(response) # rubocop:disable Metrics/MethodLength
       return if response.body.empty?
 
       body = try_parse_json(response.body)
-      body.is_a?(Hash) ? body.dig('error', 'message') : body
+      case body
+      when Hash
+        body.dig('error', 'message')
+      when Array
+        body.map do |part|
+          part.dig('error', 'message')
+        end.join('. ')
+      else
+        body
+      end
     end
 
     class << self

data/lib/ruby_llm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyLLM
-  VERSION = '0.1.0.pre38'
+  VERSION = '0.1.0.pre40'
 end

data/ruby_llm.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|docs)/}) }
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_llm
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre38
+  version: 0.1.0.pre40
 platform: ruby
 authors:
 - Carmine Paolino
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-25 00:00:00.000000000 Z
+date: 2025-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: event_stream_parser
@@ -111,21 +111,6 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- docs/.gitignore
-- docs/Gemfile
-- docs/_config.yml
-- docs/_data/navigation.yml
-- docs/guides/chat.md
-- docs/guides/embeddings.md
-- docs/guides/error-handling.md
-- docs/guides/getting-started.md
-- docs/guides/image-generation.md
-- docs/guides/index.md
-- docs/guides/rails.md
-- docs/guides/streaming.md
-- docs/guides/tools.md
-- docs/index.md
-- docs/installation.md
 - lib/ruby_llm.rb
 - lib/ruby_llm/active_record/acts_as.rb
 - lib/ruby_llm/chat.rb

data/docs/.gitignore

@@ -1,7 +0,0 @@
-_site/
-.sass-cache/
-.jekyll-cache/
-.jekyll-metadata
-# Ignore folders generated by Bundler
-.bundle/
-vendor/

data/docs/Gemfile

@@ -1,11 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'jekyll', '~> 4.3'
-gem 'just-the-docs', '~> 0.7.0'
-gem 'webrick', '~> 1.8'
-
-# GitHub Pages plugins
-group :jekyll_plugins do
-  gem 'jekyll-remote-theme'
-  gem 'jekyll-seo-tag'
-end

data/docs/_config.yml

@@ -1,43 +0,0 @@
-title: RubyLLM
-description: A delightful Ruby way to work with AI
-url: https://rubyllm.com
-baseurl: /
-remote_theme: just-the-docs/just-the-docs
-
-# Enable search
-search_enabled: true
-search:
-  heading_level: 2
-  previews: 3
-  preview_words_before: 5
-  preview_words_after: 10
-  tokenizer_separator: /[\s/]+/
-  rel_url: true
-  button: false
-
-# Navigation structure
-nav_external_links:
-  - title: RubyLLM on GitHub
-    url: https://github.com/crmne/ruby_llm
-    hide_icon: false
-
-# Footer content
-footer_content: "Copyright &copy; 2025 <a href='https://paolino.me'>Carmine Paolino</a>. Distributed under an <a href=\"https://github.com/crmne/ruby_llm/tree/main/LICENSE\">MIT license.</a>"
-
-# Enable copy button on code blocks
-enable_copy_code_button: true
-
-# Make Anchor links show on hover
-heading_anchors: true
-
-# Color scheme
-color_scheme: light
-
-# Google Analytics
-ga_tracking:
-ga_tracking_anonymize_ip: true
-
-# Custom plugins (GitHub Pages allows these)
-plugins:
-  - jekyll-remote-theme
-  - jekyll-seo-tag

data/docs/_data/navigation.yml

@@ -1,25 +0,0 @@
-- title: Home
-  url: /
-- title: Installation
-  url: /installation
-- title: Guides
-  url: /guides/
-  subfolderitems:
-    - title: Getting Started
-      url: /guides/getting-started
-    - title: Chat
-      url: /guides/chat
-    - title: Tools
-      url: /guides/tools
-    - title: Streaming
-      url: /guides/streaming
-    - title: Rails Integration
-      url: /guides/rails
-    - title: Image Generation
-      url: /guides/image-generation
-    - title: Embeddings
-      url: /guides/embeddings
-    - title: Error Handling
-      url: /guides/error-handling
-- title: GitHub
-  url: https://github.com/crmne/ruby_llm

data/docs/guides/chat.md

@@ -1,206 +0,0 @@
----
-layout: default
-title: Chat
-parent: Guides
-nav_order: 2
-permalink: /guides/chat
----
-
-# Chatting with AI Models
-
-RubyLLM's chat interface provides a natural way to interact with various AI models. This guide covers everything from basic chatting to advanced features like multimodal inputs and streaming responses.
-
-## Basic Chat
-
-Creating a chat and asking questions is straightforward:
-
-```ruby
-# Create a chat with the default model
-chat = RubyLLM.chat
-
-# Ask a question
-response = chat.ask "What's the best way to learn Ruby?"
-
-# The response is a Message object
-puts response.content
-puts "Role: #{response.role}"
-puts "Model: #{response.model_id}"
-puts "Tokens: #{response.input_tokens} input, #{response.output_tokens} output"
-```
-
-## Choosing Models
-
-You can specify which model to use when creating a chat:
-
-```ruby
-# Create a chat with a specific model
-chat = RubyLLM.chat(model: 'gpt-4o-mini')
-
-# Use Claude instead
-claude_chat = RubyLLM.chat(model: 'claude-3-5-sonnet-20241022')
-
-# Or change the model for an existing chat
-chat.with_model('gemini-2.0-flash')
-```
-
-## Multi-turn Conversations
-
-Chats maintain conversation history automatically:
-
-```ruby
-chat = RubyLLM.chat
-
-# Start a conversation
-chat.ask "What's your favorite programming language?"
-
-# Follow up
-chat.ask "Why do you like that language?"
-
-# Continue the conversation
-chat.ask "What are its weaknesses?"
-
-# Access the conversation history
-chat.messages.each do |message|
-  puts "#{message.role}: #{message.content[0..50]}..."
-end
-```
-
-## Working with Images
-
-Vision-capable models can understand images:
-
-```ruby
-chat = RubyLLM.chat
-
-# Ask about an image (local file)
-chat.ask "What's in this image?", with: { image: "path/to/image.jpg" }
-
-# Or use an image URL
-chat.ask "Describe this picture", with: { image: "https://example.com/image.jpg" }
-
-# Include multiple images
-chat.ask "Compare these two charts", with: {
-  image: ["chart1.png", "chart2.png"]
-}
-
-# Combine text and image
-chat.ask "Is this the Ruby logo?", with: { image: "logo.png" }
-```
-
-## Working with Audio
-
-Models with audio capabilities can process spoken content:
-
-```ruby
-chat = RubyLLM.chat(model: 'gpt-4o-audio-preview')
-
-# Analyze audio content
-chat.ask "What's being said in this recording?", with: {
-  audio: "meeting.wav"
-}
-
-# Ask follow-up questions about the audio
-chat.ask "Summarize the key points mentioned"
-```
-
-## Streaming Responses
-
-For a more interactive experience, you can stream responses as they're generated:
-
-```ruby
-chat = RubyLLM.chat
-
-# Stream the response with a block
-chat.ask "Tell me a story about a Ruby programmer" do |chunk|
-  # Each chunk is a partial response
-  print chunk.content
-  $stdout.flush # Ensure output is displayed immediately
-end
-
-# Useful for long responses or real-time displays
-chat.ask "Write a detailed essay about programming paradigms" do |chunk|
-  add_to_ui(chunk.content) # Your method to update UI
-end
-```
-
-## Temperature Control
-
-Control the creativity and randomness of AI responses:
-
-```ruby
-# Higher temperature (more creative)
-creative_chat = RubyLLM.chat.with_temperature(0.9)
-creative_chat.ask "Write a poem about Ruby programming"
-
-# Lower temperature (more deterministic)
-precise_chat = RubyLLM.chat.with_temperature(0.1)
-precise_chat.ask "Explain how Ruby's garbage collector works"
-```
-
-## Access Token Usage
-
-RubyLLM automatically tracks token usage for billing and quota management:
-
-```ruby
-chat = RubyLLM.chat
-response = chat.ask "Explain quantum computing"
-
-# Check token usage
-puts "Input tokens: #{response.input_tokens}"
-puts "Output tokens: #{response.output_tokens}"
-puts "Total tokens: #{response.input_tokens + response.output_tokens}"
-
-# Estimate cost (varies by model)
-model = RubyLLM.models.find(response.model_id)
-input_cost = response.input_tokens * model.input_price_per_million / 1_000_000
-output_cost = response.output_tokens * model.output_price_per_million / 1_000_000
-puts "Estimated cost: $#{(input_cost + output_cost).round(6)}"
-```
-
-## Registering Event Handlers
-
-You can register callbacks for chat events:
-
-```ruby
-chat = RubyLLM.chat
-
-# Called when a new assistant message starts
-chat.on_new_message do
-  puts "Assistant is typing..."
-end
-
-# Called when a message is complete
-chat.on_end_message do |message|
-  puts "Response complete!"
-  puts "Used #{message.input_tokens + message.output_tokens} tokens"
-end
-
-# These callbacks work with both streaming and non-streaming responses
-chat.ask "Tell me about Ruby's history"
-```
-
-## Multiple Parallel Chats
-
-You can maintain multiple separate chat instances:
-
-```ruby
-# Create multiple chat instances
-ruby_chat = RubyLLM.chat
-python_chat = RubyLLM.chat
-
-# Each has its own conversation history
-ruby_chat.ask "What's great about Ruby?"
-python_chat.ask "What's great about Python?"
-
-# Continue separate conversations
-ruby_chat.ask "How does Ruby handle metaprogramming?"
-python_chat.ask "How does Python handle decorators?"
-```
-
-## Next Steps
-
-Now that you understand chat basics, you might want to explore:
-
-- [Using Tools]({% link guides/tools.md %}) to let AI use your Ruby code
-- [Streaming Responses]({% link guides/streaming.md %}) for real-time interactions
-- [Rails Integration]({% link guides/rails.md %}) to persist conversations in your apps