instructor-rb 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5baca74deed1078f1695501139db2033ca2cb4b1e0d414ba9898b13100263bed
-  data.tar.gz: b845048bd4b712181eab322d94ba20fd64aae15eb3949560028ff3a4058d594c
+  metadata.gz: f6bc3d3377404642d01aeee121baa7d16b02c279dd966908bb22b3a3bd776d36
+  data.tar.gz: 703cb4a43ce2ed3878008eca696059739dd458db97d1de4a6eb12b8487adbda0
 SHA512:
-  metadata.gz: a949d892bf2fef53c9c34fd06da30b143e08acdfc8967e428b262eedc7eabcc7147421f1b41dcde2007fe58677c808a1ca6bb9dc1be72a4f9c20c3a5474a91bb
-  data.tar.gz: ccfc2bf5c2c702b226972895eb290c68f2a625b688936979d9f5093e39e185f1c8423aedc4f40537b3b1ad2d313ea73e4f058491bbacadb075ad3cca1cacaae7
+  metadata.gz: d26bb4abc2156e60dd5f7f1d4a76f9a737b8ce31d4a58962a509c0882548e7cda4f90b18e7ccfb26a36b5dec53b21c3a99f8388d68ad6e6e2105906812ac8e6f
+  data.tar.gz: 3f2845af3d88a1b581ba09c5a2d1661101670a625abc499972af00391f1a49f604b4043177dcaf687026255773a0df23bd7b981dae6138aa455cf624e134d1c4

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [0.1.3] - 2024-05-22
+- Bumped OpenAI client version. 
+- Laying the work for more modes. See https://python.useinstructor.com/concepts/patching/ for more information.
+- Allow the OpenAI client to be used normally in case you just want to use other client features.
+
+## [0.1.2] - 2024-05-17
+- Improved the ability to customize the function name and the LLM function call description (instructions).
+
 ## [0.1.1] - 2024-05-07
 - Improved documentation in /docs folder.
 - Readme updates.

data/lib/instructor/mode.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'ostruct'
+
+module Instructor
+  # This module defines constants related to different modes of operation.
+  # It provides options for tool behavior, function types, and JSON modes.
+  # Currently supported modes are:
+  # - tools: select between function, auto, required, and none.
+  # more modes will be added in the near future.
+  module Mode
+    tool_options = %w[function auto required none].index_by(&:itself)
+    TOOL_BEHAVIOR = OpenStruct.new(tool_options)
+
+    FUNCTIONS = 'function_call'
+    PARALLEL_TOOLS = 'parallel_tool_call'
+    TOOLS = TOOL_BEHAVIOR
+    JSON = 'json_mode'
+    MD_JSON = 'markdown_json_mode'
+    JSON_SCHEMA = 'json_schema_mode'
+  end
+end

data/lib/instructor/openai/patch.rb

@@ -29,6 +29,8 @@ module Instructor
       # @param validation_context [Hash] The validation context for the parameters. Optional.
       # @return [Object] The processed response.
       def chat(parameters:, response_model: nil, max_retries: 0, validation_context: nil)
+        return json_post(path: '/chat/completions', parameters:) if response_model.nil?
+
         with_retries(max_retries, [JSON::ParserError, Instructor::ValidationError, Faraday::ParsingError]) do
           model = determine_model(response_model)
           function = build_function(model)
@@ -46,7 +48,22 @@ module Instructor
       # @return [Hash] The prepared parameters.
       def prepare_parameters(parameters, validation_context, function)
         parameters = apply_validation_context(parameters, validation_context)
-        parameters.merge(tools: [function])
+        parameters.merge!(tools: [function])
+        tool_choice = resolve_tool_choice(function)
+        parameters.merge!(tool_choice:)
+      end
+
+      def resolve_tool_choice(function)
+        case Instructor.mode
+        when Instructor::Mode::TOOLS.function
+          { type: 'function', function: { name: function[:function][:name] } }
+        when Instructor::Mode::TOOLS.auto
+          'auto'
+        when Instructor::Mode::TOOLS.required
+          'required'
+        when Instructor::Mode::TOOLS.none
+          'none'
+        end
       end
 
       # Processes the API response.
@@ -56,7 +73,11 @@ module Instructor
       # @return [Object] The processed response.
       def process_response(response, model)
         parsed_response = Response.new(response).parse
-        iterable? ? process_multiple_responses(parsed_response, model) : process_single_response(parsed_response, model)
+        if iterable?(parsed_response)
+          process_multiple_responses(parsed_response, model)
+        else
+          process_single_response(parsed_response, model)
+        end
       end
 
       # Processes multiple responses from the API.
@@ -84,7 +105,7 @@ module Instructor
       # Determines the response model based on the provided value.
       #
       # @param response_model [Class] The response model class or typed array.
-      # @return [Class] The determined response model class.
+      # @return [Class] The response model.
       def determine_model(response_model)
         if response_model.is_a?(T::Types::TypedArray)
           @iterable = true
@@ -118,26 +139,36 @@ module Instructor
         {
           type: 'function',
           function: {
-            name: model.name.humanize.titleize,
+            name: generate_function_name(model),
             description: generate_description(model),
             parameters: model.json_schema
           }
         }
       end
 
+      def generate_function_name(model)
+        model.schema.fetch(:title, model.name)
+      end
+
       # Generates the description for the function.
       #
       # @param model [Class] The response model class.
       # @return [String] The generated description.
       def generate_description(model)
-        "Correctly extracted `#{model.name}` with all the required parameters with correct types"
+        if model.respond_to?(:instructions)
+          raise Instructor::Error, 'The instructions must be a string' unless model.instructions.is_a?(String)
+
+          model.instructions
+        else
+          "Correctly extracted `#{model.name}` with all the required parameters with correct types"
+        end
       end
 
       # Checks if the response is iterable.
       #
       # @return [Boolean] `true` if the response is iterable, `false` otherwise.
-      def iterable?
-        @iterable
+      def iterable?(response)
+        @iterable && response.is_a?(Array)
       end
     end
   end

data/lib/instructor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Instructor
-  VERSION = '0.1.1'
+  VERSION = '0.1.3'
 end

data/lib/instructor.rb

@@ -6,23 +6,32 @@ require 'active_support/all'
 require_relative 'instructor/version'
 require_relative 'instructor/openai/patch'
 require_relative 'instructor/openai/response'
+require_relative 'instructor/mode'
 
 # Instructor makes it easy to reliably get structured data like JSON from Large Language Models (LLMs)
 # like GPT-3.5, GPT-4, GPT-4-Vision
 module Instructor
+  @mode = nil
+
   class Error < ::StandardError; end
 
   # The ValidationError class represents an error that occurs during validation.
   class ValidationError < ::StandardError; end
 
+  def self.mode
+    @mode
+  end
+
   # Patches the OpenAI client to add the following functionality:
   # - Retries on exceptions
   # - Accepts and validates a response model
   # - Accepts a validation_context argument
   #
   # @param openai_client [OpenAI::Client] The OpenAI client to be patched.
+  # @param mode [Symbol] The mode to be used. Default is `Instructor::Mode::TOOLS.function`.
   # @return [OpenAI::Client] The patched OpenAI client.
-  def self.patch(openai_client)
+  def self.patch(openai_client, mode: Instructor::Mode::TOOLS.function)
+    @mode = mode
     openai_client.prepend(Instructor::OpenAI::Patch)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: instructor-rb
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Sergio Bayona
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-07 00:00:00.000000000 Z
+date: 2024-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -45,14 +45,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -215,6 +215,7 @@ files:
 - ellipsis.Dockerfile
 - ellipsis.yaml
 - lib/instructor.rb
+- lib/instructor/mode.rb
 - lib/instructor/openai/patch.rb
 - lib/instructor/openai/response.rb
 - lib/instructor/version.rb