feat(AssistantV2): add support for stateless messages

Author: mamoonraja

Scripts/Services/Assistant/V2/AssistantService.cs

@@ -242,9 +242,10 @@ private void OnDeleteSessionResponse(RESTConnector.Request req, RESTConnector.Re
                 ((RequestObject<object>)req).Callback(response, resp.Error);
         }
         /// <summary>
-        /// Send user input to assistant.
+        /// Send user input to assistant (stateful).
         ///
-        /// Send user input to an assistant and receive a response.
+        /// Send user input to an assistant and receive a response, with conversation state (including context data)
+        /// stored by Watson Assistant for the duration of the session.
         ///
         /// There is no rate limit for this operation.
         /// </summary>
@@ -257,9 +258,12 @@ private void OnDeleteSessionResponse(RESTConnector.Request req, RESTConnector.Re
         /// **Note:** Currently, the v2 API does not support creating assistants.</param>
         /// <param name="sessionId">Unique identifier of the session.</param>
         /// <param name="input">An input object that includes the input text. (optional)</param>
-        /// <param name="context">State information for the conversation. The context is stored by the assistant on a
-        /// per-session basis. You can use this property to set or modify context variables, which can also be accessed
-        /// by dialog nodes. (optional)</param>
+        /// <param name="context">Context data for the conversation. You can use this property to set or modify context
+        /// variables, which can also be accessed by dialog nodes. The context is stored by the assistant on a
+        /// per-session basis.
+        ///
+        /// **Note:** The total size of the context data stored for a stateful session cannot exceed 100KB.
+        /// (optional)</param>
         /// <returns><see cref="MessageResponse" />MessageResponse</returns>
         public bool Message(Callback<MessageResponse> callback, string assistantId, string sessionId, MessageInput input = null, MessageContext context = null)
         {
@@ -332,5 +336,96 @@ private void OnMessageResponse(RESTConnector.Request req, RESTConnector.Response
             if (((RequestObject<MessageResponse>)req).Callback != null)
                 ((RequestObject<MessageResponse>)req).Callback(response, resp.Error);
         }
+        /// <summary>
+        /// Send user input to assistant (stateless).
+        ///
+        /// Send user input to an assistant and receive a response, with conversation state (including context data)
+        /// managed by your application.
+        ///
+        /// There is no rate limit for this operation.
+        /// </summary>
+        /// <param name="callback">The callback function that is invoked when the operation completes.</param>
+        /// <param name="assistantId">Unique identifier of the assistant. To find the assistant ID in the Watson
+        /// Assistant user interface, open the assistant settings and click **API Details**. For information about
+        /// creating assistants, see the
+        /// [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-assistant-add#assistant-add-task).
+        ///
+        /// **Note:** Currently, the v2 API does not support creating assistants.</param>
+        /// <param name="input">An input object that includes the input text. (optional)</param>
+        /// <param name="context">Context data for the conversation. You can use this property to set or modify context
+        /// variables, which can also be accessed by dialog nodes. The context is not stored by the assistant. To
+        /// maintain session state, include the context from the previous response.
+        ///
+        /// **Note:** The total size of the context data for a stateless session cannot exceed 250KB. (optional)</param>
+        /// <returns><see cref="MessageResponseStateless" />MessageResponseStateless</returns>
+        public bool MessageStateless(Callback<MessageResponseStateless> callback, string assistantId, MessageInputStateless input = null, MessageContextStateless context = null)
+        {
+            if (callback == null)
+                throw new ArgumentNullException("`callback` is required for `MessageStateless`");
+            if (string.IsNullOrEmpty(assistantId))
+                throw new ArgumentNullException("`assistantId` is required for `MessageStateless`");
+
+            RequestObject<MessageResponseStateless> req = new RequestObject<MessageResponseStateless>
+            {
+                Callback = callback,
+                HttpMethod = UnityWebRequest.kHttpVerbPOST,
+                DisableSslVerification = DisableSslVerification
+            };
+
+            foreach (KeyValuePair<string, string> kvp in customRequestHeaders)
+            {
+                req.Headers.Add(kvp.Key, kvp.Value);
+            }
+
+            ClearCustomRequestHeaders();
+
+            foreach (KeyValuePair<string, string> kvp in Common.GetSdkHeaders("conversation", "V2", "MessageStateless"))
+            {
+                req.Headers.Add(kvp.Key, kvp.Value);
+            }
+
+            req.Parameters["version"] = VersionDate;
+            req.Headers["Content-Type"] = "application/json";
+            req.Headers["Accept"] = "application/json";
+
+            JObject bodyObject = new JObject();
+            if (input != null)
+                bodyObject["input"] = JToken.FromObject(input);
+            if (context != null)
+                bodyObject["context"] = JToken.FromObject(context);
+            req.Send = Encoding.UTF8.GetBytes(JsonConvert.SerializeObject(bodyObject));
+
+            req.OnResponse = OnMessageStatelessResponse;
+
+            Connector.URL = GetServiceUrl() + string.Format("/v2/assistants/{0}/message", assistantId);
+            Authenticator.Authenticate(Connector);
+
+            return Connector.Send(req);
+        }
+
+        private void OnMessageStatelessResponse(RESTConnector.Request req, RESTConnector.Response resp)
+        {
+            DetailedResponse<MessageResponseStateless> response = new DetailedResponse<MessageResponseStateless>();
+            foreach (KeyValuePair<string, string> kvp in resp.Headers)
+            {
+                response.Headers.Add(kvp.Key, kvp.Value);
+            }
+            response.StatusCode = resp.HttpResponseCode;
+
+            try
+            {
+                string json = Encoding.UTF8.GetString(resp.Data);
+                response.Result = JsonConvert.DeserializeObject<MessageResponseStateless>(json);
+                response.Response = json;
+            }
+            catch (Exception e)
+            {
+                Log.Error("AssistantService.OnMessageStatelessResponse()", "Exception: {0}", e.ToString());
+                resp.Success = false;
+            }
+
+            if (((RequestObject<MessageResponseStateless>)req).Callback != null)
+                ((RequestObject<MessageResponseStateless>)req).Callback(response, resp.Error);
+        }
     }
 }

Scripts/Services/Assistant/V2/Model/MessageContext.cs

@@ -25,15 +25,15 @@ namespace IBM.Watson.Assistant.V2.Model
     public class MessageContext
     {
         /// <summary>
-        /// Information that is shared by all skills used by the Assistant.
+        /// Session context data that is shared by all skills used by the Assistant.
         /// </summary>
         [JsonProperty("global", NullValueHandling = NullValueHandling.Ignore)]
         public MessageContextGlobal Global { get; set; }
         /// <summary>
-        /// Information specific to particular skills used by the Assistant.
+        /// Information specific to particular skills used by the assistant.
         ///
-        /// **Note:** Currently, only a single property named `main skill` is supported. This object contains variables
-        /// that apply to the dialog skill used by the assistant.
+        /// **Note:** Currently, only a single child property is supported, containing variables that apply to the
+        /// dialog skill used by the assistant.
         /// </summary>
         [JsonProperty("skills", NullValueHandling = NullValueHandling.Ignore)]
         public MessageContextSkills Skills { get; set; }

Scripts/Services/Assistant/V2/Model/MessageContextGlobal.cs

@@ -20,7 +20,7 @@
 namespace IBM.Watson.Assistant.V2.Model
 {
     /// <summary>
-    /// Information that is shared by all skills used by the Assistant.
+    /// Session context data that is shared by all skills used by the Assistant.
     /// </summary>
     public class MessageContextGlobal
     {
@@ -29,5 +29,10 @@ public class MessageContextGlobal
         /// </summary>
         [JsonProperty("system", NullValueHandling = NullValueHandling.Ignore)]
         public MessageContextGlobalSystem System { get; set; }
+        /// <summary>
+        /// The session ID.
+        /// </summary>
+        [JsonProperty("session_id", NullValueHandling = NullValueHandling.Ignore)]
+        public virtual string SessionId { get; private set; }
     }
 }

Scripts/Services/Assistant/V2/Model/MessageContextGlobalStateless.cs

@@ -0,0 +1,38 @@
+/**
+* Copyright 2018, 2019 IBM Corp. All Rights Reserved.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*      http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*
+*/
+
+using Newtonsoft.Json;
+
+namespace IBM.Watson.Assistant.V2.Model
+{
+    /// <summary>
+    /// Session context data that is shared by all skills used by the Assistant.
+    /// </summary>
+    public class MessageContextGlobalStateless
+    {
+        /// <summary>
+        /// Built-in system properties that apply to all skills used by the assistant.
+        /// </summary>
+        [JsonProperty("system", NullValueHandling = NullValueHandling.Ignore)]
+        public MessageContextGlobalSystem System { get; set; }
+        /// <summary>
+        /// The unique identifier of the session.
+        /// </summary>
+        [JsonProperty("session_id", NullValueHandling = NullValueHandling.Ignore)]
+        public string SessionId { get; set; }
+    }
+}

Scripts/Services/Assistant/V2/Model/MessageContextGlobalStateless.cs.meta

@@ -21,7 +21,8 @@
 namespace IBM.Watson.Assistant.V2.Model
 {
     /// <summary>
-    /// Contains information specific to a particular skill used by the Assistant.
+    /// Contains information specific to a particular skill used by the Assistant. The property name must be the same as
+    /// the name of the skill (for example, `main skill`).
     /// </summary>
     public class MessageContextSkill
     {

Scripts/Services/Assistant/V2/Model/MessageContextSkill.cs

@@ -0,0 +1,37 @@
+/**
+* Copyright 2018, 2019 IBM Corp. All Rights Reserved.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*      http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*
+*/
+
+using IBM.Cloud.SDK.Model;
+using Newtonsoft.Json;
+
+namespace IBM.Watson.Assistant.V2.Model
+{
+    /// <summary>
+    /// System context data used by the skill.
+    /// </summary>
+    public class MessageContextSkillSystem: DynamicModel<object>
+    {
+        /// <summary>
+        /// An encoded string representing the current conversation state. By saving this value and then sending it in
+        /// the context of a subsequent message request, you can restore the conversation to the same state. This can be
+        /// useful if you need to return to an earlier point in the conversation. If you are using stateful sessions,
+        /// you can also use a stored state value to restore a paused conversation whose session has expired.
+        /// </summary>
+        [JsonProperty("state", NullValueHandling = NullValueHandling.Ignore)]
+        public string State { get; set; }
+    }
+}

Scripts/Services/Assistant/V2/Model/MessageContextSkillSystem.cs

@@ -20,10 +20,10 @@
 namespace IBM.Watson.Assistant.V2.Model
 {
     /// <summary>
-    /// Information specific to particular skills used by the Assistant.
+    /// Information specific to particular skills used by the assistant.
     ///
-    /// **Note:** Currently, only a single property named `main skill` is supported. This object contains variables that
-    /// apply to the dialog skill used by the assistant.
+    /// **Note:** Currently, only a single child property is supported, containing variables that apply to the dialog
+    /// skill used by the assistant.
     /// </summary>
     public class MessageContextSkills: DynamicModel<MessageContextSkill>
     {

Scripts/Services/Assistant/V2/Model/MessageContextSkillSystem.cs.meta

@@ -0,0 +1,41 @@
+/**
+* Copyright 2018, 2019 IBM Corp. All Rights Reserved.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*      http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*
+*/
+
+using Newtonsoft.Json;
+
+namespace IBM.Watson.Assistant.V2.Model
+{
+    /// <summary>
+    /// MessageContextStateless.
+    /// </summary>
+    public class MessageContextStateless
+    {
+        /// <summary>
+        /// Session context data that is shared by all skills used by the Assistant.
+        /// </summary>
+        [JsonProperty("global", NullValueHandling = NullValueHandling.Ignore)]
+        public MessageContextGlobalStateless Global { get; set; }
+        /// <summary>
+        /// Information specific to particular skills used by the assistant.
+        ///
+        /// **Note:** Currently, only a single child property is supported, containing variables that apply to the
+        /// dialog skill used by the assistant.
+        /// </summary>
+        [JsonProperty("skills", NullValueHandling = NullValueHandling.Ignore)]
+        public MessageContextSkills Skills { get; set; }
+    }
+}

Scripts/Services/Assistant/V2/Model/MessageContextSkills.cs

@@ -49,11 +49,6 @@ public class MessageTypeValue
         [JsonProperty("text", NullValueHandling = NullValueHandling.Ignore)]
         public string Text { get; set; }
         /// <summary>
-        /// Optional properties that control how the assistant responds.
-        /// </summary>
-        [JsonProperty("options", NullValueHandling = NullValueHandling.Ignore)]
-        public MessageInputOptions Options { get; set; }
-        /// <summary>
         /// Intents to use when evaluating the user input. Include intents from the previous response to continue using
         /// those intents rather than trying to recognize intents in the new input.
         /// </summary>
@@ -70,5 +65,10 @@ public class MessageTypeValue
         /// </summary>
         [JsonProperty("suggestion_id", NullValueHandling = NullValueHandling.Ignore)]
         public string SuggestionId { get; set; }
+        /// <summary>
+        /// Optional properties that control how the assistant responds.
+        /// </summary>
+        [JsonProperty("options", NullValueHandling = NullValueHandling.Ignore)]
+        public MessageInputOptions Options { get; set; }
     }
 }