Merge pull request #403 from watson-developer-cloud/4.0.0/regeneration

Regeneration

Author: mediumTaj

src/IBM.Watson.Discovery.v1/DiscoveryService.cs

@@ -2815,13 +2815,13 @@ public DetailedResponse<QueryNoticesResponse> FederatedQueryNotices(string envir
         /// </summary>
         /// <param name="environmentId">The ID of the environment.</param>
         /// <param name="collectionId">The ID of the collection.</param>
+        /// <param name="prefix">The prefix to use for autocompletion. For example, the prefix `Ho` could autocomplete
+        /// to `Hot`, `Housing`, or `How do I upgrade`. Possible completions are.</param>
         /// <param name="field">The field in the result documents that autocompletion suggestions are identified from.
         /// (optional)</param>
-        /// <param name="prefix">The prefix to use for autocompletion. For example, the prefix `Ho` could autocomplete
-        /// to `Hot`, `Housing`, or `How do I upgrade`. Possible completions are. (optional)</param>
         /// <param name="count">The number of autocompletion suggestions to return. (optional)</param>
         /// <returns><see cref="Completions" />Completions</returns>
-        public DetailedResponse<Completions> GetAutocompletion(string environmentId, string collectionId, string field = null, string prefix = null, long? count = null)
+        public DetailedResponse<Completions> GetAutocompletion(string environmentId, string collectionId, string prefix, string field = null, long? count = null)
         {
             if (string.IsNullOrEmpty(environmentId))
             {
@@ -2839,6 +2839,10 @@ public DetailedResponse<Completions> GetAutocompletion(string environmentId, str
             {
                 collectionId = Uri.EscapeDataString(collectionId);
             }
+            if (string.IsNullOrEmpty(prefix))
+            {
+                throw new ArgumentNullException("`prefix` is required for `GetAutocompletion`");
+            }
 
             if (string.IsNullOrEmpty(VersionDate))
             {
@@ -2856,14 +2860,14 @@ public DetailedResponse<Completions> GetAutocompletion(string environmentId, str
 
                 restRequest.WithArgument("version", VersionDate);
                 restRequest.WithHeader("Accept", "application/json");
-                if (!string.IsNullOrEmpty(field))
-                {
-                    restRequest.WithArgument("field", field);
-                }
                 if (!string.IsNullOrEmpty(prefix))
                 {
                     restRequest.WithArgument("prefix", prefix);
                 }
+                if (!string.IsNullOrEmpty(field))
+                {
+                    restRequest.WithArgument("field", field);
+                }
                 if (count != null)
                 {
                     restRequest.WithArgument("count", count);

src/IBM.Watson.Discovery.v1/IDiscoveryService.cs

@@ -59,7 +59,7 @@ public partial interface IDiscoveryService
         DetailedResponse<QueryNoticesResponse> QueryNotices(string environmentId, string collectionId, string filter = null, string query = null, string naturalLanguageQuery = null, bool? passages = null, string aggregation = null, long? count = null, List<string> _return = null, long? offset = null, List<string> sort = null, bool? highlight = null, List<string> passagesFields = null, long? passagesCount = null, long? passagesCharacters = null, string deduplicateField = null, bool? similar = null, List<string> similarDocumentIds = null, List<string> similarFields = null);
         DetailedResponse<QueryResponse> FederatedQuery(string environmentId, string collectionIds, string filter = null, string query = null, string naturalLanguageQuery = null, bool? passages = null, string aggregation = null, long? count = null, string _return = null, long? offset = null, string sort = null, bool? highlight = null, string passagesFields = null, long? passagesCount = null, long? passagesCharacters = null, bool? deduplicate = null, string deduplicateField = null, bool? similar = null, string similarDocumentIds = null, string similarFields = null, string bias = null, bool? xWatsonLoggingOptOut = null);
         DetailedResponse<QueryNoticesResponse> FederatedQueryNotices(string environmentId, List<string> collectionIds, string filter = null, string query = null, string naturalLanguageQuery = null, string aggregation = null, long? count = null, List<string> _return = null, long? offset = null, List<string> sort = null, bool? highlight = null, string deduplicateField = null, bool? similar = null, List<string> similarDocumentIds = null, List<string> similarFields = null);
-        DetailedResponse<Completions> GetAutocompletion(string environmentId, string collectionId, string field = null, string prefix = null, long? count = null);
+        DetailedResponse<Completions> GetAutocompletion(string environmentId, string collectionId, string prefix, string field = null, long? count = null);
         DetailedResponse<TrainingDataSet> ListTrainingData(string environmentId, string collectionId);
         DetailedResponse<TrainingQuery> AddTrainingData(string environmentId, string collectionId, string naturalLanguageQuery = null, string filter = null, List<TrainingExample> examples = null);
         DetailedResponse<object> DeleteAllTrainingData(string environmentId, string collectionId);

src/IBM.Watson.Discovery.v1/Model/QueryResponse.cs

@@ -63,6 +63,11 @@ public class QueryResponse
         /// </summary>
         [JsonProperty("retrieval_details", NullValueHandling = NullValueHandling.Ignore)]
         public RetrievalDetails RetrievalDetails { get; set; }
+        /// <summary>
+        /// The suggestions for a misspelled natural language query.
+        /// </summary>
+        [JsonProperty("suggested_query", NullValueHandling = NullValueHandling.Ignore)]
+        public string SuggestedQuery { get; set; }
     }
 
 }

test/Discovery.v1.IntegrationTests/DiscoveryCpdIntegrationTests.cs

@@ -0,0 +1,70 @@
+/**
+* Copyright 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.Core.Authentication.Bearer;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+
+namespace IBM.Watson.Discovery.v1.IntegrationTests
+{
+    [TestClass]
+    public class DiscoveryCpdIntegrationTests
+    {
+        private DiscoveryService service;
+        private string environmentId;
+        private string collectionId;
+        private string bearerToken;
+        private string serviceUrl;
+
+        [TestInitialize]
+        public void Setup()
+        {
+            BearerTokenAuthenticator authenticator = new BearerTokenAuthenticator(
+                bearerToken: bearerToken
+                );
+            service = new DiscoveryService("2019-10-03", authenticator);
+            service.SetServiceUrl(serviceUrl);
+            service.DisableSslVerification(true);
+
+            var listEnvironmentsResult = service.ListEnvironments();
+
+            environmentId = listEnvironmentsResult.Result.Environments[0].EnvironmentId;
+
+            var listCollectionsResult = service.ListCollections(environmentId: environmentId);
+
+            collectionId = listCollectionsResult.Result.Collections[0].CollectionId;
+        }
+
+        [TestMethod]
+        public void TestAutocompletion()
+        {
+            var autoCompletionResult = service.GetAutocompletion(environmentId: environmentId, collectionId: collectionId, prefix: "ho");
+
+            Assert.IsNotNull(autoCompletionResult.Result);
+            Assert.IsNotNull(autoCompletionResult.Result._Completions);
+            Assert.IsNotNull(autoCompletionResult.Result._Completions[0]);
+        }
+
+        [TestMethod]
+        public void TestSpellingSuggestions()
+        {
+            var queryResult = service.Query(environmentId: environmentId, collectionId: collectionId, naturalLanguageQuery: "cluod", spellingSuggestions: true);
+
+            Assert.IsNotNull(queryResult.Result);
+            Assert.IsNotNull(queryResult.Result.SuggestedQuery);
+        }
+    }
+}