feat(DiscoveryV2): Add support for AnalyzeDocuments

Author: mamoonraja

Scripts/Services/Discovery/V2/DiscoveryService.cs

@@ -1,5 +1,5 @@
 /**
-* (C) Copyright IBM Corp. 2019, 2020.
+* (C) Copyright IBM Corp. 2020.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -1662,6 +1662,104 @@ private void OnUpdateTrainingQueryResponse(RESTConnector.Request req, RESTConnec
                 ((RequestObject<TrainingQuery>)req).Callback(response, resp.Error);
         }
         /// <summary>
+        /// Analyze a Document.
+        ///
+        /// Process a document using the specified collection's settings and return it for realtime use.
+        ///
+        /// **Note:** Documents processed using this method are not added to the specified collection.
+        ///
+        /// **Note:** This method is only supported on IBM Cloud Pak for Data instances of Discovery.
+        /// </summary>
+        /// <param name="callback">The callback function that is invoked when the operation completes.</param>
+        /// <param name="projectId">The ID of the project. This information can be found from the deploy page of the
+        /// Discovery administrative tooling.</param>
+        /// <param name="collectionId">The ID of the collection.</param>
+        /// <param name="file">The content of the document to ingest. The maximum supported file size when adding a file
+        /// to a collection is 50 megabytes, the maximum supported file size when testing a configuration is 1 megabyte.
+        /// Files larger than the supported size are rejected. (optional)</param>
+        /// <param name="filename">The filename for file. (optional)</param>
+        /// <param name="fileContentType">The content type of file. (optional)</param>
+        /// <param name="metadata">The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 MB are
+        /// rejected.
+        ///
+        ///
+        /// Example:  ``` {
+        ///   "Creator": "Johnny Appleseed",
+        ///   "Subject": "Apples"
+        /// } ```. (optional)</param>
+        /// <returns><see cref="AnalyzedDocument" />AnalyzedDocument</returns>
+        public bool AnalyzeDocument(Callback<AnalyzedDocument> callback, string projectId, string collectionId, System.IO.MemoryStream file = null, string filename = null, string fileContentType = null, string metadata = null)
+        {
+            if (callback == null)
+                throw new ArgumentNullException("`callback` is required for `AnalyzeDocument`");
+            if (string.IsNullOrEmpty(projectId))
+                throw new ArgumentNullException("`projectId` is required for `AnalyzeDocument`");
+            if (string.IsNullOrEmpty(collectionId))
+                throw new ArgumentNullException("`collectionId` is required for `AnalyzeDocument`");
+
+            RequestObject<AnalyzedDocument> req = new RequestObject<AnalyzedDocument>
+            {
+                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("discovery", "V2", "AnalyzeDocument"))
+            {
+                req.Headers.Add(kvp.Key, kvp.Value);
+            }
+
+            req.Parameters["version"] = VersionDate;
+            req.Forms = new Dictionary<string, RESTConnector.Form>();
+            if (file != null)
+            {
+                req.Forms["file"] = new RESTConnector.Form(file, filename, fileContentType);
+            }
+            if (!string.IsNullOrEmpty(metadata))
+            {
+                req.Forms["metadata"] = new RESTConnector.Form(metadata);
+            }
+
+            req.OnResponse = OnAnalyzeDocumentResponse;
+
+            Connector.URL = GetServiceUrl() + string.Format("/v2/projects/{0}/collections/{1}/analyze", projectId, collectionId);
+            Authenticator.Authenticate(Connector);
+
+            return Connector.Send(req);
+        }
+
+        private void OnAnalyzeDocumentResponse(RESTConnector.Request req, RESTConnector.Response resp)
+        {
+            DetailedResponse<AnalyzedDocument> response = new DetailedResponse<AnalyzedDocument>();
+            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<AnalyzedDocument>(json);
+                response.Response = json;
+            }
+            catch (Exception e)
+            {
+                Log.Error("DiscoveryService.OnAnalyzeDocumentResponse()", "Exception: {0}", e.ToString());
+                resp.Success = false;
+            }
+
+            if (((RequestObject<AnalyzedDocument>)req).Callback != null)
+                ((RequestObject<AnalyzedDocument>)req).Callback(response, resp.Error);
+        }
+        /// <summary>
         /// List Enrichments.
         ///
         /// List the enrichments available to this project.
@@ -2490,4 +2588,4 @@ private void OnDeleteUserDataResponse(RESTConnector.Request req, RESTConnector.R
                 ((RequestObject<object>)req).Callback(response, resp.Error);
         }
     }
-}
+}

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

@@ -0,0 +1,39 @@
+/**
+* (C) Copyright IBM Corp. 2020.
+*
+* 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 Newtonsoft.Json;
+
+namespace IBM.Watson.Discovery.V2.Model
+{
+    /// <summary>
+    /// An object containing the converted document and any identified enrichments.
+    /// </summary>
+    public class AnalyzedDocument
+    {
+        /// <summary>
+        /// Array of document results that match the query.
+        /// </summary>
+        [JsonProperty("notices", NullValueHandling = NullValueHandling.Ignore)]
+        public List<Notice> Notices { get; set; }
+        /// <summary>
+        /// Result of the document analysis.
+        /// </summary>
+        [JsonProperty("result", NullValueHandling = NullValueHandling.Ignore)]
+        public AnalyzedResult Result { get; set; }
+    }
+}

Scripts/Services/Discovery/V2/Model/AnalyzedDocument.cs.meta

@@ -0,0 +1,35 @@
+/**
+* (C) Copyright IBM Corp. 2020.
+*
+* 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 IBM.Cloud.SDK.Model;
+using Newtonsoft.Json;
+
+namespace IBM.Watson.Discovery.V2.Model
+{
+    /// <summary>
+    /// Result of the document analysis.
+    /// </summary>
+    public class AnalyzedResult: DynamicModel<object>
+    {
+        /// <summary>
+        /// Metadata of the document.
+        /// </summary>
+        [JsonProperty("metadata", NullValueHandling = NullValueHandling.Ignore)]
+        public Dictionary<string, object> Metadata { get; set; }
+    }
+}

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

@@ -1,5 +1,5 @@
 /**
-* Copyright 2018, 2019 IBM Corp. All Rights Reserved.
+* (C) Copyright IBM Corp. 2020.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -26,7 +26,7 @@ namespace IBM.Watson.Discovery.V2.Model
     public class Completions
     {
         /// <summary>
-        /// Array of autcomplete suggestion based on the provided prefix.
+        /// Array of autocomplete suggestion based on the provided prefix.
         /// </summary>
         [JsonProperty("completions", NullValueHandling = NullValueHandling.Ignore)]
         public List<string> _Completions { get; set; }

Scripts/Services/Discovery/V2/Model/AnalyzedResult.cs.meta

@@ -51,12 +51,12 @@ public class DefaultQueryParams
         [JsonProperty("suggested_refinements", NullValueHandling = NullValueHandling.Ignore)]
         public DefaultQueryParamsSuggestedRefinements SuggestedRefinements { get; set; }
         /// <summary>
-        /// When `true`, a spelling suggestions for the query are retuned by default.
+        /// When `true`, a spelling suggestions for the query are returned by default.
         /// </summary>
         [JsonProperty("spelling_suggestions", NullValueHandling = NullValueHandling.Ignore)]
         public bool? SpellingSuggestions { get; set; }
         /// <summary>
-        /// When `true`, a highlights for the query are retuned by default.
+        /// When `true`, a highlights for the query are returned by default.
         /// </summary>
         [JsonProperty("highlight", NullValueHandling = NullValueHandling.Ignore)]
         public bool? Highlight { get; set; }

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

@@ -36,7 +36,7 @@ public class DefaultQueryParamsPassages
         [JsonProperty("count", NullValueHandling = NullValueHandling.Ignore)]
         public long? Count { get; set; }
         /// <summary>
-        /// An array of field names to perfom the passage search on.
+        /// An array of field names to perform the passage search on.
         /// </summary>
         [JsonProperty("fields", NullValueHandling = NullValueHandling.Ignore)]
         public List<string> Fields { get; set; }

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

@@ -25,7 +25,7 @@ namespace IBM.Watson.Discovery.V2.Model
     public class DefaultQueryParamsSuggestedRefinements
     {
         /// <summary>
-        /// When `true`, a suggested refinements for the query are retuned by default.
+        /// When `true`, a suggested refinements for the query are returned by default.
         /// </summary>
         [JsonProperty("enabled", NullValueHandling = NullValueHandling.Ignore)]
         public bool? Enabled { get; set; }

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

@@ -25,7 +25,7 @@ namespace IBM.Watson.Discovery.V2.Model
     public class DefaultQueryParamsTableResults
     {
         /// <summary>
-        /// When `true`, a table results for the query are retuned by default.
+        /// When `true`, a table results for the query are returned by default.
         /// </summary>
         [JsonProperty("enabled", NullValueHandling = NullValueHandling.Ignore)]
         public bool? Enabled { get; set; }

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

@@ -35,7 +35,7 @@ public class ProjectListDetailsRelevancyTrainingStatus
         [JsonProperty("total_examples", NullValueHandling = NullValueHandling.Ignore)]
         public long? TotalExamples { get; set; }
         /// <summary>
-        /// When `true`, sufficent label diversity is present to allow training for this project.
+        /// When `true`, sufficient label diversity is present to allow training for this project.
         /// </summary>
         [JsonProperty("sufficient_label_diversity", NullValueHandling = NullValueHandling.Ignore)]
         public bool? SufficientLabelDiversity { get; set; }
@@ -50,7 +50,7 @@ public class ProjectListDetailsRelevancyTrainingStatus
         [JsonProperty("minimum_examples_added", NullValueHandling = NullValueHandling.Ignore)]
         public bool? MinimumExamplesAdded { get; set; }
         /// <summary>
-        /// The time that the most recent successful training occured.
+        /// The time that the most recent successful training occurred.
         /// </summary>
         [JsonProperty("successfully_trained", NullValueHandling = NullValueHandling.Ignore)]
         public string SuccessfullyTrained { get; set; }

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

@@ -1,5 +1,5 @@
 /**
-* (C) Copyright IBM Corp. 2018, 2020.
+* (C) Copyright IBM Corp. 2020.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -60,5 +60,10 @@ public class QueryResponse
         /// </summary>
         [JsonProperty("table_results", NullValueHandling = NullValueHandling.Ignore)]
         public List<QueryTableResult> TableResults { get; set; }
+        /// <summary>
+        /// Passages returned by Discovery.
+        /// </summary>
+        [JsonProperty("passages", NullValueHandling = NullValueHandling.Ignore)]
+        public List<QueryResponsePassage> Passages { get; set; }
     }
 }

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

@@ -0,0 +1,63 @@
+/**
+* (C) Copyright IBM Corp. 2020.
+*
+* 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.Discovery.V2.Model
+{
+    /// <summary>
+    /// A passage query response.
+    /// </summary>
+    public class QueryResponsePassage
+    {
+        /// <summary>
+        /// The content of the extracted passage.
+        /// </summary>
+        [JsonProperty("passage_text", NullValueHandling = NullValueHandling.Ignore)]
+        public string PassageText { get; set; }
+        /// <summary>
+        /// The confidence score of the passage's analysis. A higher score indicates greater confidence.
+        /// </summary>
+        [JsonProperty("passage_score", NullValueHandling = NullValueHandling.Ignore)]
+        public double? PassageScore { get; set; }
+        /// <summary>
+        /// The unique identifier of the ingested document.
+        /// </summary>
+        [JsonProperty("document_id", NullValueHandling = NullValueHandling.Ignore)]
+        public string DocumentId { get; set; }
+        /// <summary>
+        /// The unique identifier of the collection.
+        /// </summary>
+        [JsonProperty("collection_id", NullValueHandling = NullValueHandling.Ignore)]
+        public string CollectionId { get; set; }
+        /// <summary>
+        /// The position of the first character of the extracted passage in the originating field.
+        /// </summary>
+        [JsonProperty("start_offset", NullValueHandling = NullValueHandling.Ignore)]
+        public long? StartOffset { get; set; }
+        /// <summary>
+        /// The position of the last character of the extracted passage in the originating field.
+        /// </summary>
+        [JsonProperty("end_offset", NullValueHandling = NullValueHandling.Ignore)]
+        public long? EndOffset { get; set; }
+        /// <summary>
+        /// The label of the field from which the passage has been extracted.
+        /// </summary>
+        [JsonProperty("field", NullValueHandling = NullValueHandling.Ignore)]
+        public string Field { get; set; }
+    }
+}