jxnl / jxnl/instructor-rb

`main` branch version doesn't match released gem version for 0.1.3

Open
#24 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Ruby
Stars
87
Forks
11
PR merge metrics
No merged PRs in 30d

Description

I noticed that the deployed version of the gem doesn't match what is currently on the `main` branch as `v0.1.3`. Are there plans to push up a new version with the latest API?

```ruby
[1] pry(main)> show-source Instructor

From: /Users/markfaga/.asdf/installs/ruby/3.3.5/lib/ruby/gems/3.3.0/gems/instructor-rb-0.1.3/lib/instructor.rb:11
Module name: Instructor
Number of lines: 25

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, mode: Instructor::Mode::TOOLS.function)
@mode = mode
openai_client.prepend(Instructor::OpenAI::Patch)
end
end
```

Contributor guide

Open the contributing guide

Research direction

Start by comparing the main branch at v0.1.3 with the deployed instructor-rb 0.1.3 gem, focusing on instructor.rb and the API shown in the report. Confirm which version contains the latest API and establish the intended release state; done when the released gem and main branch agree.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
release
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.