instruct 0.1.0a1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 91c55f91575720976bb45e97f2526c6f0fee0f8b1dc841a74ddaefb343d6fa1b
+  data.tar.gz: 1c651ca4c3f8b733e07be1b6da4a2b89b9d2fac6343488341f892fdc7e7bb2a8
+SHA512:
+  metadata.gz: ab7ea3e51f2e5402b612d80e31ce0e36603cff3cc4a36b957861680ba29d005ec3e9105716ef2722708f18c9846011e7ab180b11f865742c60298494058a35a0
+  data.tar.gz: 383a431acd033aa806fba1a488090a1a25579aeb3bb7c1f20963583111017190cd69136ffa8e788a146486dacfa6d5c658128d1ad02d4ed83cc0c3d2567d169d

data/LICENSE

@@ -0,0 +1,202 @@
+Copyright 2024-, Andrew Mackross
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,387 @@
+# Instruct
+
+🏗️ **This gem is still undergoing active development and is not yet ready for use
+beyond experimentation.**
+
+I'm making this public to get feedback and to see if there is any interest in
+from the community to help develop this further.
+
+---
+
+*Instruct LLMs to do what you want in Ruby.*
+
+Combine **code**, **prompts**, and **completions** in a natural and intuitive
+way for programmers. Inspired by libraries like
+[Guidance](https://github.com/guidance-ai/guidance) and rack, Instruct strips
+away boilerplate code while providing a flexible and powerful interface that
+doesn't abstract away control.
+
+
+## Features
+
+* **Natural and Intuitive API**
+  Using LLMs with instruct is not too different from plain old string
+  manipulation. This lets you think about your prompts and completions in a way
+  that intuitively makes sense to most programmers.
+* **Safe Prompting**
+  The ERB `#p{}`rompt helper can be used to generate prompts with dynamic input in an
+  familiar way. Dynamic input is automatically marked as unsafe and can be
+  handled differently by middleware (for example to check for prompt
+  injections). Use `.prompt_safe` to mark part of the prompt as safe.
+* **Flexible Middleware Stack**
+  Middleware can be used to add features like structured output, conversation
+  pruning, RAG integrations, retries, auto-continuation, guard-rails, monitoring
+  and more. The middleware stack provides a common way to transform a prompt for
+  different LLM models with different capabilities.
+* **Streaming Support**
+  Both middleware and callers can process completion responses as the chunks
+  arrive. This can be used to display a completion in real time, or to validate
+  or parse the output of an LLM call as it's being generated.
+* **Rails Integration**
+  Prompts, completions and models can be serialized and stored on ActiveRecord
+  with custom attributes and will automatically serialize when passed to an
+  ActiveJob. Enabling easy background processing of LLM calls.
+
+## Installation
+
+This gem won't be published to RubyGems until it's more stable. For now, you can
+add these lines to your application's Gemfile:
+
+```ruby
+  gem "instruct", github: "instruct-rb/instruct", branch: "development"
+  gem "attributed-string", github: "instruct-rb/attributed-string", branch: "main"
+```
+
+Include the helpers and refinements in the modules or classes where you want to
+use Instruct.
+
+```ruby
+  include Instruct::Helpers
+  using Instruct::Refinements
+```
+
+Instruct supports the ruby-openai gem and anthropic out of the box, simply include the
+one or both gems in your Gemfile.
+
+```ruby
+  gem "ruby-openai"
+  gem "anthropic"
+```
+
+For more info on setting up the OpenAI or Anthropic clients, see the docs for
+[OpenAI Usage](docs/openai-usage.md) and [Anthropic Usage](docs/anthropic-usage.md).
+
+## Usage
+
+### The gen function
+
+`gen` is used to **gen**erate completions from an LLM.
+
+### Simple Usage
+
+Getting a single completion from an LLM is as simple as calling `gen` with a prompt.
+
+When a prompt is a present as the first argument the gen call immediately
+retrieves the completion from the LLM.
+
+The model can be set with the model keyword argument if no default model has been
+set. Similarly all arguments that `ruby-openai` and `anthropic` can be configured with
+can be passed into the gen call.
+```ruby
+completion = gen("The capital of France is ", stop_chars: "\n ,.", model: 'gpt-3-5-turbo-instruct')
+
+puts completion # => "Paris"
+```
+
+### Deferred Completions
+
+The gen function can also create deferred completions. This is used to create
+prompts that can be called multiple times or passed around as an argument.
+
+```ruby
+
+  # Adding gen to a string creates a deferred completion. This is indicated by
+  # the 💬 emoji.
+  prompt = "The capital of France is " + gen(stop_chars: "\n ,;.") + "!"
+
+  puts prompt # => "The capital of France is 💬!"
+
+  # Each time the prompt is called, a new completion is generated and returned.
+  completion = prompt.call
+
+  puts completion # => "Paris"
+
+  # When a completion is added to the prompt that generated it, a new
+  # prompt is created with the completion replacing the deferred completion.
+  puts prompt + completion # => "The capital of France is Paris!"
+
+  # Note the exclamation mark is still present and comes after the completion.
+```
+
+### Appending to an existing prompt
+
+The double angle bracket operator `<<` can be used to quickly append objects
+to a prompt. This can be used to modify and build up a prompt in place.
+
+Unlike the `+=` and `concat` operators, the `<<` operator will immediately call any
+deferred completions and append them to the prompt.
+
+```ruby
+  string = Instruct::Prompt.new
+  string << "The capital of France is "
+  string << gen(stop_chars: "\n ,;.") + "!"
+
+  puts string # => "The capital of France is Paris!"
+
+  string << " It is widely known for " + gen(stop_chars: ".") + "."
+  puts string # => "The capital of France is Paris! It is widely known for its fashion, art and culture."
+```
+
+### Capturing Generated Completion
+
+Because it's quite common to want to access a completion, but not break apart
+the prompt and completion into separate components, instruct provides `capture`
+captures the result of a completion from a deferred generation and makes it
+accessible from the prompt with `captured`.
+
+```ruby
+  string = Instruct::Prompt.new
+  string << "The capital of France is " + gen(stop: '\n','.').capture(:capital)
+
+  puts string.captured(:capital) # => "Paris"
+```
+
+Passing a `list: :key` keyword argument will capture an array of completions under the same key.
+
+### Creating a Prompt Transcript
+
+Most modern LLMs are designed for conversational style completions. The chat
+completion middleware transforms a prompt formatted like a transcript into an
+object that can be used with these APIs.
+```ruby
+  # Roles can be added to a prompt transcript by a new line with the role name
+  # followed by a colon and then a space.
+  transcript = p{"
+    system: You're an expert geographer that speaks only French
+    user: What is the capital of Australia?
+  "} + gen(prompt, stop_chars: "\n ,;.", model: 'gpt-4o')
+
+
+  # Note the returned or captured completion does not include any role prefix.
+  completion = transcript.call
+  puts completion # => "le capital de l'Australie est Canberra"
+
+  # However, when the completion is added to the transcript, the `assistant: `
+  # prefix is automatically prepended (if required), enabling a new user prompt
+  # to be appended immediately after.
+  puts transcript + completion
+  # => "system: You're an expert geographer that speaks only French
+  #     user: What is the capital of Australia?
+  #     assistant: le capital de l'Australie est Canberra"
+```
+
+If you want to be more explicit about adding roles in to a prompt, instruct provides
+`#p.system`, `#p.user`, and `#p.assistant` helper methods. There is nothing
+special about these methods, they just prepend the role prefix to the string
+
+```ruby
+  transcript = p.system{"You're an expert geographer that speaks only French"}
+  transcript += p.user{"What is the capital of Australia?"}
+  transcript += gen(stop_chars: "\n ,;.", model: 'gpt-4o')
+```
+
+### The p(rompt) Block ERB Helper
+
+`#p{}` (shown above) allows for dynamic prompt templating using ERB tags
+`<%= %>` with automatic handling of safe and unsafe content similar to HTML
+templating.
+
+This safety mechanism provides a way for both programmer and middleware to tell
+the difference between user, LLM, and prompt template text. In the case of the
+Chat Completion Middleware, role switches cannot occur in unsafe text.
+
+Similarly, guard middleware might be added to check unsafe content for prompt
+injections or innapropriate content.
+
+ERB heredoc blocks combined with the `p` helper provide syntax highlighting
+in most editors making long dynamic prompts easy to read. The following prompt
+shows how to use a chomped ERB heredoc to generate larger prompts with both
+"safe" and "unsafe" content.
+
+```ruby
+  p = p{<<~ERB.chomp
+      This is a longer prompt, if the included content might include
+      injections use the normal ERB tags like so: <%= unsafe_user_content %>.
+
+      If we know that something doesn't include prompt injections, add it
+      as: <%= raw some_safe_content %>, #{some_safe_content} or <%=
+      some_safe_string.prompt_safe %>.
+
+      By default generated LLM responses as <%= gen %> or #{ gen } will be added
+      to the prompt as unsafe. To add it as safe we cannot use the ERB
+      method, we instead need to call .prompt_safe on the completion befored
+      appending it.
+    ERB
+  }
+```
+
+### A More Complex Example: Multi-Turn Conversations Between Agents
+
+Here we put together all the features so far to show how you can easily manage multi-turn
+interactions between two different agents.
+
+```ruby
+  # Create two agents: Noel Gallagher and an interviewer with a system prompt.
+  noel = p.system{"You're Noel Gallagher. Answer questions from an interviewer."}
+  interviewer = p.system{"You're a skilled interviewer asking Noel Gallagher questions."}
+
+  # We start a dynamic Q&A loop with the interviewer by kicking off the
+  # interviewing agent and capturing the response under the :reply key.
+  interviewer << p.user{"__Noel sits down in front of you.__"} + gen.capture(:reply)
+
+  puts interviewer.captured(:reply) # => "Hello Noel, how are you today?"
+
+  5.times do
+    # Noel is sent the last value captured in the interviewer's transcript under the :reply key.
+    # Similarly, we generate a response for Noel and capture it under the :reply key.
+    noel << p.user{"<%= interviewer.captured(:reply) %>"} + gen.capture(:reply, list: :replies)
+
+    # Noel's captured reply is now sent to the interviewer, who captures it in the same way.
+    interviewer << p.user{"<%=  noel.captured(:reply) %>"} + gen.capture(:reply, list: :replies)
+  end
+
+  # After the conversation, we can access the list captured replies from both agents
+  noel_said = noel.captured(:replies).map{ |r| "noel: #{r}" }
+  interviewer_said = interviewer.captured(:replies).map{ |r| "interviewer: #{r}" }
+
+  puts interviwer_said.zip(noel_said).flatten.join("\n\n")
+  # => "noel: ... \n\n interviewer: ..., ..."
+```
+
+## The Prompt
+The following examples illustrate how the Prompt can be manipulated in
+different ways.
+``` ruby
+  Instruct::Prompt.new << "The capital of France is" + gen(stop: '\n','.')
+  # => "The capital of France is Paris"
+
+  prompt = "The capital of France is" + gen(stop: '\n','.')
+  # => "The capital of France is 💬"
+  # Note that a prompt can just be created by adding a string and a gen
+  # call. However, the gen call is deferred (as indicated by the 💬).
+
+  prompt.class
+  # => Instruct::Prompt
+
+  result = prompt.call do |response|
+    # This optional block on the call method can be used for streaming
+    # The response is called after each chunk is processed by the middleware,
+    # the response is the entire buffer so Paris as three chunks might look like
+    # "P", "Par", "Paris". It's possible that middleware could change the
+    # response, so it's best not to treat these as final until after the call is
+    # finished.
+  end
+  # => "Paris"
+
+  result.class
+  # => Instruct::Prompt::Completion
+
+  result.prompt
+  # => "The capital of France is 💬"
+
+
+  result.prompt == prompt
+  # => true
+
+  together = prompt + result
+  # => "The capital of France is Paris"
+  # Adding a completion to a prompt will return the prompt with the completion appended.
+  # If this completion was generated using the same prompt, it will also update the prompts
+  # content with any additional changes that were made by middleware during
+  # the call that produced the completion. This includes transferring the captured values.
+
+  together.class
+  # => Instruct::Prompt
+
+  # This does nothing as there are no deferred calls.
+  together.call
+  # => nil
+
+  prompt = "The capital of Germany is" + gen(stop: '\n','.') + ", which is in the region of " + gen(stop: '\n','.')
+  # => "The capital of Germany is 💬, which is in the region of 💬"
+
+  result = prompt.call
+  # => [ "Berlin", "Europe" ] # Array<Instruct::Prompt::Completion>
+
+  new_prompt == Instruct::Serializer.load(Instruct::Serializer.dump(prompt))
+  # => "The capital of Germany is 💬, which is in the region of 💬"
+
+  new_prompt == prompt
+  # => true
+
+  # The results are joined together with the prompt in the order they were returned.
+  together = new_prompt + result
+  # => "The capital of Germany is Berlin, which is in the region of Europe"
+
+  # The interpolation only occurs if the prompt that generated the completion(s)
+  # is equal to the prompt that is being added or concatenated to. In all other
+  # cases the completion is added to the end of the prompt.
+```
+
+## Logging Setup
+`Instruct.error_logger` and `Instruct.logger` can be set to any ruby `Logger`
+class. By default they are configured to log warn and error messages. Set the `INSTRUCT_LOG_LEVEL`
+environment variable to `debug`, `info`, `warn`, `error`, `fatal`, `unknown` to change the
+the log level, or change the log level directly on the logger instance.
+
+```ruby
+# logs errors and warnings to STDERR by default, by default all warnings and
+# errors are logged
+Instruct.err_logger.sev_threshold = :warn
+
+# logs all debug and info messages to STDOUT, by default nothing is logged as
+# the default is warn.
+Instruct.logger.sev_threshold = :warn
+```
+
+
+## What's missing
+This gem is still in development and is missing many features before a 1.0,
+please feel free to get in touch if you would like to contribute or have any
+ideas.
+
+- Middleware
+  - [ ] Constraint based validation with automatic retries
+  - [ ] Improvments to chat completion middleware
+    - [ ] Allow role switching on the same line but then in the updated prompt fix it
+    - [ ] New Conversation middleware with default to user with system kw arg or assistant kw arg (maybe its one and the same?)
+  - [ ] Conversation management (prune long running conversations)
+  - [ ] Async support (waiting on async support in ruby-openai). This enables
+        the use of async calls to the LLM and the use of async middleware.
+  - [ ] Streaming structured output (similar to BAML or a CFG)
+    - [ ] Self healing
+  - [ ] Guard-rails (middleware that checks for prompt injections/high perplexity)
+  - [ ] Auto-continuation (middleware that adds prompts to continue a conversation)
+  - [ ] Support transform attachments in the prompt intos multi-modal input
+  - [ ] Anthropic caching
+  - [ ] Visualize streaming prompt as a tree in web interface (dependent on forking)
+  - [ ] Standardize finish reasons, and shared call arguments
+- Models
+  - [x] OpenAI API model selection
+  - [x] Anthropic API model selection
+  - [ ] Gemini models
+  - [ ] Local models
+    - [ ] Constrained inference like Guidance
+    - [ ] Token healing
+- Core
+  - [ ] Track forking path
+  - [ ] Change middleware by passing it into the gen or call methods
+  - [ ] Tool calling
+    - [ ] Develop an intuitive API for calling tools
+  - [ ] Batch APIs
+  - [ ] Improve attributed string API with a visitor style presenter
+    - [ ] Update middleware and printers to use the new presenters
+  - [x] Serialization of prompts (Consider migrations / upgrades) for storage
+    - [x] Register ActiveJob serializer for prompts so that they can be added to the job queue
+    - [ ] Register ActiveRecord serializer for prompts so that they can be stored in the database
+  - [x] `stop_chars` and `stop`