RecastAI 1.1.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b8ad1ab3c3644a475ee1ef6cb9d2fc1ff9cc2576
-  data.tar.gz: b8aa64148bc4fa52e834baa5f7e0a1519f198459
+  metadata.gz: cb697ada3b68765c4aaa58a74aecb84b4abd6ce1
+  data.tar.gz: aea0d30db62c6f16036f5bfb05d4192fabb79586
 SHA512:
-  metadata.gz: 8fbb4fba5c6df33976ba39903ec228e33c152e333879ef17a9b72e646d4d85bfaf543b3de1b4842c01fd03390e15cff0734a5eb565eeef676b9d6061ff67ae1a
-  data.tar.gz: 86ef258e86abcebf37bc945d3cc3cf58a634416e3eab53e12bc68ce1b5919b6f1eaa9e706a51337ed35a37e94f8f4e941142509e0664a904f8b5430869ebece3
+  metadata.gz: 4c8345542618e865f9fe864661f68ffc1e0b5ba482cc7bc367ae50c2d055fc1c2c85dcf2ed04de031c46574d0de1b6f5adee8c489797a5a991183c91db4a6a0a
+  data.tar.gz: 39b7610d272e106875fa4feb59b25db4db1e802d461e2adb8e3a871ba0fe5d55744220fe798caf22fb01bcbdc1f335a1bed5318bc79fdaeae6b62581a89088b3

data/.rubocop.yml

@@ -1,7 +1,7 @@
 Metrics/LineLength:
-  Max: 999
+  Max: 9999
 Metrics/MethodLength:
-  Max: 999
+  Max: 9999
 Style/Documentation:
   Enabled: false
 Style/SpaceBeforeBlockBraces:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    RecastAI (1.1.0)
+    RecastAI (2.0.0)
       httmultiparty (~> 0.3)
       httparty (~> 0.13)
 
@@ -61,4 +61,4 @@ DEPENDENCIES
   webmock (~> 1.24)
 
 BUNDLED WITH
-   1.11.2
+   1.12.5

data/README.md

@@ -31,12 +31,8 @@ require 'recastai'
 client = RecastAI::Client.new(YOUR_TOKEN, YOUR_LANGUAGE)
 
 # text request
-responseFromText = client.text_request(YOUR_TEXT)
-
-# file request
-responseFromFile = client.file_request(File.new(File.join(File.dirname(__FILE__), YOUR_FILE)))
-
-if responseFromText.intent == YOUR_EXPECTED_INTENT
+response = client.text_request(YOUR_TEXT)
+if response.intent.slug == YOUR_EXPECTED_INTENT
   # Do your code...
 end
 ```
@@ -49,11 +45,11 @@ This gem contains 5 main classes, as follows:
 
 * RecastAI::Client is the client allowing you to make requests.
 * RecastAI::Response contains the response from [Recast.AI](https://recast.ai).
-* RecastAI::Sentence represents a sentence of the response.
+* RecastAI::Intent represents an intent of the response.
 * RecastAI::Entity represents an entity found by Recast.AI in your user's input.
 * RecastAI::RecastError is the error thrown by the gem.
 
-Don't hesitate to dive into the code, it's commented ;)
+Don't hesitate to dive into the code, it's commented :)
 
 ## RecastAI::Client
 
@@ -112,7 +108,7 @@ __file format: .wav__
 ```ruby
 response = client.file_request(File.new(File.join(File.dirname(__FILE__),YOUR_FILE)))
 
-if response.intent == YOUR_EXPECTED_INTENT
+if response.intent.slug == YOUR_EXPECTED_INTENT
   # Do your code...
 end
 ```
@@ -140,23 +136,11 @@ The Response is generated after a call to either file_request or text_request.
 ```ruby
 response = client.text_request(YOUR_TEXT)
 
-if response.intent == YOUR_EXPECTED_INTENT
+if response.intent.slug == YOUR_EXPECTED_INTENT
   # Do your code...
 end
 ```
 
-### Get the first sentence
-
-| Method          | Params | Return             |
-| --------------- |:------:| :------------------|
-| sentence()      |        | the first sentence |
-
-```ruby
-response = client.text_request(YOUR_TEXT)
-
-first_sentence = response.sentence
-```
-
 ### Get the first entity matching name
 
 | Method     | Params        | Return                   |
@@ -181,6 +165,38 @@ response = client.text_request(YOUR_TEXT)
 locations = response.all('location')
 ```
 
+
+
+### Act helpers
+
+| Method        | Params | Return                                                 |
+| ------------- |:------:| :----------------------------------------------------- |
+| assert?       |        | Bool: whether or not the sentence is an assertion      |
+| command?      |        | Bool: whether or not the sentence is a command         |
+| wh\_query?    |        | Bool: whether or not the sentence is a question        |
+| yn\_query?    |        | Bool: whether or not the sentence is a query           |
+
+### Type helpers
+
+| Method        | Params | Return                                                 |
+| ------------- |:------:| :----------------------------------------------------- |
+| abbreviation? |        | Bool: is the answer of the sentence an abbreviation?   |
+| entity?       |        | Bool: is the answer of the sentence an entity?         |
+| description?  |        | Bool: is the answer of the sentence an description?    |
+| human?        |        | Bool: is the answer of the sentence an human?          |
+| location?     |        | Bool: is the answer of the sentence a location?        |
+| number?       |        | Bool: is the answer of the sentence an number?         |
+
+### Sentiment helpers
+
+| Method        | Params | Return                                                 |
+| ------------- |:------:| :----------------------------------------------------- |
+| vpositive?    |        | Bool: is the sentence very positive?                   |
+| positive?     |        | Bool: is the sentence positive?                        |
+| neutral?      |        | Bool: is the sentence neutral?                         |
+| negative?     |        | Bool: is the sentence negative?                        |
+| vnegative?    |        | Bool: is the sentence very negative?                   |
+
 ### Getters
 
 Each of the following methods corresponds to a Response attribute
@@ -188,68 +204,36 @@ Each of the following methods corresponds to a Response attribute
 | Method        | Params | Return                                              |
 | ------------- |:------:| :---------------------------------------------------|
 | raw()         |        | String: the raw unparsed json response              |
+| uuid()        |        | String: the universal unique id of the request      |
 | source()      |        | String: the user input                              |
-| intents()     |        | Array[object]: all the matched intents              |
-| sentences()   |        | Array[Sentence]: all the detected sentences         |
+| intents()     |        | Array[Intent]: all the matched intents              |
+| act()         |        | String: the act of the sentence                     |
+| type()        |        | String: the type of the sentence                    |
+| sentiment()   |        | String: the sentiment of the sentence               |
+| entities()    |        | Array[Entity]: all the detected entities            |
+| language()    |        | String: the language of the sentence                |
 | version()     |        | String: the version of the json                     |
 | timestamp()   |        | String: the timestamp at the end of the processing  |
 | status()      |        | String: the status of the response                  |
-| type()        |        | String: the type of the response                    |
-
-
-## RecastAI::Sentence
-
-The Sentence is generated by the Recast.AI Response initializer
-
-### Get the first entity matching name
-
-| Method     | Params        | Return                   |
-| ---------- |:-------------:| :------------------------|
-| get(name)  | name: String  | the first Entity matched |
-
-```ruby
-response = client.text_request(YOUR_TEXT)
-
-sentence = response.sentence
-
-location = sentence.get('location')
-```
-
-### Get all entities matching name
-
-| Method     | Params        | Return                   |
-| ---------- |:-------------:| :------------------------|
-| all(name)  | name: String  | all the Entities matched |
 
-```ruby
-response = client.text_request(YOUR_TEXT)
+## RecastAI::Intent
 
-sentence = response.sentence
+Each of the following methods corresponds to an Intent attribute
 
-locations = sentence.all('location')
-```
-
-### Getters
-
-Each of the following methods corresponds to a Response attribute
-
-| Method      | Params | Return                                               |
-| ----------- |:------:| :----------------------------------------------------|
-| source      |        | String: the source of the sentence                   |
-| type        |        | String: the type of the sentence                     |
-| action      |        | String: The action of the sentence                   |
-| agent       |        | String: the agent of the sentence                    |
-| polarity    |        | String: the polarity of the sentence                 |
-| entities    |        | Array[Entity]: the entities detected in the sentence |
+| Attributes  | Description                                                   |
+| ----------- |:--------------------------------------------------------------|
+| slug        | String: the slug of the intent                                |
+| confidence  | Float: the unparsed json value of the intent                  |
 
 ## RecastAI::Entity
 
-Each of the following methods corresponds to a Response attribute
+Each of the following methods corresponds to an Entity attribute
 
 | Attributes  | Description                                                   |
 | ----------- |:--------------------------------------------------------------|
 | name        | String: the name of the entity                                |
-| raw         | String: the unparsed json value of the entity                 |
+| raw         | String: the raw value extracted from the sentence             |
+| confidence  | Float: the detection score between 0 and 1 excluded           |
 
 In addition to those methods, more attributes are generated depending of the nature of the entity.
 The full list can be found there: [man.recast.ai](https://man.recast.ai/#list-of-entities)
@@ -288,7 +272,7 @@ Copyright (c) [2016] [Recast.AI](https://recast.ai)
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+to tsuse, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 

data/lib/recastai.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 
 require 'httparty'
@@ -8,5 +10,5 @@ require 'recastai/utils'
 require 'recastai/errors'
 require 'recastai/client'
 require 'recastai/response'
-require 'recastai/sentence'
+require 'recastai/intent'
 require 'recastai/entity'

data/lib/recastai/client.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module RecastAI
   class Client
     attr_accessor :token
@@ -25,10 +27,11 @@ module RecastAI
 
       body = { 'text' => text }
       body['language'] = language unless language.nil?
-      response = HTTParty.post(Utils::API_ENDPOINT,
-                               body: body,
-                               headers: { 'Authorization' => "Token #{token}" }
-                              )
+      response = HTTParty.post(
+        Utils::API_ENDPOINT,
+        body: body,
+        headers: { 'Authorization' => "Token #{token}" }
+      )
       raise(RecastError.new(response.message)) if response.code != 200
 
       Response.new(response.body)
@@ -52,10 +55,11 @@ module RecastAI
 
       body = { 'voice' => File.new(file) }
       body['language'] = language unless language.nil?
-      response = HTTMultiParty.post(Utils::API_ENDPOINT,
-                                    body: body,
-                                    headers: { 'Authorization' => "Token #{token}" }
-                                   )
+      response = HTTMultiParty.post(
+        Utils::API_ENDPOINT,
+        body: body,
+        headers: { 'Authorization' => "Token #{token}" }
+      )
       raise(RecastError.new(response.message)) if response.code != 200
 
       Response.new(response.body)

data/lib/recastai/entity.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module RecastAI
   class Entity
     attr_reader :name
@@ -5,6 +7,8 @@ module RecastAI
     def initialize(name, data)
       @name = name
 
+      # For each pair key, value, set a instance variable
+      # and an attr_reader named k and returning v
       data.each_pair do |k, v|
         self.instance_variable_set("@#{k}", v)
         self.define_singleton_method(k.to_sym){ v }

data/lib/recastai/errors.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module RecastAI
   class RecastError < Exception
   end

data/lib/recastai/intent.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+module RecastAI
+  class Intent
+    attr_reader :slug
+    attr_reader :confidence
+
+    def initialize(intent)
+      @slug       = intent['slug']
+      @confidence = intent['confidence']
+    end
+  end
+end

data/lib/recastai/response.rb

@@ -1,9 +1,15 @@
+# encoding: utf-8
+
 module RecastAI
   class Response
     attr_reader :raw
+    attr_reader :uuid
     attr_reader :source
     attr_reader :intents
-    attr_reader :sentences
+    attr_reader :act
+    attr_reader :type
+    attr_reader :sentiment
+    attr_reader :entities
     attr_reader :language
     attr_reader :version
     attr_reader :timestamp
@@ -15,9 +21,13 @@ module RecastAI
       response = JSON.parse(response)
       response = response['results']
 
+      @uuid      = response['uuid']
       @source    = response['source']
-      @intents   = response['intents']
-      @sentences = response['sentences'].map{ |s| Sentence.new(s) }
+      @intents   = response['intents'].map{ |i| Intent.new(i) }
+      @act       = response['act']
+      @type      = response['type']
+      @sentiment = response['sentiment']
+      @entities  = response['entities'].flat_map{ |n, e| e.map{ |ee| Entity.new(n, ee) } }
       @language  = response['language']
       @version   = response['version']
       @timestamp = response['timestamp']
@@ -34,16 +44,6 @@ module RecastAI
       @intents.any? ? @intents.first : nil
     end
 
-    ##
-    # Returns the first sentence provided there is one
-    #
-    # * *Args* :
-    # * *Returns* :
-    #   - A Sentence or nil
-    def sentence
-      @sentences.any? ? @sentences.first : nil
-    end
-
     ##
     # Returns the first entity whose name matches the parameter
     #
@@ -52,10 +52,8 @@ module RecastAI
     # * *Returns* :
     #   - An instance of Entity or nil
     def get(name)
-      @sentences.each do |sentence|
-        sentence.entities.each do |entity|
-          return entity if entity.name.casecmp(name.to_s) == 0
-        end
+      @entities.each do |entity|
+        return entity if entity.name.casecmp(name.to_s) == 0
       end
 
       nil
@@ -69,32 +67,159 @@ module RecastAI
     # * *Returns* :
     #   - An array of instances of Entity or an empty array
     def all(name)
-      entities = []
-
-      @sentences.each do |sentence|
-        sentence.entities.each do |entity|
-          entities << entity if entity.name.casecmp(name.to_s) == 0
-        end
+      @entities.select do |entity|
+        entity.name.casecmp(name.to_s) == 0
       end
+    end
 
-      entities
+    ##
+    # Return whether or not the act is an assertion
+    #
+    # + *Args* :
+    # + *Returns* :
+    #   - True or False
+    def assert?
+      @act == Utils::ACT_ASSERT
     end
 
     ##
-    # Returns all entities
+    # Return whether or not the act is a command
     #
-    # * *Returns* :
-    #   - An array of instances of Entity or an empty array
-    def entities
-      entities = []
+    # + *Args* :
+    # + *Returns* :
+    #   - True or False
+    def command?
+      @act == Utils::ACT_COMMAND
+    end
 
-      @sentences.each do |sentence|
-        sentence.entities.each do |entity|
-          entities << entity
-        end
-      end
+    ##
+    # Return whether or not the act is a wh-query
+    #
+    # + *Args* :
+    # + *Returns* :
+    #   - True or False
+    def wh_query?
+      @act == Utils::ACT_WH_QUERY
+    end
+
+    ##
+    # Return whether or not the act is a yn-query
+    #
+    # + *Args* :
+    # + *Returns* :
+    #   - True or False
+    def yn_query?
+      @act == Utils::ACT_YN_QUERY
+    end
+
+    ##
+    # Return whether or not the type is an abbreviation
+    #
+    # + *Args* :
+    # + *Returns* :
+    #   - True or False
+    def abbreviation?
+      !@type.index(Utils::TYPE_ABBREVIATION).nil?
+    end
+
+    ##
+    # Return whether or not the type is an entity
+    #
+    # + *Args* :
+    # + *Returns* :
+    #   - True or False
+    def entity?
+      !@type.index(Utils::TYPE_ENTITY).nil?
+    end
+
+    ##
+    # Return whether or not the type is a description
+    #
+    # + *Args* :
+    # + *Returns* :
+    #   - True or False
+    def description?
+      !@type.index(Utils::TYPE_DESCRIPTION).nil?
+    end
+
+    ##
+    # Return whether or not the type is a human
+    #
+    # + *Args* :
+    # + *Returns* :
+    #   - True or False
+    def human?
+      !@type.index(Utils::TYPE_HUMAN).nil?
+    end
+
+    ##
+    # Return whether or not the type is a location
+    #
+    # + *Args* :
+    # + *Returns* :
+    #   - True or False
+    def location?
+      !@type.index(Utils::TYPE_LOCATION).nil?
+    end
+
+    ##
+    # Return whether or not the type is a number
+    #
+    # + *Args* :
+    # + *Returns* :
+    #   - True or False
+    def number?
+      !@type.index(Utils::TYPE_NUMBER).nil?
+    end
+
+    ##
+    # Return whether or not the sentiment is very positive
+    #
+    # + *Args* :
+    # + *Returns* :
+    #   - True or False
+    def vpositive?
+      @sentiment == Utils::SENTIMENT_VPOSITIVE
+    end
+
+    ##
+    # Return whether or not the sentiment is positive
+    #
+    # + *Args* :
+    # + *Returns* :
+    #   - True or False
+    def positive?
+      @sentiment == Utils::SENTIMENT_POSITIVE
+    end
+
+    ##
+    # Return whether or not the sentiment is neutral
+    #
+    # + *Args* :
+    # + *Returns* :
+    #   - True or False
+    def neutral?
+      @sentiment == Utils::SENTIMENT_NEUTRAL
+    end
+
+    ##
+    # Return whether or not the sentiment is negative
+    #
+    # + *Args* :
+    # + *Returns* :
+    #   - True or False
+    def negative?
+      @sentiment == Utils::SENTIMENT_NEGATIVE
+    end
 
-      entities
+    ##
+    # Return whether or not the sentiment is very negative
+    #
+    # + *Args* :
+    # + *Returns* :
+    #   - True or False
+    def vnegative?
+      @sentiment == Utils::SENTIMENT_VNEGATIVE
     end
   end
 end

data/lib/recastai/utils.rb

@@ -1,13 +1,36 @@
+# encoding: utf-8
+
 module RecastAI
   class Utils
     # Versioning
-    MAJOR   = '1'.freeze
-    MINOR   = '1'.freeze
-    MICRO   = '1'.freeze
+    MAJOR = '2'.freeze
+    MINOR = '0'.freeze
+    MICRO = '0'.freeze
     VERSION = "#{MAJOR}.#{MINOR}.#{MICRO}".freeze
 
     # Endpoints
-    API_ENDPOINT = 'https://api.recast.ai/v1/request'.freeze
-    WS_ENDPOINT  = 'wss://api.recast.ai/v1/request'.freeze
+    API_ENDPOINT = 'https://api.recast.ai/v2/request'.freeze
+    WS_ENDPOINT = 'wss://api.recast.ai/v2/request'.freeze
+
+    # Act constants
+    ACT_ASSERT = 'assert'.freeze
+    ACT_COMMAND = 'command'.freeze
+    ACT_WH_QUERY = 'wh-query'.freeze
+    ACT_YN_QUERY = 'yn-query'.freeze
+
+    # Type constants
+    TYPE_ABBREVIATION = 'abbr:'.freeze
+    TYPE_ENTITY = 'enty:'.freeze
+    TYPE_DESCRIPTION = 'desc:'.freeze
+    TYPE_HUMAN = 'hum:'.freeze
+    TYPE_LOCATION = 'loc:'.freeze
+    TYPE_NUMBER = 'num:'.freeze
+
+    # Sentiment constants
+    SENTIMENT_VPOSITIVE = 'vpositive'.freeze
+    SENTIMENT_POSITIVE = 'positive'.freeze
+    SENTIMENT_NEUTRAL = 'neutral'.freeze
+    SENTIMENT_NEGATIVE = 'negative'.freeze
+    SENTIMENT_VNEGATIVE = 'vnegative'.freeze
   end
 end

data/recastai.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.name                  = 'RecastAI'
   spec.version               = RecastAI::Utils::VERSION
   spec.date                  = Date.today
-  spec.summary               = %q(Recast.AI official SDK for Ruby)
-  spec.description           = %q(Recast.AI official SDK for Ruby. Allows you to make requests to your bots.)
+  spec.summary               = 'Recast.AI official SDK for Ruby'
+  spec.description           = 'Recast.AI official SDK for Ruby. Allows you to make requests to your bots.'
   spec.homepage              = 'https://github.com/RecastAI/SDK-ruby'
   spec.license               = 'MIT'
   spec.authors               = ['Paul Renvoisé']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: RecastAI
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Paul Renvoisé
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-07 00:00:00.000000000 Z
+date: 2016-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -116,8 +116,8 @@ files:
 - lib/recastai/client.rb
 - lib/recastai/entity.rb
 - lib/recastai/errors.rb
+- lib/recastai/intent.rb
 - lib/recastai/response.rb
-- lib/recastai/sentence.rb
 - lib/recastai/utils.rb
 - misc/.gitkeep
 - misc/logo-inline.png

data/lib/recastai/sentence.rb

@@ -1,51 +0,0 @@
-module RecastAI
-  class Sentence
-    attr_reader :source
-    attr_reader :type
-    attr_reader :action
-    attr_reader :agent
-    attr_reader :polarity
-    attr_reader :entities
-
-    def initialize(sentence)
-      @source   = sentence['source']
-      @type     = sentence['type']
-      @action   = sentence['action']
-      @agent    = sentence['agent']
-      @polarity = sentence['polarity']
-      @entities = sentence['entities'].flat_map{ |n, e| e.map{ |ee| Entity.new(n, ee) } }
-    end
-
-    ##
-    # Returns the first entity whose name matches the parameter
-    #
-    # * *Args* :
-    #   - +name+ - String, the entity's name
-    # * *Returns* :
-    #   - An instance of Entity or nil
-    def get(name)
-      @entities.each do |entity|
-        return entity if entity.name.casecmp(name.to_s) == 0
-      end
-
-      nil
-    end
-
-    ##
-    # Returns all entities whose names matches the parameter
-    #
-    # * *Args* :
-    #   - +name+ - String, the entities' names
-    # * *Returns* :
-    #   - An array of instances of Entity or an empty array
-    def all(name)
-      entities = []
-
-      @entities.each do |entity|
-        entities << entity if entity.name.casecmp(name.to_s) == 0
-      end
-
-      entities
-    end
-  end
-end