instructor-rb 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5baca74deed1078f1695501139db2033ca2cb4b1e0d414ba9898b13100263bed
-  data.tar.gz: b845048bd4b712181eab322d94ba20fd64aae15eb3949560028ff3a4058d594c
+  metadata.gz: c5f3b630f135c5ab67b275814d8986b732a0deac2a8cb751189444d5774ab169
+  data.tar.gz: cc25330573de9056fdf7e6c5f14d4fb143777b9f26a7d085e00499df6610c8da
 SHA512:
-  metadata.gz: a949d892bf2fef53c9c34fd06da30b143e08acdfc8967e428b262eedc7eabcc7147421f1b41dcde2007fe58677c808a1ca6bb9dc1be72a4f9c20c3a5474a91bb
-  data.tar.gz: ccfc2bf5c2c702b226972895eb290c68f2a625b688936979d9f5093e39e185f1c8423aedc4f40537b3b1ad2d313ea73e4f058491bbacadb075ad3cca1cacaae7
+  metadata.gz: 90ce22b6ca7bdc23a063b7fcee1329a194cc493b71803902d2455d0c22d105de7506c7387f6b0e7b682405493dc7eb9c7da68e6da68feedb89bdbcbea598cea2
+  data.tar.gz: f6ebf426c755b1d55cb809d75c56a38e5861515419e61e235097c2033729abf8e7e9df200146844c742fcc17fb8b984b4b6cd11d751927a1d93760db321f670c

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## [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/openai/patch.rb

@@ -118,19 +118,29 @@ 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.

data/lib/instructor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Instructor
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 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.2
 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-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport