google_palm_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 07dac69e13dd3173be4f180d964976dd23fa6fc77b36af0742507d853cf17638
+  data.tar.gz: a495c0b2f59377c57c3d90f4d8bbedbc4835a75b194e745c7d99d0322e0fc8f4
+SHA512:
+  metadata.gz: 7732a91b0c60d747cb48c1f7c5f9d939d07708a518745ca2c0112b91b52343ef3c1e0b7359a39bcb33b4b5fb68e12b08858c5e5c607f8a9e8e26105111781da1
+  data.tar.gz: 428afa1b2b46347acec9826fb8ca9f92eaa68418ba69761170b5e82809f120a4b86b09b47210e41fb405473a94c36bc0e9eba41cf5db4a8cdda9006ac9432608

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-05-23
+
+- Initial release
+  - Added `GooglePalmApi::Client` class that supports `embed()`, `generate_text()`, `generate_chat_message()`, `get_model()`, `list_models()` and `count_message_tokens()` methods

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in google_palm_api.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "standard", "~> 1.28.0"

data/Gemfile.lock

@@ -0,0 +1,113 @@
+PATH
+  remote: .
+  specs:
+    google_palm_api (0.1.0)
+      faraday (>= 1.0.0)
+      faraday_middleware (>= 1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    faraday (1.10.3)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    faraday_middleware (1.2.0)
+      faraday (~> 1.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.0.0)
+    method_source (1.0.0)
+    multipart-post (2.3.0)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.50.2)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.1)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.16.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    standard (1.28.2)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50.2)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.0.1)
+    standard-custom (1.0.0)
+      lint_roller (~> 1.0)
+    standard-performance (1.0.1)
+      lint_roller (~> 1.0)
+      rubocop-performance (~> 1.16.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  x86_64-darwin-19
+  x86_64-linux
+
+DEPENDENCIES
+  google_palm_api!
+  pry-byebug (~> 3.9)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  standard (~> 1.28.0)
+
+BUNDLED WITH
+   2.4.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Andrei Bondarev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# GooglePalmApi
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/google_palm_api`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add google_palm_api
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install google_palm_api
+
+## Usage
+
+```ruby
+require 'google_palm_api'
+```
+```ruby
+client.generate_text(prompt:)
+```
+```ruby
+client.generate_chat_message(prompt:)
+```
+```ruby
+client.embed(text:)
+```
+```ruby
+client.get_model(model:)
+```
+```ruby
+client.list_models()
+```
+```ruby
+client.count_message_tokens(message:)
+```
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/andreibondarev/google_palm_api.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/google_palm_api/client.rb

@@ -0,0 +1,200 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "faraday_middleware"
+
+module GooglePalmApi
+  class Client
+    attr_reader :api_key, :connection
+
+    ENDPOINT_URL = "https://generativelanguage.googleapis.com/"
+
+    DEFAULTS = {
+      temperature: 0.0,
+      completion_model_name: "text-bison-001",
+      chat_completion_model_name: "chat-bison-001",
+      embeddings_model_name: "embedding-gecko-001"
+    }
+
+    def initialize(api_key:)
+      @api_key = api_key
+    end
+
+    #
+    # The text service is designed for single turn interactions.
+    # It's ideal for tasks that can be completed within one response from the API, without the need for a continuous conversation.
+    # The text service allows you to obtain text completions, generate summaries, or perform other NLP tasks that don't require back-and-forth interactions.
+    # Method signature: https://developers.generativeai.google/api/python/google/generativeai/generate_text
+    #
+    # @param [String] prompt
+    # @param [String] model
+    # @param [Float] temperature
+    # @param [Integer] candidate_count
+    # @param [Integer] max_output_tokens
+    # @param [Float] top_p
+    # @param [Integer] top_k
+    # @param [String] safety_settings
+    # @param [Array] stop_sequences
+    # @param [String] client
+    # @return [Hash]
+    #
+    def generate_text(
+      prompt:,
+      temperature: nil,
+      candidate_count: nil,
+      max_output_tokens: nil,
+      top_p: nil,
+      top_k: nil,
+      safety_settings: nil,
+      stop_sequences: nil,
+      client: nil
+    )
+      response = connection.post("/v1beta2/models/#{DEFAULTS[:completion_model_name]}:generateText") do |req|
+        req.params = {key: api_key}
+
+        req.body = {prompt: {text: prompt}}
+        req.body[:temperature] = temperature || DEFAULTS[:temperature]
+        req.body[:candidate_count] = candidate_count if candidate_count
+        req.body[:max_output_tokens] = max_output_tokens if max_output_tokens
+        req.body[:top_p] = top_p if top_p
+        req.body[:top_k] = top_k if top_k
+        req.body[:safety_settings] = safety_settings if safety_settings
+        req.body[:stop_sequences] = stop_sequences if stop_sequences
+        req.body[:client] = client if client
+      end
+      response.body
+    end
+
+    #
+    # The chat service is designed for interactive, multi-turn conversations.
+    # The service enables you to create applications that engage users in dynamic and context-aware conversations.
+    # You can provide a context for the conversation as well as examples of conversation turns for the model to follow.
+    # It's ideal for applications that require ongoing communication, such as chatbots, interactive tutors, or customer support assistants.
+    # Method signature: https://developers.generativeai.google/api/python/google/generativeai/chat
+    #
+    # @param [String] prompt
+    # @param [String] model
+    # @param [String] context
+    # @param [Array] examples
+    # @param [Array] messages
+    # @param [Float] temperature
+    # @param [Integer] candidate_count
+    # @param [Float] top_p
+    # @param [Integer] top_k
+    # @param [String] client
+    # @return [Hash]
+    #
+    def generate_chat_message(
+      prompt:,
+      context: nil,
+      examples: nil,
+      messages: nil,
+      temperature: nil,
+      candidate_count: nil,
+      top_p: nil,
+      top_k: nil,
+      client: nil
+    )
+      # Overwrite the default ENDPOINT_URL for this method.
+      response = connection.post("/v1beta2/models/#{DEFAULTS[:chat_completion_model_name]}:generateMessage") do |req|
+        req.params = {key: api_key}
+
+        req.body = {prompt: {messages: [{content: prompt}]}}
+        req.body[:context] = context if context
+        req.body[:examples] = examples if examples
+        req.body[:messages] = messages if messages
+        req.body[:temperature] = temperature || DEFAULTS[:temperature]
+        req.body[:candidate_count] = candidate_count if candidate_count
+        req.body[:top_p] = top_p if top_p
+        req.body[:top_k] = top_k if top_k
+        req.body[:client] = client if client
+      end
+      response.body
+    end
+
+    #
+    # The embedding service in the PaLM API generates state-of-the-art embeddings for words, phrases, and sentences.
+    # The resulting embeddings can then be used for NLP tasks, such as semantic search, text classification and clustering among many others.
+    # This section describes what embeddings are and highlights some key use cases for the embedding service to help you get started.
+    # When you're ready to start developing, you can find complete runnable code in the embeddings quickstart.
+    # Method signature: https://developers.generativeai.google/api/python/google/generativeai/generate_embeddings
+    #
+    # @param [String] text
+    # @param [String] model
+    # @param [String] client
+    # @return [Hash]
+    #
+    def embed(
+      text:,
+      model: nil,
+      client: nil
+    )
+      response = connection.post("/v1beta2/models/#{model || DEFAULTS[:embeddings_model_name]}:embedText") do |req|
+        req.params = {key: api_key}
+
+        req.body = {text: text}
+        req.body[:model] = model if model
+        req.body[:client] = client if client
+      end
+      response.body
+    end
+
+    #
+    # Lists models available through the API.
+    #
+    # @param [Integer] page_size
+    # @param [String] page_token
+    # @return [Hash]
+    #
+    def list_models(page_size: nil, page_token: nil)
+      response = connection.get("/v1beta2/models") do |req|
+        req.params = {key: api_key}
+
+        req.params[:pageSize] = page_size if page_size
+        req.params[:pageToken] = page_token if page_token
+      end
+      response.body
+    end
+
+    #
+    # Runs a model's tokenizer on a string and returns the token count.
+    #
+    # @param [String] model
+    # @param [String] prompt
+    # @return [Hash]
+    #
+    def count_message_tokens(model:, prompt:)
+      response = connection.post("/v1beta2/models/#{model}:countMessageTokens") do |req|
+        req.params = {key: api_key}
+
+        req.body = {prompt: {messages: [{content: prompt}]}}
+      end
+      response.body
+    end
+
+    #
+    # Gets information about a specific Model.
+    #
+    # @param [String] name
+    # @return [Hash]
+    #
+    def get_model(model:)
+      response = connection.get("/v1beta2/models/#{model}") do |req|
+        req.params = {key: api_key}
+      end
+      response.body
+    end
+
+    private
+
+    # standard:disable Lint/DuplicateMethods
+    def connection
+      Faraday.new(url: ENDPOINT_URL) do |faraday|
+        faraday.request :json
+        faraday.response :json, content_type: /\bjson$/
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+    # standard:enable Lint/DuplicateMethods
+  end
+end

data/lib/google_palm_api/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GooglePalmApi
+  VERSION = "0.1.0"
+end

data/lib/google_palm_api.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "google_palm_api/version"
+
+module GooglePalmApi
+  class Error < StandardError; end
+
+  autoload :Client, "google_palm_api/client"
+end

data/sig/google_palm_api.rbs

@@ -0,0 +1,4 @@
+module GooglePalmApi
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: google_palm_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrei Bondarev
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-05-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: Ruby client for Google PaLM API
+email:
+- andrei.bondarev13@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/google_palm_api.rb
+- lib/google_palm_api/client.rb
+- lib/google_palm_api/version.rb
+- sig/google_palm_api.rbs
+homepage: https://github.com/andreibondarev/google_palm_api
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/andreibondarev/google_palm_api
+  source_code_uri: https://github.com/andreibondarev/google_palm_api
+  changelog_uri: https://github.com/andreibondarev/google_palm_api/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Ruby client for Google PaLM API
+test_files: []