Merge pull request #457 from watson-developer-cloud/5532-update-sdk

5532 update sdk

Author: mediumTaj

Examples/ServiceExamples/Scripts/ExampleAssistantV2.cs

@@ -15,10 +15,8 @@
 *
 */
 
-using System;
 using System.Collections;
 using System.Collections.Generic;
-using FullSerializer;
 using IBM.Watson.DeveloperCloud.Connection;
 using IBM.Watson.DeveloperCloud.Logging;
 using IBM.Watson.DeveloperCloud.Utilities;
@@ -58,8 +56,6 @@ public class ExampleAssistantV2 : MonoBehaviour
 
         private Assistant _service;
 
-        private fsSerializer _serializer = new fsSerializer();
-
         private bool _createSessionTested = false;
         private bool _messageTested = false;
         private bool _deleteSessionTested = false;

Examples/ServiceExamples/Scripts/ExampleVisualRecognition.cs

@@ -88,12 +88,7 @@ void Start()
     private IEnumerator CreateService()
     {
         Credentials credentials = null;
-        if (!string.IsNullOrEmpty(_apikey))
-        {
-            //  Authenticate using apikey
-            credentials = new Credentials(_apikey, _serviceUrl);
-        }
-        else if (!string.IsNullOrEmpty(_iamApikey))
+        if (!string.IsNullOrEmpty(_iamApikey))
         {
             //  Authenticate using iamApikey
             TokenOptions tokenOptions = new TokenOptions()
@@ -110,7 +105,7 @@ private IEnumerator CreateService()
         }
         else
         {
-            throw new WatsonException("Please provide either CF apikey or IAM apikey to authenticate the service.");
+            throw new WatsonException("Please provide IAM apikey to authenticate the service.");
         }
 
         //  Create credential and instantiate service

README.md

@@ -67,9 +67,9 @@ The credentials for each service contain either a `username`, `password` and end
 To get started with the Watson Services in Unity, click on each service below to read through each of their `README.md`'s and their codes.
 * [Assistant V1](/Scripts/Services/Assistant/v1)
 * [Assistant V2](/Scripts/Services/Assistant/v2)
-* [Conversation](/Scripts/Services/Conversation/v1)
+* [Conversation](/Scripts/Services/Conversation/v1) (deprecated - Use Assistant V1 or Assistant V2)
 * [Discovery](/Scripts/Services/Discovery/v1)
-* [Language Translator V2](/Scripts/Services/LanguageTranslator/v2) (deprecated)
+* [Language Translator V2](/Scripts/Services/LanguageTranslator/v2) (deprecated - Use LanguageTranslator V3)
 * [Language Translator V3](/Scripts/Services/LanguageTranslator/v3)
 * [Natural Language Classifier](/Scripts/Services/NaturalLanguageClassifier/v2)
 * [Natural Language Understanding](/Scripts/Services/NaturalLanguageUnderstanding/v1)
@@ -84,7 +84,6 @@ Watson services are migrating to token-based Identity and Access Management (IAM
 
 - With some service instances, you authenticate to the API by using **[IAM](#iam)**.
 - In other instances, you authenticate by providing the **[username and password](#username-and-password)** for the service instance.
-- Visual Recognition uses a form of [API key](#api-key) only with instances created before May 23, 2018. Newer instances of Visual Recognition use [IAM](#iam).
 
 ### Getting credentials
 To find out which authentication to use, view the service credentials. You find the service credentials for authentication the same way for all Watson services:
@@ -179,20 +178,6 @@ void Start()
 }
 ```
 
-### API key
-**Important**: This type of authentication works only with Visual Recognition instances created before May 23, 2018. Newer instances of Visual Recognition use [IAM](#iam).
-```cs
-using IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3;
-using IBM.Watson.DeveloperCloud.Utilities;
-
-void Start()
-{
-    Credentials credentials = new Credentials(<apikey>, <url>);
-    VisualRecognition _visualRecognition = new VisualRecognition(credentials);
-}
-```
-
-
 ## Callbacks
 Success and failure callbacks are required. You can specify the return type in the callback.  
 ```cs

Scripts/Services/Conversation/v1/Conversation.cs

@@ -92,6 +92,7 @@ public Credentials Credentials
         /// Conversation constructor
         /// </summary>
         /// <param name="credentials">The service credentials</param>
+        [Obsolete("Conversation V1 is deprecated and will be removed in the next major release of the SDK. Use Assistant V1 or Assistant V2.")]
         public Conversation(Credentials credentials)
         {
             if (credentials.HasCredentials() || credentials.HasWatsonAuthenticationToken() || credentials.HasIamTokenData())

Scripts/Services/Conversation/v1/README.md

@@ -1,5 +1,7 @@
 # Conversation
 
+**Conversation V1 is deprecated and will be removed in the next major release of the SDK. Use Assistant V1 or Assistant V2.**
+
 With the IBM Watson™ [Conversation][conversation] service, you can create an application that understands natural-language input and uses machine learning to respond to customers in a way that simulates a conversation between humans.
 
 ## Usage

Scripts/Services/Discovery/v1/DataModels.cs

@@ -71,10 +71,20 @@ public class Environment
         /// </summary>
         public bool read_only { get; set; }
         /// <summary>
-        /// Size of the environment. = ['XS', 'S', 'MS', 'M', 'ML', 'L', 'XL', 'XXL', 'XXXL'].
+        /// Size of the environment. = ['LT', 'XS', 'S', 'MS', 'M', 'ML', 'L', 'XL', 'XXL', 'XXXL'].
         /// </summary>
         public SizeEnum? size { get; set; }
         /// <summary>
+        /// The new size requested for this environment. Only returned when the environment *status* is `resizing`.
+        /// 
+        /// *Note:* Querying and indexing can still be performed during an environment upsize.
+        /// </summary>
+        public string requested_size { get; set; }
+        /// <summary>
+        /// Information about Continuous Relevancy Training for this environment.
+        /// </summary>
+        public SearchStatus search_status { get; set; }
+        /// <summary>
         /// Disk and memory usage.
         /// </summary>
         public IndexCapacity index_capacity { get; set; }
@@ -112,6 +122,11 @@ public class CreateEnvironmentRequest
     /// </value>
     public enum SizeEnum
     {
+        /// <summary>
+        /// Enum LT for LT
+        /// </summary>
+        [EnumMember(Value = "LT")]
+        LT,
 
         /// <summary>
         /// Enum XS for XS

Scripts/Services/Discovery/v1/Discovery.cs

@@ -2612,12 +2612,20 @@ private void OnUpdateDocumentResponse(RESTConnector.Request req, RESTConnector.R
         /// <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 FederatedQuery(SuccessCallback<QueryResponse> successCallback, FailCallback failCallback, string environmentId, List<string> collectionIds, string filter = null, string query = null, string naturalLanguageQuery = null, string aggregation = null, long? count = null, List<string> returnFields = null, long? offset = null, List<string> sort = null, bool? highlight = null, bool? deduplicate = null, string deduplicateField = null, bool? similar = null, List<string> similarDocumentIds = null, List<string> similarFields = null, bool? passages = null, List<string> passagesFields = null, long? passagesCount = null, long? passagesCharacters = null, Dictionary<string, object> customData = null)
+        public bool FederatedQuery(SuccessCallback<QueryResponse> successCallback, FailCallback failCallback, string environmentId, List<string> collectionIds, string filter = null, string query = null, string naturalLanguageQuery = null, string aggregation = null, long? count = null, List<string> returnFields = null, long? offset = null, List<string> sort = null, bool? highlight = null, bool? deduplicate = null, string deduplicateField = null, bool? similar = null, List<string> similarDocumentIds = null, List<string> similarFields = null, bool? passages = null, List<string> passagesFields = null, long? passagesCount = null, long? passagesCharacters = null, string bias = null, string loggingOptOut = null, Dictionary<string, object> customData = null)
         {
             if (successCallback == null)
                 throw new ArgumentNullException("successCallback");
             if (failCallback == null)
                 throw new ArgumentNullException("failCallback");
+            if (string.IsNullOrEmpty(environmentId))
+            {
+                throw new ArgumentNullException("environmentId");
+            }
+            if(collectionIds == null || collectionIds.Count < 1)
+            {
+                throw new ArgumentNullException("collectionId");
+            }
 
             FederatedQueryRequestObj req = new FederatedQueryRequestObj();
             req.SuccessCallback = successCallback;
@@ -2631,44 +2639,41 @@ public bool FederatedQuery(SuccessCallback<QueryResponse> successCallback, FailC
                 }
             }
             req.Parameters["version"] = VersionDate;
-            if (collectionIds != null)
-                req.Parameters["collection_ids"] = collectionIds != null && collectionIds.Count > 0 ? string.Join(",", collectionIds.ToArray()) : null;
-            if (!string.IsNullOrEmpty(filter))
-                req.Parameters["filter"] = filter;
-            if (!string.IsNullOrEmpty(query))
-                req.Parameters["query"] = query;
-            if (!string.IsNullOrEmpty(naturalLanguageQuery))
-                req.Parameters["natural_language_query"] = naturalLanguageQuery;
-            if (!string.IsNullOrEmpty(aggregation))
-                req.Parameters["aggregation"] = aggregation;
-            if (count != null)
-                req.Parameters["count"] = count;
-            if (returnFields != null)
-                req.Parameters["return"] = returnFields != null && returnFields.Count > 0 ? string.Join(",", returnFields.ToArray()) : null;
-            if (offset != null)
-                req.Parameters["offset"] = offset;
-            if (sort != null)
-                req.Parameters["sort"] = sort != null && sort.Count > 0 ? string.Join(",", sort.ToArray()) : null;
-            if (highlight != null)
-                req.Parameters["highlight"] = highlight;
-            if (deduplicate != null)
-                req.Parameters["deduplicate"] = deduplicate;
-            if (!string.IsNullOrEmpty(deduplicateField))
-                req.Parameters["deduplicate.field"] = deduplicateField;
-            if (similar != null)
-                req.Parameters["similar"] = similar;
-            if (similarDocumentIds != null)
-                req.Parameters["similar.document_ids"] = similarDocumentIds != null && similarDocumentIds.Count > 0 ? string.Join(",", similarDocumentIds.ToArray()) : null;
-            if (similarFields != null)
-                req.Parameters["similar.fields"] = similarFields != null && similarFields.Count > 0 ? string.Join(",", similarFields.ToArray()) : null;
-            if (passages != null)
-                req.Parameters["passages"] = passages;
-            if (passagesFields != null)
-                req.Parameters["passages.fields"] = passagesFields != null && passagesFields.Count > 0 ? string.Join(",", passagesFields.ToArray()) : null;
-            if (passagesCount != null)
-                req.Parameters["passages.count"] = passagesCount;
-            if (passagesCharacters != null)
-                req.Parameters["passages.characters"] = passagesCharacters;
+            if (loggingOptOut != null)
+            {
+                req.Headers.Add("X-Watson-Logging-Opt-Out", loggingOptOut.ToString());
+            }
+            req.Headers["Content-Type"] = "application/json";
+
+            QueryLarge queryLarge = new QueryLarge()
+            {
+                Filter = filter,
+                Query = query,
+                NaturalLanguageQuery = naturalLanguageQuery,
+                Passages = passages,
+                Aggregation = aggregation,
+                Count = count,
+                ReturnFields = (returnFields == null || returnFields.Count < 1) ? null : string.Join(", ", returnFields.ToArray()),
+                Offset = offset,
+                Sort = (sort == null || sort.Count < 1) ? null : string.Join(", ", sort.ToArray()),
+                Highlight = highlight,
+                PassagesFields = (passagesFields == null || passagesFields.Count < 1) ? null : string.Join(", ", passagesFields.ToArray()),
+                PassagesCount = passagesCount,
+                PassagesCharacters = passagesCharacters,
+                Deduplicate = deduplicate,
+                DeduplicateField = deduplicateField,
+                CollectionIds = (collectionIds == null || collectionIds.Count < 1) ? null : string.Join(", ", collectionIds.ToArray()),
+                Similar = similar,
+                SimilarDocumentIds = (similarDocumentIds == null || similarDocumentIds.Count < 1) ? null : string.Join(", ", similarDocumentIds.ToArray()),
+                SimilarFields = (similarFields == null || similarFields.Count < 1) ? null : string.Join(", ", similarFields.ToArray()),
+                Bias = bias
+            };
+
+            fsData data = null;
+            _serializer.TrySerialize(queryLarge, out data);
+            string json = data.ToString().Replace('\"', '"');
+            req.Send = Encoding.UTF8.GetBytes(json);
+
             req.OnResponse = OnFederatedQueryResponse;
 
             RESTConnector connector = RESTConnector.GetConnector(Credentials, string.Format("/v1/environments/{0}/query", environmentId));
@@ -2969,7 +2974,7 @@ private void OnFederatedQueryNoticesResponse(RESTConnector.Request req, RESTConn
         /// <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 Query(SuccessCallback<QueryResponse> successCallback, FailCallback failCallback, string environmentId, string collectionId, string filter = null, string query = null, string naturalLanguageQuery = null, bool? passages = null, string aggregation = null, long? count = null, List<string> returnFields = null, long? offset = null, List<string> sort = null, bool? highlight = null, List<string> passagesFields = null, long? passagesCount = null, long? passagesCharacters = null, bool? deduplicate = null, string deduplicateField = null, bool? similar = null, List<string> similarDocumentIds = null, List<string> similarFields = null, bool? loggingOptOut = null, Dictionary<string, object> customData = null)
+        public bool Query(SuccessCallback<QueryResponse> successCallback, FailCallback failCallback, string environmentId, string collectionId, string filter = null, string query = null, string naturalLanguageQuery = null, bool? passages = null, string aggregation = null, long? count = null, List<string> returnFields = null, long? offset = null, List<string> sort = null, bool? highlight = null, List<string> passagesFields = null, long? passagesCount = null, long? passagesCharacters = null, bool? deduplicate = null, string deduplicateField = null, bool? similar = null, List<string> similarDocumentIds = null, List<string> similarFields = null, string bias = null, bool? loggingOptOut = null, Dictionary<string, object> customData = null)
         {
             if (successCallback == null)
                 throw new ArgumentNullException("successCallback");
@@ -2989,43 +2994,39 @@ public bool Query(SuccessCallback<QueryResponse> successCallback, FailCallback f
             }
             req.Parameters["version"] = VersionDate;
             if (loggingOptOut != null)
-                req.Headers["X-Watson-Logging-Opt-Out"] = loggingOptOut.ToString();
-            if (!string.IsNullOrEmpty(filter))
-                req.Parameters["filter"] = filter;
-            if (!string.IsNullOrEmpty(query))
-                req.Parameters["query"] = query;
-            if (!string.IsNullOrEmpty(naturalLanguageQuery))
-                req.Parameters["natural_language_query"] = naturalLanguageQuery;
-            if (passages != null)
-                req.Parameters["passages"] = passages;
-            if (!string.IsNullOrEmpty(aggregation))
-                req.Parameters["aggregation"] = aggregation;
-            if (count != null)
-                req.Parameters["count"] = count;
-            if (returnFields != null)
-                req.Parameters["return"] = returnFields != null && returnFields.Count > 0 ? string.Join(",", returnFields.ToArray()) : null;
-            if (offset != null)
-                req.Parameters["offset"] = offset;
-            if (sort != null)
-                req.Parameters["sort"] = sort != null && sort.Count > 0 ? string.Join(",", sort.ToArray()) : null;
-            if (highlight != null)
-                req.Parameters["highlight"] = highlight;
-            if (passagesFields != null)
-                req.Parameters["passages.fields"] = passagesFields != null && passagesFields.Count > 0 ? string.Join(",", passagesFields.ToArray()) : null;
-            if (passagesCount != null)
-                req.Parameters["passages.count"] = passagesCount;
-            if (passagesCharacters != null)
-                req.Parameters["passages.characters"] = passagesCharacters;
-            if (deduplicate != null)
-                req.Parameters["deduplicate"] = deduplicate;
-            if (!string.IsNullOrEmpty(deduplicateField))
-                req.Parameters["deduplicate.field"] = deduplicateField;
-            if (similar != null)
-                req.Parameters["similar"] = similar;
-            if(similarDocumentIds != null)
-                req.Parameters["similar.document_ids"] = similarDocumentIds != null && similarDocumentIds.Count > 0 ? string.Join(",", similarDocumentIds.ToArray()) : null;
-            if(similarFields != null)
-                req.Parameters["similar.fields"] = similarFields != null && similarFields.Count > 0 ? string.Join(",", similarFields.ToArray()) : null;
+            {
+                req.Headers.Add("X-Watson-Logging-Opt-Out", loggingOptOut.ToString());
+            }
+            req.Headers["Content-Type"] = "application/json";
+
+            QueryLarge queryLarge = new QueryLarge()
+            {
+                Filter = filter,
+                Query = query,
+                NaturalLanguageQuery = naturalLanguageQuery,
+                Passages = passages,
+                Aggregation = aggregation,
+                Count = count,
+                ReturnFields = (returnFields == null || returnFields.Count < 1) ? null : string.Join(", ", returnFields.ToArray()),
+                Offset = offset,
+                Sort = (sort == null || sort.Count < 1) ? null : string.Join(", ", sort.ToArray()),
+                Highlight = highlight,
+                PassagesFields = (passagesFields == null || passagesFields.Count < 1) ? null : string.Join(", ", passagesFields.ToArray()),
+                PassagesCount = passagesCount,
+                PassagesCharacters = passagesCharacters,
+                Deduplicate = deduplicate,
+                DeduplicateField = deduplicateField,
+                Similar = similar,
+                SimilarDocumentIds = (similarDocumentIds == null || similarDocumentIds.Count < 1) ? null : string.Join(", ", similarDocumentIds.ToArray()),
+                SimilarFields = (similarFields == null || similarFields.Count < 1) ? null : string.Join(", ", similarFields.ToArray()),
+                Bias = bias
+            };
+
+            fsData data = null;
+            _serializer.TrySerialize(queryLarge, out data);
+            string json = data.ToString().Replace('\"', '"');
+            req.Send = Encoding.UTF8.GetBytes(json);
+
             req.OnResponse = OnQueryResponse;
 
             RESTConnector connector = RESTConnector.GetConnector(Credentials, string.Format("/v1/environments/{0}/collections/{1}/query", environmentId, collectionId));