ibm_watson 1.1.0 → 1.5.0

data/lib/ibm_watson/assistant_v2.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# (C) Copyright IBM Corp. 2019.
+# (C) Copyright IBM Corp. 2018, 2020.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -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
 
     #########################
@@ -77,11 +83,11 @@ module IBMWatson
     #   responses. It also maintains the state of the conversation. A session persists
     #   until it is deleted, or until it times out because of inactivity. (For more
     #   information, see the
-    #   [documentation](https://cloud.ibm.com/docs/services/assistant?topic=assistant-assistant-settings).
+    #   [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-assistant-settings).
     # @param assistant_id [String] Unique identifier of the assistant. To find the assistant ID in the Watson
     #   Assistant user interface, open the assistant settings and click **API Details**.
     #   For information about creating assistants, see the
-    #   [documentation](https://cloud.ibm.com/docs/services/assistant?topic=assistant-assistant-add#assistant-add-task).
+    #   [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-assistant-add#assistant-add-task).
     #
     #   **Note:** Currently, the v2 API does not support creating assistants.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
@@ -114,11 +120,11 @@ module IBMWatson
     # Delete session.
     # Deletes a session explicitly before it times out. (For more information about the
     #   session inactivity timeout, see the
-    #   [documentation](https://cloud.ibm.com/docs/services/assistant?topic=assistant-assistant-settings)).
+    #   [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-assistant-settings)).
     # @param assistant_id [String] Unique identifier of the assistant. To find the assistant ID in the Watson
     #   Assistant user interface, open the assistant settings and click **API Details**.
     #   For information about creating assistants, see the
-    #   [documentation](https://cloud.ibm.com/docs/services/assistant?topic=assistant-assistant-add#assistant-add-task).
+    #   [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-assistant-add#assistant-add-task).
     #
     #   **Note:** Currently, the v2 API does not support creating assistants.
     # @param session_id [String] Unique identifier of the session.
@@ -154,21 +160,26 @@ module IBMWatson
 
     ##
     # @!method message(assistant_id:, session_id:, input: nil, context: nil)
-    # Send user input to assistant.
-    # Send user input to an assistant and receive a response.
+    # Send user input to assistant (stateful).
+    # Send user input to an assistant and receive a response, with conversation state
+    #   (including context data) stored by Watson Assistant for the duration of the
+    #   session.
     #
     #   There is no rate limit for this operation.
     # @param assistant_id [String] Unique identifier of the assistant. To find the assistant ID in the Watson
     #   Assistant user interface, open the assistant settings and click **API Details**.
     #   For information about creating assistants, see the
-    #   [documentation](https://cloud.ibm.com/docs/services/assistant?topic=assistant-assistant-add#assistant-add-task).
+    #   [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-assistant-add#assistant-add-task).
     #
     #   **Note:** Currently, the v2 API does not support creating assistants.
     # @param session_id [String] Unique identifier of the session.
     # @param input [MessageInput] An input object that includes the input text.
-    # @param context [MessageContext] State information for the conversation. The context is stored by the assistant on
-    #   a per-session basis. You can use this property to set or modify context variables,
-    #   which can also be accessed by dialog nodes.
+    # @param context [MessageContext] Context data for the conversation. You can use this property to set or modify
+    #   context variables, which can also be accessed by dialog nodes. The context is
+    #   stored by the assistant on a per-session basis.
+    #
+    #   **Note:** The total size of the context data stored for a stateful session cannot
+    #   exceed 100KB.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
     def message(assistant_id:, session_id:, input: nil, context: nil)
       raise ArgumentError.new("assistant_id must be provided") if assistant_id.nil?
@@ -201,5 +212,57 @@ module IBMWatson
       )
       response
     end
+
+    ##
+    # @!method message_stateless(assistant_id:, input: nil, context: nil)
+    # Send user input to assistant (stateless).
+    # Send user input to an assistant and receive a response, with conversation state
+    #   (including context data) managed by your application.
+    #
+    #   There is no rate limit for this operation.
+    # @param assistant_id [String] Unique identifier of the assistant. To find the assistant ID in the Watson
+    #   Assistant user interface, open the assistant settings and click **API Details**.
+    #   For information about creating assistants, see the
+    #   [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-assistant-add#assistant-add-task).
+    #
+    #   **Note:** Currently, the v2 API does not support creating assistants.
+    # @param input [MessageInputStateless] An input object that includes the input text.
+    # @param context [MessageContextStateless] Context data for the conversation. You can use this property to set or modify
+    #   context variables, which can also be accessed by dialog nodes. The context is not
+    #   stored by the assistant. To maintain session state, include the context from the
+    #   previous response.
+    #
+    #   **Note:** The total size of the context data for a stateless session cannot exceed
+    #   250KB.
+    # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
+    def message_stateless(assistant_id:, input: nil, context: nil)
+      raise ArgumentError.new("assistant_id must be provided") if assistant_id.nil?
+
+      headers = {
+      }
+      sdk_headers = Common.new.get_sdk_headers("conversation", "V2", "message_stateless")
+      headers.merge!(sdk_headers)
+
+      params = {
+        "version" => @version
+      }
+
+      data = {
+        "input" => input,
+        "context" => context
+      }
+
+      method_url = "/v2/assistants/%s/message" % [ERB::Util.url_encode(assistant_id)]
+
+      response = request(
+        method: "POST",
+        url: method_url,
+        headers: headers,
+        params: params,
+        json: data,
+        accept_json: true
+      )
+      response
+    end
   end
 end

data/lib/ibm_watson/compare_comply_v1.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# (C) Copyright IBM Corp. 2019.
+# (C) Copyright IBM Corp. 2018, 2020.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# (C) Copyright IBM Corp. 2019.
+# (C) Copyright IBM Corp. 2018, 2020.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -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
 
     #########################
@@ -631,6 +637,8 @@ module IBMWatson
 
       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")
@@ -1310,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.
@@ -1430,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.
@@ -1530,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.
@@ -1590,6 +1598,8 @@ module IBMWatson
     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
       }
@@ -1642,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.
@@ -2180,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:)
@@ -2216,7 +2226,7 @@ module IBMWatson
     # 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.

data/lib/ibm_watson/discovery_v2.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# (C) Copyright IBM Corp. 2019.
+# (C) Copyright IBM Corp. 2019, 2020.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -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.
@@ -387,14 +393,14 @@ module IBMWatson
     #   **_/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 +465,18 @@ module IBMWatson
     #   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.
+    #
+    #   **Note:** If an uploaded document is segmented, all segments will be overwritten,
+    #   even if the updated version of the document has fewer segments.
     # @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,8 +538,11 @@ module IBMWatson
     #   '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.
+    #
+    #   **Note:** Segments of an uploaded document cannot be deleted individually. Delete
+    #   all segments by deleting using the `parent_document_id` of a segment result.
     # @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.
@@ -647,6 +659,10 @@ module IBMWatson
     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")

data/lib/ibm_watson/language_translator_v3.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# (C) Copyright IBM Corp. 2019.
+# (C) Copyright IBM Corp. 2018, 2020.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -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?
@@ -391,18 +402,21 @@ module IBMWatson
     # 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)
+    #   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.