ibm_watson 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c838e01be7a29c86664614e73080b4fe60a85735f13d5a6507ffb170dec5abef
-  data.tar.gz: 7ab1438cd84748d94ce274415cb630b3c3674f816266d62db0c8e2ca515cc475
+  metadata.gz: 2d4c227c6c5c5022489eaf6a69b8b674ec91facde966f3e077b9c53c969ccd80
+  data.tar.gz: 1eed5dfb21f288d25d555828a741c5836b6b25c984d7f2b1eb3de2a9f703f977
 SHA512:
-  metadata.gz: 33da6c05de9c94139b1452a4e301bc703bedb1fd924e79932cd5eec3636115302460ae17fa418a5393ee680042102195fbe042d58e5853a7610dd901585c4c6b
-  data.tar.gz: a838a1d1eba30f7df87c7f7fe3cf80a5167c0fba422bcd30cb46ac5a34f2b604ea34dac1c1a58e504288b65566c4e98bdca77bbd5facab104e091027b38ba79c
+  metadata.gz: f8a58cdc4bc68c22395584350e43e47d3d93a82602d41443dfb7160f9887241d76616372ec8a77f596686b47a7216a26b710107776d19c601f54dd05e2a20089
+  data.tar.gz: 5e80aa7bba94a5951ac4bbfae545c82a72f161f360b7e4b9633da07461d3ef679ceeb54880552216c84a33b7d8407599ac85035926f3b830fa9351664c70a4bf

data/README.md

@@ -129,7 +129,7 @@ IBM Cloud is migrating to token-based Identity and Access Management (IAM) authe
 You supply either an IAM service **API key** or an **access token**:
 
 * Use the API key to have the SDK manage the lifecycle of the access token. The SDK requests an access token, ensures that the access token is valid, and refreshes it if necessary.
-* Use the access token if you want to manage the lifecycle yourself. For details, see [Authenticating with IAM tokens](https://cloud.ibm.com/docs/services/watson?topic=watson-iam).
+* Use the access token if you want to manage the lifecycle yourself. For details, see [Authenticating with IAM tokens](https://cloud.ibm.com/docs/watson?topic=watson-iam).
 
 #### Supplying the IAM API key
 
@@ -390,6 +390,10 @@ assistant = IBMWatson::AssistantV1.new(
 
 ```
 
+## Questions
+
+If you have issues with the APIs or have a question about the Watson services, see [Stack Overflow](https://stackoverflow.com/questions/tagged/ibm-watson+ruby).
+
 ## Ruby version
 
 Tested on:
@@ -419,6 +423,6 @@ We'd love to highlight cool open-source projects that use this SDK! If you'd lik
 [examples]: https://github.com/watson-developer-cloud/ruby-sdk/tree/master/examples
 [CONTRIBUTING]: https://github.com/watson-developer-cloud/ruby-sdk/blob/master/CONTRIBUTING.md
 [license]: http://www.apache.org/licenses/LICENSE-2.0
-[vcap_services]: https://cloud.ibm.com/docs/services/watson?topic=watson-vcapServices
+[vcap_services]: https://cloud.ibm.com/docs/watson?topic=watson-vcapServices
 [ibm-cloud-onboarding]: http://cloud.ibm.com/registration?target=/developer/watson&cm_sp=WatsonPlatform-WatsonServices-_-OnPageNavLink-IBMWatson_SDKs-_-Ruby
 [ivar]: http://ruby-concurrency.github.io/concurrent-ruby/Concurrent/IVar.html

data/lib/ibm_watson/assistant_v1.rb

@@ -33,6 +33,8 @@ module IBMWatson
   # The Assistant V1 service.
   class AssistantV1 < IBMCloudSdkCore::BaseService
     include Concurrent::Async
+    DEFAULT_SERVICE_NAME = "assistant"
+    DEFAULT_SERVICE_URL = "https://gateway.watsonplatform.net/assistant/api"
     ##
     # @!method initialize(args)
     # Construct a new client for the Assistant service.
@@ -51,19 +53,23 @@ module IBMWatson
     # @option args service_url [String] The base service URL to use when contacting the service.
     #   The base service_url may differ between IBM Cloud regions.
     # @option args authenticator [Object] The Authenticator instance to be configured for this service.
+    # @option args service_name [String] The name of the service to configure. Will be used as the key to load
+    #   any external configuration, if applicable.
     def initialize(args = {})
       @__async_initialized__ = false
       defaults = {}
       defaults[:version] = nil
-      defaults[:service_url] = "https://gateway.watsonplatform.net/assistant/api"
+      defaults[:service_url] = DEFAULT_SERVICE_URL
+      defaults[:service_name] = DEFAULT_SERVICE_NAME
       defaults[:authenticator] = nil
+      user_service_url = args[:service_url] unless args[:service_url].nil?
       args = defaults.merge(args)
       @version = args[:version]
       raise ArgumentError.new("version must be provided") if @version.nil?
 
-      args[:service_name] = "assistant"
       args[:authenticator] = IBMCloudSdkCore::ConfigBasedAuthenticatorFactory.new.get_authenticator(service_name: args[:service_name]) if args[:authenticator].nil?
       super
+      @service_url = user_service_url unless user_service_url.nil?
     end
 
     #########################
@@ -706,7 +712,7 @@ module IBMWatson
     # Create user input example.
     # Add a new user input example to an intent.
     #
-    #   If you want to add multiple exaples with a single API call, consider using the
+    #   If you want to add multiple examples with a single API call, consider using the
     #   **[Update intent](#update-intent)** method instead.
     #
     #   This operation is limited to 1000 requests per 30 minutes. For more information,
@@ -2054,7 +2060,8 @@ module IBMWatson
     # @param digress_out_slots [String] Whether the user can digress to top-level nodes while filling out slots.
     # @param user_label [String] A label that can be displayed externally to describe the purpose of the node to
     #   users.
-    # @param disambiguation_opt_out [Boolean] Whether the dialog node should be excluded from disambiguation suggestions.
+    # @param disambiguation_opt_out [Boolean] Whether the dialog node should be excluded from disambiguation suggestions. Valid
+    #   only when **type**=`standard` or `frame`.
     # @param include_audit [Boolean] Whether to include the audit properties (`created` and `updated` timestamps) in
     #   the response.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
@@ -2189,7 +2196,8 @@ module IBMWatson
     # @param new_digress_out_slots [String] Whether the user can digress to top-level nodes while filling out slots.
     # @param new_user_label [String] A label that can be displayed externally to describe the purpose of the node to
     #   users.
-    # @param new_disambiguation_opt_out [Boolean] Whether the dialog node should be excluded from disambiguation suggestions.
+    # @param new_disambiguation_opt_out [Boolean] Whether the dialog node should be excluded from disambiguation suggestions. Valid
+    #   only when **type**=`standard` or `frame`.
     # @param include_audit [Boolean] Whether to include the audit properties (`created` and `updated` timestamps) in
     #   the response.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.

data/lib/ibm_watson/assistant_v2.rb

@@ -33,6 +33,8 @@ module IBMWatson
   # The Assistant V2 service.
   class AssistantV2 < IBMCloudSdkCore::BaseService
     include Concurrent::Async
+    DEFAULT_SERVICE_NAME = "assistant"
+    DEFAULT_SERVICE_URL = "https://gateway.watsonplatform.net/assistant/api"
     ##
     # @!method initialize(args)
     # Construct a new client for the Assistant service.
@@ -51,19 +53,23 @@ module IBMWatson
     # @option args service_url [String] The base service URL to use when contacting the service.
     #   The base service_url may differ between IBM Cloud regions.
     # @option args authenticator [Object] The Authenticator instance to be configured for this service.
+    # @option args service_name [String] The name of the service to configure. Will be used as the key to load
+    #   any external configuration, if applicable.
     def initialize(args = {})
       @__async_initialized__ = false
       defaults = {}
       defaults[:version] = nil
-      defaults[:service_url] = "https://gateway.watsonplatform.net/assistant/api"
+      defaults[:service_url] = DEFAULT_SERVICE_URL
+      defaults[:service_name] = DEFAULT_SERVICE_NAME
       defaults[:authenticator] = nil
+      user_service_url = args[:service_url] unless args[:service_url].nil?
       args = defaults.merge(args)
       @version = args[:version]
       raise ArgumentError.new("version must be provided") if @version.nil?
 
-      args[:service_name] = "assistant"
       args[:authenticator] = IBMCloudSdkCore::ConfigBasedAuthenticatorFactory.new.get_authenticator(service_name: args[:service_name]) if args[:authenticator].nil?
       super
+      @service_url = user_service_url unless user_service_url.nil?
     end
 
     #########################

data/lib/ibm_watson/compare_comply_v1.rb

@@ -29,6 +29,8 @@ module IBMWatson
   # The Compare Comply V1 service.
   class CompareComplyV1 < IBMCloudSdkCore::BaseService
     include Concurrent::Async
+    DEFAULT_SERVICE_NAME = "compare_comply"
+    DEFAULT_SERVICE_URL = "https://gateway.watsonplatform.net/compare-comply/api"
     ##
     # @!method initialize(args)
     # Construct a new client for the Compare Comply service.
@@ -47,19 +49,23 @@ module IBMWatson
     # @option args service_url [String] The base service URL to use when contacting the service.
     #   The base service_url may differ between IBM Cloud regions.
     # @option args authenticator [Object] The Authenticator instance to be configured for this service.
+    # @option args service_name [String] The name of the service to configure. Will be used as the key to load
+    #   any external configuration, if applicable.
     def initialize(args = {})
       @__async_initialized__ = false
       defaults = {}
       defaults[:version] = nil
-      defaults[:service_url] = "https://gateway.watsonplatform.net/compare-comply/api"
+      defaults[:service_url] = DEFAULT_SERVICE_URL
+      defaults[:service_name] = DEFAULT_SERVICE_NAME
       defaults[:authenticator] = nil
+      user_service_url = args[:service_url] unless args[:service_url].nil?
       args = defaults.merge(args)
       @version = args[:version]
       raise ArgumentError.new("version must be provided") if @version.nil?
 
-      args[:service_name] = "compare_comply"
       args[:authenticator] = IBMCloudSdkCore::ConfigBasedAuthenticatorFactory.new.get_authenticator(service_name: args[:service_name]) if args[:authenticator].nil?
       super
+      @service_url = user_service_url unless user_service_url.nil?
     end
 
     #########################
@@ -473,10 +479,10 @@ module IBMWatson
     # Run Compare and Comply methods over a collection of input documents.
     #
     #   **Important:** Batch processing requires the use of the [IBM Cloud Object Storage
-    #   service](https://cloud.ibm.com/docs/services/cloud-object-storage?topic=cloud-object-storage-about#about-ibm-cloud-object-storage).
+    #   service](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-about#about-ibm-cloud-object-storage).
     #   The use of IBM Cloud Object Storage with Compare and Comply is discussed at [Using
     #   batch
-    #   processing](https://cloud.ibm.com/docs/services/compare-comply?topic=compare-comply-batching#before-you-batch).
+    #   processing](https://cloud.ibm.com/docs/compare-comply?topic=compare-comply-batching#before-you-batch).
     # @param function [String] The Compare and Comply method to run across the submitted input documents.
     # @param input_credentials_file [File] A JSON file containing the input Cloud Object Storage credentials. At a minimum,
     #   the credentials must enable `READ` permissions on the bucket defined by the

data/lib/ibm_watson/discovery_v1.rb

@@ -32,6 +32,8 @@ module IBMWatson
   # The Discovery V1 service.
   class DiscoveryV1 < IBMCloudSdkCore::BaseService
     include Concurrent::Async
+    DEFAULT_SERVICE_NAME = "discovery"
+    DEFAULT_SERVICE_URL = "https://gateway.watsonplatform.net/discovery/api"
     ##
     # @!method initialize(args)
     # Construct a new client for the Discovery service.
@@ -50,19 +52,23 @@ module IBMWatson
     # @option args service_url [String] The base service URL to use when contacting the service.
     #   The base service_url may differ between IBM Cloud regions.
     # @option args authenticator [Object] The Authenticator instance to be configured for this service.
+    # @option args service_name [String] The name of the service to configure. Will be used as the key to load
+    #   any external configuration, if applicable.
     def initialize(args = {})
       @__async_initialized__ = false
       defaults = {}
       defaults[:version] = nil
-      defaults[:service_url] = "https://gateway.watsonplatform.net/discovery/api"
+      defaults[:service_url] = DEFAULT_SERVICE_URL
+      defaults[:service_name] = DEFAULT_SERVICE_NAME
       defaults[:authenticator] = nil
+      user_service_url = args[:service_url] unless args[:service_url].nil?
       args = defaults.merge(args)
       @version = args[:version]
       raise ArgumentError.new("version must be provided") if @version.nil?
 
-      args[:service_name] = "discovery"
       args[:authenticator] = IBMCloudSdkCore::ConfigBasedAuthenticatorFactory.new.get_authenticator(service_name: args[:service_name]) if args[:authenticator].nil?
       super
+      @service_url = user_service_url unless user_service_url.nil?
     end
 
     #########################
@@ -1312,7 +1318,7 @@ module IBMWatson
     # Query a collection.
     # By using this method, you can construct long queries. For details, see the
     #   [Discovery
-    #   documentation](https://cloud.ibm.com/docs/services/discovery?topic=discovery-query-concepts#query-concepts).
+    #   documentation](https://cloud.ibm.com/docs/discovery?topic=discovery-query-concepts#query-concepts).
     # @param environment_id [String] The ID of the environment.
     # @param collection_id [String] The ID of the collection.
     # @param filter [String] A cacheable query that excludes documents that don't mention the query content.
@@ -1432,7 +1438,7 @@ module IBMWatson
     # Queries for notices (errors or warnings) that might have been generated by the
     #   system. Notices are generated when ingesting documents and performing relevance
     #   training. See the [Discovery
-    #   documentation](https://cloud.ibm.com/docs/services/discovery?topic=discovery-query-concepts#query-concepts)
+    #   documentation](https://cloud.ibm.com/docs/discovery?topic=discovery-query-concepts#query-concepts)
     #   for more details on the query language.
     # @param environment_id [String] The ID of the environment.
     # @param collection_id [String] The ID of the collection.
@@ -1532,7 +1538,7 @@ module IBMWatson
     # Query multiple collections.
     # By using this method, you can construct long queries that search multiple
     #   collection. For details, see the [Discovery
-    #   documentation](https://cloud.ibm.com/docs/services/discovery?topic=discovery-query-concepts#query-concepts).
+    #   documentation](https://cloud.ibm.com/docs/discovery?topic=discovery-query-concepts#query-concepts).
     # @param environment_id [String] The ID of the environment.
     # @param collection_ids [String] A comma-separated list of collection IDs to be queried against.
     # @param filter [String] A cacheable query that excludes documents that don't mention the query content.
@@ -1646,7 +1652,7 @@ module IBMWatson
     # Queries for notices (errors or warnings) that might have been generated by the
     #   system. Notices are generated when ingesting documents and performing relevance
     #   training. See the [Discovery
-    #   documentation](https://cloud.ibm.com/docs/services/discovery?topic=discovery-query-concepts#query-concepts)
+    #   documentation](https://cloud.ibm.com/docs/discovery?topic=discovery-query-concepts#query-concepts)
     #   for more details on the query language.
     # @param environment_id [String] The ID of the environment.
     # @param collection_ids [Array[String]] A comma-separated list of collection IDs to be queried against.
@@ -2184,7 +2190,7 @@ module IBMWatson
     #   You associate a customer ID with data by passing the **X-Watson-Metadata** header
     #   with a request that passes data. For more information about personal data and
     #   customer IDs, see [Information
-    #   security](https://cloud.ibm.com/docs/services/discovery?topic=discovery-information-security#information-security).
+    #   security](https://cloud.ibm.com/docs/discovery?topic=discovery-information-security#information-security).
     # @param customer_id [String] The customer ID for which all data is to be deleted.
     # @return [nil]
     def delete_user_data(customer_id:)

data/lib/ibm_watson/discovery_v2.rb

@@ -32,6 +32,8 @@ module IBMWatson
   # The Discovery V2 service.
   class DiscoveryV2 < IBMCloudSdkCore::BaseService
     include Concurrent::Async
+    DEFAULT_SERVICE_NAME = "discovery"
+    DEFAULT_SERVICE_URL = nil
     ##
     # @!method initialize(args)
     # Construct a new client for the Discovery service.
@@ -50,19 +52,23 @@ module IBMWatson
     # @option args service_url [String] The base service URL to use when contacting the service.
     #   The base service_url may differ between IBM Cloud regions.
     # @option args authenticator [Object] The Authenticator instance to be configured for this service.
+    # @option args service_name [String] The name of the service to configure. Will be used as the key to load
+    #   any external configuration, if applicable.
     def initialize(args = {})
       @__async_initialized__ = false
       defaults = {}
       defaults[:version] = nil
-      defaults[:service_url] = nil
+      defaults[:service_url] = DEFAULT_SERVICE_URL
+      defaults[:service_name] = DEFAULT_SERVICE_NAME
       defaults[:authenticator] = nil
+      user_service_url = args[:service_url] unless args[:service_url].nil?
       args = defaults.merge(args)
       @version = args[:version]
       raise ArgumentError.new("version must be provided") if @version.nil?
 
-      args[:service_name] = "discovery"
       args[:authenticator] = IBMCloudSdkCore::ConfigBasedAuthenticatorFactory.new.get_authenticator(service_name: args[:service_name]) if args[:authenticator].nil?
       super
+      @service_url = user_service_url unless user_service_url.nil?
     end
 
     #########################
@@ -107,7 +113,7 @@ module IBMWatson
     # @!method query(project_id:, collection_ids: nil, filter: nil, query: nil, natural_language_query: nil, aggregation: nil, count: nil, _return: nil, offset: nil, sort: nil, highlight: nil, spelling_suggestions: nil, table_results: nil, suggested_refinements: nil, passages: nil)
     # Query a project.
     # By using this method, you can construct queries. For details, see the [Discovery
-    #   documentation](https://cloud.ibm.com/docs/services/discovery-data?topic=discovery-data-query-concepts).
+    #   documentation](https://cloud.ibm.com/docs/discovery-data?topic=discovery-data-query-concepts).
     # @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_ids [Array[String]] A comma-separated list of collection IDs to be queried against.

data/lib/ibm_watson/language_translator_v3.rb

@@ -32,6 +32,8 @@ module IBMWatson
   # The Language Translator V3 service.
   class LanguageTranslatorV3 < IBMCloudSdkCore::BaseService
     include Concurrent::Async
+    DEFAULT_SERVICE_NAME = "language_translator"
+    DEFAULT_SERVICE_URL = "https://gateway.watsonplatform.net/language-translator/api"
     ##
     # @!method initialize(args)
     # Construct a new client for the Language Translator service.
@@ -50,19 +52,23 @@ module IBMWatson
     # @option args service_url [String] The base service URL to use when contacting the service.
     #   The base service_url may differ between IBM Cloud regions.
     # @option args authenticator [Object] The Authenticator instance to be configured for this service.
+    # @option args service_name [String] The name of the service to configure. Will be used as the key to load
+    #   any external configuration, if applicable.
     def initialize(args = {})
       @__async_initialized__ = false
       defaults = {}
       defaults[:version] = nil
-      defaults[:service_url] = "https://gateway.watsonplatform.net/language-translator/api"
+      defaults[:service_url] = DEFAULT_SERVICE_URL
+      defaults[:service_name] = DEFAULT_SERVICE_NAME
       defaults[:authenticator] = nil
+      user_service_url = args[:service_url] unless args[:service_url].nil?
       args = defaults.merge(args)
       @version = args[:version]
       raise ArgumentError.new("version must be provided") if @version.nil?
 
-      args[:service_name] = "language_translator"
       args[:authenticator] = IBMCloudSdkCore::ConfigBasedAuthenticatorFactory.new.get_authenticator(service_name: args[:service_name]) if args[:authenticator].nil?
       super
+      @service_url = user_service_url unless user_service_url.nil?
     end
 
     #########################
@@ -72,13 +78,18 @@ module IBMWatson
     ##
     # @!method translate(text:, model_id: nil, source: nil, target: nil)
     # Translate.
-    # Translates the input text from the source language to the target language.
+    # Translates the input text from the source language to the target language. A
+    #   target language or translation model ID is required. The service attempts to
+    #   detect the language of the source text if it is not specified.
     # @param text [Array[String]] Input text in UTF-8 encoding. Multiple entries will result in multiple
     #   translations in the response.
-    # @param model_id [String] A globally unique string that identifies the underlying model that is used for
-    #   translation.
-    # @param source [String] Translation source language code.
-    # @param target [String] Translation target language code.
+    # @param model_id [String] The model to use for translation. For example, `en-de` selects the IBM provided
+    #   base model for English to German translation. A model ID overrides the source and
+    #   target parameters and is required if you use a custom model. If no model ID is
+    #   specified, you must specify a target language.
+    # @param source [String] Language code that specifies the language of the source document.
+    # @param target [String] Language code that specifies the target language for translation. Required if
+    #   model ID is not specified.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
     def translate(text:, model_id: nil, source: nil, target: nil)
       raise ArgumentError.new("text must be provided") if text.nil?
@@ -394,15 +405,18 @@ module IBMWatson
     # @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)
+    #   types](https://cloud.ibm.com/docs/language-translator?topic=language-translator-document-translator-tutorial#supported-file-formats)
     #
     #   Maximum file size: **20 MB**.
     # @param filename [String] The filename for file.
     # @param file_content_type [String] The content type of file.
-    # @param model_id [String] The model to use for translation. `model_id` or both `source` and `target` are
-    #   required.
+    # @param model_id [String] The model to use for translation. For example, `en-de` selects the IBM provided
+    #   base model for English to German translation. A model ID overrides the source and
+    #   target parameters and is required if you use a custom model. If no model ID is
+    #   specified, you must specify a target language.
     # @param source [String] Language code that specifies the language of the source document.
-    # @param target [String] Language code that specifies the target language for translation.
+    # @param target [String] Language code that specifies the target language for translation. Required if
+    #   model ID is not specified.
     # @param document_id [String] To use a previously submitted document as the source for a new translation, enter
     #   the `document_id` of the document.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.

data/lib/ibm_watson/natural_language_classifier_v1.rb

@@ -31,6 +31,8 @@ module IBMWatson
   # The Natural Language Classifier V1 service.
   class NaturalLanguageClassifierV1 < IBMCloudSdkCore::BaseService
     include Concurrent::Async
+    DEFAULT_SERVICE_NAME = "natural_language_classifier"
+    DEFAULT_SERVICE_URL = "https://gateway.watsonplatform.net/natural-language-classifier/api"
     ##
     # @!method initialize(args)
     # Construct a new client for the Natural Language Classifier service.
@@ -39,15 +41,19 @@ module IBMWatson
     # @option args service_url [String] The base service URL to use when contacting the service.
     #   The base service_url may differ between IBM Cloud regions.
     # @option args authenticator [Object] The Authenticator instance to be configured for this service.
+    # @option args service_name [String] The name of the service to configure. Will be used as the key to load
+    #   any external configuration, if applicable.
     def initialize(args = {})
       @__async_initialized__ = false
       defaults = {}
-      defaults[:service_url] = "https://gateway.watsonplatform.net/natural-language-classifier/api"
+      defaults[:service_url] = DEFAULT_SERVICE_URL
+      defaults[:service_name] = DEFAULT_SERVICE_NAME
       defaults[:authenticator] = nil
+      user_service_url = args[:service_url] unless args[:service_url].nil?
       args = defaults.merge(args)
-      args[:service_name] = "natural_language_classifier"
       args[:authenticator] = IBMCloudSdkCore::ConfigBasedAuthenticatorFactory.new.get_authenticator(service_name: args[:service_name]) if args[:authenticator].nil?
       super
+      @service_url = user_service_url unless user_service_url.nil?
     end
 
     #########################

data/lib/ibm_watson/natural_language_understanding_v1.rb

@@ -20,7 +20,7 @@
 # can ignore most advertisements and other unwanted content.
 #
 # You can create [custom
-# models](https://cloud.ibm.com/docs/services/natural-language-understanding?topic=natural-language-understanding-customizing)
+# models](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-customizing)
 # with Watson Knowledge Studio to detect custom entities and relations in Natural Language
 # Understanding.
 
@@ -36,6 +36,8 @@ module IBMWatson
   # The Natural Language Understanding V1 service.
   class NaturalLanguageUnderstandingV1 < IBMCloudSdkCore::BaseService
     include Concurrent::Async
+    DEFAULT_SERVICE_NAME = "natural_language_understanding"
+    DEFAULT_SERVICE_URL = "https://gateway.watsonplatform.net/natural-language-understanding/api"
     ##
     # @!method initialize(args)
     # Construct a new client for the Natural Language Understanding service.
@@ -54,19 +56,23 @@ module IBMWatson
     # @option args service_url [String] The base service URL to use when contacting the service.
     #   The base service_url may differ between IBM Cloud regions.
     # @option args authenticator [Object] The Authenticator instance to be configured for this service.
+    # @option args service_name [String] The name of the service to configure. Will be used as the key to load
+    #   any external configuration, if applicable.
     def initialize(args = {})
       @__async_initialized__ = false
       defaults = {}
       defaults[:version] = nil
-      defaults[:service_url] = "https://gateway.watsonplatform.net/natural-language-understanding/api"
+      defaults[:service_url] = DEFAULT_SERVICE_URL
+      defaults[:service_name] = DEFAULT_SERVICE_NAME
       defaults[:authenticator] = nil
+      user_service_url = args[:service_url] unless args[:service_url].nil?
       args = defaults.merge(args)
       @version = args[:version]
       raise ArgumentError.new("version must be provided") if @version.nil?
 
-      args[:service_name] = "natural_language_understanding"
       args[:authenticator] = IBMCloudSdkCore::ConfigBasedAuthenticatorFactory.new.get_authenticator(service_name: args[:service_name]) if args[:authenticator].nil?
       super
+      @service_url = user_service_url unless user_service_url.nil?
     end
 
     #########################
@@ -90,7 +96,7 @@ module IBMWatson
     #
     #   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).
+    #   language](https://cloud.ibm.com/docs/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.
@@ -100,10 +106,10 @@ module IBMWatson
     #   required.
     # @param clean [Boolean] Set this to `false` to disable webpage cleaning. To learn more about webpage
     #   cleaning, see the [Analyzing
-    #   webpages](https://cloud.ibm.com/docs/services/natural-language-understanding?topic=natural-language-understanding-analyzing-webpages)
+    #   webpages](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-analyzing-webpages)
     #   documentation.
     # @param xpath [String] An [XPath
-    #   query](https://cloud.ibm.com/docs/services/natural-language-understanding?topic=natural-language-understanding-analyzing-webpages#xpath)
+    #   query](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-analyzing-webpages#xpath)
     #   to perform on `html` or `url` input. Results of the query will be appended to the
     #   cleaned webpage text before it is analyzed. To analyze only the results of the
     #   XPath query, set the `clean` parameter to `false`.
@@ -112,7 +118,7 @@ module IBMWatson
     # @param language [String] ISO 639-1 code that specifies the language of your text. This overrides automatic
     #   language detection. Language support differs depending on the features you include
     #   in your analysis. See [Language
-    #   support](https://cloud.ibm.com/docs/services/natural-language-understanding?topic=natural-language-understanding-language-support)
+    #   support](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-language-support)
     #   for more information.
     # @param limit_text_characters [Fixnum] Sets the maximum number of characters that are processed by the service.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
@@ -161,7 +167,7 @@ module IBMWatson
     # @!method list_models
     # List models.
     # Lists Watson Knowledge Studio [custom entities and relations
-    #   models](https://cloud.ibm.com/docs/services/natural-language-understanding?topic=natural-language-understanding-customizing)
+    #   models](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-customizing)
     #   that are deployed to your Natural Language Understanding service.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
     def list_models