watson-client 0.0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 75eb37d001cf07bb49a4719cd6ef33760dd51ef7
-  data.tar.gz: f23f072ec1f00124c73618f1eabd1a775b53997e
+  metadata.gz: 708f63fa2b0fc8d8401632cba3851fcea62ec86e
+  data.tar.gz: c939cdec985dbb758214bdd07c9db71c5c3cb9f1
 SHA512:
-  metadata.gz: bf10d1598cf074e77b59cb8ee78eaf9f9f42f50917d428ae5be724b336fce03bf6763c37d569c8fdee7203301b04038a1591e29e518c043139bde440e9b974d2
-  data.tar.gz: 9402bdc34541986e5070c79b6881a5634582a46f08e1da434fcc9fbcd5cb4a75a743933e88ca4d82dd780282f88c92435b9b4771011990efeb70f708363d9209
+  metadata.gz: 17d81c47cd0818d1f5a122ca2977be8f5cbad8bb9302e217bbca69b3901d0506d11021cc1a5b7ffcebbdb2b62215ef935cccf98fdf2d596d21aff0af36d381e4
+  data.tar.gz: 6dedc5fe97f496b03616d8c149b2458f8b1a670c9dc4281c994a8fd08c4c64d899f7b11497c8457d624c4b89fd55db96775be7e1d223309bc69881663c0da7b5

data/README.md

@@ -18,7 +18,7 @@ Watson::Conversation.configure(
 **Example:**
 A simple response from your dialog model
 ```ruby
-require 'watson-client'
+require 'watson'
 
 client = Watson::Conversation.new
 client.send_message('message one')
@@ -29,7 +29,7 @@ client.send_message('message two')
 
 Try something different
 ```ruby
-require 'watson-client'
+require 'watson'
 
 puts 'Say Hi!'
 user_input = nil
@@ -37,7 +37,8 @@ until user_input == 'q' || user_input == 'exit'
   print '> '
   user_input = gets.chomp
   return if user_input == 'q' || user_input == 'exit'
-  client.send_message(user_input)
+  r = client.send_message(user_input)
+  puts r
   sleep 0.5
 end
 ```
@@ -59,3 +60,21 @@ responses = Watson::RetrieveAndRank.send_message('message')
 ```
 
 The response is returned as a JSON array.
+
+### Conversation Enhanced
+Combination of Conversation API and Retrieve & Rank API. In order to get this class working you need to set both both configurations variables.
+If the `Conversation` class detects an unknown message, we call `RetrieveAndRank` with the intent name of that unknown message, so we need to set that intent name in the constructor of `ConversationEnhanced` class.
+
+```ruby
+client = Watson::ConversationEnhanced.new('INTENT_NAME')
+user_input = nil
+until user_input == 'q' || user_input == 'exit'
+  print '> '
+  user_input = gets.chomp
+  return if user_input == 'q' || user_input == 'exit'
+  r = client.send_message(user_input)
+  puts r
+  sleep 0.5
+end
+
+```

data/lib/watson/conversation.rb

@@ -12,9 +12,10 @@ module Watson
     end
 
     def send_message(message = '')
-      params = { input: { text: message }, alternate_intents: true }
+      return if message.empty?
+      @message = message
+      params = { input: { text: @message }, alternate_intents: true }
       params.merge!(@context) unless @context.nil?
-
       response = Excon.post(url,
                             body:     params.to_json,
                             headers:  {
@@ -24,9 +25,13 @@ module Watson
                             user:      @@username,
                             password:  @@password)
       result = JSON.parse(response.body)
-
       @context = { context: result['context'] }
-      puts result['output']['text']
+      build_response(result)
+    end
+
+    def build_response(result)
+      { source: 'conversation', intent: result['intents'][0]['intent'],
+        message: @message, tittle: @message, body: result['output']['text'] }
     end
 
     def url

data/lib/watson/conversation_enhanced.rb

@@ -0,0 +1,26 @@
+module Watson
+  class ConversationEnhanced < Conversation
+
+    def initialize(intent = '')
+      @intent = intent
+    end
+
+    def send_message(message = '')
+      return if message.empty?
+      response = super
+      if must_retrieve?(response[:intent])
+        retrieve_and_rank(message)
+      else
+        response
+      end
+    end
+
+    def must_retrieve?(result)
+      result == @intent
+    end
+
+    def retrieve_and_rank(message)
+      RetrieveAndRank.send_message(message)
+    end
+  end
+end

data/lib/watson/retrieve_and_rank.rb

@@ -9,7 +9,9 @@ module Watson
     end
 
     def self.send_message(message = '')
-      query = URI.encode(message)
+      return if message.empty?
+      @message = message
+      query = URI.encode(@message)
       response = Excon.post(url(query),
                             headers: {
                               'Content-Type' => 'application/json',
@@ -22,7 +24,10 @@ module Watson
     end
 
     def self.answers(data)
-      data.each { |d| puts d['body'] }
+      data.collect do |d|
+        { source: 'retrieveandrank', intent: '',
+          message: @message, tittle: d['title'], body: d['body'] }
+      end
     end
 
     def self.url(query)

data/lib/watson.rb

@@ -3,3 +3,4 @@ require 'json'
 require 'uri'
 require_relative '../lib/watson/conversation'
 require_relative '../lib/watson/retrieve_and_rank'
+require_relative '../lib/watson/conversation_enhanced'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: watson-client
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors:
 - Carlos Andres Torres Cruz
@@ -24,7 +24,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Send and receive messages to Conversation or Retrieve and Rank services
+description: REST API client for IBM Watson™ services, Conversation, Retrieve & Rank,
+  Conversation enhanced services are available
 email: carlosandrestorres28@gmail.com
 executables: []
 extensions: []
@@ -32,8 +33,8 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/watson.rb
-- lib/watson/cluster.rb
 - lib/watson/conversation.rb
+- lib/watson/conversation_enhanced.rb
 - lib/watson/retrieve_and_rank.rb
 homepage: https://github.com/katorres02/w-ruby
 licenses:

data/lib/watson/cluster.rb

@@ -1,13 +0,0 @@
-module Watson
-  class Cluster
-    attr_reader :solr_cluster_id, :cluster_name, :cluster_size,
-                :solr_cluster_status
-
-    def initialize(options = {})
-      @solr_cluster_id     = options['solr_cluster_id']
-      @cluster_name        = options['cluster_name']
-      @cluster_size        = options['cluster_size']
-      @solr_cluster_status = options['solr_cluster_status']
-    end
-  end
-end