cloudflare-ai 0.4.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4de1d8c20767aab8d40b96fa01a447e1ab83a1586cad6c4a3d7597331cabc5bd
-  data.tar.gz: 7b912c4bf7bb23ec4f2befca92c966656ac4ab0527b03857adaf14b8e8b87a34
+  metadata.gz: 8f1d5e2776ba81382b1cb02355ac23348bee4a661d141c7c144136f1b9547eed
+  data.tar.gz: b651a6faed4d18a9b00cfed3f2217bc3cdc47ff9a2f9371cf50ab9c1f6bfab6f
 SHA512:
-  metadata.gz: c87c773d129790a865a524a56c1ab545a51f3d8a54825b4e02d092282b733f5dbee9a59d1536fd8df096aac47c7d94ae4466e6d6f94aa90115ec4cebdd4d4b0e
-  data.tar.gz: 45ead04646ae3756d05d0d4805bfbfcd509d421b08bfec63a53ff3736abd16887786d17741df542e4596500779881d35e9d8af6ffdb07c2bd2ffdfc632e17883
+  metadata.gz: 2fe5ec654b60e662113f79d2e66adf0483c17c0b2ffd2ea483c8f3b45c0d2ae747605b831e5cf6eed9ea8cd7ae614e6992199cf3fcad41870cb8ca8e269cb048
+  data.tar.gz: 3f4eac6cea6d8cdd00a00f71c3eca95ccfb61b2de8b2f45a4dfa46a7d81b45978eb5c92883569c8fd4398874005d0bad456096baa01cb7c82e22587b9700dc2a

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/)
-  * [ ] [Image Classification](https://developers.cloudflare.com/workers-ai/models/image-classification/)
-  * [ ] [Translation](https://developers.cloudflare.com/workers-ai/models/translation/)
+  * [x] [Text Classification](https://developers.cloudflare.com/workers-ai/models/text-classification/)
+  * [x] [Translation](https://developers.cloudflare.com/workers-ai/models/translation/)
+  * [x] [Image Classification](https://developers.cloudflare.com/workers-ai/models/image-classification/)
   * [ ] [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/)
 
@@ -75,7 +75,8 @@ The full list of supported models is available here: [models.rb](lib/cloudflare/
 More information is available [in the cloudflare documentation](https://developers.cloudflare.com/workers-ai/models/).
 The default model used is the first enumerated model in the applicable set in [models.rb](lib/cloudflare/ai/models.rb).
 
-### Text generation (chat / scoped prompt)
+### Text generation
+#### (chat / scoped prompt)
 ```ruby
 messages = [
   Cloudflare::AI::Message.new(role: "system", content: "You are a big fan of Cloudflare and Ruby."),
@@ -86,6 +87,11 @@ messages = [
 result = client.chat(messages: messages)
 puts result.response # => "Yes, I love Cloudflare!"
 ```
+#### (string prompt)
+```ruby
+result = client.complete(prompt: "What is your name?", max_tokens: 512)
+puts result.response # => "My name is Jonas."
+```
 
 #### Streaming responses
 Responses will be streamed back to the client using Server Side Events (SSE) if a block is passed to the `chat` or `complete` method.
@@ -99,6 +105,9 @@ 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.
+
 #### 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 +128,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 +152,29 @@ p result.result # => [{"label"=>"NEGATIVE", "score"=>0.6647962927818298}, {"labe
 #### Result object
 All invocations of the `classify` methods return a `Cloudflare::AI::Results::TextClassification`.
 
+### Image classification
+The image classification endpoint accepts either a path to a file or a file stream.
+
+```ruby
+result = client.classify(image: "/path/to/cat.jpg")
+p result.result # => {"result":[{"label":"TABBY","score":0.6159140467643738},{"label":"TIGER CAT","score":0.12016300112009048},{"label":"EGYPTIAN CAT","score":0.07523812353610992},{"label":"DOORMAT","score":0.018854796886444092},{"label":"ASHCAN","score":0.01314085815101862}],"success":true,"errors":[],"messages":[]}
+
+result = client.classify(image: File.open("/path/to/cat.jpg"))
+p result.result # => {"result":[{"label":"TABBY","score":0.6159140467643738},{"label":"TIGER CAT","score":0.12016300112009048},{"label":"EGYPTIAN CAT","score":0.07523812353610992},{"label":"DOORMAT","score":0.018854796886444092},{"label":"ASHCAN","score":0.01314085815101862}],"success":true,"errors":[],"messages":[]}
+```
+
+#### 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

@@ -2,6 +2,7 @@ require "event_stream_parser"
 require "faraday"
 
 class Cloudflare::AI::Client
+  include Cloudflare::AI::Clients::ImageHelpers
   include Cloudflare::AI::Clients::TextGenerationHelpers
 
   attr_reader :url, :account_id, :api_token
@@ -18,11 +19,19 @@ class Cloudflare::AI::Client
     post_streamable_request(url, payload, &block)
   end
 
-  def classify(text:, model_name: Cloudflare::AI::Models.text_classification.first)
+  def classify(text: nil, image: nil, model_name: nil)
+    raise ArgumentError, "Must provide either text or image (and not both)" if [text, image].compact.size != 1
+
+    model_name ||= text ? Cloudflare::AI::Models.text_classification.first : Cloudflare::AI::Models.image_classification.first
     url = service_url_for(account_id: account_id, model_name: model_name)
-    payload = {text: text}.to_json
 
-    Cloudflare::AI::Results::TextClassification.new(connection.post(url, payload).body)
+    if text
+      payload = {text: text}.to_json
+      Cloudflare::AI::Results::TextClassification.new(connection.post(url, payload).body)
+    else
+      image = File.open(image) if image.is_a?(String)
+      Cloudflare::AI::Results::ImageClassification.new(post_request_with_binary_file(url, image).body)
+    end
   end
 
   def complete(prompt:, model_name: default_text_generation_model_name, max_tokens: default_max_tokens, &block)
@@ -39,6 +48,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/image_helpers.rb

@@ -0,0 +1,20 @@
+require "faraday/multipart"
+
+module Cloudflare
+  module AI
+    module Clients
+      module ImageHelpers
+        private
+
+        def post_request_with_binary_file(url, file)
+          connection.post do |req|
+            req.url url
+            req.headers["Transfer-Encoding"] = "chunked"
+            req.headers["Content-Type"] = "multipart/form-data"
+            req.body = ::Faraday::UploadIO.new(file, "octet/stream")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cloudflare/ai/models.rb

@@ -17,7 +17,7 @@ class Cloudflare::AI::Models
     end
 
     def image_classification
-      %w[@cf/huggingface/distilbert-sst-2-int8]
+      %w[@cf/microsoft/resnet-50]
     end
 
     def text_to_image

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

@@ -0,0 +1,3 @@
+class Cloudflare::AI::Results::ImageClassification < Cloudflare::AI::Result
+  # Empty seam kept for consistency with other result objects that have more complexity.
+end

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.1"
+    VERSION = "0.6.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudflare-ai
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Ajay Krishnan
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-22 00:00:00.000000000 Z
+date: 2024-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -93,14 +107,17 @@ files:
 - README.md
 - lib/cloudflare/ai.rb
 - lib/cloudflare/ai/client.rb
+- lib/cloudflare/ai/clients/image_helpers.rb
 - lib/cloudflare/ai/clients/text_generation_helpers.rb
 - lib/cloudflare/ai/contextual_logger.rb
 - lib/cloudflare/ai/message.rb
 - lib/cloudflare/ai/models.rb
 - lib/cloudflare/ai/result.rb
+- lib/cloudflare/ai/results/image_classification.rb
 - 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: