Cohere

+  

Cohere API client for Ruby.

Part of the Langchain.rb stack.

Installation

Install the gem and add to the application's Gemfile by executing:

$ bundle add cohere-ruby

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install cohere-ruby

Usage

Instantiating API client

require "cohere"

client = Cohere::Client.new(
  api_key: ENV['COHERE_API_KEY']
)

Generate

client.generate(
  prompt: "Once upon a time in a magical land called"
)

Chat

client.chat(
  model: "command-r-plus-08-2024",
  messages: [{role:"user", content: "Hey! How are you?"}]
)

chat supports a streaming option. You can pass a block to the chat method and it will yield a new chunk as soon as it is received.

client.chat(
  model: "command-r-plus-08-2024",
  messages: [{role:"user", content: "Hey! How are you?"}]
) do |chunk, overall_received_bytes|
  puts "Received #{overall_received_bytes} bytes: #{chunk.force_encoding(Encoding::UTF_8)}"
end

force_encoding is preferred to avoid JSON parsing issue when Cohere returns emoticon.

chat supports Tool use (function calling).

tools = [
  {
    name: "query_daily_sales_report",
    description: "Connects to a database to retrieve overall sales volumes and sales information for a given day.",
    parameter_definitions: {
      day: {
        description: "Retrieves sales data for this day, formatted as YYYY-MM-DD.",
        type: "str",
        required: true
      }
    }
  }
]

message = "Can you provide a sales summary for 29th September 2023, and also give me some details about the products in the 'Electronics' category, for example their prices and stock levels?"

client.chat(
  model: model,
  messages: [{ role:"user", content: message }],
  tools: tools
)

Embed

client.embed(
  model: "embed-english-v3.0",
  texts: ["hello", "goodbye"],
  input_type: "classification",
  embedding_types: ["float"]
)

Rerank

docs = [
  "Carson City is the capital city of the American state of Nevada.",
  "The Commonwealth of the Northern Mariana Islands is a group of islands in the Pacific Ocean. Its capital is Saipan.",
  "Capitalization or capitalisation in English grammar is the use of a capital letter at the start of a word. English usage varies from capitalization in other languages.",
  "Washington, D.C. (also known as simply Washington or D.C., and officially as the District of Columbia) is the capital of the United States. It is a federal district.",
  "Capital punishment (the death penalty) has existed in the United States since beforethe United States was a country. As of 2017, capital punishment is legal in 30 of the 50 states.",
]

client.rerank(
  model: "rerank-english-v3.0",
  query: "What is the capital of the United States?",
  documents: docs
)

Classify

examples = [
  { text: "Dermatologists don't like her!", label: "Spam" },
  { text: "Hello, open to this?", label: "Spam" },
  { text: "I need help please wire me $1000 right now", label: "Spam" },
  { text: "Nice to know you ;)", label: "Spam" },
  { text: "Please help me?", label: "Spam" },
  { text: "Your parcel will be delivered today", label: "Not spam" },
  { text: "Review changes to our Terms and Conditions", label: "Not spam" },
  { text: "Weekly sync notes", label: "Not spam" },
  { text: "Re: Follow up from today's meeting", label: "Not spam" },
  { text: "Pre-read for tomorrow", label: "Not spam" }
]

inputs = [
  "Confirm your email address",
  "hey i need u to send some $",
]

client.classify(
  model: "embed-multilingual-v2.0",
  inputs: inputs,
  examples: examples
)

Tokenize

client.tokenize(
  model: "command-r-plus-08-2024",
  text: "Hello, world!"
)

Detokenize

client.detokenize(
  model: "command-r-plus-08-2024",
  tokens: [33555, 1114, 34]
)

Detect language

client.detect_language(
  texts: ["Здравствуй, Мир"]
)

Summarize

client.summarize(
  text: "..."
)

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bundle exec rspec 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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/andreibondarev/cohere.

License

The gem is available as open source under the terms of the MIT License.