llm.rb 0.10.0 → 0.11.0

data/lib/llm/providers/openai/{response_parser/respond_parser.rb → response/responds.rb}

@@ -1,28 +1,16 @@
 # frozen_string_literal: true
 
-module LLM::OpenAI::ResponseParser
-  ##
-  # @private
-  class RespondParser
-    def initialize(body)
-      @body = LLM::Object.from_hash(body)
-    end
+module LLM::OpenAI::Response
+  module Responds
 
-    def format(response)
-      {
-        id:,
-        model:,
-        input_tokens:,
-        output_tokens:,
-        total_tokens:,
-        outputs: [format_message(response)]
-      }
-    end
+    def outputs = [format_message]
+    def choices = body.output
+    def tools = output.select { _1.type == "function_call" }
 
     private
 
-    def format_message(response)
-      message = LLM::Message.new("assistant", +"", {response:, tool_calls: []})
+    def format_message
+      message = LLM::Message.new("assistant", +"", {response: self, tool_calls: []})
       choices.each.with_index do |choice, index|
         if choice.type == "function_call"
           message.extra[:tool_calls] << format_tool(choice)
@@ -43,14 +31,5 @@ module LLM::OpenAI::ResponseParser
         arguments: JSON.parse(tool.arguments)
       )
     end
-
-    def body = @body
-    def id = body.id
-    def model = body.model
-    def input_tokens = body.usage.input_tokens
-    def output_tokens = body.usage.output_tokens
-    def total_tokens = body.usage.total_tokens
-    def choices = body.output
-    def tools = output.select { _1.type == "function_call" }
   end
 end

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

@@ -33,6 +33,7 @@ class LLM::OpenAI
   #   file = llm.files.create file: "/documents/freebsd.pdf"
   #   res  = llm.responses.create ["Describe the document, file]
   class Responses
+    require_relative "response/responds"
     include Format
 
     ##
@@ -49,9 +50,9 @@ class LLM::OpenAI
     # @param prompt (see LLM::Provider#complete)
     # @param params (see LLM::Provider#complete)
     # @raise (see LLM::Provider#request)
-    # @raise [LLM::Error::PromptError]
+    # @raise [LLM::PromptError]
     #  When given an object a provider does not understand
-    # @return [LLM::Response::Output]
+    # @return [LLM::Response]
     def create(prompt, params = {})
       params = {role: :user, model: @provider.default_model}.merge!(params)
       params = [params, format_schema(params), format_tools(params)].inject({}, &:merge!).compact
@@ -61,7 +62,7 @@ class LLM::OpenAI
       body = JSON.dump({input: [format(messages, :response)].flatten}.merge!(params))
       set_body_stream(req, StringIO.new(body))
       res = execute(request: req)
-      LLM::Response::Respond.new(res).extend(response_parser)
+      LLM::Response.new(res).extend(LLM::OpenAI::Response::Responds)
     end
 
     ##
@@ -69,13 +70,13 @@ class LLM::OpenAI
     # @see https://platform.openai.com/docs/api-reference/responses/get OpenAI docs
     # @param [#id, #to_s] response Response ID
     # @raise (see LLM::Provider#request)
-    # @return [LLM::Response::Output]
+    # @return [LLM::Response]
     def get(response, **params)
       response_id = response.respond_to?(:id) ? response.id : response
       query = URI.encode_www_form(params)
       req = Net::HTTP::Get.new("/v1/responses/#{response_id}?#{query}", headers)
       res = execute(request: req)
-      LLM::Response::Respond.new(res).extend(response_parser)
+      LLM::Response.new(res).extend(LLM::OpenAI::Response::Responds)
     end
 
     ##
@@ -88,14 +89,14 @@ class LLM::OpenAI
       response_id = response.respond_to?(:id) ? response.id : response
       req = Net::HTTP::Delete.new("/v1/responses/#{response_id}", headers)
       res = execute(request: req)
-      LLM::Object.from_hash JSON.parse(res.body)
+      LLM::Response.new(res)
     end
 
     private
 
-    [:response_parser, :headers,
-     :execute, :set_body_stream,
-     :format_schema, :format_tools].each do |m|
+    [:headers, :execute,
+     :set_body_stream, :format_schema,
+     :format_tools].each do |m|
       define_method(m) { |*args, **kwargs, &b| @provider.send(m, *args, **kwargs, &b) }
     end
   end

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

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+class LLM::OpenAI
+  ##
+  # The {LLM::OpenAI::VectorStore LLM::OpenAI::VectorStore} class provides
+  # an interface to OpenAI's vector stores API
+  # @see https://platform.openai.com/docs/api-reference/vector_stores/create OpenAI docs
+  class VectorStores
+    ##
+    # @param [LLM::Provider] provider
+    #  An OpenAI provider
+    def initialize(provider)
+      @provider = provider
+    end
+
+    ##
+    # List all vector stores
+    # @param [Hash] params Other parameters (see OpenAI docs)
+    # @return [LLM::Response]
+    def all(**params)
+      query = URI.encode_www_form(params)
+      req = Net::HTTP::Get.new("/v1/vector_stores?#{query}", headers)
+      res = execute(request: req)
+      LLM::Response.new(res)
+    end
+
+    ##
+    # Create a vector store
+    # @param [String] name The name of the vector store
+    # @param [Array<String>] file_ids The IDs of the files to include in the vector store
+    # @param [Hash] params Other parameters (see OpenAI docs)
+    # @raise (see LLM::Provider#request)
+    # @return [LLM::Response]
+    # @see https://platform.openai.com/docs/api-reference/vector_stores/create OpenAI docs
+    def create(name:, file_ids: [], **params)
+      req = Net::HTTP::Post.new("/v1/vector_stores", headers)
+      req.body = JSON.dump(params.merge({name:, file_ids:}).compact)
+      res = execute(request: req)
+      LLM::Response.new(res)
+    end
+
+    ##
+    # Get a vector store
+    # @param [String, #id] vector The ID of the vector store
+    # @raise (see LLM::Provider#request)
+    # @return [LLM::Response]
+    # @see https://platform.openai.com/docs/api-reference/vector_stores/retrieve OpenAI docs
+    def get(vector:)
+      vector_id = vector.respond_to?(:id) ? vector.id : vector
+      req = Net::HTTP::Get.new("/v1/vector_stores/#{vector_id}", headers)
+      res = execute(request: req)
+      LLM::Response.new(res)
+    end
+
+    ##
+    # Modify an existing vector store
+    # @param [String, #id] vector The ID of the vector store
+    # @param [String] name The new name of the vector store
+    # @param [Hash] params Other parameters (see OpenAI docs)
+    # @raise (see LLM::Provider#request)
+    # @return [LLM::Response]
+    # @see https://platform.openai.com/docs/api-reference/vector_stores/modify OpenAI docs
+    def modify(vector:, name: nil, **params)
+      vector_id = vector.respond_to?(:id) ? vector.id : vector
+      req = Net::HTTP::Post.new("/v1/vector_stores/#{vector_id}", headers)
+      req.body = JSON.dump(params.merge({name:}).compact)
+      res = execute(request: req)
+      LLM::Response.new(res)
+    end
+
+    ##
+    # Delete a vector store
+    # @param [String, #id] vector The ID of the vector store
+    # @raise (see LLM::Provider#request)
+    # @return [LLM::Response]
+    # @see https://platform.openai.com/docs/api-reference/vector_stores/delete OpenAI docs
+    def delete(vector:)
+      vector_id = vector.respond_to?(:id) ? vector.id : vector
+      req = Net::HTTP::Delete.new("/v1/vector_stores/#{vector_id}", headers)
+      res = execute(request: req)
+      LLM::Response.new(res)
+    end
+
+    ##
+    # Search a vector store
+    # @param [String, #id] vector The ID of the vector store
+    # @param query [String] The query to search for
+    # @param params [Hash] Other parameters (see OpenAI docs)
+    # @raise (see LLM::Provider#request)
+    # @return [LLM::Response]
+    # @see https://platform.openai.com/docs/api-reference/vector_stores/search OpenAI docs
+    def search(vector:, query:, **params)
+      vector_id = vector.respond_to?(:id) ? vector.id : vector
+      req = Net::HTTP::Post.new("/v1/vector_stores/#{vector_id}/search", headers)
+      req.body = JSON.dump(params.merge({query:}).compact)
+      res = execute(request: req)
+      LLM::Response.new(res)
+    end
+
+    private
+
+    [:headers, :execute, :set_body_stream].each do |m|
+      define_method(m) { |*args, **kwargs, &b| @provider.send(m, *args, **kwargs, &b) }
+    end
+  end
+end

data/lib/llm/providers/openai.rb

@@ -5,16 +5,18 @@ module LLM
   # The OpenAI class implements a provider for
   # [OpenAI](https://platform.openai.com/)
   class OpenAI < Provider
+    require_relative "openai/response/embedding"
+    require_relative "openai/response/completion"
     require_relative "openai/error_handler"
     require_relative "openai/format"
     require_relative "openai/stream_parser"
-    require_relative "openai/response_parser"
     require_relative "openai/models"
     require_relative "openai/responses"
     require_relative "openai/images"
     require_relative "openai/audio"
     require_relative "openai/files"
     require_relative "openai/moderations"
+    require_relative "openai/vector_stores"
 
     include Format
 
@@ -38,7 +40,7 @@ module LLM
       req = Net::HTTP::Post.new("/v1/embeddings", headers)
       req.body = JSON.dump({input:, model:}.merge!(params))
       res = execute(request: req)
-      Response::Embedding.new(res).extend(response_parser)
+      LLM::Response.new(res).extend(LLM::OpenAI::Response::Embedding)
     end
 
     ##
@@ -48,7 +50,7 @@ module LLM
     # @param params (see LLM::Provider#complete)
     # @example (see LLM::Provider#complete)
     # @raise (see LLM::Provider#request)
-    # @raise [LLM::Error::PromptError]
+    # @raise [LLM::PromptError]
     #  When given an object a provider does not understand
     # @return (see LLM::Provider#complete)
     def complete(prompt, params = {})
@@ -61,7 +63,7 @@ module LLM
       body = JSON.dump({messages: format(messages, :complete).flatten}.merge!(params))
       set_body_stream(req, StringIO.new(body))
       res = execute(request: req, stream:)
-      Response::Completion.new(res).extend(response_parser)
+      LLM::Response.new(res).extend(LLM::OpenAI::Response::Completion)
     end
 
     ##
@@ -113,6 +115,14 @@ module LLM
       LLM::OpenAI::Moderations.new(self)
     end
 
+    ##
+    # Provides an interface to OpenAI's vector store API
+    # @see https://platform.openai.com/docs/api-reference/vector-stores/create OpenAI docs
+    # @return [LLM::OpenAI::VectorStore]
+    def vector_stores
+      LLM::OpenAI::VectorStores.new(self)
+    end
+
     ##
     # @return (see LLM::Provider#assistant_role)
     def assistant_role
@@ -136,10 +146,6 @@ module LLM
       )
     end
 
-    def response_parser
-      LLM::OpenAI::ResponseParser
-    end
-
     def stream_parser
       LLM::OpenAI::StreamParser
     end

data/lib/llm/response.rb

@@ -3,18 +3,11 @@
 module LLM
   class Response
     require "json"
-    require_relative "response/completion"
-    require_relative "response/embedding"
-    require_relative "response/respond"
-    require_relative "response/image"
-    require_relative "response/audio"
-    require_relative "response/audio_transcription"
-    require_relative "response/audio_translation"
-    require_relative "response/file"
-    require_relative "response/filelist"
-    require_relative "response/download_file"
-    require_relative "response/modellist"
-    require_relative "response/moderationlist"
+
+    ##
+    # Returns the HTTP response
+    # @return [Net::HTTPResponse]
+    attr_reader :res
 
     ##
     # @param [Net::HTTPResponse] res
@@ -30,9 +23,40 @@ module LLM
     # @return [Hash, String]
     def body
       @body ||= case @res["content-type"]
-      when %r|\Aapplication/json\s*| then JSON.parse(@res.body)
+      when %r|\Aapplication/json\s*| then LLM::Object.from_hash(JSON.parse(@res.body))
       else @res.body
       end
     end
+
+    ##
+    # Returns an inspection of the response object
+    # @return [String]
+    def inspect
+      "#<#{self.class.name}:0x#{object_id.to_s(16)} @body=#{body.inspect} @res=#{@res.inspect}>"
+    end
+
+    ##
+    # Returns true if the response is successful
+    # @return [Boolean]
+    def ok?
+      Net::HTTPSuccess === @res
+    end
+
+    ##
+    # Returns true if the response is from the Files API
+    # @return [Boolean]
+    def file?
+      false
+    end
+
+    private
+
+    def method_missing(m, *args, **kwargs, &b)
+      body.respond_to?(m) ? body[m.to_s] : super
+    end
+
+    def respond_to_missing?(m, include_private = false)
+      body.respond_to?(m) || super
+    end
   end
 end

data/lib/llm/version.rb

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

data/lib/llm.rb

@@ -12,7 +12,6 @@ module LLM
   require_relative "llm/mime"
   require_relative "llm/multipart"
   require_relative "llm/file"
-  require_relative "llm/model"
   require_relative "llm/provider"
   require_relative "llm/bot"
   require_relative "llm/buffer"
@@ -27,18 +26,9 @@ module LLM
   # @return (see LLM::Anthropic#initialize)
   def anthropic(**)
     require_relative "llm/providers/anthropic" unless defined?(LLM::Anthropic)
-    require_relative "llm/providers/voyageai" unless defined?(LLM::VoyageAI)
     LLM::Anthropic.new(**)
   end
 
-  ##
-  # @param (see LLM::Provider#initialize)
-  # @return (see LLM::VoyageAI#initialize)
-  def voyageai(**)
-    require_relative "llm/providers/voyageai" unless defined?(LLM::VoyageAI)
-    LLM::VoyageAI.new(**)
-  end
-
   ##
   # @param (see LLM::Provider#initialize)
   # @return (see LLM::Gemini#initialize)
@@ -87,8 +77,8 @@ module LLM
   #     fn.params do |schema|
   #       schema.object(command: schema.string.required)
   #     end
-  #     fn.define do |params|
-  #       system(params.command)
+  #     fn.define do |command:|
+  #       system(command)
   #     end
   #   end
   # @param [Symbol] name The name of the function

data/llm.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
 
   spec.description = spec.summary
   spec.homepage = "https://github.com/llmrb/llm"
-  spec.license = "0BSDL"
+  spec.license = "0BSD"
   spec.required_ruby_version = ">= 3.2.0"
 
   spec.metadata["homepage_uri"] = spec.homepage

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: llm.rb
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Antar Azri
@@ -189,7 +189,6 @@ files:
 - lib/llm/json/schema/version.rb
 - lib/llm/message.rb
 - lib/llm/mime.rb
-- lib/llm/model.rb
 - lib/llm/multipart.rb
 - lib/llm/object.rb
 - lib/llm/object/builder.rb
@@ -200,8 +199,7 @@ files:
 - lib/llm/providers/anthropic/format.rb
 - lib/llm/providers/anthropic/format/completion_format.rb
 - lib/llm/providers/anthropic/models.rb
-- lib/llm/providers/anthropic/response_parser.rb
-- lib/llm/providers/anthropic/response_parser/completion_parser.rb
+- lib/llm/providers/anthropic/response/completion.rb
 - lib/llm/providers/anthropic/stream_parser.rb
 - lib/llm/providers/deepseek.rb
 - lib/llm/providers/deepseek/format.rb
@@ -214,8 +212,10 @@ files:
 - lib/llm/providers/gemini/format/completion_format.rb
 - lib/llm/providers/gemini/images.rb
 - lib/llm/providers/gemini/models.rb
-- lib/llm/providers/gemini/response_parser.rb
-- lib/llm/providers/gemini/response_parser/completion_parser.rb
+- lib/llm/providers/gemini/response/completion.rb
+- lib/llm/providers/gemini/response/embedding.rb
+- lib/llm/providers/gemini/response/file.rb
+- lib/llm/providers/gemini/response/image.rb
 - lib/llm/providers/gemini/stream_parser.rb
 - lib/llm/providers/llamacpp.rb
 - lib/llm/providers/ollama.rb
@@ -223,8 +223,8 @@ files:
 - lib/llm/providers/ollama/format.rb
 - lib/llm/providers/ollama/format/completion_format.rb
 - lib/llm/providers/ollama/models.rb
-- lib/llm/providers/ollama/response_parser.rb
-- lib/llm/providers/ollama/response_parser/completion_parser.rb
+- lib/llm/providers/ollama/response/completion.rb
+- lib/llm/providers/ollama/response/embedding.rb
 - lib/llm/providers/ollama/stream_parser.rb
 - lib/llm/providers/openai.rb
 - lib/llm/providers/openai/audio.rb
@@ -237,34 +237,23 @@ files:
 - lib/llm/providers/openai/images.rb
 - lib/llm/providers/openai/models.rb
 - lib/llm/providers/openai/moderations.rb
-- lib/llm/providers/openai/response_parser.rb
-- lib/llm/providers/openai/response_parser/completion_parser.rb
-- lib/llm/providers/openai/response_parser/respond_parser.rb
+- lib/llm/providers/openai/response/audio.rb
+- lib/llm/providers/openai/response/completion.rb
+- lib/llm/providers/openai/response/embedding.rb
+- lib/llm/providers/openai/response/file.rb
+- lib/llm/providers/openai/response/image.rb
+- lib/llm/providers/openai/response/moderations.rb
+- lib/llm/providers/openai/response/responds.rb
 - lib/llm/providers/openai/responses.rb
 - lib/llm/providers/openai/stream_parser.rb
-- lib/llm/providers/voyageai.rb
-- lib/llm/providers/voyageai/error_handler.rb
-- lib/llm/providers/voyageai/response_parser.rb
+- lib/llm/providers/openai/vector_stores.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/modellist.rb
-- lib/llm/response/moderationlist.rb
-- lib/llm/response/moderationlist/moderation.rb
-- lib/llm/response/respond.rb
 - lib/llm/utils.rb
 - lib/llm/version.rb
 - llm.gemspec
 homepage: https://github.com/llmrb/llm
 licenses:
-- 0BSDL
+- 0BSD
 metadata:
   homepage_uri: https://github.com/llmrb/llm
   source_code_uri: https://github.com/llmrb/llm
@@ -282,7 +271,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.1
+rubygems_version: 3.6.9
 specification_version: 4
 summary: llm.rb is a zero-dependency Ruby toolkit for Large Language Models that includes
   OpenAI, Gemini, Anthropic, DeepSeek, Ollama, and LlamaCpp. The toolkit includes

data/lib/llm/model.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-##
-# The {LLM::Model LLM::Model} class represents an LLM model that
-# is available to use. Its properties are delegated to the underlying
-# response body, and vary by provider.
-class LLM::Model < LLM::Object
-  ##
-  # Returns a subclass of {LLM::Provider LLM::Provider}
-  # @return [LLM::Provider]
-  attr_accessor :provider
-
-  ##
-  # Returns the model ID
-  # @return [String]
-  def id
-    case @provider.class.to_s
-    when "LLM::Ollama"
-      self["name"]
-    when "LLM::Gemini"
-      self["name"].sub(%r|\Amodels/|, "")
-    else
-      self["id"]
-    end
-  end
-
-  ##
-  # @return [String]
-  def to_json(*)
-    id.to_json(*)
-  end
-end

data/lib/llm/providers/anthropic/response_parser/completion_parser.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-module LLM::Anthropic::ResponseParser
-  ##
-  # @private
-  class CompletionParser
-    def initialize(body)
-      @body = LLM::Object.from_hash(body)
-    end
-
-    def format(response)
-      {
-        model:,
-        prompt_tokens:,
-        completion_tokens:,
-        total_tokens:,
-        choices: format_choices(response)
-      }
-    end
-
-    private
-
-    def format_choices(response)
-      texts.map.with_index do |choice, index|
-        extra = {index:, response:, tool_calls: format_tool_calls(tools), original_tool_calls: tools}
-        LLM::Message.new(role, choice.text, extra)
-      end
-    end
-
-    def format_tool_calls(tools)
-      (tools || []).filter_map do |tool|
-        tool = {
-          id: tool.id,
-          name: tool.name,
-          arguments: tool.input
-        }
-        LLM::Object.new(tool)
-      end
-    end
-
-    def body = @body
-    def role = body.role
-    def model = body.model
-    def prompt_tokens = body.usage&.input_tokens
-    def completion_tokens = body.usage&.output_tokens
-    def total_tokens = body.usage&.total_tokens
-    def parts = body.content
-    def texts = parts.select { _1["type"] == "text" }
-    def tools = parts.select { _1["type"] == "tool_use" }
-  end
-end

data/lib/llm/providers/anthropic/response_parser.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-class LLM::Anthropic
-  ##
-  # @private
-  module ResponseParser
-    require_relative "response_parser/completion_parser"
-    def parse_embedding(body)
-      {
-        model: body["model"],
-        embeddings: body["data"].map { _1["embedding"] },
-        total_tokens: body.dig("usage", "total_tokens")
-      }
-    end
-
-    ##
-    # @param [Hash] body
-    #  The response body from the LLM provider
-    # @return [Hash]
-    def parse_completion(body)
-      CompletionParser.new(body).format(self)
-    end
-  end
-end

data/lib/llm/providers/gemini/response_parser.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-class LLM::Gemini
-  ##
-  # @private
-  module ResponseParser
-    require_relative "response_parser/completion_parser"
-
-    ##
-    # @param [Hash] body
-    #  The response body from the LLM provider
-    # @return [Hash]
-    def parse_completion(body)
-      CompletionParser.new(body).format(self)
-    end
-
-    ##
-    # @param [Hash] body
-    #  The response body from the LLM provider
-    # @return [Hash]
-    def parse_embedding(body)
-      {
-        model: "text-embedding-004",
-        embeddings: body.dig("embedding", "values")
-      }
-    end
-
-    ##
-    # @param [Hash] body
-    #  The response body from the LLM provider
-    # @return [Hash]
-    def parse_image(body)
-      {
-        urls: [],
-        images: body["candidates"].flat_map do |c|
-          parts = c["content"]["parts"]
-          parts.filter_map do
-            data = _1.dig("inlineData", "data")
-            next unless data
-            StringIO.new(data.unpack1("m0"))
-          end
-        end
-      }
-    end
-  end
-end