cloudflare-ai 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0a6b80e669a5c4d64ec87433ed1c3426ee0a2a1087016773c5648c799b34912
-  data.tar.gz: fe1d3b2afb5f70cbe476b1b8e006819b2e6e469184169993a15c7c4c34b89ca8
+  metadata.gz: f8c78786e06d2a3cc05b177aedc99672b4be56016c33d6be2e718533b6b3f507
+  data.tar.gz: 535f23f9e6ffedbe0e090ded97459e021e57b84025456dab77d3d85dd2da194d
 SHA512:
-  metadata.gz: 84dcec88bcd44e4a7b004235b15b559d924c1e8dfce552234b2d9286762ab2a12d282954e8d863523b1c9170c24f49a772da7320b5b475b66b79b141ac2c532d
-  data.tar.gz: 0f676b2accb65edc63b2b9b1c2b8a532ebfedba588dfdcb1ae38ccfdf7edb4869c1ebee2060e887e5ac166772cda91d3e43e2ca650e878eb63b8c964d7fc19e1
+  metadata.gz: 6d35d01ae35a9407b97acfc0643c66c33b26d608d90373daf3c00001f86d7d2d2893162b370c417e2db7a96b43cec74d66e2652caa11ed89bbf31b968b4fd34d
+  data.tar.gz: 5af4ef84fdfc0ed649f951f18c10105b97ee4ae55b5d951f90551f7b0e5e452ca98ce408ded86980e67da05bfaf4e42321097b0b3f1cb2cfd224d67da74f8d44

data/README.md

@@ -61,6 +61,19 @@ Thiis gem provides a client that wraps around [Cloudflare's REST API](https://de
 client = Cloudflare::AI::Client.new(account_id: ENV["CLOUDFLARE_ACCOUNT_ID"], api_token: ENV["CLOUDFLARE_API_TOKEN"])
 ```
 
+### Model selection
+The model name is an optional parameter to every one of the client methods described below.
+For example, if an example is documented as 
+```ruby
+result = client.complete(prompt: "Hello my name is")
+```
+this is implicitly the same as 
+```ruby
+result = client.complete(prompt: "Hello my name is", model: "@cf/meta/llama-2-7b-chat-fp16")
+```
+The full list of supported models is available here: [models.rb](lib/cloudflare/ai/models.rb).
+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)
 ```ruby
@@ -120,7 +133,16 @@ result = client.embed(text: ["Hello", "World"])
 ```
 
 #### Result object
-All invocations of the `embedding` methods return a `Cloudflare::AI::Results::TextEmbedding`. 
+All invocations of the `embed` methods return a `Cloudflare::AI::Results::TextEmbedding`. 
+
+### Text classification
+```ruby
+result = client.classify(text: "You meanie!")
+p result.result # => [{"label"=>"NEGATIVE", "score"=>0.6647962927818298}, {"label"=>"POSITIVE", "score"=>0.3352036774158478}]
+```
+
+#### Result object
+All invocations of the `classify` methods return a `Cloudflare::AI::Results::TextClassification`.
 
 # Logging
 

data/lib/cloudflare/ai/client.rb

@@ -18,6 +18,13 @@ class Cloudflare::AI::Client
     post_streamable_request(url, payload, &block)
   end
 
+  def classify(text:, model_name: Cloudflare::AI::Models.text_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)
+  end
+
   def complete(prompt:, model_name: default_text_generation_model_name, &block)
     url = service_url_for(account_id: account_id, model_name: model_name)
     stream = block ? true : false

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

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

data/lib/cloudflare/ai/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudflare-ai
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ajay Krishnan
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-21 00:00:00.000000000 Z
+date: 2024-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -98,6 +98,7 @@ files:
 - lib/cloudflare/ai/message.rb
 - lib/cloudflare/ai/models.rb
 - lib/cloudflare/ai/result.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/version.rb