cloudflare-ai 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8c78786e06d2a3cc05b177aedc99672b4be56016c33d6be2e718533b6b3f507
-  data.tar.gz: 535f23f9e6ffedbe0e090ded97459e021e57b84025456dab77d3d85dd2da194d
+  metadata.gz: 9085ff95f730366db7b3261cc94935f782d719b8129dd1341796ee6d66fd373c
+  data.tar.gz: 60b29886c88200aebdd1c46e743a28dd597540144494e8288098e05c6ddb8e04
 SHA512:
-  metadata.gz: 6d35d01ae35a9407b97acfc0643c66c33b26d608d90373daf3c00001f86d7d2d2893162b370c417e2db7a96b43cec74d66e2652caa11ed89bbf31b968b4fd34d
-  data.tar.gz: 5af4ef84fdfc0ed649f951f18c10105b97ee4ae55b5d951f90551f7b0e5e452ca98ce408ded86980e67da05bfaf4e42321097b0b3f1cb2cfd224d67da74f8d44
+  metadata.gz: 3b95c01b2cab4dec4c0bdd476d99f5ab65183215a64e6c6711a50caed5874a51ff34b78b530b1877b13a1be8851fc527202a1b250f94d57a554ff46b25716136
+  data.tar.gz: 86721eb5cf51bfd886a6f9e1a4be71c4b33492cd90e2a2adedbe2f6474c7e601b4e2f1bc52bfd315039a3b24ea202fd627dc032a2dda63e8ad6f04b0e01da08a

data/README.md

@@ -21,9 +21,9 @@ It's still early days, and here are my immediate priorities:
 * [ ] Support for more AI model categories
   * [x] [Text Generation](https://developers.cloudflare.com/workers-ai/models/text-generation/)
   * [x] [Text Embeddings](https://developers.cloudflare.com/workers-ai/models/text-embeddings/)
-  * [ ] [Text Classification](https://developers.cloudflare.com/workers-ai/models/text-classification/)
+  * [x] [Text Classification](https://developers.cloudflare.com/workers-ai/models/text-classification/)
+  * [x] [Translation](https://developers.cloudflare.com/workers-ai/models/translation/)
   * [ ] [Image Classification](https://developers.cloudflare.com/workers-ai/models/image-classification/)
-  * [ ] [Translation](https://developers.cloudflare.com/workers-ai/models/translation/)
   * [ ] [Text-to-Image](https://developers.cloudflare.com/workers-ai/models/text-to-image/)
   * [ ] [Automatic Speech Recognition](https://developers.cloudflare.com/workers-ai/models/speech-recognition/)
 
@@ -99,6 +99,12 @@ result = client.complete(prompt: "Hi!") { |data| puts data}
 # [DONE]
 
 ```
+#### Token limits
+Invocations of the `prompt` and `chat` can take an optional `max_tokens` argument that defaults to 256.
+```ruby
+result = client.complete(prompt: "What is your name?", max_tokens: 512)
+```
+
 #### Result object
 All invocations of the `prompt` and `chat` methods return a `Cloudflare::AI::Results::TextGeneration` object. This object's serializable JSON output is
 based on the raw response from the Cloudflare API.
@@ -119,7 +125,6 @@ puts result.failure? # => true
 puts result.to_json # => {"result":null,"success":false,"errors":[{"code":7009,"message":"Upstream service unavailable"}],"messages":[]}
 ```
 
-
 ### Text embedding
 ```ruby
 result = client.embed(text: "Hello")
@@ -144,6 +149,15 @@ p result.result # => [{"label"=>"NEGATIVE", "score"=>0.6647962927818298}, {"labe
 #### Result object
 All invocations of the `classify` methods return a `Cloudflare::AI::Results::TextClassification`.
 
+### Translation
+```ruby
+result = client.translate(text: "Hello Jello", source_lang: "en", target_lang: "fr")
+p result.translated_text # => Hola Jello
+```
+
+#### Result object
+All invocations of the `translate` methods return a `Cloudflare::AI::Results::Translate`.
+
 # Logging
 
 This gem uses standard logging mechanisms and defaults to `:warn` level. Most messages are at info level, but we will add debug or warn statements as needed.

data/lib/cloudflare/ai/client.rb

@@ -11,10 +11,10 @@ class Cloudflare::AI::Client
     @api_token = api_token
   end
 
-  def chat(messages:, model_name: default_text_generation_model_name, &block)
+  def chat(messages:, model_name: default_text_generation_model_name, max_tokens: default_max_tokens, &block)
     url = service_url_for(account_id: account_id, model_name: model_name)
     stream = block ? true : false
-    payload = create_streamable_payload({messages: messages.map(&:serializable_hash)}, stream: stream)
+    payload = create_streamable_payload({messages: messages.map(&:serializable_hash)}, stream: stream, max_tokens: max_tokens)
     post_streamable_request(url, payload, &block)
   end
 
@@ -25,10 +25,10 @@ class Cloudflare::AI::Client
     Cloudflare::AI::Results::TextClassification.new(connection.post(url, payload).body)
   end
 
-  def complete(prompt:, model_name: default_text_generation_model_name, &block)
+  def complete(prompt:, model_name: default_text_generation_model_name, max_tokens: default_max_tokens, &block)
     url = service_url_for(account_id: account_id, model_name: model_name)
     stream = block ? true : false
-    payload = create_streamable_payload({prompt: prompt}, stream: stream)
+    payload = create_streamable_payload({prompt: prompt}, stream: stream, max_tokens: max_tokens)
     post_streamable_request(url, payload, &block)
   end
 
@@ -39,6 +39,12 @@ class Cloudflare::AI::Client
     Cloudflare::AI::Results::TextEmbedding.new(connection.post(url, payload).body)
   end
 
+  def translate(text:, target_lang:, source_lang: "en", model_name: Cloudflare::AI::Models.translation.first)
+    url = service_url_for(account_id: account_id, model_name: model_name)
+    payload = {text: text, target_lang: target_lang, source_lang: source_lang}.to_json
+    Cloudflare::AI::Results::Translation.new(connection.post(url, payload).body)
+  end
+
   private
 
   def connection

data/lib/cloudflare/ai/clients/text_generation_helpers.rb

@@ -2,12 +2,16 @@ module Cloudflare
   module AI
     module Clients
       module TextGenerationHelpers
-        def default_text_generation_model_name
-          Cloudflare::AI::Models.text_generation.first
+        def create_streamable_payload(data, stream:, max_tokens:)
+          data.merge({stream: stream, max_tokens: max_tokens}).to_json
+        end
+
+        def default_max_tokens
+          256
         end
 
-        def create_streamable_payload(data, stream: false)
-          data.merge({stream: stream}).to_json
+        def default_text_generation_model_name
+          Cloudflare::AI::Models.text_generation.first
         end
 
         def post_streamable_request(url, payload, &block)

data/lib/cloudflare/ai/results/translation.rb

@@ -0,0 +1,5 @@
+class Cloudflare::AI::Results::Translation < Cloudflare::AI::Result
+  def translated_text
+    result&.dig(:translated_text) # nil if no shape
+  end
+end

data/lib/cloudflare/ai/version.rb

@@ -2,6 +2,6 @@
 
 module Cloudflare
   module AI
-    VERSION = "0.4.0"
+    VERSION = "0.5.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudflare-ai
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Ajay Krishnan
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-22 00:00:00.000000000 Z
+date: 2024-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -101,6 +101,7 @@ files:
 - lib/cloudflare/ai/results/text_classification.rb
 - lib/cloudflare/ai/results/text_embedding.rb
 - lib/cloudflare/ai/results/text_generation.rb
+- lib/cloudflare/ai/results/translation.rb
 - lib/cloudflare/ai/version.rb
 homepage: https://rubygems.org/gems/cloudflare-ai
 licenses: