feat(Discovery): use json sub types in query aggregation

Author: mamoonraja

.travis.yml

@@ -1,6 +1,6 @@
 language: node_js
 node_js:
-- "8"
+- "10"
 os:
 - osx
 osx_image: xcode61

Examples/ExampleDiscoveryV2.cs

@@ -43,7 +43,7 @@ public IEnumerator CreateService()
         //  Create credential and instantiate service using bearer token
         BearerTokenAuthenticator authenticator = new BearerTokenAuthenticator(bearerToken: bearerToken);
 
-        // Otions 2
+        // Option 2
         //  Create credential and instantiate service using username/password
         // var authenticator = new CloudPakForDataAuthenticator(
         //     url: "https://{cpd_cluster_host}{:port}",

Scripts/Services/Assistant/V1/AssistantService.cs

@@ -517,16 +517,16 @@ private void OnGetWorkspaceResponse(RESTConnector.Request req, RESTConnector.Res
         /// (optional)</param>
         /// <param name="counterexamples">An array of objects defining input examples that have been marked as
         /// irrelevant input. (optional)</param>
-        /// <param name="webhooks"> (optional)</param>
         /// <param name="append">Whether the new data is to be appended to the existing data in the workspace. If
         /// **append**=`false`, elements included in the new data completely replace the corresponding existing
         /// elements, including all subelements. For example, if the new data includes **entities** and
         /// **append**=`false`, all existing entities in the workspace are discarded and replaced with the new entities.
         ///
         /// If **append**=`true`, existing elements are preserved, and the new elements are added. If any elements in
         /// the new data collide with existing elements, the update request fails. (optional, default to false)</param>
+        /// <param name="webhooks"> (optional)</param>
         /// <returns><see cref="Workspace" />Workspace</returns>
-        public bool UpdateWorkspace(Callback<Workspace> callback, string workspaceId, string name = null, string description = null, string language = null, Dictionary<string, object> metadata = null, bool? learningOptOut = null, WorkspaceSystemSettings systemSettings = null, List<CreateIntent> intents = null, List<CreateEntity> entities = null, List<DialogNode> dialogNodes = null, List<Counterexample> counterexamples = null, List<Webhook> webhooks = null, bool? append = null)
+        public bool UpdateWorkspace(Callback<Workspace> callback, string workspaceId, string name = null, string description = null, string language = null, Dictionary<string, object> metadata = null, bool? learningOptOut = null, WorkspaceSystemSettings systemSettings = null, List<CreateIntent> intents = null, List<CreateEntity> entities = null, List<DialogNode> dialogNodes = null, List<Counterexample> counterexamples = null, bool? append = null, List<Webhook> webhooks = null)
         {
             if (callback == null)
                 throw new ArgumentNullException("`callback` is required for `UpdateWorkspace`");

Scripts/Services/Discovery/V1/Model/Calculation.cs

@@ -23,7 +23,7 @@ namespace IBM.Watson.Discovery.V1.Model
     /// <summary>
     /// Calculation.
     /// </summary>
-    public class Calculation
+    public class Calculation: QueryAggregation
     {
         /// <summary>
         /// The field where the aggregation is located in the document.

Scripts/Services/Discovery/V1/Model/Filter.cs

@@ -23,7 +23,7 @@ namespace IBM.Watson.Discovery.V1.Model
     /// <summary>
     /// Filter.
     /// </summary>
-    public class Filter
+    public class Filter: QueryAggregation
     {
         /// <summary>
         /// The match the aggregated results queried for.

Scripts/Services/Discovery/V1/Model/Histogram.cs

@@ -23,7 +23,7 @@ namespace IBM.Watson.Discovery.V1.Model
     /// <summary>
     /// Histogram.
     /// </summary>
-    public class Histogram
+    public class Histogram: QueryAggregation
     {
         /// <summary>
         /// The field where the aggregation is located in the document.

Scripts/Services/Discovery/V1/Model/Nested.cs

@@ -23,7 +23,7 @@ namespace IBM.Watson.Discovery.V1.Model
     /// <summary>
     /// Nested.
     /// </summary>
-    public class Nested
+    public class Nested: QueryAggregation
     {
         /// <summary>
         /// The area of the results the aggregation was restricted to.

Scripts/Services/Discovery/V1/Model/QueryAggregation.cs

@@ -16,13 +16,26 @@
 */
 
 using System.Collections.Generic;
+using JsonSubTypes;
 using Newtonsoft.Json;
 
 namespace IBM.Watson.Discovery.V1.Model
 {
     /// <summary>
     /// An aggregation produced by  Discovery to analyze the input provided.
     /// </summary>
+    [JsonConverter(typeof(JsonSubtypes), "Type")]
+    [JsonSubtypes.KnownSubType(typeof(Histogram), "histogram")]
+    [JsonSubtypes.KnownSubType(typeof(Calculation), "max")]
+    [JsonSubtypes.KnownSubType(typeof(Calculation), "min")]
+    [JsonSubtypes.KnownSubType(typeof(Calculation), "average")]
+    [JsonSubtypes.KnownSubType(typeof(Calculation), "sum")]
+    [JsonSubtypes.KnownSubType(typeof(Calculation), "unique_count")]
+    [JsonSubtypes.KnownSubType(typeof(Term), "term")]
+    [JsonSubtypes.KnownSubType(typeof(Filter), "filter")]
+    [JsonSubtypes.KnownSubType(typeof(Nested), "nested")]
+    [JsonSubtypes.KnownSubType(typeof(Timeslice), "timeslice")]
+    [JsonSubtypes.KnownSubType(typeof(TopHits), "top_hits")]
     public class QueryAggregation
     {
         /// <summary>

Scripts/Services/Discovery/V1/Model/Term.cs

@@ -23,7 +23,7 @@ namespace IBM.Watson.Discovery.V1.Model
     /// <summary>
     /// Term.
     /// </summary>
-    public class Term
+    public class Term: QueryAggregation
     {
         /// <summary>
         /// The field where the aggregation is located in the document.

Scripts/Services/Discovery/V1/Model/Timeslice.cs

@@ -23,7 +23,7 @@ namespace IBM.Watson.Discovery.V1.Model
     /// <summary>
     /// Timeslice.
     /// </summary>
-    public class Timeslice
+    public class Timeslice: QueryAggregation
     {
         /// <summary>
         /// The field where the aggregation is located in the document.

Scripts/Services/Discovery/V1/Model/TopHits.cs

@@ -23,7 +23,7 @@ namespace IBM.Watson.Discovery.V1.Model
     /// <summary>
     /// TopHits.
     /// </summary>
-    public class TopHits
+    public class TopHits: QueryAggregation
     {
         /// <summary>
         /// Number of top hits returned by the aggregation.

Scripts/Services/Discovery/V2/Model/QueryAggregation.cs

@@ -16,12 +16,25 @@
 */
 
 using Newtonsoft.Json;
+using JsonSubTypes;
 
 namespace IBM.Watson.Discovery.V2.Model
 {
     /// <summary>
     /// An abstract aggregation type produced by Discovery to analyze the input provided.
     /// </summary>
+    [JsonConverter(typeof(JsonSubtypes), "Type")]
+    [JsonSubtypes.KnownSubType(typeof(QueryHistogramAggregation), "histogram")]
+    [JsonSubtypes.KnownSubType(typeof(QueryCalculationAggregation), "max")]
+    [JsonSubtypes.KnownSubType(typeof(QueryCalculationAggregation), "min")]
+    [JsonSubtypes.KnownSubType(typeof(QueryCalculationAggregation), "average")]
+    [JsonSubtypes.KnownSubType(typeof(QueryCalculationAggregation), "sum")]
+    [JsonSubtypes.KnownSubType(typeof(QueryCalculationAggregation), "unique_count")]
+    [JsonSubtypes.KnownSubType(typeof(QueryTermAggregation), "term")]
+    [JsonSubtypes.KnownSubType(typeof(QueryFilterAggregation), "filter")]
+    [JsonSubtypes.KnownSubType(typeof(QueryNestedAggregation), "nested")]
+    [JsonSubtypes.KnownSubType(typeof(QueryTimesliceAggregation), "timeslice")]
+    [JsonSubtypes.KnownSubType(typeof(QueryTopHitsAggregation), "top_hits")]
     public class QueryAggregation
     {
         /// <summary>

Scripts/Services/Discovery/V2/Model/QueryCalculationAggregation.cs

@@ -23,7 +23,7 @@ namespace IBM.Watson.Discovery.V2.Model
     /// Returns a scalar calculation across all documents for the field specified. Possible calculations include min,
     /// max, sum, average, and unique_count.
     /// </summary>
-    public class QueryCalculationAggregation
+    public class QueryCalculationAggregation: QueryAggregation
     {
         /// <summary>
         /// The field to perform the calculation on.

Scripts/Services/Discovery/V2/Model/QueryFilterAggregation.cs

@@ -23,7 +23,7 @@ namespace IBM.Watson.Discovery.V2.Model
     /// <summary>
     /// A modifier that will narrow down the document set of the sub aggregations it precedes.
     /// </summary>
-    public class QueryFilterAggregation
+    public class QueryFilterAggregation: QueryAggregation
     {
         /// <summary>
         /// The filter written in Discovery Query Language syntax applied to the documents before sub aggregations are

Scripts/Services/Discovery/V2/Model/QueryHistogramAggregation.cs

@@ -24,7 +24,7 @@ namespace IBM.Watson.Discovery.V2.Model
     /// Numeric interval segments to categorize documents by using field values from a single numeric field to describe
     /// the category.
     /// </summary>
-    public class QueryHistogramAggregation
+    public class QueryHistogramAggregation: QueryAggregation
     {
         /// <summary>
         /// The numeric field name used to create the histogram.

Scripts/Services/Discovery/V2/Model/QueryLargePassages.cs

@@ -23,7 +23,7 @@ namespace IBM.Watson.Discovery.V2.Model
     /// <summary>
     /// Configuration for passage retrieval.
     /// </summary>
-    public class QueryLargePassages
+    public class QueryLargePassages: QueryAggregation
     {
         /// <summary>
         /// A passages query that returns the most relevant passages from the results.

Scripts/Services/Discovery/V2/Model/QueryLargeSuggestedRefinements.cs

@@ -22,7 +22,7 @@ namespace IBM.Watson.Discovery.V2.Model
     /// <summary>
     /// Configuration for suggested refinements.
     /// </summary>
-    public class QueryLargeSuggestedRefinements
+    public class QueryLargeSuggestedRefinements: QueryAggregation
     {
         /// <summary>
         /// Whether to perform suggested refinements.

Scripts/Services/Discovery/V2/Model/QueryLargeTableResults.cs

@@ -22,7 +22,7 @@ namespace IBM.Watson.Discovery.V2.Model
     /// <summary>
     /// Configuration for table retrieval.
     /// </summary>
-    public class QueryLargeTableResults
+    public class QueryLargeTableResults: QueryAggregation
     {
         /// <summary>
         /// Whether to enable table retrieval.

Scripts/Services/Discovery/V2/Model/QueryNestedAggregation.cs

@@ -24,7 +24,7 @@ namespace IBM.Watson.Discovery.V2.Model
     /// A restriction that alter the document set used for sub aggregations it precedes to nested documents found in the
     /// field specified.
     /// </summary>
-    public class QueryNestedAggregation
+    public class QueryNestedAggregation: QueryAggregation
     {
         /// <summary>
         /// The path to the document field to scope sub aggregations to.

Tests/DiscoveryV1IntegrationTests.cs

@@ -917,6 +917,72 @@ public IEnumerator TestQuery()
         }
         #endregion
 
+        #region Query Aggregation
+        [UnityTest, Order(28)]
+        public IEnumerator TestQueryAggregation()
+        {
+            Log.Debug("DiscoveryServiceV1IntegrationTests", "Attempting to Query...");
+            string naturalLanguageQuery = "Who beat Ken Jennings in Jeopardy!";
+            QueryResponse queryResultTimeslice = null;
+            service.Query(
+                callback: (DetailedResponse<QueryResponse> response, IBMError error) =>
+                {
+                    Log.Debug("DiscoveryServiceV1IntegrationTests", "Query result: {0}", response.Response);
+                    queryResultTimeslice = response.Result;
+                    Assert.IsNotNull(queryResultTimeslice);
+                    Assert.IsNull(error);
+                    Assert.IsNotNull(queryResultTimeslice.Aggregations);
+                    Assert.IsTrue((queryResultTimeslice.Aggregations[0] as Timeslice).Field == "product.sales");
+                    Assert.IsTrue((queryResultTimeslice.Aggregations[0] as Timeslice).Interval == "2d");
+                    Assert.IsTrue((queryResultTimeslice.Aggregations[0] as Timeslice).Anomaly == true);
+                },
+                environmentId: "system",
+                collectionId: "news-en",
+                naturalLanguageQuery: naturalLanguageQuery,
+                aggregation: "timeslice(product.sales,2day,anomaly:true)"
+            );
+
+            QueryResponse queryResultTerm = null;
+            service.Query(
+                callback: (DetailedResponse<QueryResponse> response, IBMError error) =>
+                {
+                    Log.Debug("DiscoveryServiceV1IntegrationTests", "Query result: {0}", response.Response);
+                    queryResultTerm = response.Result;
+                    Assert.IsNotNull(queryResultTerm);
+                    Assert.IsNull(error);
+                    Assert.IsNotNull(queryResultTerm.Aggregations);
+                    Assert.IsTrue((queryResultTerm.Aggregations[0] as Term).Field == "enriched_text.concepts.text");
+                    Assert.IsTrue((queryResultTerm.Aggregations[0] as Term).Count == 10);
+                },
+                environmentId: "system",
+                collectionId: "news-en",
+                naturalLanguageQuery: naturalLanguageQuery,
+                aggregation: "term(enriched_text.concepts.text,count:10)"
+            );
+
+            QueryResponse queryResultFilter = null;
+            service.Query(
+                callback: (DetailedResponse<QueryResponse> response, IBMError error) =>
+                {
+                    Log.Debug("DiscoveryServiceV1IntegrationTests", "Query result: {0}", response.Response);
+                    queryResultFilter = response.Result;
+                    Assert.IsNotNull(queryResultFilter);
+                    Assert.IsNull(error);
+                    Assert.IsNotNull(queryResultFilter.Aggregations);
+                    Assert.IsTrue((queryResultFilter.Aggregations[0] as Filter).Match == "enriched_text.concepts.text:\"cloud computing\"");
+                },
+                environmentId: "system",
+                collectionId: "news-en",
+                naturalLanguageQuery: naturalLanguageQuery,
+                aggregation: "filter(enriched_text.concepts.text:\"cloud computing\")"
+            );
+
+            while (queryResultTimeslice == null || queryResultFilter == null || queryResultTerm == null)
+                yield return null;
+
+        }
+        #endregion
+
         #region QueryNotices
         [UnityTest, Order(29)]
         public IEnumerator TestQueryNotices()