cohere-ruby 0.9.7 → 0.9.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f3e839b9a7eb9b33711cd3f909dec96c85b9402a9d43f173c8350f666bde182
-  data.tar.gz: 5c549985ee0e26b99e5f20e2baefad46ab39f3ad300e8f928c69355f1caa847b
+  metadata.gz: 35acc85a1ec589048eae603675fd23afeec9c66c0ce8c14954c20916c099b93b
+  data.tar.gz: e48ea97c36afafa8ca134c240a19ff159af1086643e99efba0aaf5aaed225cca
 SHA512:
-  metadata.gz: '08b9d5b439fe3bf4a64a52d65535635e044d52051af213dddcb216aa0efaf9ecd982b6f80b20dcde7916f41d52b5ae21e5c825083bbb139baf9fe787afc8e093'
-  data.tar.gz: 58a85830e7564db2eafa1dc833f7d6d516451fedf50fbd968f202e9243b47cb738e54ed15f6fc88841382181b9331ef1c40cbfc8ec6a57b101fccef759742adb
+  metadata.gz: eb6700a2088e5b37842fb6a601e160bbc6e8a6e8c15a7dd52b42f74cc0ce5fc71c77d789d9eaa20a440b1a3c4b4bab46088a5117b84d0a5027531acbfaf28067
+  data.tar.gz: 4e759bd938560031412e4602ee86321e3953e61dfa9c368c843b0d1b71e0676b061007dda48514b8ef5e9df072f7df3b5c817452f06a72553864bf77a679b492

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [0.9.9] - 2024-04-05
+- Adding missing parameters to endpoints
+
+## [0.9.8] - 2024-02-10
+- Adding method for /chat endpoint
+
 ## [0.1.0] - 2023-04-23
 
 - Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cohere-ruby (0.9.7)
+    cohere-ruby (0.9.9)
       faraday (>= 2.0.1, < 3.0)
 
 GEM
@@ -67,6 +67,7 @@ GEM
     unicode-display_width (2.4.2)
 
 PLATFORMS
+  arm64-darwin-23
   x86_64-darwin-19
   x86_64-darwin-21
   x86_64-linux

data/README.md

@@ -29,21 +29,71 @@ 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(
-  api_key: ENV['COHERE_API_KEY']
+  ENV['COHERE_API_KEY']
 )
 ```
+
 ### Generate
+
 ```ruby
 client.generate(
     prompt: "Once upon a time in a magical land called"
 )
 ```
 
+### 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!"]
@@ -51,6 +101,7 @@ client.embed(
 ```
 
 ### Classify
+
 ```ruby
 examples = [
     { text: "Dermatologists don't like her!", label: "Spam" },
@@ -77,6 +128,7 @@ client.classify(
 ```
 
 ### Tokenize
+
 ```ruby
 client.tokenize(
     text: "hello world!"
@@ -84,6 +136,7 @@ client.tokenize(
 ```
 
 ### Detokenize
+
 ```ruby
 client.detokenize(
     tokens: [33555, 1114 , 34]
@@ -91,6 +144,7 @@ client.detokenize(
 ```
 
 ### Detect language
+
 ```ruby
 client.detect_language(
     texts: ["Здравствуй, Мир"]
@@ -98,6 +152,7 @@ client.detect_language(
 ```
 
 ### Summarize
+
 ```ruby
 client.summarize(
     text: "..."

data/lib/cohere/client.rb

@@ -12,6 +12,55 @@ module Cohere
       @api_key = api_key
     end
 
+    def chat(
+      message:,
+      model: nil,
+      stream: false,
+      preamble: nil,
+      preamble_override: nil,
+      chat_history: [],
+      conversation_id: nil,
+      prompt_truncation: nil,
+      connectors: [],
+      search_queries_only: false,
+      documents: [],
+      citation_quality: nil,
+      temperature: nil,
+      max_tokens: nil,
+      k: nil,
+      p: nil,
+      frequency_penalty: nil,
+      presence_penalty: nil,
+      tools: [],
+      &block
+    )
+      response = connection.post("chat") do |req|
+        req.body = {message: message}
+        req.body[:model] = model if model
+        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
+        req.body[:prompt_truncation] = prompt_truncation if prompt_truncation
+        req.body[:connectors] = connectors if connectors
+        req.body[:search_queries_only] = search_queries_only if search_queries_only
+        req.body[:documents] = documents if documents
+        req.body[:citation_quality] = citation_quality if citation_quality
+        req.body[:temperature] = temperature if temperature
+        req.body[:max_tokens] = max_tokens if max_tokens
+        req.body[:k] = k if k
+        req.body[:p] = p if p
+        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
+
     # This endpoint generates realistic text conditioned on a given input.
     def generate(
       prompt:,
@@ -53,11 +102,13 @@ module Cohere
     def embed(
       texts:,
       model: nil,
+      input_type: nil,
       truncate: nil
     )
       response = connection.post("embed") do |req|
         req.body = {texts: texts}
         req.body[:model] = model if model
+        req.body[:input_type] = input_type if input_type
         req.body[:truncate] = truncate if truncate
       end
       response.body

data/lib/cohere/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cohere-ruby
 version: !ruby/object:Gem::Version
-  version: 0.9.7
+  version: 0.9.9
 platform: ruby
 authors:
 - Andrei Bondarev
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-17 00:00:00.000000000 Z
+date: 2024-04-05 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.2.3
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: Cohere API client for Ruby.