scaleapi 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 856d5ad5cfe00e33de0af54810ccc62740e4527a
-  data.tar.gz: 27f450cea25f9b945dc31464b9f6d1373e2f46d9
+  metadata.gz: b21cd5e56a610ea9d0e324922d6b350a5e70496a
+  data.tar.gz: 3ffb5f6a80df8d13ce5251db9668f6d6d652c2bd
 SHA512:
-  metadata.gz: 6c39fd22f18b487ea5e1b1e2ca87c3038fb0256ff41cb3eedc5a6916d02441a5f0f6e78d89c37561e9ea771a6ab3fe743c3f50bb209da875184f8f20e3cbefd2
-  data.tar.gz: eea51b37f316e343d2b326b8648372e3433954fd73643cba4607d1a2006de06f3113cb4ccd294e50d709c56bc522624b1fdb6087d7a15ae5298eaea44ff8816e
+  metadata.gz: f14677d50a682ee2bf7e95c076d9f0a698a797e711621b3249b6a7446be0832deb0d6fa993482d829a9e791ce13bfe03a63e0a1e8e0d0307a313d1cc98da9833
+  data.tar.gz: 3b47e584e202f6895a2417d6ac6f490fb20403a6c0c9e5c255a17c9f287301a21f584e6f215546df4692baeb7c46711038bb2dff9ec10a606992982f8585aff1

data/README.md

@@ -5,7 +5,6 @@ This is the official Scale API RubyGem (`scaleapi`).
 
 [Scale](https://www.scaleapi.com) is an API for Human Intelligence. Businesses like Alphabet (Google), Uber, Proctor & Gamble, Houzz, and many more use us to power tasks such as:
 - Draw bounding boxes and label parts of images (to train ML algorithms for self-driving cars)
-- Place phone calls
 - Transcribe documents, images, and webpages
 - Scrape websites
 - Triage support tickets
@@ -239,55 +238,6 @@ This will also return a `Scale::Api::Tasks::ImageRecognition` object.
 
 [Read more about creating image recognition tasks](https://docs.scaleapi.com/#create-image-recognition-task)
 
-### Phone Call Tasks
-
-You can use this to have real people call other people! Isn't that cool?
-
-To create a [phone call task](https://docs.scaleapi.com/#create-phone-call-task), run the following:
-```ruby
-require 'scale'
-scale = Scale.new(api_key: 'SCALE_API_KEY')
-
-scale.create_phone_call_task({
-  callback_url: 'http://www.example.com/callback',
-  instruction: 'Call this person and follow the script provided, recording responses',
-  phone_number: '5055006865',
-  entity_name: 'Alexandr Wang',
-  script: 'Hello ! Are you happy today? (pause) One more thing - what is your email address?',
-  fields: {
-    email: 'Email Address',
-  },
-  choices: ['He is happy', 'He is not happy']
-})
-```
-Upon success, this will return a `Scale::Api::Tasks::PhoneCall` object. If it fails, it will raise one of the [errors](#user-content-errors).
-
-Note: `create_phone_call_task` is also aliased to `create_phonecall_task`, to help avoid confusion.
-
-Alternatively, you can also create a task this way
-```ruby
-require 'scale'
-scale = Scale.new(api_key: 'SCALE_API_KEY')
-
-scale.tasks.create({
-  type: 'phonecall',
-  callback_url: 'http://www.example.com/callback',
-  instruction: 'Call this person and follow the script provided, recording responses',
-  phone_number: '5055006865',
-  entity_name: 'Alexandr Wang',
-  script: 'Hello ! Are you happy today? (pause) One more thing - what is your email address?',
-  fields: {
-    email: 'Email Address',
-  },
-  choices: ['He is happy', 'He is not happy']
-})
-```
-
-This will also return a `Scale::Api::Tasks::PhoneCall` object.
-
-[Read more about creating phone call tasks](https://docs.scaleapi.com/#create-phone-call-task)
-
-
 ### Transcription Tasks
 
 To create a [transcription task](https://docs.scaleapi.com/#create-transcription-task), run the following:
@@ -482,7 +432,6 @@ All tasks return a task object for their `type`. Currently, this gem supports th
 - `comparison` (`Scale::Api::Tasks::Comparison`)
 - `datacollection` (`Scale::Api::Tasks::Datacollection`)
 - `annotation` (`Scale::Api::Tasks::ImageRecognition`)
-- `phonecall` (`Scale::Api::Tasks::PhoneCall`)
 - `transcription` (`Scale::Api::Tasks::Transcription`)
 - `audiotranscription` (`Scale::Api::Tasks::AudioTranscription`)
 

data/lib/scale.rb

@@ -68,6 +68,14 @@ class Scale
     Api::Tasks::AudioTranscription.create(args.merge(client: client))
   end
 
+  def create_pointannotation_task(args = {})
+    Api::Tasks::Pointannotation.create(args.merge(client: client))
+  end
+
+  def create_segmentannotation_task(args = {})
+    Api::Tasks::Segmentannotation.create(args.merge(client: client))
+  end
+
   def build_callback(params, callback_key: nil)
     callback = Api::Callback.new(params, callback_key: callback_key, client: client)
     
@@ -101,4 +109,6 @@ require 'scale/api/tasks/polygonannotation'
 require 'scale/api/tasks/lineannotation'
 require 'scale/api/tasks/phone_call'
 require 'scale/api/tasks/transcription'
+require 'scale/api/tasks/pointannotation'
+require 'scale/api/tasks/segmentannotaiton'
 require 'scale/api/task_list'

data/lib/scale/api/task_list.rb

@@ -8,6 +8,8 @@ require 'scale/api/tasks/polygonannotation'
 require 'scale/api/tasks/lineannotation'
 require 'scale/api/tasks/phone_call'
 require 'scale/api/tasks/transcription'
+require 'scale/api/tasks/segmentannotation'
+require 'scale/api/tasks/pointannotation'
 
 class Scale
   class Api
@@ -25,7 +27,9 @@ class Scale
         'polygonannotation' => ::Scale::Api::Tasks::Polygonannotation,
         'lineannotation' => ::Scale::Api::Tasks::Lineannotation,
         'phonecall' => ::Scale::Api::Tasks::PhoneCall,
-        'transcription' => ::Scale::Api::Tasks::Transcription
+        'transcription' => ::Scale::Api::Tasks::Transcription,
+        'pointannotation' => ::Scale::Api::Tasks::Pointannotation,
+        'segmentannotation' => ::Scale::Api::Tasks::Segmentannotation
       }.freeze
 
       def initialize(client: nil, docs: [], limit: 99, offset: 0, has_more: false, params: {})

data/lib/scale/api/tasks/categorization.rb

@@ -7,7 +7,7 @@ class Scale
       class Categorization < BaseTask
         CREATE_PATH = 'task/categorize'.freeze
 
-        def self.create(callback_url: nil, instruction: nil, attachment_type: nil, attachment: nil, categories: [], urgency: 'day', category_ids: {}, allow_multiple: false, metadata: {}, client: nil)
+        def self.create(callback_url: nil, instruction: nil, attachment_type: nil, attachment: nil, categories: [], layers: nil, urgency: 'day', category_ids: {}, allow_multiple: false, metadata: {}, client: nil)
           body = {
             callback_url: callback_url,
             instruction: instruction,
@@ -17,7 +17,8 @@ class Scale
             urgency: urgency,
             category_ids: category_ids,
             allow_multiple: allow_multiple,
-            metadata: metadata
+            metadata: metadata,
+            layers: layers
           }
 
           body.delete(:category_ids) if category_ids.keys.count.zero?
@@ -29,4 +30,4 @@ class Scale
       end
     end
   end
-end
+end

data/lib/scale/api/tasks/image_recognition.rb

@@ -7,7 +7,7 @@ class Scale
       class ImageRecognition < Scale::Api::Tasks::BaseTask
         CREATE_PATH = 'task/annotation'.freeze
 
-        def self.create(callback_url: nil, instruction: nil, attachment_type: nil, attachment: null, objects_to_annotate: [], with_labels: false, min_width: nil, min_height: nil, examples: [], urgency: 'day', metadata: {}, client: nil)
+        def self.create(callback_url: nil, instruction: nil, attachment_type: nil, attachment: null, objects_to_annotate: [], with_labels: false, min_width: nil, min_height: nil, layers: nil, examples: [], urgency: 'day', metadata: {}, annotation_attributes: nil, client: nil)
           response = client.post(CREATE_PATH, {
             callback_url: callback_url,
             instruction: instruction,
@@ -19,7 +19,9 @@ class Scale
             min_height: min_height,
             examples: examples,
             urgency: urgency,
-            metadata: metadata
+            metadata: metadata,
+            layers: layers,
+            annotation_attributes: annotation_attributes
           })
 
           ImageRecognition.new(JSON.parse(response.body))

data/lib/scale/api/tasks/lineannotation.rb

@@ -7,7 +7,7 @@ class Scale
       class Lineannotation < Scale::Api::Tasks::BaseTask
         CREATE_PATH = 'task/lineannotation'.freeze
 
-        def self.create(callback_url: nil, instruction: nil, attachment_type: nil, attachment: null, objects_to_annotate: [], with_labels: false, examples: [], urgency: 'day', metadata: {}, client: nil)
+        def self.create(callback_url: nil, instruction: nil, attachment_type: nil, attachment: null, objects_to_annotate: [], with_labels: false, layers: nil, examples: [], urgency: 'day', splines: false, annotation_attributes: nil, metadata: {}, client: nil)
           response = client.post(CREATE_PATH, {
             callback_url: callback_url,
             instruction: instruction,
@@ -17,7 +17,10 @@ class Scale
             with_labels: with_labels,
             examples: examples,
             urgency: urgency,
-            metadata: metadata
+            metadata: metadata,
+            layers: layers,
+            splines: splines,
+            annotation_attributes: annotation_attributes
           })
 
           Lineannotation.new(JSON.parse(response.body))

data/lib/scale/api/tasks/phone_call.rb

@@ -8,21 +8,9 @@ class Scale
         CREATE_PATH = 'task/phonecall'.freeze
 
         def self.create(callback_url: nil, instruction: nil, phone_number: nil, script: nil, entity_name: nil, attachment: nil, attachment_type: nil, fields: {}, choices: {}, urgency: 'day', metadata: {}, client: nil)
-          response = client.post(CREATE_PATH, {
-            callback_url: callback_url,
-            instruction: instruction,
-            attachment_type: attachment_type,
-            attachment: attachment,
-            phone_number: phone_number,
-            script: script,
-            entity_name: entity_name,
-            fields: fields,
-            choices: choices,
-            urgency: urgency,
-            metadata: metadata
-          })
-
-          PhoneCall.new(JSON.parse(response.body))
+          message = 'Phone call tasks have been deprecated and are no longer available.'
+          pp message
+          raise ScaleApi::Api::BadRequest.new(message)
         end
       end
     end

data/lib/scale/api/tasks/pointannotation.rb

@@ -0,0 +1,30 @@
+require 'json'
+require 'scale/api/tasks/base_task'
+
+class Scale
+  class Api
+    class Tasks
+      class Pointannotation < Scale::Api::Tasks::BaseTask
+        CREATE_PATH = 'task/polygonannotation'.freeze
+
+        def self.create(callback_url: nil, instruction: nil, attachment_type: nil, attachment: null, objects_to_annotate: [], with_labels: false, layers: nil, examples: [], urgency: 'day', metadata: {}, annotation_attributes: nil, client: nil)
+          response = client.post(CREATE_PATH, {
+            callback_url: callback_url,
+            instruction: instruction,
+            attachment_type: attachment_type,
+            attachment: attachment,
+            objects_to_annotate: objects_to_annotate,
+            with_labels: with_labels,
+            examples: examples,
+            urgency: urgency,
+            metadata: metadata,
+            layers: layers,
+            annotation_attributes: annotation_attributes
+          })
+
+          Pointannotation.new(JSON.parse(response.body))
+        end
+      end
+    end
+  end
+end

data/lib/scale/api/tasks/polygonannotation.rb

@@ -7,7 +7,7 @@ class Scale
       class Polygonannotation < Scale::Api::Tasks::BaseTask
         CREATE_PATH = 'task/polygonannotation'.freeze
 
-        def self.create(callback_url: nil, instruction: nil, attachment_type: nil, attachment: null, objects_to_annotate: [], with_labels: false, examples: [], urgency: 'day', metadata: {}, client: nil)
+        def self.create(callback_url: nil, instruction: nil, attachment_type: nil, attachment: null, objects_to_annotate: [], with_labels: false, layers: nil, examples: [], urgency: 'day', metadata: {}, annotation_attributes: nil, client: nil)
           response = client.post(CREATE_PATH, {
             callback_url: callback_url,
             instruction: instruction,
@@ -17,7 +17,9 @@ class Scale
             with_labels: with_labels,
             examples: examples,
             urgency: urgency,
-            metadata: metadata
+            metadata: metadata,
+            layers: layers,
+            annotation_attributes: annotation_attributes
           })
 
           Polygonannotation.new(JSON.parse(response.body))

data/lib/scale/api/tasks/segmentannotation.rb

@@ -0,0 +1,27 @@
+require 'json'
+require 'scale/api/tasks/base_task'
+
+class Scale
+  class Api
+    class Tasks
+      class Segmentannotation < Scale::Api::Tasks::BaseTask
+        CREATE_PATH = 'task/segmentannotation'.freeze
+
+        def self.create(callback_url: nil, instruction: nil, attachment_type: nil, attachment: null, labels: [], allow_unlabeled: false, layers: nil, examples: [], urgency: 'day', metadata: {}, client: nil)
+          response = client.post(CREATE_PATH, {
+            callback_url: callback_url,
+            instruction: instruction,
+            attachment_type: attachment_type,
+            attachment: attachment,
+            labels: labels,
+            allow_unlabeled: allow_unlabeled,
+            urgency: urgency,
+            metadata: metadata
+          })
+
+          Segmentannotation.new(JSON.parse(response.body))
+        end
+      end
+    end
+  end
+end

data/lib/scale/api/tasks/transcription.rb

@@ -7,8 +7,8 @@ class Scale
       class Transcription < BaseTask
         CREATE_PATH = 'task/transcription'.freeze
 
-        def self.create(callback_url: nil, instruction: nil, attachment_type: nil, choices: {}, attachment: null, fields: {}, urgency: 'day', metadata: {}, client: nil)
-          response = client.post(CREATE_PATH, {
+        def self.create(callback_url: nil, instruction: nil, attachment_type: nil, choices: {}, attachment: null, fields: {}, urgency: 'day', metadata: {}, client: nil, repeatable_fields: nil)
+          args = {
             callback_url: callback_url,
             instruction: instruction,
             attachment_type: attachment_type,
@@ -17,8 +17,11 @@ class Scale
             choices: choices,
             urgency: urgency,
             metadata: metadata
-          })
-
+          }
+          if repeatable_fields != nil
+            args['repeatable_fields'] = repeatable_fields
+          end
+          response = client.post(CREATE_PATH, args)
           Transcription.new(JSON.parse(response.body))
         end
       end

data/scaleapi-ruby.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "scaleapi"
-  spec.version       = "0.3.0"
+  spec.version       = "0.5.0"
   spec.authors       = ["Alexandr Wang"]
   spec.email         = ["alex@scaleapi.com"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scaleapi
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Alexandr Wang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-18 00:00:00.000000000 Z
+date: 2017-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,7 +81,9 @@ files:
 - lib/scale/api/tasks/image_recognition.rb
 - lib/scale/api/tasks/lineannotation.rb
 - lib/scale/api/tasks/phone_call.rb
+- lib/scale/api/tasks/pointannotation.rb
 - lib/scale/api/tasks/polygonannotation.rb
+- lib/scale/api/tasks/segmentannotation.rb
 - lib/scale/api/tasks/transcription.rb
 - scaleapi-ruby.gemspec
 homepage: https://www.scaleapi.com