llm.rb 0.2.1 → 0.3.0

data/spec/ollama/conversation_spec.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "setup"
+
+RSpec.describe "LLM::Chat: ollama" do
+  let(:described_class) { LLM::Chat }
+  let(:provider) { LLM.ollama(nil, host: "eel.home.network") }
+  let(:conversation) { described_class.new(provider, **params).lazy }
+
+  context "when asked to describe an image",
+          vcr: {cassette_name: "ollama/conversations/multimodal_response"} do
+    subject { conversation.last_message }
+
+    let(:params) { {model: "llava"} }
+    let(:image) { LLM::File("spec/fixtures/images/bluebook.png") }
+
+    before do
+      conversation.chat(image, :user)
+      conversation.chat("Describe the image with a short sentance", :user)
+    end
+
+    it "describes the image" do
+      is_expected.to have_attributes(
+        role: "assistant",
+        content: " The image is a graphic illustration of a book" \
+                 " with its pages spread out, symbolizing openness" \
+                 " or knowledge. "
+      )
+    end
+  end
+end

data/spec/openai/audio_spec.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "setup"
+
+RSpec.describe "LLM::OpenAI::Audio" do
+  let(:token) { ENV["LLM_SECRET"] || "TOKEN" }
+  let(:provider) { LLM.openai(token) }
+
+  context "when given a successful create operation",
+        vcr: {cassette_name: "openai/audio/successful_create"} do
+    subject(:response) { provider.audio.create_speech(input: "A dog on a rocket to the moon") }
+
+    it "is successful" do
+      expect(response).to be_instance_of(LLM::Response::Audio)
+    end
+
+    it "returns an audio" do
+      expect(response.audio).to be_instance_of(StringIO)
+    end
+  end
+
+  context "when given a successful transcription operation",
+        vcr: {cassette_name: "openai/audio/successful_transcription"} do
+    subject(:response) do
+      provider.audio.create_transcription(
+        file: LLM::File("spec/fixtures/audio/rocket.mp3")
+      )
+    end
+
+    it "is successful" do
+      expect(response).to be_instance_of(LLM::Response::AudioTranscription)
+    end
+
+    it "returns a transcription" do
+      expect(response.text).to eq("A dog on a rocket to the moon.")
+    end
+  end
+
+  context "when given a successful translation operation",
+        vcr: {cassette_name: "openai/audio/successful_translation"} do
+    subject(:response) do
+      provider.audio.create_translation(
+        file: LLM::File("spec/fixtures/audio/bismillah.mp3")
+      )
+    end
+
+    it "is successful" do
+      expect(response).to be_instance_of(LLM::Response::AudioTranslation)
+    end
+
+    it "returns a translation (Arabic => English)" do
+      expect(response.text).to eq("In the name of Allah, the Beneficent, the Merciful.")
+    end
+  end
+end

data/spec/openai/completion_spec.rb

@@ -37,7 +37,7 @@ RSpec.describe "LLM::OpenAI: completions" do
       end
 
       it "includes the response" do
-        expect(choice.extra[:completion]).to eq(response)
+        expect(choice.extra[:response]).to eq(response)
       end
     end
   end

data/spec/openai/files_spec.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+require "setup"
+
+RSpec.describe "LLM::OpenAI::Files" do
+  let(:token) { ENV["LLM_SECRET"] || "TOKEN" }
+  let(:provider) { LLM.openai(token) }
+
+  context "when given a successful create operation (haiku1.txt)",
+          vcr: {cassette_name: "openai/files/successful_create_haiku1"} do
+    subject(:file) { provider.files.create(file: LLM::File("spec/fixtures/documents/haiku1.txt")) }
+    after { provider.files.delete(file:) }
+
+    it "is successful" do
+      expect(file).to be_instance_of(LLM::Response::File)
+    end
+
+    it "returns a file object" do
+      expect(file).to have_attributes(
+        id: instance_of(String),
+        filename: "haiku1.txt",
+        purpose: "assistants"
+      )
+    end
+  end
+
+  context "when given a successful create operation (haiku2.txt)",
+          vcr: {cassette_name: "openai/files/successful_create_haiku2"} do
+    subject(:file) { provider.files.create(file: LLM::File("spec/fixtures/documents/haiku2.txt")) }
+    after { provider.files.delete(file:) }
+
+    it "is successful" do
+      expect(file).to be_instance_of(LLM::Response::File)
+    end
+
+    it "returns a file object" do
+      expect(file).to have_attributes(
+        id: instance_of(String),
+        filename: "haiku2.txt",
+        purpose: "assistants"
+      )
+    end
+  end
+
+  context "when given a successful delete operation (haiku3.txt)",
+          vcr: {cassette_name: "openai/files/successful_delete_haiku3"} do
+    let(:file) { provider.files.create(file: LLM::File("spec/fixtures/documents/haiku3.txt")) }
+    subject { provider.files.delete(file:) }
+
+    it "is successful" do
+      is_expected.to be_instance_of(OpenStruct)
+    end
+
+    it "returns deleted status" do
+      is_expected.to have_attributes(
+        deleted: true
+      )
+    end
+  end
+
+  context "when given a successful get operation (haiku4.txt)",
+          vcr: {cassette_name: "openai/files/successful_get_haiku4"} do
+    let(:file) { provider.files.create(file: LLM::File("spec/fixtures/documents/haiku4.txt")) }
+    subject { provider.files.get(file:) }
+    after { provider.files.delete(file:) }
+
+    it "is successful" do
+      is_expected.to be_instance_of(LLM::Response::File)
+    end
+
+    it "returns a file object" do
+      is_expected.to have_attributes(
+        id: instance_of(String),
+        filename: "haiku4.txt",
+        purpose: "assistants"
+      )
+    end
+  end
+
+  context "when given a successful all operation",
+          vcr: {cassette_name: "openai/files/successful_all"} do
+    let!(:files) do
+      [
+        provider.files.create(file: LLM::File("spec/fixtures/documents/haiku1.txt")),
+        provider.files.create(file: LLM::File("spec/fixtures/documents/haiku2.txt"))
+      ]
+    end
+    subject(:file) { provider.files.all }
+    after { files.each { |file| provider.files.delete(file:) } }
+
+    it "is successful" do
+      expect(file).to be_instance_of(LLM::Response::FileList)
+    end
+
+    it "returns an array of file objects" do
+      expect(file).to match_array(
+        [
+          have_attributes(
+            id: instance_of(String),
+            filename: "haiku1.txt",
+            purpose: "assistants"
+          ),
+          have_attributes(
+            id: instance_of(String),
+            filename: "haiku2.txt",
+            purpose: "assistants"
+          )
+        ]
+      )
+    end
+  end
+
+  context "when asked to describe the contents of a file",
+          vcr: {cassette_name: "openai/files/describe_freebsd.sysctl.pdf"} do
+    subject { bot.last_message.content }
+    let(:bot) { LLM::Chat.new(provider).lazy }
+    let(:file) { provider.files.create(file: LLM::File("spec/fixtures/documents/freebsd.sysctl.pdf")) }
+    after { provider.files.delete(file:) }
+
+    before do
+      bot.respond(file)
+      bot.respond("Describe the contents of the file to me")
+      bot.respond("Your summary should be no more than ten words")
+    end
+
+    it "describes the document" do
+      is_expected.to eq("FreeBSD system control nodes implementation and usage overview.")
+    end
+  end
+
+  context "when asked to describe the contents of a file",
+          vcr: {cassette_name: "openai/files/describe_freebsd.sysctl_2.pdf"} do
+    subject { bot.last_message.content }
+    let(:bot) { LLM::Chat.new(provider).lazy }
+    let(:file) { provider.files.create(file: LLM::File("spec/fixtures/documents/freebsd.sysctl.pdf")) }
+    after { provider.files.delete(file:) }
+
+    before do
+      bot.respond([
+        "Describe the contents of the file to me",
+        "Your summary should be no more than ten words",
+        file
+      ])
+    end
+
+    it "describes the document" do
+      is_expected.to eq("FreeBSD kernel system control nodes overview and implementation.")
+    end
+  end
+end

data/spec/openai/images_spec.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require "setup"
+
+RSpec.describe "LLM::OpenAI::Images" do
+  let(:token) { ENV["LLM_SECRET"] || "TOKEN" }
+  let(:provider) { LLM.openai(token) }
+
+  context "when given a successful create operation (urls)",
+          vcr: {cassette_name: "openai/images/successful_create_urls"} do
+    subject(:response) { provider.images.create(prompt: "A dog on a rocket to the moon") }
+
+    it "is successful" do
+      expect(response).to be_instance_of(LLM::Response::Image)
+    end
+
+    it "returns an array of urls" do
+      expect(response.urls).to be_instance_of(Array)
+    end
+
+    it "returns a url" do
+      expect(response.urls[0]).to be_instance_of(String)
+    end
+  end
+
+  context "when given a successful create operation (base64)",
+          vcr: {cassette_name: "openai/images/successful_create_base64"} do
+    subject(:response) do
+      provider.images.create(
+        prompt: "A dog on a rocket to the moon",
+        response_format: "b64_json"
+      )
+    end
+
+    it "is successful" do
+      expect(response).to be_instance_of(LLM::Response::Image)
+    end
+
+    it "returns an array of images" do
+      expect(response.images).to be_instance_of(Array)
+    end
+
+    it "returns an encoded string" do
+      expect(response.images[0].encoded).to be_instance_of(String)
+    end
+
+    it "returns an binary string" do
+      expect(response.images[0].binary).to be_instance_of(String)
+    end
+  end
+
+  context "when given a successful variation operation",
+        vcr: {cassette_name: "openai/images/successful_variation"} do
+    subject(:response) do
+      provider.images.create_variation(
+        image: LLM::File("spec/fixtures/images/bluebook.png"),
+        n: 5
+      )
+    end
+
+    it "is successful" do
+      expect(response).to be_instance_of(LLM::Response::Image)
+    end
+
+    it "returns data" do
+      expect(response.urls.size).to eq(5)
+    end
+
+    it "returns multiple variations" do
+      response.urls.each { expect(_1).to be_instance_of(String) }
+    end
+  end
+
+  context "when given a successful edit",
+        vcr: {cassette_name: "openai/images/successful_edit"} do
+    subject(:response) do
+      provider.images.edit(
+        image: LLM::File("spec/fixtures/images/bluebook.png"),
+        prompt: "Add white background"
+      )
+    end
+
+    it "is successful" do
+      expect(response).to be_instance_of(LLM::Response::Image)
+    end
+
+    it "returns data" do
+      expect(response.urls).to be_instance_of(Array)
+    end
+
+    it "returns a url" do
+      expect(response.urls[0]).to be_instance_of(String)
+    end
+  end
+end

data/spec/openai/responses_spec.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "setup"
+
+RSpec.describe "LLM::OpenAI::Responses" do
+  let(:token) { ENV["LLM_SECRET"] || "TOKEN" }
+  let(:provider) { LLM.openai(token) }
+
+  context "when given a successful create operation",
+          vcr: {cassette_name: "openai/responses/successful_create"} do
+    subject { provider.responses.create("Hello", :developer) }
+
+    it "is successful" do
+      is_expected.to be_instance_of(LLM::Response::Output)
+    end
+
+    it "has outputs" do
+      is_expected.to have_attributes(
+        outputs: [instance_of(LLM::Message)]
+      )
+    end
+  end
+
+  context "when given a successful get operation",
+          vcr: {cassette_name: "openai/responses/successful_get"} do
+    let(:response) { provider.responses.create("Hello", :developer) }
+    subject { provider.responses.get(response) }
+
+    it "is successful" do
+      is_expected.to be_instance_of(LLM::Response::Output)
+    end
+
+    it "has outputs" do
+      is_expected.to have_attributes(
+        outputs: [instance_of(LLM::Message)]
+      )
+    end
+  end
+
+  context "when given a successful delete operation",
+          vcr: {cassette_name: "openai/responses/successful_delete"} do
+    let(:response) { provider.responses.create("Hello", :developer) }
+    subject { provider.responses.delete(response) }
+
+    it "is successful" do
+      is_expected.to have_attributes(
+        deleted: true
+      )
+    end
+  end
+end

data/spec/setup.rb

@@ -16,5 +16,13 @@ VCR.configure do |config|
   config.cassette_library_dir = "spec/fixtures/cassettes"
   config.hook_into :webmock
   config.configure_rspec_metadata!
+
+  ##
+  # scrub
   config.filter_sensitive_data("TOKEN") { ENV["LLM_SECRET"] }
+  config.before_record do
+    body = _1.response.body
+    body.gsub! %r|#{Regexp.escape("https://oaidalleapiprodscus.blob.core.windows.net/")}[^"]+|,
+               "https://openai.com/generated/image.png"
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: llm.rb
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Antar Azri
@@ -9,50 +9,8 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-04 00:00:00.000000000 Z
+date: 2025-04-25 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: net-http
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-- !ruby/object:Gem::Dependency
-  name: json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: yaml
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -189,40 +147,57 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSE.txt
 - README.md
 - lib/llm.rb
-- lib/llm/conversation.rb
+- lib/llm/buffer.rb
+- lib/llm/chat.rb
 - lib/llm/core_ext/ostruct.rb
 - lib/llm/error.rb
 - lib/llm/file.rb
 - lib/llm/http_client.rb
 - lib/llm/message.rb
-- lib/llm/message_queue.rb
+- lib/llm/mime.rb
 - lib/llm/model.rb
+- lib/llm/multipart.rb
 - lib/llm/provider.rb
 - lib/llm/providers/anthropic.rb
 - lib/llm/providers/anthropic/error_handler.rb
 - lib/llm/providers/anthropic/format.rb
 - lib/llm/providers/anthropic/response_parser.rb
 - lib/llm/providers/gemini.rb
+- lib/llm/providers/gemini/audio.rb
 - lib/llm/providers/gemini/error_handler.rb
+- lib/llm/providers/gemini/files.rb
 - lib/llm/providers/gemini/format.rb
+- lib/llm/providers/gemini/images.rb
 - lib/llm/providers/gemini/response_parser.rb
 - lib/llm/providers/ollama.rb
 - lib/llm/providers/ollama/error_handler.rb
 - lib/llm/providers/ollama/format.rb
 - lib/llm/providers/ollama/response_parser.rb
 - lib/llm/providers/openai.rb
+- lib/llm/providers/openai/audio.rb
 - lib/llm/providers/openai/error_handler.rb
+- lib/llm/providers/openai/files.rb
 - lib/llm/providers/openai/format.rb
+- lib/llm/providers/openai/images.rb
 - lib/llm/providers/openai/response_parser.rb
+- lib/llm/providers/openai/responses.rb
 - lib/llm/providers/voyageai.rb
 - lib/llm/providers/voyageai/error_handler.rb
 - lib/llm/providers/voyageai/response_parser.rb
 - lib/llm/response.rb
+- lib/llm/response/audio.rb
+- lib/llm/response/audio_transcription.rb
+- lib/llm/response/audio_translation.rb
 - lib/llm/response/completion.rb
+- lib/llm/response/download_file.rb
 - lib/llm/response/embedding.rb
+- lib/llm/response/file.rb
+- lib/llm/response/filelist.rb
+- lib/llm/response/image.rb
+- lib/llm/response/output.rb
+- lib/llm/utils.rb
 - lib/llm/version.rb
 - llm.gemspec
 - share/llm/models/anthropic.yml
@@ -232,21 +207,28 @@ files:
 - spec/anthropic/completion_spec.rb
 - spec/anthropic/embedding_spec.rb
 - spec/gemini/completion_spec.rb
+- spec/gemini/conversation_spec.rb
 - spec/gemini/embedding_spec.rb
+- spec/gemini/files_spec.rb
+- spec/gemini/images_spec.rb
 - spec/llm/conversation_spec.rb
 - spec/ollama/completion_spec.rb
+- spec/ollama/conversation_spec.rb
 - spec/ollama/embedding_spec.rb
+- spec/openai/audio_spec.rb
 - spec/openai/completion_spec.rb
 - spec/openai/embedding_spec.rb
+- spec/openai/files_spec.rb
+- spec/openai/images_spec.rb
+- spec/openai/responses_spec.rb
 - spec/readme_spec.rb
 - spec/setup.rb
 homepage: https://github.com/llmrb/llm
 licenses:
-- MIT
+- 0BSDL
 metadata:
   homepage_uri: https://github.com/llmrb/llm
   source_code_uri: https://github.com/llmrb/llm
-  changelog_uri: https://github.com/llmrb/llm/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2024 Antar Azri
-
-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/lib/llm/conversation.rb

@@ -1,90 +0,0 @@
-# frozen_string_literal: true
-
-module LLM
-  ##
-  # {LLM::Conversation LLM::Conversation} provides a conversation
-  # object that maintains a thread of messages that acts as context
-  # throughout the conversation.
-  # @example
-  #   llm = LLM.openai(ENV["KEY"])
-  #   convo = llm.chat("You are my climate expert", :system)
-  #   convo.chat("What's the climate like in Rio de Janerio?", :user)
-  #   convo.chat("What's the climate like in Algiers?", :user)
-  #   convo.chat("What's the climate like in Tokyo?", :user)
-  #   p bot.messages.map { [_1.role, _1.content] }
-  class Conversation
-    ##
-    # @return [Array<LLM::Message>]
-    attr_reader :messages
-
-    ##
-    # @param [LLM::Provider] provider
-    #  A provider
-    # @param [Hash] params
-    #  The parameters to maintain throughout the conversation
-    def initialize(provider, params = {})
-      @provider = provider
-      @params = params
-      @lazy = false
-      @messages = []
-    end
-
-    ##
-    # @param prompt (see LLM::Provider#prompt)
-    # @return [LLM::Conversation]
-    def chat(prompt, role = :user, **params)
-      tap do
-        if lazy?
-          @messages << [LLM::Message.new(role, prompt), @params.merge(params)]
-        else
-          completion = complete(prompt, role, params)
-          @messages.concat [Message.new(role, prompt), completion.choices[0]]
-        end
-      end
-    end
-
-    ##
-    # @note
-    #  The `read_response` and `recent_message` methods are aliases of
-    #  the `last_message` method, and you can choose the name that best
-    #  fits your context or code style.
-    # @param [#to_s] role
-    #  The role of the last message.
-    #  Defaults to the LLM's assistant role (eg "assistant" or "model")
-    # @return [LLM::Message]
-    #  The last message for the given role
-    def last_message(role: @provider.assistant_role)
-      messages.reverse_each.find { _1.role == role.to_s }
-    end
-    alias_method :recent_message, :last_message
-    alias_method :read_response, :last_message
-
-    ##
-    # Enables lazy mode for the conversation.
-    # @return [LLM::Conversation]
-    def lazy
-      tap do
-        next if lazy?
-        @lazy = true
-        @messages = LLM::MessageQueue.new(@provider)
-      end
-    end
-
-    ##
-    # @return [Boolean]
-    #  Returns true if the conversation is lazy
-    def lazy?
-      @lazy
-    end
-
-    private
-
-    def complete(prompt, role, params)
-      @provider.complete(
-        prompt,
-          role,
-          **@params.merge(params.merge(messages:))
-      )
-    end
-  end
-end