cohere-ruby 0.9.8 → 0.9.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83208ee6cbdf496180ac2e6ed258388a74a266d86188b81ceb011bf5f2b61f44
-  data.tar.gz: 9f0ff2d20ea3c988663bc1c104f46f0c94a6d8d833d4a0ebf1cb81f765d8502d
+  metadata.gz: 6c5f0625529c315bd0a953bb8e0acf36fbebe685b13decde1fe26d93b5d97ab8
+  data.tar.gz: 504ce83377f6f2175b2d7ab9f899c307a7a02563c75b8c630b249d0e7487c746
 SHA512:
-  metadata.gz: a0425fe338748ba829c6d15b3fe319c23cf6fe47ab18c885476dcccffe969888c215162d9139768e53ed569b5e6799c9abc17ecb028551f3cd48c2f92cec49e6
-  data.tar.gz: 48add01bf4d9ee6a43ee27809efe2eb352eee73bceac26b6fcfff29ae060063b8e3f4dc5803e317d80a612d0f6890ac18ca1d90cf5fd62254e3d1bc6f1dce8de
+  metadata.gz: 1dc8c2c85e551438f597346679c3bb198808e906eb9317dd05c26511556e34f512707cbc4bb3046487de9e498ca7b92c6405d2f9c3e4175f466e49618c7215b9
+  data.tar.gz: 0024a4c8c6091fa78fe83dcd7879ea8a511436e4ddc16929dd3e88e517901ba1ac569e16c519f47abccbba08a0cdd43fe795c4e867b4e252f0d5003a9ffb5b3e

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [0.9.10] - 2024-05-10
+- /chat endpoint does not require `message:` parameter anymore
+
+## [0.9.9] - 2024-04-05
+- Adding missing parameters to endpoints
+
 ## [0.9.8] - 2024-02-10
 - Adding method for /chat endpoint
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cohere-ruby (0.9.8)
+    cohere-ruby (0.9.10)
       faraday (>= 2.0.1, < 3.0)
 
 GEM

data/README.md

@@ -29,14 +29,17 @@ If bundler is not being used to manage dependencies, install the gem by executin
 ## Usage
 
 ### Instantiating API client
+
 ```ruby
 require "cohere"
 
 client = Cohere::Client.new(
-  ENV['COHERE_API_KEY']
+  api_key: ENV['COHERE_API_KEY']
 )
 ```
+
 ### Generate
+
 ```ruby
 client.generate(
     prompt: "Once upon a time in a magical land called"
@@ -44,13 +47,53 @@ client.generate(
 ```
 
 ### Chat
+
 ```ruby
 client.chat(
     message: "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.
+
+```ruby
+client.chat(message: "Hey! How are you?", stream: true) 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).
+
+```ruby
+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,
+  message: message,
+  tools: tools,
+)
+```
+
+
+
 ### Embed
+
 ```ruby
 client.embed(
     texts: ["hello!"]
@@ -58,6 +101,7 @@ client.embed(
 ```
 
 ### Classify
+
 ```ruby
 examples = [
     { text: "Dermatologists don't like her!", label: "Spam" },
@@ -84,6 +128,7 @@ client.classify(
 ```
 
 ### Tokenize
+
 ```ruby
 client.tokenize(
     text: "hello world!"
@@ -91,6 +136,7 @@ client.tokenize(
 ```
 
 ### Detokenize
+
 ```ruby
 client.detokenize(
     tokens: [33555, 1114 , 34]
@@ -98,6 +144,7 @@ client.detokenize(
 ```
 
 ### Detect language
+
 ```ruby
 client.detect_language(
     texts: ["Здравствуй, Мир"]
@@ -105,6 +152,7 @@ client.detect_language(
 ```
 
 ### Summarize
+
 ```ruby
 client.summarize(
     text: "..."

data/lib/cohere/client.rb

@@ -8,14 +8,16 @@ module Cohere
 
     ENDPOINT_URL = "https://api.cohere.ai/v1"
 
-    def initialize(api_key)
+    def initialize(api_key:, timeout: nil)
       @api_key = api_key
+      @timeout = timeout
     end
 
     def chat(
-      message:,
+      message: nil,
       model: nil,
       stream: false,
+      preamble: nil,
       preamble_override: nil,
       chat_history: [],
       conversation_id: nil,
@@ -28,13 +30,22 @@ module Cohere
       max_tokens: nil,
       k: nil,
       p: nil,
+      seed: nil,
       frequency_penalty: nil,
-      presence_penalty: nil
+      presence_penalty: nil,
+      tools: [],
+      &block
     )
       response = connection.post("chat") do |req|
-        req.body = {message: message}
+        req.body = {}
+
+        req.body[:message] = message if message
         req.body[:model] = model if model
-        req.body[:stream] = stream if stream
+        if stream || block
+          req.body[:stream] = true
+          req.options.on_data = block if block
+        end
+        req.body[:preamble] = preamble if preamble
         req.body[:preamble_override] = preamble_override if preamble_override
         req.body[:chat_history] = chat_history if chat_history
         req.body[:conversation_id] = conversation_id if conversation_id
@@ -47,8 +58,10 @@ module Cohere
         req.body[:max_tokens] = max_tokens if max_tokens
         req.body[:k] = k if k
         req.body[:p] = p if p
+        req.body[:seed] = seed if seed
         req.body[:frequency_penalty] = frequency_penalty if frequency_penalty
         req.body[:presence_penalty] = presence_penalty if presence_penalty
+        req.body[:tools] = tools if tools
       end
       response.body
     end
@@ -171,7 +184,7 @@ module Cohere
 
     # standard:disable Lint/DuplicateMethods
     def connection
-      @connection ||= Faraday.new(url: ENDPOINT_URL) do |faraday|
+      @connection ||= Faraday.new(url: ENDPOINT_URL, request: {timeout: @timeout}) do |faraday|
         if api_key
           faraday.request :authorization, :Bearer, api_key
         end

data/lib/cohere/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cohere
-  VERSION = "0.9.8"
+  VERSION = "0.9.10"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cohere-ruby
 version: !ruby/object:Gem::Version
-  version: 0.9.8
+  version: 0.9.10
 platform: ruby
 authors:
 - Andrei Bondarev
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-11 00:00:00.000000000 Z
+date: 2024-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -70,7 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: Cohere API client for Ruby.