feat(Discovery): Updated data models for Discovery NLU integration and RetreivalDetails

Author: mediumTaj

Scripts/Services/Discovery/v1/DataModels.cs

@@ -803,6 +803,10 @@ public enum LanguageEnum
         /// 'fr', 'fre', 'fra', 'it', 'ita', 'pt', 'por', 'ru', 'rus', 'es', 'spa', 'sv', 'swe']
         /// </summary>
         public string language { get; set; }
+        /// <summary>
+        /// Options which are specific to a particular enrichment.
+        /// </summary>
+        public NluEnrichmentFeatures features { get; set; }
     }
 
     /// <summary>
@@ -1128,6 +1132,16 @@ public class QueryResponse
         /// </summary>
         [fsProperty("session_token")]
         public string SessionToken { get; set; }
+        /// <summary>
+        /// The number of duplicates removed.
+        /// </summary>
+        [fsProperty("duplicates_removed")]
+        public int duplicatesRemoved { get; set; }
+        /// <summary>
+        /// An object contain retrieval type information.
+        /// </summary>
+        [fsProperty("retrieval_details")]
+        public RetrievalDetails retrievalDetails { get; set; }
 
         public override string ToString()
         {

Scripts/Services/Discovery/v1/Models/NluEnrichmentCategories.cs

@@ -0,0 +1,27 @@
+/**
+* Copyright 2018 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.
+*
+*/
+
+namespace IBM.Watson.DeveloperCloud.Services.Discovery.v1
+{
+    /// <summary>
+    /// An object that indicates the Categories enrichment will be applied to the specified field.
+    /// </summary>
+    public class NluEnrichmentCategories
+    {
+    }
+
+}

Scripts/Services/Discovery/v1/Models/NluEnrichmentCategories.cs.meta

@@ -0,0 +1,33 @@
+/**
+* Copyright 2018 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 FullSerializer;
+namespace IBM.Watson.DeveloperCloud.Services.Discovery.v1
+{
+    /// <summary>
+    /// An object specifiying the concepts enrichment and related parameters.
+    /// </summary>
+    public class NluEnrichmentConcepts
+    {
+        /// <summary>
+        /// The maximum number of concepts enrichments to extact from each instance of the specified field.
+        /// </summary>
+        [fsProperty("limit")]
+        public long? Limit { get; set; }
+    }
+
+}

Scripts/Services/Discovery/v1/Models/NluEnrichmentConcepts.cs

@@ -0,0 +1,39 @@
+/**
+* Copyright 2018 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 System.Collections.Generic;
+using FullSerializer;
+namespace IBM.Watson.DeveloperCloud.Services.Discovery.v1
+{
+    /// <summary>
+    /// An object specifying the emotion detection enrichment and related parameters.
+    /// </summary>
+    public class NluEnrichmentEmotion
+    {
+        /// <summary>
+        /// When `true`, emotion detection is performed on the entire field.
+        /// </summary>
+        [fsProperty("document")]
+        public bool? Document { get; set; }
+        /// <summary>
+        /// A comma-separated list of target strings that will have any associated emotions detected.
+        /// </summary>
+        [fsProperty("targets")]
+        public List<string> Targets { get; set; }
+    }
+
+}

Scripts/Services/Discovery/v1/Models/NluEnrichmentConcepts.cs.meta

@@ -0,0 +1,65 @@
+/**
+* Copyright 2018 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 FullSerializer;
+namespace IBM.Watson.DeveloperCloud.Services.Discovery.v1
+{
+    /// <summary>
+    /// An object speficying the Entities enrichment and related parameters.
+    /// </summary>
+    public class NluEnrichmentEntities
+    {
+        /// <summary>
+        /// When `true`, sentiment analysis of entities will be performed on the specified field.
+        /// </summary>
+        [fsProperty("sentiment")]
+        public bool? Sentiment { get; set; }
+        /// <summary>
+        /// When `true`, emotion detection of entities will be performed on the specified field.
+        /// </summary>
+        [fsProperty("emotion")]
+        public bool? Emotion { get; set; }
+        /// <summary>
+        /// The maximum number of entities to extract for each instance of the specified field.
+        /// </summary>
+        [fsProperty("limit")]
+        public long? Limit { get; set; }
+        /// <summary>
+        /// When `true`, the number of mentions of each identified entity is recorded. The default is `false`.
+        /// </summary>
+        [fsProperty("mentions")]
+        public bool? Mentions { get; set; }
+        /// <summary>
+        /// When `true`, the types of mentions for each idetifieid entity is recorded. The default is `false`.
+        /// </summary>
+        [fsProperty("mention_types")]
+        public bool? MentionTypes { get; set; }
+        /// <summary>
+        /// When `true`, a list of sentence locations for each instance of each identified entity is recorded. The
+        /// default is `false`.
+        /// </summary>
+        [fsProperty("sentence_locations")]
+        public bool? SentenceLocations { get; set; }
+        /// <summary>
+        /// The enrichement model to use with entity extraction. May be a custom model provided by Watson Knowledge
+        /// Studio, the public model for use with Knowledge Graph `en-news`, or the default public model `alchemy`.
+        /// </summary>
+        [fsProperty("model")]
+        public string Model { get; set; }
+    }
+
+}

Scripts/Services/Discovery/v1/Models/NluEnrichmentEmotion.cs

@@ -0,0 +1,68 @@
+/**
+* Copyright 2018 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 FullSerializer;
+namespace IBM.Watson.DeveloperCloud.Services.Discovery.v1
+{
+    /// <summary>
+    /// NluEnrichmentFeatures.
+    /// </summary>
+    public class NluEnrichmentFeatures
+    {
+        /// <summary>
+        /// An object specifying the Keyword enrichment and related parameters.
+        /// </summary>
+        [fsProperty("keywords")]
+        public NluEnrichmentKeywords Keywords { get; set; }
+        /// <summary>
+        /// An object speficying the Entities enrichment and related parameters.
+        /// </summary>
+        [fsProperty("entities")]
+        public NluEnrichmentEntities Entities { get; set; }
+        /// <summary>
+        /// An object specifying the sentiment extraction enrichment and related parameters.
+        /// </summary>
+        [fsProperty("sentiment")]
+        public NluEnrichmentSentiment Sentiment { get; set; }
+        /// <summary>
+        /// An object specifying the emotion detection enrichment and related parameters.
+        /// </summary>
+        [fsProperty("emotion")]
+        public NluEnrichmentEmotion Emotion { get; set; }
+        /// <summary>
+        /// An object that indicates the Categories enrichment will be applied to the specified field.
+        /// </summary>
+        [fsProperty("categories")]
+        public NluEnrichmentCategories Categories { get; set; }
+        /// <summary>
+        /// An object specifiying the semantic roles enrichment and related parameters.
+        /// </summary>
+        [fsProperty("semantic_roles")]
+        public NluEnrichmentSemanticRoles SemanticRoles { get; set; }
+        /// <summary>
+        /// An object specifying the relations enrichment and related parameters.
+        /// </summary>
+        [fsProperty("relations")]
+        public NluEnrichmentRelations Relations { get; set; }
+        /// <summary>
+        /// An object specifiying the concepts enrichment and related parameters.
+        /// </summary>
+        [fsProperty("concepts")]
+        public NluEnrichmentConcepts Concepts { get; set; }
+    }
+
+}

Scripts/Services/Discovery/v1/Models/NluEnrichmentEmotion.cs.meta

@@ -0,0 +1,43 @@
+/**
+* Copyright 2018 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 FullSerializer;
+namespace IBM.Watson.DeveloperCloud.Services.Discovery.v1
+{
+    /// <summary>
+    /// An object specifying the Keyword enrichment and related parameters.
+    /// </summary>
+    public class NluEnrichmentKeywords
+    {
+        /// <summary>
+        /// When `true`, sentiment analysis of keywords will be performed on the specified field.
+        /// </summary>
+        [fsProperty("sentiment")]
+        public bool? Sentiment { get; set; }
+        /// <summary>
+        /// When `true`, emotion detection of keywords will be performed on the specified field.
+        /// </summary>
+        [fsProperty("emotion")]
+        public bool? Emotion { get; set; }
+        /// <summary>
+        /// The maximum number of keywords to extract for each instance of the specified field.
+        /// </summary>
+        [fsProperty("limit")]
+        public long? Limit { get; set; }
+    }
+
+}