nlu_adapter 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7499fe30c4727e84ae33be8b0e3905d921942daa4b74cac9105105e473107160
-  data.tar.gz: 2cdb76a1ba9593b53d80d5f32b3be140c38d629e376c9abbd6893ff1ae1669d6
+  metadata.gz: 25db10d98a5439cbbc18327adba57ed9422211b2088644d950d9172cb8ed210f
+  data.tar.gz: 4ccf19d8a3633de04e0764fa74c374d185e3182dece8750cb3d9a7931a07167a
 SHA512:
-  metadata.gz: d0f35e5f09313ba18410c8ccf9d07ae4ea4ecb6cb217cf348e0cfccb8af0600e01262911e0890a706360b0c650ad9a9f395cf86273af9fa541065dec0098f854
-  data.tar.gz: 1d350b886b3154d973a5aef113cd505311ecc544037f7250f2f7a5da0b1691e6e87b7c9b91ed6c51fd116527c7207a1c78585705944cc0c566067007fdc7d606
+  metadata.gz: a6184e011cda087ec1e98cb5a81da9f3e01a982e05fdb7d75946bc2a3e083573f61a1992139533f2d73f6b4a42c4b1de73f36fcf30c68189e1b45347e7a3eee6
+  data.tar.gz: 136be99c729217c0e7af0e24c7fc5401dad0f311dc60045b58b8490b48ee160d4a871d72fc156f61cb2e5ed823ca23c97e3b507e07ce3b4fea82d3effb9b4a0e

data/.yardopts

@@ -6,3 +6,4 @@ CODE_OF_CONDUCT.md
 LICENSE
 docs/dialogflow.md
 docs/lex.md
+docs/watson_assistant.md

data/CHANGELOG.md

@@ -1,8 +1,14 @@
-0.1.4
+0.1.5 (22/Feb/2019)
+---
+* Added IBM Watson Assistant
+* Updated documentation
+
+0.1.4 (19/Jan/2019)
 ---
 * Fixed a bad push
+  * Note/Update: It was not bad! www.rubydoc.info was not refreshing for some strange reason
 
-0.1.3
+0.1.3 (19/Jan/2019)
 ---
 * New functionalities:
   * bulk_parse - parse multiple texts

data/README.md

@@ -31,6 +31,7 @@ NLU Service | Intent | Intet Collection | Intent identification
 ----------- | ------ | ---------------- | ---------------------
 [Aws Lex](https://aws.amazon.com/lex/) ([doc](docs/lex.md)) | C,R,U | C,R,U | Yes
 [Google Dialogflow](https://dialogflow.com/) ([doc](docs/dialogflow.md)) | C,R,U | To-Do | Yes
+[IBM Watson Assistant](https://cloud.ibm.com/catalog/services/watson-assistant) ([doc](docs/watson_assistant.md)) | C,R,U | To-Do | Yes
 
 ## Classification metrics
 ### Supported intent classification metrics

data/docs/dialogflow.md

@@ -1,13 +1,17 @@
+# @markup markdown
+
 # NluAdapter::Dialogflow
 
 Adapter for Google Dialogflow
 
 ## Setup
 
+Please check the [documentation](https://dialogflow.com/).
 
 ## Examples
 
-1. Parse a text and identify intent from an existing Lex bot
+1. Parse a text and identify intent from an existing Dialogflow bot
+
 ```ruby
 require 'nlu_adapter'
 
@@ -20,6 +24,7 @@ puts d.parse('I want to book a hotel')
 {:intent_name=>"BookHotel"}
 ```
 2. Create an intent
+
 ```ruby
 require 'nlu_adapter'
 
@@ -35,6 +40,7 @@ d.create_intent(i)
 Create an Agent from Dialogflow console.
 
 ## Running examples
+
 ```bash
 $ cat test-df-1.rb
 require 'nlu_adapter'

data/docs/lex.md

@@ -1,12 +1,17 @@
+# @markup markdown
+
 # NluAdapter::Lex
 
 Adapter for Aws Lex
 
 ## Setup
 
+Please check the [documentation](https://aws.amazon.com/lex/).
+
 ## Examples
 
 1. Parse a text and identify intent from an existing Lex bot
+
 ```ruby
 require 'nlu_adapter'
 
@@ -19,6 +24,7 @@ puts l.parse('I want to book a hotel')
 {:intent_name=>"BookHotel"}
 ```
 2. Create an intent
+
 ```ruby
 require 'nlu_adapter'
 
@@ -30,6 +36,7 @@ l.create_intent(i)
 ```
 
 3. Create an intent collection
+
 ```ruby
 
 require 'nlu_adapter'
@@ -45,6 +52,7 @@ l.create_intent_collection(ic)
 ```
 
 ## Running examples
+
 ```bash
 $ cat test-lex-1.rb
 require 'nlu_adapter'

data/docs/watson_assistant.md

@@ -0,0 +1,64 @@
+# @markup markdown
+
+# NluAdapter::WatsonAssistant
+
+Adapter for IBM Watson Assistant
+
+## Setup
+
+Please check the [Getting started tutorial](https://cloud.ibm.com/docs/services/assistant/getting-started.html#getting-started)
+
+* To get the API details
+ * Go to [resources list](https://cloud.ibm.com/resources)
+ * Select the desired service from the Services section
+ * Download / Copy the API Key & URL
+ * Click on the Launch tool to go to IBM Watson Assistant
+ * Select the Skills tab
+ * Click on the vertical ... icon for the desired skill
+ * Then click on View API Details from the menu
+ * Copy the Workspace ID
+
+* To create intents
+ * In the above step instead of clicking on the vertical ... icon, click the skill name
+
+## Examples
+
+1. Parse a text and identify intent from an existing skill
+
+```ruby
+require 'nlu_adapter'
+
+wa = NluAdapter.new(:WatsonAssistant, {url: 'https://gateway-lon.watsonplatform.net/assistant/api', version: '2018-09-20'})
+
+puts wa.parse('I want to book a hotel')
+
+```
+```
+{:intent_name=>"BookHotel"}
+```
+2. Create an intent
+
+```ruby
+require 'nlu_adapter'
+
+wa = NluAdapter.new(:WatsonAssistant, {url: 'https://gateway-lon.watsonplatform.net/assistant/api', version: '2018-09-20'})
+i = wa.new_intent('BookHotel', ['please book a hotel', 'I want to book a hotel'])
+
+wa.create_intent(i)
+
+```
+
+## Running examples
+
+```bash
+$ cat test-wa-1.rb
+require 'nlu_adapter'
+
+wa = NluAdapter.new(:WatsonAssistant, {url: 'https://gateway-lon.watsonplatform.net/assistant/api', version: '2018-09-20'})
+
+puts wa.parse('I want to book a hotel')
+
+$ WATSON_API_KEY='XXX' WATSON_WORKSPACE_ID='YYY' ruby ./test-wa-1.rb
+{:intent_name=>"BookHotel"}
+
+```

data/lib/nlu_adapter.rb

@@ -6,8 +6,9 @@ module NluAdapter
 	autoload :ParseHelper, 'nlu_adapter/parse_helper'
 	autoload :Metrics, 'nlu_adapter/metrics'
 	module Adapters
-		autoload :Lex,					'nlu_adapter/lex'
+		autoload :Lex,				'nlu_adapter/lex'
 		autoload :Dialogflow,			'nlu_adapter/dialogflow'
+		autoload :WatsonAssistant,		'nlu_adapter/watson_assistant'
 	end
 
 	def self.new(name, options = {})

data/lib/nlu_adapter/version.rb

@@ -1,3 +1,3 @@
 module NluAdapter
-	VERSION = "0.1.4"
+	VERSION = "0.1.5"
 end

data/lib/nlu_adapter/watson_assistant.rb

@@ -0,0 +1,157 @@
+require "ibm_watson/assistant_v1"
+
+
+module NluAdapter
+	module Adapters
+		# IBM Watson Assistant wrapper class
+		#
+		class WatsonAssistant
+			include ParseHelper
+
+			include IBMWatson
+
+			# Constructor
+			def initialize(options = {})
+				@url = options[:url] || "https://gateway-lon.watsonplatform.net/assistant/api"
+				@version = options[:version] || "2018-09-20"
+				@workspace_id = ENV["WATSON_WORKSPACE_ID"]
+				begin
+					@assistant = AssistantV1.new(
+						iam_apikey: ENV["WATSON_API_KEY"],
+						version: @version,
+						url: @url
+					)
+				rescue WatsonApiException => ex
+					puts "Error: #{ex.inspect}"
+				end
+			end
+
+			# Understand a given text
+			#
+			# @param text [String] a text to parse using the NLU provider
+			# @return [Json] return the identified intent name
+			#
+			def parse(text)
+				intent_name = nil
+				begin
+					response = @assistant.message(
+						workspace_id: @workspace_id,
+						input: {
+							text: text
+						}
+					)
+
+					intent_name = response.result["intents"][0]["intent"]
+				rescue WatsonApiException => ex
+					puts "Error: #{ex.inspect}"
+				end
+				return { intent_name: intent_name}
+			end
+
+			# Get an instance of Intent, if it exists else nil
+			#
+			# @param name [String] name of the intent
+			# @return [Intent] intent object
+			#
+			def get_intent(name)
+				begin
+					response = @assistant.get_intent(
+						workspace_id: @workspace_id,
+						intent: name,
+						export: true
+					)
+
+					return Intent.new({id: response.result['intent'], #for is update check
+						name: response.result['intent'],
+						description: response.result['description'],
+						utterences: response.result['examples'].map { |e| e['text']} })
+
+				rescue WatsonApiException => ex
+					puts "Error: #{ex.inspect}"
+				end
+				return nil
+			end
+
+			# Get a new instance of Intent
+			#
+			# @param name [String] name of the intent
+			# @param utterences [Array] phrases for training
+			# @return [Intent] Intent object
+			#
+			def new_intent(name, description, utterences = [])
+				i = get_intent(name)
+
+				i = Intent.new if !i
+				i.name = name
+				i.description = description
+				i.utterences = utterences
+
+				return i
+			end
+
+			# Given an Intent object, create/update it in Dialogflow
+			#
+			# @param intent [Intent] Intent object
+			# @return [Intent] Intent object
+			#
+			# @todo convert response -> Intent
+			#
+			def create_intent(intent)
+				#check: to create / update
+				i = intent.to_h
+				if !intent.id
+					response = @assistant.create_intent(
+						workspace_id: @workspace_id,
+						intent: i[:name],
+						description: i[:description],
+						examples: i[:examples]
+					)
+				else
+					response = @assistant.update_intent(
+						workspace_id: @workspace_id,
+						intent: intent.id,
+						new_examples: i[:examples],
+						new_description: i[:description],
+						new_intent: i[:name]
+					)
+
+				end
+			end
+
+
+			# Class represents Intent in an IntentCollection
+			class Intent
+				include NluAdapterIntent
+				attr_accessor :id, :description
+
+				# Constructor
+				def initialize(options = {})
+					@id = options[:id] #check for is update
+					@name = options[:name]
+					@description = options[:description]
+					@utterences = options[:utterences]
+				end
+
+				# Convert self to Hash
+				# @return [Hash] ruby hash
+				#
+				def to_h
+					{
+						name: @name,
+						description: @description,
+						examples: @utterences.map {|u| {"text" => u } }
+					}
+				end
+
+				# convert self to json
+				# @return [json] json
+				#
+				def to_json
+					to_h.to_json
+				end
+
+			end
+
+		end
+	end
+end

data/nlu_adapter.gemspec

@@ -49,4 +49,8 @@ Gem::Specification.new do |spec|
 
   #An implementation of Matrix and Vector classes.
   spec.add_dependency('matrix', '~> 0.1.0')
+
+  #Official client library to use the IBM Watson Services
+  spec.add_dependency('ibm_watson', '~> 0.12.0')
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nlu_adapter
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Girish Nair
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-18 00:00:00.000000000 Z
+date: 2019-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: ibm_watson
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
 description: An adapter for various NLU web services like Aws Lex, Google Dialogflow
   etc.
 email:
@@ -130,6 +144,7 @@ files:
 - bin/setup
 - docs/dialogflow.md
 - docs/lex.md
+- docs/watson_assistant.md
 - entrypoint.sh
 - lib/nlu_adapter.rb
 - lib/nlu_adapter/dialogflow.rb
@@ -139,6 +154,7 @@ files:
 - lib/nlu_adapter/metrics.rb
 - lib/nlu_adapter/parse_helper.rb
 - lib/nlu_adapter/version.rb
+- lib/nlu_adapter/watson_assistant.rb
 - nlu_adapter.gemspec
 homepage: https://rubygems.org/gems/nlu_adapter
 licenses: