Merge pull request #84 from watson-developer-cloud/release-1-2019

Release 1 2019

Author: mamoonraja

lib/ibm_watson/assistant_v1.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# (C) Copyright IBM Corp. 2019.
+# (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.
@@ -2306,6 +2306,9 @@ def list_all_logs(filter:, sort: nil, page_limit: nil, cursor: nil)
     #   with a request that passes data. For more information about personal data and
     #   customer IDs, see [Information
     #   security](https://cloud.ibm.com/docs/services/assistant?topic=assistant-information-security#information-security).
+    #
+    #   This operation is limited to 4 requests per minute. For more information, see
+    #   **Rate limiting**.
     # @param customer_id [String] The customer ID for which all data is to be deleted.
     # @return [nil]
     def delete_user_data(customer_id:)

lib/ibm_watson/assistant_v2.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# (C) Copyright IBM Corp. 2019.
+# (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.

lib/ibm_watson/compare_comply_v1.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# (C) Copyright IBM Corp. 2019.
+# (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.

lib/ibm_watson/discovery_v1.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# (C) Copyright IBM Corp. 2019.
+# (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.
@@ -631,6 +631,8 @@ def update_collection(environment_id:, collection_id:, name:, description: nil,
 
       raise ArgumentError.new("collection_id must be provided") if collection_id.nil?
 
+      raise ArgumentError.new("name must be provided") if name.nil?
+
       headers = {
       }
       sdk_headers = Common.new.get_sdk_headers("discovery", "V1", "update_collection")
@@ -1590,6 +1592,8 @@ def query_notices(environment_id:, collection_id:, filter: nil, query: nil, natu
     def federated_query(environment_id:, collection_ids:, filter: nil, query: nil, natural_language_query: nil, passages: nil, aggregation: nil, count: nil, _return: nil, offset: nil, sort: nil, highlight: nil, passages_fields: nil, passages_count: nil, passages_characters: nil, deduplicate: nil, deduplicate_field: nil, similar: nil, similar_document_ids: nil, similar_fields: nil, bias: nil, x_watson_logging_opt_out: nil)
       raise ArgumentError.new("environment_id must be provided") if environment_id.nil?
 
+      raise ArgumentError.new("collection_ids must be provided") if collection_ids.nil?
+
       headers = {
         "X-Watson-Logging-Opt-Out" => x_watson_logging_opt_out
       }
@@ -2216,7 +2220,7 @@ def delete_user_data(customer_id:)
     # Create event.
     # The **Events** API can be used to create log entries that are associated with
     #   specific queries. For example, you can record which documents in the results set
-    #   were "clicked" by a user and when that click occured.
+    #   were "clicked" by a user and when that click occurred.
     # @param type [String] The event type to be created.
     # @param data [EventData] Query event data object.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.

lib/ibm_watson/discovery_v2.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# (C) Copyright IBM Corp. 2019.
+# (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.
@@ -387,14 +387,14 @@ def get_component_settings(project_id:)
     #   **_/v2/projects/{project_id}/collections/{collection_id}/documents** method.
     #
     #   **Note:** This operation only works on collections created to accept direct file
-    #   uploads. It cannot be used to modify a collection that conects to an external
+    #   uploads. It cannot be used to modify a collection that connects to an external
     #   source such as Microsoft SharePoint.
     # @param project_id [String] The ID of the project. This information can be found from the deploy page of the
     #   Discovery administrative tooling.
     # @param collection_id [String] The ID of the collection.
     # @param file [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 confiruration is 1 megabyte. Files larger than the supported size are
+    #   testing a configuration is 1 megabyte. Files larger than the supported size are
     #   rejected.
     # @param filename [String] The filename for file.
     # @param file_content_type [String] The content type of file.
@@ -459,15 +459,15 @@ def add_document(project_id:, collection_id:, file: nil, filename: nil, file_con
     #   any document stored with the same **document_id** if it exists.
     #
     #   **Note:** This operation only works on collections created to accept direct file
-    #   uploads. It cannot be used to modify a collection that conects to an external
+    #   uploads. It cannot be used to modify a collection that connects to an external
     #   source such as Microsoft SharePoint.
     # @param project_id [String] The ID of the project. This information can be found from the deploy page of the
     #   Discovery administrative tooling.
     # @param collection_id [String] The ID of the collection.
     # @param document_id [String] The ID of the document.
     # @param file [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 confiruration is 1 megabyte. Files larger than the supported size are
+    #   testing a configuration is 1 megabyte. Files larger than the supported size are
     #   rejected.
     # @param filename [String] The filename for file.
     # @param file_content_type [String] The content type of file.
@@ -529,7 +529,7 @@ def update_document(project_id:, collection_id:, document_id:, file: nil, filena
     #   'deleted'.
     #
     #   **Note:** This operation only works on collections created to accept direct file
-    #   uploads. It cannot be used to modify a collection that conects to an external
+    #   uploads. It cannot be used to modify a collection that connects to an external
     #   source such as Microsoft SharePoint.
     # @param project_id [String] The ID of the project. This information can be found from the deploy page of the
     #   Discovery administrative tooling.
@@ -647,6 +647,10 @@ def delete_training_queries(project_id:)
     def create_training_query(project_id:, natural_language_query:, examples:, filter: nil)
       raise ArgumentError.new("project_id must be provided") if project_id.nil?
 
+      raise ArgumentError.new("natural_language_query must be provided") if natural_language_query.nil?
+
+      raise ArgumentError.new("examples must be provided") if examples.nil?
+
       headers = {
       }
       sdk_headers = Common.new.get_sdk_headers("discovery", "V2", "create_training_query")

lib/ibm_watson/language_translator_v3.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# (C) Copyright IBM Corp. 2019.
+# (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.
@@ -391,7 +391,7 @@ def list_documents
     # Submit a document for translation. You can submit the document contents in the
     #   `file` parameter, or you can reference a previously submitted document by document
     #   ID.
-    # @param file [File] The source file to translate.
+    # @param file [File] The contents of the source file to translate.
     #
     #   [Supported file
     #   types](https://cloud.ibm.com/docs/services/language-translator?topic=language-translator-document-translator-tutorial#supported-file-formats)

lib/ibm_watson/natural_language_classifier_v1.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# (C) Copyright IBM Corp. 2019.
+# (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.

lib/ibm_watson/natural_language_understanding_v1.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# (C) Copyright IBM Corp. 2019.
+# (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.
@@ -21,8 +21,8 @@
 #
 # You can create [custom
 # models](https://cloud.ibm.com/docs/services/natural-language-understanding?topic=natural-language-understanding-customizing)
-# with Watson Knowledge Studio to detect custom entities, relations, and categories in
-# Natural Language Understanding.
+# with Watson Knowledge Studio to detect custom entities and relations in Natural Language
+# Understanding.
 
 require "concurrent"
 require "erb"
@@ -87,6 +87,10 @@ def initialize(args = {})
     #   - Semantic roles
     #   - Sentiment
     #   - Syntax (Experimental).
+    #
+    #   If a language for the input text is not specified with the `language` parameter,
+    #   the service [automatically detects the
+    #   language](https://cloud.ibm.com/docs/services/natural-language-understanding?topic=natural-language-understanding-detectable-languages).
     # @param features [Features] Specific features to analyze the document for.
     # @param text [String] The plain text to analyze. One of the `text`, `html`, or `url` parameters is
     #   required.

lib/ibm_watson/personality_insights_v3.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# (C) Copyright IBM Corp. 2019.
+# (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.