Merge pull request #366 from watson-developer-cloud/rc-2.2.1

Watson Unity SDK v2.2.1

Author: mediumTaj

CHANGELOG.md

@@ -1,5 +1,9 @@
 Change Log
 ==========
+## Version 2.2.1
+_2018-04-12_
+* Fixed: Serialization/Deserialization of generic object in the `assistant` service([361](https://github.com/watson-developer-cloud/unity-sdk/issues/361), [363](https://github.com/watson-developer-cloud/unity-sdk/pull/363)).
+
 ## Version 2.2.0
 _2018-04-09_
 * New: Updated Visual Recognition with Core ML support ([4182](https://zenhub.innovate.ibm.com/app/workspace/o/watson/developer-experience/issues/4182), [357](https://github.com/watson-developer-cloud/unity-sdk/pull/357)).

Doxyfile

@@ -38,7 +38,7 @@ PROJECT_NAME           = "Watson Developer Cloud Unity SDK"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 2.2.0
+PROJECT_NUMBER         = 2.2.1
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

Examples/ServiceExamples/Scripts/ExampleAssistant.cs

@@ -46,7 +46,10 @@ public class ExampleAssistant : MonoBehaviour
 
     private fsSerializer _serializer = new fsSerializer();
 
-    private string _inputString = "Turn on the winshield wipers";
+    private string _inputString = "Hello";
+    private string _conversationString0 = "unlock the door";
+    private string _conversationString1 = "turn on the ac";
+    private string _conversationString2 = "turn down the radio";
 
     private static string _createdWorkspaceName = "unity-sdk-example-workspace-delete";
     private static string _createdWorkspaceDescription = "A Workspace created by the Unity SDK Assistant example script. Please delete this.";
@@ -61,6 +64,7 @@ public class ExampleAssistant : MonoBehaviour
     private static string _createdExample = "untiyExample";
     private static string _dialogNodeName = "untiyDialognode";
     private static string _dialogNodeDesc = "Unity SDK Integration test dialog node";
+    private Dictionary<string, object> _context = null;
 
     private bool _listWorkspacesTested = false;
     private bool _createWorkspaceTested = false;
@@ -109,53 +113,6 @@ public class ExampleAssistant : MonoBehaviour
     void Start()
     {
         LogSystem.InstallDefaultReactors();
-        
-        Runnable.Run(GetCredentials());
-    }
-
-    private IEnumerator GetCredentials()
-    {
-        //Credentials credentials = new Credentials(_username, _password, _url);
-
-        #region Get Credentials via internal service
-        VcapCredentials vcapCredentials = new VcapCredentials();
-        fsData data = null;
-
-        string result = null;
-
-        var vcapUrl = Environment.GetEnvironmentVariable("VCAP_URL");
-        var vcapUsername = Environment.GetEnvironmentVariable("VCAP_USERNAME");
-        var vcapPassword = Environment.GetEnvironmentVariable("VCAP_PASSWORD");
-
-        using (SimpleGet simpleGet = new SimpleGet(vcapUrl, vcapUsername, vcapPassword))
-        {
-            while (!simpleGet.IsComplete)
-                yield return null;
-
-            result = simpleGet.Result;
-        }
-
-        //  Add in a parent object because Unity does not like to deserialize root level collection types.
-        result = Utility.AddTopLevelObjectToJson(result, "VCAP_SERVICES");
-
-        //  Convert json to fsResult
-        fsResult r = fsJsonParser.Parse(result, out data);
-        if (!r.Succeeded)
-            throw new WatsonException(r.FormattedMessages);
-
-        //  Convert fsResult to VcapCredentials
-        object obj = vcapCredentials;
-        r = _serializer.TryDeserialize(data, obj.GetType(), ref obj);
-        if (!r.Succeeded)
-            throw new WatsonException(r.FormattedMessages);
-
-        //  Set credentials from imported credntials
-        Credential credential = vcapCredentials.VCAP_SERVICES["conversation"];
-        _username = credential.Username.ToString();
-        _password = credential.Password.ToString();
-        _url = credential.Url.ToString();
-        //_workspaceId = credential.WorkspaceId.ToString();
-        #endregion
 
         //  Create credential and instantiate service
         Credentials credentials = new Credentials(_username, _password, _url);
@@ -203,10 +160,42 @@ private IEnumerator Examples()
         input.Add("text", _inputString);
         MessageRequest messageRequest = new MessageRequest()
         {
-            Input = input,
-            AlternateIntents = true
+            Input = input
         };
         _service.Message(OnMessage, OnFail, _workspaceId, messageRequest);
+        while (!_messageTested)
+            yield return null;
+        _messageTested = false;
+
+        input["text"] = _conversationString0;
+        MessageRequest messageRequest0 = new MessageRequest()
+        {
+            Input = input,
+            Context = _context
+        };
+        _service.Message(OnMessage, OnFail, _workspaceId, messageRequest0);
+        while (!_messageTested)
+            yield return null;
+        _messageTested = false;
+
+        input["text"] = _conversationString1;
+        MessageRequest messageRequest1 = new MessageRequest()
+        {
+            Input = input,
+            Context = _context
+        };
+        _service.Message(OnMessage, OnFail, _workspaceId, messageRequest1);
+        while (!_messageTested)
+            yield return null;
+        _messageTested = false;
+
+        input["text"] = _conversationString2;
+        MessageRequest messageRequest2 = new MessageRequest()
+        {
+            Input = input,
+            Context = _context
+        };
+        _service.Message(OnMessage, OnFail, _workspaceId, messageRequest2);
         while (!_messageTested)
             yield return null;
 
@@ -677,9 +666,40 @@ private void OnListIntents(IntentCollection response, Dictionary<string, object>
         _listIntentsTested = true;
     }
 
-    private void OnMessage(MessageResponse response, Dictionary<string, object> customData)
+    private void OnMessage(object response, Dictionary<string, object> customData)
     {
         Log.Debug("ExampleAssistant.OnMessage()", "Response: {0}", customData["json"].ToString());
+
+        //  Convert resp to fsdata
+        fsData fsdata = null;
+        fsResult r = _serializer.TrySerialize(response.GetType(), response, out fsdata);
+        if (!r.Succeeded)
+            throw new WatsonException(r.FormattedMessages);
+
+        //  Convert fsdata to MessageResponse
+        MessageResponse messageResponse = new MessageResponse();
+        object obj = messageResponse;
+        r = _serializer.TryDeserialize(fsdata, obj.GetType(), ref obj);
+        if (!r.Succeeded)
+            throw new WatsonException(r.FormattedMessages);
+
+        //  Set context for next round of messaging
+        object _tempContext = null;
+        (response as Dictionary<string, object>).TryGetValue("context", out _tempContext);
+
+        if (_tempContext != null)
+            _context = _tempContext as Dictionary<string, object>;
+        else
+            Log.Debug("ExampleConversation.OnMessage()", "Failed to get context");
+
+        //  Get intent
+        object tempIntentsObj = null;
+        (response as Dictionary<string, object>).TryGetValue("intents", out tempIntentsObj);
+        object tempIntentObj = (tempIntentsObj as List<object>)[0];
+        object tempIntent = null;
+        (tempIntentObj as Dictionary<string, object>).TryGetValue("intent", out tempIntent);
+        string intent = tempIntent.ToString();
+
         _messageTested = true;
     }
 

Scripts/Services/Assistant/v1/Assistant.cs

@@ -22,6 +22,7 @@
 using IBM.Watson.DeveloperCloud.Logging;
 using IBM.Watson.DeveloperCloud.Utilities;
 using System;
+using MiniJSON;
 
 namespace IBM.Watson.DeveloperCloud.Services.Assistant.v1
 {
@@ -108,24 +109,47 @@ public Assistant(Credentials credentials)
         /// <param name="workspaceId">Unique identifier of the workspace.</param>
         /// <param name="request">The message to be sent. This includes the user's input, along with optional intents, entities, and context from the last response. (optional)</param>
         /// <param name="nodesVisitedDetails">Whether to include additional diagnostic information about the dialog nodes that were visited during processing of the message. (optional, default to false)</param>
-        /// <returns><see cref="MessageResponse" />MessageResponse</returns>
         /// <param name="customData">A Dictionary<string, object> of data that will be passed to the callback. The raw json output from the REST call will be passed in this object as the value of the 'json' key.</string></param>
-        public bool Message(SuccessCallback<MessageResponse> successCallback, FailCallback failCallback, string workspaceId, MessageRequest request = null, bool? nodesVisitedDetails = null, Dictionary<string, object> customData = null)
+        public bool Message(SuccessCallback<object> successCallback, FailCallback failCallback, string workspaceId, MessageRequest request = null, bool? nodesVisitedDetails = null, Dictionary<string, object> customData = null)
         {
             if (successCallback == null)
                 throw new ArgumentNullException("successCallback");
             if (failCallback == null)
                 throw new ArgumentNullException("failCallback");
 
+            IDictionary<string, string> requestDict = new Dictionary<string, string>();
+            if (request.Context != null)
+                requestDict.Add("context", Json.Serialize(request.Context));
+            if (request.Input != null)
+                requestDict.Add("input", Json.Serialize(request.Input));
+            if(request.AlternateIntents != null)
+                requestDict.Add("alternate_intents", Json.Serialize(request.AlternateIntents));
+            if (request.Entities != null)
+                requestDict.Add("entities", Json.Serialize(request.Entities));
+            if (request.Intents != null)
+                requestDict.Add("intents", Json.Serialize(request.Intents));
+            if (request.Output != null)
+                requestDict.Add("output", Json.Serialize(request.Output));
+
+            int iterator = 0;
+            StringBuilder stringBuilder = new StringBuilder("{");
+            foreach (KeyValuePair<string, string> property in requestDict)
+            {
+                string delimeter = iterator < requestDict.Count - 1 ? "," : "";
+                stringBuilder.Append(string.Format("\"{0}\": {1}{2}", property.Key, property.Value, delimeter));
+                iterator++;
+            }
+            stringBuilder.Append("}");
+
+            string stringToSend = stringBuilder.ToString();
+
             MessageRequestObj req = new MessageRequestObj();
             req.SuccessCallback = successCallback;
             req.FailCallback = failCallback;
             req.CustomData = customData == null ? new Dictionary<string, object>() : customData;
             req.Parameters["version"] = VersionDate;
             req.Headers["Content-Type"] = "application/json";
-            fsData data = null;
-            _serializer.TrySerialize(request.Input, out data);
-            req.Send = Encoding.UTF8.GetBytes(data.ToString());
+            req.Send = Encoding.UTF8.GetBytes(stringToSend);
             req.OnResponse = OnMessageResponse;
 
             RESTConnector connector = RESTConnector.GetConnector(Credentials, string.Format("/v1/workspaces/{0}/message", workspaceId));
@@ -140,7 +164,7 @@ private class MessageRequestObj : RESTConnector.Request
             /// <summary>
             /// The success callback.
             /// </summary>
-            public SuccessCallback<MessageResponse> SuccessCallback { get; set; }
+            public SuccessCallback<object> SuccessCallback { get; set; }
             /// <summary>
             /// The fail callback.
             /// </summary>
@@ -153,23 +177,17 @@ private class MessageRequestObj : RESTConnector.Request
 
         private void OnMessageResponse(RESTConnector.Request req, RESTConnector.Response resp)
         {
-            MessageResponse result = new MessageResponse();
-            fsData data = null;
+            object result = null;
+            string data = "";
             Dictionary<string, object> customData = ((MessageRequestObj)req).CustomData;
 
             if (resp.Success)
             {
                 try
                 {
-                    fsResult r = fsJsonParser.Parse(Encoding.UTF8.GetString(resp.Data), out data);
-                    if (!r.Succeeded)
-                        throw new WatsonException(r.FormattedMessages);
-
-                    object obj = result;
-                    r = _serializer.TryDeserialize(data, obj.GetType(), ref obj);
-                    if (!r.Succeeded)
-                        throw new WatsonException(r.FormattedMessages);
-
+                    //  For deserializing into a generic object
+                    data = Encoding.UTF8.GetString(resp.Data);
+                    result = Json.Deserialize(data);
                     customData.Add("json", data);
                 }
                 catch (Exception e)

Scripts/Services/Assistant/v1/IAssistant.cs

@@ -37,7 +37,7 @@ namespace IBM.Watson.DeveloperCloud.Services.Assistant.v1
 
     public interface IAssistant
     {
-        bool Message(SuccessCallback<MessageResponse> successCallback, FailCallback failCallback, string workspaceId, MessageRequest request = null, bool? nodesVisitedDetails = null, Dictionary<string, object> customData = null);
+        bool Message(SuccessCallback<object> successCallback, FailCallback failCallback, string workspaceId, MessageRequest request = null, bool? nodesVisitedDetails = null, Dictionary<string, object> customData = null);
         bool CreateWorkspace(SuccessCallback<Workspace> successCallback, FailCallback failCallback, CreateWorkspace properties = null, Dictionary<string, object> customData = null);
 
         bool DeleteWorkspace(SuccessCallback<object> successCallback, FailCallback failCallback, string workspaceId, Dictionary<string, object> customData = null);

Scripts/Services/Assistant/v1/Model/MessageRequest.cs

@@ -31,7 +31,7 @@ public class MessageRequest
         /// </summary>
         /// <value>An input object that includes the input text.</value>
         [fsProperty("input")]
-        public Dictionary<string, object> Input { get; set; }
+        public object Input { get; set; }
         /// <summary>
         /// Whether to return more than one intent. Set to `true` to return all matching intents.
         /// </summary>
@@ -43,7 +43,7 @@ public class MessageRequest
         /// </summary>
         /// <value>State information for the conversation. Continue a conversation by including the context object from the previous response.</value>
         [fsProperty("context")]
-        public Dictionary<string, object> Context { get; set; }
+        public object Context { get; set; }
         /// <summary>
         /// Entities to use when evaluating the message. Include entities from the previous response to continue using those entities rather than detecting entities in the new input.
         /// </summary>

Scripts/Services/Assistant/v1/Model/MessageResponse.cs

@@ -31,37 +31,37 @@ public class MessageResponse
         /// </summary>
         /// <value>The user input from the request.</value>
         [fsProperty("input")]
-        public Dictionary<string, object> Input { get; set; }
+        public object Input { get; set; }
         /// <summary>
         /// An array of intents recognized in the user input, sorted in descending order of confidence.
         /// </summary>
         /// <value>An array of intents recognized in the user input, sorted in descending order of confidence.</value>
         [fsProperty("intents")]
-        public Dictionary<string, object> Intents { get; set; }
+        public object Intents { get; set; }
         /// <summary>
         /// An array of entities identified in the user input.
         /// </summary>
         /// <value>An array of entities identified in the user input.</value>
         [fsProperty("entities")]
-        public Dictionary<string, object> Entities { get; set; }
+        public object Entities { get; set; }
         /// <summary>
         /// Whether to return more than one intent. A value of `true` indicates that all matching intents are returned.
         /// </summary>
         /// <value>Whether to return more than one intent. A value of `true` indicates that all matching intents are returned.</value>
         [fsProperty("alternate_intents")]
-        public Dictionary<string, object> AlternateIntents { get; set; }
+        public object AlternateIntents { get; set; }
         /// <summary>
         /// State information for the conversation.
         /// </summary>
         /// <value>State information for the conversation.</value>
         [fsProperty("context")]
-        public Dictionary<string, object> Context { get; set; }
+        public object Context { get; set; }
         /// <summary>
         /// Output from the dialog, including the response to the user, the nodes that were triggered, and log messages.
         /// </summary>
         /// <value>Output from the dialog, including the response to the user, the nodes that were triggered, and log messages.</value>
         [fsProperty("output")]
-        public Dictionary<string, object> Output { get; set; }
+        public object Output { get; set; }
     }
 
 }