llm.rb 0.10.0 → 0.11.0

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

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-module LLM::Ollama::ResponseParser
-  ##
-  # @private
-  class CompletionParser
-    def initialize(body)
-      @body = LLM::Object.from_hash(body)
-    end
-
-    def format(response)
-      {
-        model:,
-        choices: [format_choices(response)],
-        prompt_tokens:,
-        completion_tokens:
-      }
-    end
-
-    private
-
-    def format_choices(response)
-      role, content, calls = message.to_h.values_at(:role, :content, :tool_calls)
-      extra = {response:, tool_calls: format_tool_calls(calls)}
-      LLM::Message.new(role, content, extra)
-    end
-
-    def format_tool_calls(tools)
-      return [] unless tools
-      tools.filter_map do |tool|
-        next unless tool["function"]
-        LLM::Object.new(tool["function"])
-      end
-    end
-
-    def body = @body
-    def model = body.model
-    def prompt_tokens = body.prompt_eval_count
-    def completion_tokens = body.eval_count
-    def message = body.message
-  end
-end

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

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-class LLM::Ollama
-  ##
-  # @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: body["model"],
-        embeddings: body["data"].map { _1["embedding"] },
-        prompt_tokens: body.dig("usage", "prompt_tokens"),
-        total_tokens: body.dig("usage", "total_tokens")
-      }
-    end
-  end
-end

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

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-class LLM::OpenAI
-  ##
-  # @private
-  module ResponseParser
-    require_relative "response_parser/completion_parser"
-    require_relative "response_parser/respond_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_respond_response(body)
-      RespondParser.new(body).format(self)
-    end
-
-    ##
-    # @param [Hash] body
-    #  The response body from the LLM provider
-    # @return [Hash]
-    def parse_moderation_list(body)
-      {
-        id: body["id"],
-        model: body["model"],
-        moderations: body["results"].map { LLM::Response::ModerationList::Moderation.new(_1) }
-      }
-    end
-
-    ##
-    # @param [Hash] body
-    #  The response body from the LLM provider
-    # @return [Hash]
-    def parse_embedding(body)
-      {
-        model: body["model"],
-        embeddings: body["data"].map { _1["embedding"] },
-        prompt_tokens: body.dig("usage", "prompt_tokens"),
-        total_tokens: body.dig("usage", "total_tokens")
-      }
-    end
-
-    ##
-    # @param [Hash] body
-    #  The response body from the LLM provider
-    # @return [Hash]
-    def parse_image(body)
-      {
-        urls: body["data"].filter_map { _1["url"] },
-        images: body["data"].filter_map do
-          next unless _1["b64_json"]
-          StringIO.new(_1["b64_json"].unpack1("m0"))
-        end
-      }
-    end
-  end
-end

data/lib/llm/providers/voyageai/error_handler.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-class LLM::VoyageAI
-  class ErrorHandler
-    ##
-    # @return [Net::HTTPResponse]
-    #  Non-2XX response from the server
-    attr_reader :res
-
-    ##
-    # @param [Net::HTTPResponse] res
-    #  The response from the server
-    # @return [LLM::OpenAI::ErrorHandler]
-    def initialize(res)
-      @res = res
-    end
-
-    ##
-    # @raise [LLM::Error]
-    #  Raises a subclass of {LLM::Error LLM::Error}
-    def raise_error!
-      case res
-      when Net::HTTPUnauthorized
-        raise LLM::UnauthorizedError.new { _1.response = res }, "Authentication error"
-      when Net::HTTPTooManyRequests
-        raise LLM::RateLimitError.new { _1.response = res }, "Too many requests"
-      else
-        raise LLM::ResponseError.new { _1.response = res }, "Unexpected response"
-      end
-    end
-  end
-end

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

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-class LLM::VoyageAI
-  module ResponseParser
-    def parse_embedding(body)
-      {
-        model: body["model"],
-        embeddings: body["data"].map { _1["embedding"] },
-        total_tokens: body.dig("usage", "total_tokens")
-      }
-    end
-  end
-end

data/lib/llm/providers/voyageai.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-module LLM
-  class VoyageAI < Provider
-    require_relative "voyageai/error_handler"
-    require_relative "voyageai/response_parser"
-    HOST = "api.voyageai.com"
-
-    ##
-    # @param key (see LLM::Provider#initialize)
-    def initialize(**)
-      super(host: HOST, **)
-    end
-
-    ##
-    # Provides an embedding via VoyageAI per
-    # [Anthropic's recommendation](https://docs.anthropic.com/en/docs/build-with-claude/embeddings)
-    # @param input (see LLM::Provider#embed)
-    # @return (see LLM::Provider#embed)
-    def embed(input, model: "voyage-2", **params)
-      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)
-    end
-
-    private
-
-    def headers
-      {
-        "Content-Type" => "application/json",
-        "Authorization" => "Bearer #{@key}"
-      }
-    end
-
-    def response_parser
-      LLM::VoyageAI::ResponseParser
-    end
-
-    def error_handler
-      LLM::VoyageAI::ErrorHandler
-    end
-  end
-end

data/lib/llm/response/audio.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module LLM
-  ##
-  # The {LLM::Response::Audio LLM::Response::Audio} class represents an
-  # audio file that has been returned by a provider. It wraps an IO object
-  # that can be used to read the contents of an audio stream (as binary data).
-  class Response::Audio < Response
-    ##
-    # @return [StringIO]
-    attr_accessor :audio
-  end
-end

data/lib/llm/response/audio_transcription.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module LLM
-  ##
-  # The {LLM::Response::AudioTranscription LLM::Response::AudioTranscription}
-  # class represents an audio transcription that has been returned by
-  # a provider (eg OpenAI, Gemini, etc)
-  class Response::AudioTranscription < Response
-    ##
-    # Returns the text of the transcription
-    # @return [String]
-    attr_accessor :text
-  end
-end

data/lib/llm/response/audio_translation.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module LLM
-  ##
-  # The {LLM::Response::AudioTranslation LLM::Response::AudioTranslation}
-  # class represents an audio translation that has been returned by
-  # a provider (eg OpenAI, Gemini, etc)
-  class Response::AudioTranslation < Response
-    ##
-    # Returns the text of the translation
-    # @return [String]
-    attr_accessor :text
-  end
-end

data/lib/llm/response/completion.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-module LLM
-  class Response::Completion < Response
-    ##
-    # @return [String]
-    #   Returns the model name used for the completion
-    def model
-      parsed[:model]
-    end
-
-    ##
-    # @return [Array<LLM::Message>]
-    #   Returns an array of messages
-    def choices
-      parsed[:choices]
-    end
-    alias_method :messages, :choices
-
-    ##
-    # @return [Integer]
-    #   Returns the count of prompt tokens
-    def prompt_tokens
-      parsed[:prompt_tokens]
-    end
-
-    ##
-    # @return [Integer]
-    #   Returns the count of completion tokens
-    def completion_tokens
-      parsed[:completion_tokens]
-    end
-
-    ##
-    # @return [Integer]
-    #   Returns the total count of tokens
-    def total_tokens
-      prompt_tokens + completion_tokens
-    end
-
-    private
-
-    ##
-    # @private
-    # @return [Hash]
-    #   Returns the parsed completion response from the provider
-    def parsed
-      @parsed ||= parse_completion(body)
-    end
-  end
-end

data/lib/llm/response/download_file.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module LLM
-  ##
-  # The {LLM::Response::DownloadFile LLM::Response::DownloadFile} class
-  # represents the contents of a file that has been returned by a
-  # provider. It wraps an IO object that can be used to read the file
-  # contents.
-  class Response::DownloadFile < Response
-    ##
-    # Returns a StringIO object
-    # @return [StringIO]
-    attr_accessor :file
-  end
-end

data/lib/llm/response/embedding.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-module LLM
-  class Response::Embedding < Response
-    def model
-      parsed[:model]
-    end
-
-    def embeddings
-      parsed[:embeddings]
-    end
-
-    def total_tokens
-      parsed[:total_tokens]
-    end
-
-    private
-
-    def parsed
-      @parsed ||= parse_embedding(body)
-    end
-  end
-end

data/lib/llm/response/file.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-module LLM
-  ##
-  # The {LLM::Response::File LLM::Response::File} class represents a file
-  # that has been uploaded to a provider. Its properties are delegated
-  # to the underlying response body, and vary by provider.
-  class Response::File < Response
-    ##
-    # Returns a normalized response body
-    # @return [Hash]
-    def body
-      @_body ||= if super["file"]
-        super["file"].transform_keys { snakecase(_1) }
-      else
-        super.transform_keys { snakecase(_1) }
-      end
-    end
-
-    ##
-    # @return [String]
-    def inspect
-      "#<#{self.class}:0x#{object_id.to_s(16)} body=#{body}>"
-    end
-
-    private
-
-    include LLM::Utils
-
-    def respond_to_missing?(m, _)
-      body.key?(m.to_s) || super
-    end
-
-    def method_missing(m, *args, &block)
-      if body.key?(m.to_s)
-        body[m.to_s]
-      else
-        super
-      end
-    end
-  end
-end

data/lib/llm/response/filelist.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module LLM
-  ##
-  # The {LLM::Response::FileList LLM::Response::FileList} class represents a
-  # list of file objects that are returned by a provider. It is an Enumerable
-  # object, and can be used to iterate over the file objects in a way that is
-  # similar to an array. Each element is an instance of LLM::Object.
-  class Response::FileList < Response
-    include Enumerable
-
-    attr_accessor :files
-
-    def each(&)
-      @files.each(&)
-    end
-  end
-end

data/lib/llm/response/image.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module LLM
-  ##
-  # The {LLM::Response::Image LLM::Response::Image} class represents
-  # an image response. An image response might encapsulate one or more
-  # URLs, or a base64 encoded image -- depending on the provider.
-  class Response::Image < Response
-    ##
-    # Returns one or more image objects, or nil
-    # @return [Array<LLM::Object>, nil]
-    def images
-      parsed[:images].any? ? parsed[:images] : nil
-    end
-
-    ##
-    # Returns one or more image URLs, or nil
-    # @return [Array<String>, nil]
-    def urls
-      parsed[:urls].any? ? parsed[:urls] : nil
-    end
-
-    private
-
-    def parsed
-      @parsed ||= parse_image(body)
-    end
-  end
-end

data/lib/llm/response/modellist.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module LLM
-  ##
-  # The {LLM::Response::ModelList LLM::Response::ModelList} class represents a
-  # list of model objects that are returned by a provider. It is an Enumerable
-  # object, and can be used to iterate over the model objects in a way that is
-  # similar to an array. Each element is an instance of LLM::Object.
-  class Response::ModelList < Response
-    include Enumerable
-
-    attr_accessor :models
-
-    def each(&)
-      @models.each(&)
-    end
-  end
-end

data/lib/llm/response/moderationlist/moderation.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-class LLM::Response::ModerationList
-  ##
-  # The {LLM::Response::ModerationList::Moderation Moderation}
-  # class represents a moderation object that is returned by
-  # the moderations interface.
-  # @see LLM::Response::ModerationList
-  # @see LLM::OpenAI::Moderations
-  class Moderation
-    ##
-    # @param [Hash] moderation
-    # @return [LLM::Response::ModerationList::Moderation]
-    def initialize(moderation)
-      @moderation = moderation
-    end
-
-    ##
-    # Returns true if the moderation is flagged
-    # @return [Boolean]
-    def flagged?
-      @moderation["flagged"]
-    end
-
-    ##
-    # Returns the moderation categories
-    # @return [Array<String>]
-    def categories
-      @moderation["categories"].filter_map { _2 ? _1 : nil }
-    end
-
-    ##
-    # Returns the moderation scores
-    # @return [Hash]
-    def scores
-      @moderation["category_scores"].select { categories.include?(_1) }
-    end
-
-    ##
-    # @return [String]
-    def inspect
-      "#<#{self.class}:0x#{object_id.to_s(16)} " \
-      "categories=#{categories} " \
-      "scores=#{scores}>"
-    end
-  end
-end

data/lib/llm/response/moderationlist.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-module LLM
-  ##
-  # The {LLM::Response::ModerationList LLM::Response::ModerationList} class
-  # represents a response from the moderations API. It is an Enumerable that
-  # yields an instance of {LLM::Response::ModerationList::Moderation LLM::Response::ModerationList::Moderation},
-  # and each moderation object contains the categories and scores for a given
-  # input.
-  # @see LLM::OpenAI::Moderations LLM::OpenAI::Moderations
-  class Response::ModerationList < Response
-    require_relative "moderationlist/moderation"
-    include Enumerable
-
-    ##
-    # Returns the moderation ID
-    # @return [String]
-    def id
-      parsed[:id]
-    end
-
-    ##
-    # Returns the moderation model
-    # @return [String]
-    def model
-      parsed[:model]
-    end
-
-    ##
-    # Yields each moderation object
-    # @yieldparam [OpenStruct] moderation
-    # @yieldreturn [void]
-    # @return [void]
-    def each(&)
-      moderations.each(&)
-    end
-
-    private
-
-    def parsed
-      @parsed ||= parse_moderation_list(body)
-    end
-
-    ##
-    # Returns an array of moderation objects
-    # @return [Array<OpenStruct>]
-    def moderations
-      parsed[:moderations]
-    end
-  end
-end

data/lib/llm/response/respond.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-module LLM
-  class Response::Respond < Response
-    ##
-    # @return [String]
-    #  Returns the id of the response
-    def id
-      parsed[:id]
-    end
-
-    ##
-    # @return [String]
-    #  Returns the model name
-    def model
-      parsed[:model]
-    end
-
-    ##
-    # @return [Array<LLM::Message>]
-    def outputs
-      parsed[:outputs]
-    end
-
-    ##
-    # @return [Integer]
-    #  Returns the input token count
-    def input_tokens
-      parsed[:input_tokens]
-    end
-
-    ##
-    # @return [Integer]
-    #  Returns the output token count
-    def output_tokens
-      parsed[:output_tokens]
-    end
-
-    ##
-    # @return [Integer]
-    #  Returns the total count of tokens
-    def total_tokens
-      parsed[:total_tokens]
-    end
-
-    private
-
-    ##
-    # @private
-    # @return [Hash]
-    #  Returns the parsed response from the provider
-    def parsed
-      @parsed ||= parse_respond_response(body)
-    end
-  end
-end