cohere-ruby 0.9.9 → 0.9.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35acc85a1ec589048eae603675fd23afeec9c66c0ce8c14954c20916c099b93b
-  data.tar.gz: e48ea97c36afafa8ca134c240a19ff159af1086643e99efba0aaf5aaed225cca
+  metadata.gz: 5f1c3798500d154b882bd6bb2e0e43904fea4bf69db4d982da4abc6265bc461c
+  data.tar.gz: d91ed933c24f2dacc5f2604639d307fd389f3774aaed8082df07e03ac2961704
 SHA512:
-  metadata.gz: eb6700a2088e5b37842fb6a601e160bbc6e8a6e8c15a7dd52b42f74cc0ce5fc71c77d789d9eaa20a440b1a3c4b4bab46088a5117b84d0a5027531acbfaf28067
-  data.tar.gz: 4e759bd938560031412e4602ee86321e3953e61dfa9c368c843b0d1b71e0676b061007dda48514b8ef5e9df072f7df3b5c817452f06a72553864bf77a679b492
+  metadata.gz: b989c60be670a143848367a7be84f53fc6adf97f31e1f3739113a7a7caec988450e4e889bcbc7f2733783623977dc4f6e1eb7484470259935e30e7dc6d5d1414
+  data.tar.gz: 00a2e3e1a19bfb1980d06ebc1fd6117262bcdf226bc95bfe0edff8ea8e1397791eaf7ef37b78ad158e0ef5a8363fa809c9215fc325d771e72abf22d7919c54c0

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [0.9.11] - 2024-08-01
+- New `rerank()` method
+
+## [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
 

data/Gemfile.lock

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

data/README.md

@@ -1,7 +1,7 @@
 # Cohere
 
 <p>
-    <img alt='Weaviate logo' src='https://static.wikia.nocookie.net/logopedia/images/d/d4/Cohere_2023.svg/revision/latest?cb=20230419182227' height='50' />
+    <img alt='Cohere logo' src='https://static.wikia.nocookie.net/logopedia/images/d/d4/Cohere_2023.svg/revision/latest?cb=20230419182227' height='50' />
     +&nbsp;&nbsp;
     <img alt='Ruby logo' src='https://user-images.githubusercontent.com/541665/230231593-43861278-4550-421d-a543-fd3553aac4f6.png' height='40' />
 </p>
@@ -34,7 +34,7 @@ If bundler is not being used to manage dependencies, install the gem by executin
 require "cohere"
 
 client = Cohere::Client.new(
-  ENV['COHERE_API_KEY']
+  api_key: ENV['COHERE_API_KEY']
 )
 ```
 
@@ -42,7 +42,7 @@ client = Cohere::Client.new(
 
 ```ruby
 client.generate(
-    prompt: "Once upon a time in a magical land called"
+  prompt: "Once upon a time in a magical land called"
 )
 ```
 
@@ -50,7 +50,7 @@ client.generate(
 
 ```ruby
 client.chat(
-    message: "Hey! How are you?"
+  message: "Hey! How are you?"
 )
 ```
 
@@ -90,30 +90,45 @@ client.chat(
 )
 ```
 
-
-
 ### Embed
 
 ```ruby
 client.embed(
-    texts: ["hello!"]
+  texts: ["hello!"]
+)
+```
+
+### Rerank
+
+```ruby
+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(
+  texts: ["hello!"]
 )
 ```
 
+
 ### Classify
 
 ```ruby
 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" }
+  { 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 = [
@@ -122,8 +137,8 @@ inputs = [
 ]
 
 client.classify(
-    examples: examples,
-    inputs: inputs
+  examples: examples,
+  inputs: inputs
 )
 ```
 
@@ -131,7 +146,7 @@ client.classify(
 
 ```ruby
 client.tokenize(
-    text: "hello world!"
+  text: "hello world!"
 )
 ```
 
@@ -139,7 +154,7 @@ client.tokenize(
 
 ```ruby
 client.detokenize(
-    tokens: [33555, 1114 , 34]
+  tokens: [33555, 1114 , 34]
 )
 ```
 
@@ -147,7 +162,7 @@ client.detokenize(
 
 ```ruby
 client.detect_language(
-    texts: ["Здравствуй, Мир"]
+  texts: ["Здравствуй, Мир"]
 )
 ```
 
@@ -155,7 +170,7 @@ client.detect_language(
 
 ```ruby
 client.summarize(
-    text: "..."
+  text: "..."
 )
 ```
 

data/lib/cohere/client.rb

@@ -8,12 +8,13 @@ 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,
@@ -29,13 +30,16 @@ module Cohere
       max_tokens: nil,
       k: nil,
       p: nil,
+      seed: nil,
       frequency_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
         if stream || block
           req.body[:stream] = true
@@ -54,6 +58,7 @@ 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
@@ -114,6 +119,29 @@ module Cohere
       response.body
     end
 
+    def rerank(
+      query:,
+      documents:,
+      model: nil,
+      top_n: nil,
+      rank_fields: nil,
+      return_documents: nil,
+      max_chunks_per_doc: nil
+    )
+      response = connection.post("rerank") do |req|
+        req.body = {
+          query: query,
+          documents: documents
+        }
+        req.body[:model] = model if model
+        req.body[:top_n] = top_n if top_n
+        req.body[:rank_fields] = rank_fields if rank_fields
+        req.body[:return_documents] = return_documents if return_documents
+        req.body[:max_chunks_per_doc] = max_chunks_per_doc if max_chunks_per_doc
+      end
+      response.body
+    end
+
     def classify(
       inputs:,
       examples:,
@@ -179,7 +207,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.9"
+  VERSION = "0.9.11"
 end

metadata

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