ruby-amazon-bedrock 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cc2fda0ffade519b17acc4d278b6d4d55136c8df511a2da329dccbc3dc63bd9
-  data.tar.gz: c6afb32b619515b886b5cb34ed01791a62ea1fda119407d8b72ce1455d65f149
+  metadata.gz: f3a872c53afed3f2fb371cbc1c4b661ad00d02583e7a31f1558f6081462d2740
+  data.tar.gz: 5c5ed1f988239ecdf8a50e35c870544794f2c976572018feaf21404eb8097f01
 SHA512:
-  metadata.gz: bdadc9d45b3fac52916462f5e47e62cb91e4f25f949d4af9b7fe3ecca9a7bb151bdcfb0837c2fd511115affd49845441a6a964a0175cc1748583186f053de1e2
-  data.tar.gz: 90b2adc4a2f8f49237803f81663ea3d4a54b0177bbd6075f6a86f8982dad6a23cac6266dc50cf92aa4902cef9241f9bf1f4ec22dbf6bf8b98269daa9d1102834
+  metadata.gz: 74db07e19c34b58d106c0e9847c9e244b48642f32eaf4b5f6b339aff974dcdbbad9b3949eb0076773f331a7843d87e6230e1cf2386fb9d8eecc8b6c3c2385fb2
+  data.tar.gz: 307e7f513903954428303c8ab40c86df98d694770ce2022c405088a4042f2095504962102d43d50ec70124aafe9d7198e0db77cfd14c5e9e189693cb65866deb

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [0.2.1] - 2023-12-25
+
+- Make gem configurable
+- Fix A121 Labs payloads
+- Update README.md with A121 Labs documentation
+
 ## [0.2.0] - 2023-12-14
 
 - Add Text and Image builders to be able to return text or save images depending on the model use case.

data/Gemfile

@@ -11,6 +11,5 @@ gem "pry", "~> 0.13"
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
 gem "rubocop", "~> 1.21"
-gem "simplecov", "~> 0.21"
 gem "vcr", "~> 6.0"
 gem "webmock", "~> 3.12"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-amazon-bedrock (0.2.0)
+    ruby-amazon-bedrock (0.2.1)
       aws-sdk-bedrockruntime (~> 1.0)
 
 GEM
@@ -29,7 +29,6 @@ GEM
     crack (0.4.5)
       rexml
     diff-lcs (1.5.0)
-    docile (1.4.0)
     dotenv (2.8.1)
     hashdiff (1.0.1)
     jmespath (1.6.2)
@@ -76,12 +75,6 @@ GEM
     rubocop-ast (1.30.0)
       parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
-    simplecov (0.22.0)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-      simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.4)
     thor (1.3.0)
     unicode-display_width (2.5.0)
     vcr (6.2.0)
@@ -101,7 +94,6 @@ DEPENDENCIES
   rspec (~> 3.0)
   rubocop (~> 1.21)
   ruby-amazon-bedrock!
-  simplecov (~> 0.21)
   vcr (~> 6.0)
   webmock (~> 3.12)
 

data/README.md

@@ -1,6 +1,7 @@
 # Ruby Amazon Bedrock
 
-[![CircleCI](https://dl.circleci.com/status-badge/img/circleci/JP4R1PDyZ2Yax5GxVQoMZN/LAwrE89wMVTrgpfzaimon/tree/main.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/circleci/JP4R1PDyZ2Yax5GxVQoMZN/LAwrE89wMVTrgpfzaimon/tree/main)
+[![Gem Version](https://badge.fury.io/rb/ruby-amazon-bedrock.svg)](https://badge.fury.io/rb/ruby-amazon-bedrock)
+[![CircleCI](https://dl.circleci.com/status-badge/img/circleci/JP4R1PDyZ2Yax5GxVQoMZN/LAwrE89wMVTrgpfzaimon/tree/main.svg?style=shield&circle-token=31edf35e4c3f323ce0044c6fceadf9ffb15f5d3c)](https://dl.circleci.com/status-badge/redirect/circleci/JP4R1PDyZ2Yax5GxVQoMZN/LAwrE89wMVTrgpfzaimon/tree/main)
 
 Seamless Integration with Amazon Bedrock API for AI-Powered Text and Image Generation in Ruby 🤖 + 💎. [Amazon Bedrock API](https://aws.amazon.com/es/bedrock/).
 
@@ -13,7 +14,7 @@ Amazon Bedrock is a fully managed service that makes FMs from leading AI startup
 Add the following line to your application's Gemfile:
 
 ```ruby
-gem "ruby-amazon-bedrock"
+gem "ruby-amazon-bedrock", "~> 0.2.1"
 ```
 
 And then execute:
@@ -27,7 +28,7 @@ $ bundle install
 Or install with:
 
 ```bash
-$ gem install ruby-amazon-bedrock
+$ gem install ruby-amazon-bedrock -v 0.2.1
 ```
 
 and require with:
@@ -55,34 +56,78 @@ Be aware that by using `ruby-amazon-bedrock` gem in conjunction with Amazon Bedr
 Instantiate a client by passing your AWS IAM credentials:
 
 ```ruby
-client = RubyAmazonBedrock::Client.new(region: "aws_region", access_key_id: "access_key_id", access_token: "access_token")
+client = RubyAmazonBedrock::Client.new(
+  region: "AWS_REGION",
+  access_key_id: "AWS_ACCESS_KEY_ID",
+  access_token: "AWS_SECRET_ACCESS_KEY"
+)
 ```
 
-## Models Providers
+## With Configuration
+
+```ruby
+RubyAmazonBedrock.configure do |config|
+  config.region = ENV.fetch('AWS_REGION', nil)
+  config.access_key_id = ENV.fetch('AWS_ACCESS_KEY_ID', nil)
+  config.secret_access_key = ENV.fetch('AWS_SECRET_ACCESS_KEY', nil)
+end
+
+client = RubyAmazonBedrock::Client.new
+```
+
+## Model Providers
 
 Amazon Bedrock is a fully managed service that makes FMs from leading AI startups and Amazon available via an API, so you can choose from a wide range of FMs to find the model that is best suited for your use case.
 
-<!-- ### AI21 Labs
+### AI21 Labs
 
 Businesses use AI21's Jurassic family of leading LLMs to build generative AI-driven applications and services leveraging existing organizational data. Jurassic supports cross-industry use cases including long and short-form text generation, contextual question answering, summarization, and classification. Designed to follow natural language instructions, Jurassic is trained on a massive corpus of web text and supports six languages in addition to English. [See more ...](https://us-east-1.console.aws.amazon.com/bedrock/home?region=us-east-1#/providers?model=ai21.j2-ultra-v1)
 
 How to call AI21 models:
 
-Jurassic-2 Ultra
+_*Jurassic-2 Ultra*_
 
 Supported use cases: Open book question answering, summarization, draft generation, information extraction, ideation
 
 Languages: English, Spanish, French, German, Portuguese, Italian, Dutch
 
 ```ruby
-client.invoke_model('ai21.j2-ultra-v1', 'Your prompt goes here ...')
+client.invoke_model(id: 'ai21.j2-ultra-v1', input: "What's natural language processing?")
+
+# Response
+{:id=>1234,
+ :prompt=>
+  {:text=>"Describe how an LLM works",
+   :tokens=>
+    [{:generatedToken=>{:token=>"▁Describe", :logprob=>-10.674324035644531, :raw_logprob=>-10.674324035644531},
+ :completions=>
+  [{:data=>
+    {:text=>
+       "\nNatural language processing (NLP) is a field of computer science, artificial intelligence, and linguistics concerned with the interactions between computers and human (natural) languages, in particular how to program computers to process and analyze large amounts of natural language data. The goal of NLP is to provide computers with the ability to read, understand, and generate human language.",
+      :tokens=>
+       [{:generatedToken=>{:token=>"<|newline|>", :logprob=>0.0, :raw_logprob=>-0.00046850196667946875},
 ```
 
-Jurassic-2 Mid
+_*Jurassic-2 Mid*_
 
 ```ruby
-client.invoke_model('ai21.j2-mid-v1', 'Your prompt goes here ...')
-``` -->
+client.invoke_model(id: 'ai21.j2-mid-v1', input: "What's GenAI?")
+
+# Response
+{:id=>1234,
+ :prompt=>
+  {:text=>"What's GenAI?",
+   :tokens=>
+    [{:generatedToken=>{:token=>"▁What's", :logprob=>-9.553738594055176, :raw_logprob=>-9.553738594055176},
+      :topTokens=>nil,
+      :textRange=>{:start=>0, :end=>6}},
+ :completions=>
+  [{:data=>
+     {:text=>
+       "\nGenAI is a proposed standard for a generic AI language, which would allow AI systems to communicate and reason with each other in a common language. The goal of GenAI is to create a universal language that can be used by all AI systems, regardless of their specific task or underlying architecture. This would make it easier for AI systems to work together and learn from each other, and it would also make it easier for humans to interact with and understand AI systems.",
+      :tokens=>
+       [{:generatedToken=>{:token=>"<|newline|>", :logprob=>0.0, :raw_logprob=>-0.0009662011871114373},
+```
 
 ### Amazon Titan
 

data/lib/amazon_bedrock/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyAmazonBedrock
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/lib/amazon_bedrock.rb

@@ -3,8 +3,41 @@
 require_relative "amazon_bedrock/version"
 require_relative "bedrock_runtime/client"
 
+# The RubyAmazonBedrock module serves as a namespace for classes that
+# interact with Amazon Bedrock Service. It includes configuration management
+# and custom error classes for handling AWS service interactions.
 module RubyAmazonBedrock
   # Raised when an unknown model identifier is provided to PayloadFactory.
   class UnknownModelError < StandardError; end
   class Error < StandardError; end
+
+  # Configuration class for setting up AWS credentials and region.
+  class Configuration
+    attr_accessor :region, :access_key_id, :secret_access_key
+
+    # Initializes a new Configuration instance, loading values from
+    # environment variables or setting them to nil by default so the
+    # values can be dynamically set.
+    def initialize
+      @region = ENV.fetch('AWS_REGION', nil)
+      @access_key_id = ENV.fetch('AWS_ACCESS_KEY_ID', nil)
+      @secret_access_key = ENV.fetch('AWS_SECRET_ACCESS_KEY', nil)
+    end
+  end
+
+  class << self
+    # Returns the current configuration instance or creates a new one.
+    #
+    # @return [Configuration] the current configuration instance
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    # Provides a block to configure the RubyAmazonBedrock settings.
+    #
+    # @yield [Configuration] Yields the current configuration to a block.
+    def configure
+      yield(configuration)
+    end
+  end
 end

data/lib/bedrock_runtime/client.rb

@@ -4,7 +4,6 @@ require 'base64'
 require 'aws-sdk-bedrockruntime'
 require 'bedrock_runtime/payload_factory'
 require 'bedrock_runtime/response_factory'
-require 'pry'
 
 module RubyAmazonBedrock
   # Client for interfacing with the Amazon Bedrock Runtime.
@@ -15,11 +14,13 @@ module RubyAmazonBedrock
     # Initializes the AWS BedrockRuntime client.
     #
     # @note The AWS credentials and region are fetched from the environment variables.
-    def initialize(region:, access_key_id:, secret_access_key:)
+    def initialize(region: nil, access_key_id: nil, secret_access_key: nil)
+      config = RubyAmazonBedrock.configuration || RubyAmazonBedrock::Configuration.new
+
       @client = Aws::BedrockRuntime::Client.new(
-        region: region,
-        access_key_id: access_key_id,
-        secret_access_key: secret_access_key
+        region: region || config.region,
+        access_key_id: access_key_id || config.access_key_id,
+        secret_access_key: secret_access_key || config.secret_access_key
       )
     end
 

data/lib/bedrock_runtime/payload_builders/ai_21_labs/base.rb

@@ -37,8 +37,8 @@ module RubyAmazonBedrock
               prompt: @input,
               maxTokens: 200,
               temperature: 0,
-              topP: 250,
-              stop_sequences: [],
+              topP: 1.0,
+              stopSequences: [],
               countPenalty: { scale: 0 },
               presencePenalty: { scale: 0 },
               frequencyPenalty: { scale: 0 }

data/lib/bedrock_runtime/payload_builders/ai_21_labs/j2_mid_v1.rb

@@ -14,7 +14,7 @@ module RubyAmazonBedrock
         #
         # @return [String] 'ai21labs.j2-mid-v1'
         def model_id
-          'ai21labs.j2-mid-v1'
+          'ai21.j2-mid-v1'
         end
       end
     end

data/lib/bedrock_runtime/payload_builders/ai_21_labs/j2_ultra_v1.rb

@@ -14,7 +14,7 @@ module RubyAmazonBedrock
         #
         # @return [String] 'ai21labs.j2-ultra-v1'
         def model_id
-          'ai21labs.j2-ultra-v1'
+          'ai21.j2-ultra-v1'
         end
       end
     end

data/lib/bedrock_runtime/payload_factory.rb

@@ -50,8 +50,8 @@ module RubyAmazonBedrock
     # @return [Hash] The mapping of model identifiers to builder classes.
     def models_to_builders
       {
-        'ai21labs.j2-mid-v1' => PayloadBuilders::Ai21Labs::J2MidV1,
-        'ai21labs.j2-ultra-v1' => PayloadBuilders::Ai21Labs::J2UltraV1,
+        'ai21.j2-mid-v1' => PayloadBuilders::Ai21Labs::J2MidV1,
+        'ai21.j2-ultra-v1' => PayloadBuilders::Ai21Labs::J2UltraV1,
         'amazon.titan-image-generator-v1' => PayloadBuilders::Amazon::TitanImageGeneratorV1,
         'amazon.titan-text-lite-v1' => PayloadBuilders::Amazon::TitanTextLiteV1,
         'amazon.titan-text-express-v1' => PayloadBuilders::Amazon::TitanTextExpressV1,

data/spec/bedrock_runtime/payload_builders/ai_21_labs/base_spec.rb

@@ -11,8 +11,8 @@ RSpec.describe RubyAmazonBedrock::PayloadBuilders::Ai21Labs::Base do
       prompt: input,
       maxTokens: 200,
       temperature: 0,
-      topP: 250,
-      stop_sequences: [],
+      topP: 1.0,
+      stopSequences: [],
       countPenalty: { scale: 0 },
       presencePenalty: { scale: 0 },
       frequencyPenalty: { scale: 0 }

data/spec/bedrock_runtime/payload_builders/ai_21_labs/j2_mid_v1_spec.rb

@@ -11,8 +11,8 @@ RSpec.describe RubyAmazonBedrock::PayloadBuilders::Ai21Labs::J2MidV1 do
       prompt: input,
       maxTokens: 200,
       temperature: 0,
-      topP: 250,
-      stop_sequences: [],
+      topP: 1.0,
+      stopSequences: [],
       countPenalty: { scale: 0 },
       presencePenalty: { scale: 0 },
       frequencyPenalty: { scale: 0 }
@@ -24,7 +24,7 @@ RSpec.describe RubyAmazonBedrock::PayloadBuilders::Ai21Labs::J2MidV1 do
       payload_builder = described_class.new(input, options)
       payload = payload_builder.build
 
-      expect(payload[:model_id]).to eq('ai21labs.j2-mid-v1')
+      expect(payload[:model_id]).to eq('ai21.j2-mid-v1')
       expect(payload[:content_type]).to eq('application/json')
       expect(payload[:accept]).to eq('*/*')
       expect(payload[:body]).to eq(body)

data/spec/bedrock_runtime/payload_builders/ai_21_labs/j2_ultra_v1_spec.rb

@@ -11,8 +11,8 @@ RSpec.describe RubyAmazonBedrock::PayloadBuilders::Ai21Labs::J2UltraV1 do
       prompt: input,
       maxTokens: 200,
       temperature: 0,
-      topP: 250,
-      stop_sequences: [],
+      topP: 1.0,
+      stopSequences: [],
       countPenalty: { scale: 0 },
       presencePenalty: { scale: 0 },
       frequencyPenalty: { scale: 0 }
@@ -24,7 +24,7 @@ RSpec.describe RubyAmazonBedrock::PayloadBuilders::Ai21Labs::J2UltraV1 do
       payload_builder = described_class.new(input, options)
       payload = payload_builder.build
 
-      expect(payload[:model_id]).to eq('ai21labs.j2-ultra-v1')
+      expect(payload[:model_id]).to eq('ai21.j2-ultra-v1')
       expect(payload[:content_type]).to eq('application/json')
       expect(payload[:accept]).to eq('*/*')
       expect(payload[:body]).to eq(body)

data/spec/bedrock_runtime/payload_factory_spec.rb

@@ -5,8 +5,8 @@ require 'bedrock_runtime/payload_factory'
 
 RSpec.describe RubyAmazonBedrock::PayloadFactory do
   let(:bedrock_models) do
-    ["ai21labs.j2-mid-v1",
-     "ai21labs.j2-ultra-v1",
+    ["ai21.j2-mid-v1",
+     "ai21.j2-ultra-v1",
      "amazon.titan-image-generator-v1",
      "amazon.titan-text-lite-v1",
      "amazon.titan-text-express-v1",

data/spec/spec_helper.rb

@@ -1,15 +1,12 @@
 # frozen_string_literal: true
 
 require 'dotenv/load'
-require 'simplecov'
 require 'vcr'
 
 require 'amazon_bedrock'
 require 'bedrock_runtime/client'
 require 'bedrock_runtime/payload_factory'
 
-SimpleCov.start
-
 RSpec.configure do |config|
   # Enable flags like --only-failures and --next-failure
   config.example_status_persistence_file_path = '.rspec_status'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-amazon-bedrock
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Alvaro Delgado
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-14 00:00:00.000000000 Z
+date: 2023-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-bedrockruntime