ibm_watson 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39e10926734524673eccb99a00cdcb9356d3570514b6ee6e320054b6a11f310e
-  data.tar.gz: 50a19a96c0bfb3843eba4540bc36a417ed0aed27ca1eb02e491c73a2897c2912
+  metadata.gz: ae8370e694afb3c9bc5904e6cf9156e329c46569e531953bd5de499d8e06d069
+  data.tar.gz: 07a2a51577402b7a908996e3e536d7085bfd4e3fbb1e854bff24902d71d085c9
 SHA512:
-  metadata.gz: 313e51742037b568acc09e6caff75508e6a3f900cea657a499fc4f7f0b15052c224071577ccd4beb6774a3fc0c60eda8f22fe2393c2eaf84f594d6a5cc38b32b
-  data.tar.gz: d35a075c19323141bac2c5c15bf61b873d616ac5c4bb9578969713294056b81207d3d200560fba3947ca019acc00a6bb30bdebc8638e95c8ffca50df810e03ed
+  metadata.gz: 12746df4ba137cda554cfb8fcd7f313bfc7a355f2f258a86a39d3d6824f06e9e7e30947c22b846bc811d3bafadb8e7e1cdb4e916209fe76b44c74358fa1f6c75
+  data.tar.gz: 9942822349a390ebe594b4905f1148b0a21aa6eac12de531c6505aee9e43d00a5cdb16a3a18ad71b87bc75625987ff35ee2c1d92f06a11123da797b5d3a6f254

data/README.md

@@ -16,6 +16,7 @@ Ruby gem to quickly get started with the various [IBM Watson][wdc] services.
 * [Before you begin](#before-you-begin)
 * [Installation](#installation)
 * [Examples](#examples)
+* [Discovery v2 only on CP4D](#discovery-v2-only-on-cp4d)
 * [Running in IBM Cloud](#running-in-ibm-cloud)
 * [Authentication](#authentication)
   * [Getting credentials](#getting-credentials)
@@ -61,6 +62,10 @@ require "ibm_watson"
 
 The [examples][examples] folder has basic and advanced examples. The examples within each service assume that you already have [service credentials](#getting-credentials).
 
+## Discovery v2 only on CP4D
+
+Discovery v2 is only available on Cloud Pak for Data.
+
 ## Running in IBM Cloud
 
 If you run your app in IBM Cloud, the SDK gets credentials from the [`VCAP_SERVICES`][vcap_services] environment variable.
@@ -350,7 +355,7 @@ The SDK will manage the token for the user
 
 ```ruby
 
-authenticator = IBMWatson::Authenticators::CLoudPakForDataAuthenticator.new(
+authenticator = IBMWatson::Authenticators::CloudPakForDataAuthenticator.new(
   username: "<username>",
   password: "<password>",
   url: "<authentication url>",
@@ -360,7 +365,7 @@ assistant = IBMWatson::AssistantV1.new(
   version: "<version>",
   authenticator: authenticator
 )
-assistant.configure_http_client(disable_ssl_verification: true) # MAKE SURE SSL VERIFICATION IS DISABLED
+
 ```
 
 ## Ruby version

data/lib/ibm_watson.rb

@@ -13,6 +13,7 @@ module IBMWatson
   require_relative("./ibm_watson/assistant_v2.rb")
   require_relative("./ibm_watson/text_to_speech_v1.rb")
   require_relative("./ibm_watson/discovery_v1.rb")
+  require_relative("./ibm_watson/discovery_v2.rb")
   require_relative("./ibm_watson/natural_language_understanding_v1.rb")
   require_relative("./ibm_watson/speech_to_text_v1.rb")
   require_relative("./ibm_watson/visual_recognition_v3.rb")

data/lib/ibm_watson/assistant_v1.rb

@@ -177,7 +177,7 @@ module IBMWatson
     end
 
     ##
-    # @!method create_workspace(name: nil, description: nil, language: nil, metadata: nil, learning_opt_out: nil, system_settings: nil, intents: nil, entities: nil, dialog_nodes: nil, counterexamples: nil)
+    # @!method create_workspace(name: nil, description: nil, language: nil, metadata: nil, learning_opt_out: nil, system_settings: nil, intents: nil, entities: nil, dialog_nodes: nil, counterexamples: nil, webhooks: nil)
     # Create workspace.
     # Create a workspace based on component objects. You must provide workspace
     #   components defining the content of the new workspace.
@@ -199,8 +199,9 @@ module IBMWatson
     # @param dialog_nodes [Array[DialogNode]] An array of objects describing the dialog nodes in the workspace.
     # @param counterexamples [Array[Counterexample]] An array of objects defining input examples that have been marked as irrelevant
     #   input.
+    # @param webhooks [Array[Webhook]]
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
-    def create_workspace(name: nil, description: nil, language: nil, metadata: nil, learning_opt_out: nil, system_settings: nil, intents: nil, entities: nil, dialog_nodes: nil, counterexamples: nil)
+    def create_workspace(name: nil, description: nil, language: nil, metadata: nil, learning_opt_out: nil, system_settings: nil, intents: nil, entities: nil, dialog_nodes: nil, counterexamples: nil, webhooks: nil)
       headers = {
       }
       sdk_headers = Common.new.get_sdk_headers("conversation", "V1", "create_workspace")
@@ -220,7 +221,8 @@ module IBMWatson
         "intents" => intents,
         "entities" => entities,
         "dialog_nodes" => dialog_nodes,
-        "counterexamples" => counterexamples
+        "counterexamples" => counterexamples,
+        "webhooks" => webhooks
       }
 
       method_url = "/v1/workspaces"
@@ -282,7 +284,7 @@ module IBMWatson
     end
 
     ##
-    # @!method update_workspace(workspace_id:, name: nil, description: nil, language: nil, metadata: nil, learning_opt_out: nil, system_settings: nil, intents: nil, entities: nil, dialog_nodes: nil, counterexamples: nil, append: nil)
+    # @!method update_workspace(workspace_id:, name: nil, description: nil, language: nil, metadata: nil, learning_opt_out: nil, system_settings: nil, intents: nil, entities: nil, dialog_nodes: nil, counterexamples: nil, webhooks: nil, append: nil)
     # Update workspace.
     # Update an existing workspace with new or modified data. You must provide component
     #   objects defining the content of the updated workspace.
@@ -305,6 +307,7 @@ module IBMWatson
     # @param dialog_nodes [Array[DialogNode]] An array of objects describing the dialog nodes in the workspace.
     # @param counterexamples [Array[Counterexample]] An array of objects defining input examples that have been marked as irrelevant
     #   input.
+    # @param webhooks [Array[Webhook]]
     # @param append [Boolean] Whether the new data is to be appended to the existing data in the workspace. If
     #   **append**=`false`, elements included in the new data completely replace the
     #   corresponding existing elements, including all subelements. For example, if the
@@ -315,7 +318,7 @@ module IBMWatson
     #   added. If any elements in the new data collide with existing elements, the update
     #   request fails.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
-    def update_workspace(workspace_id:, name: nil, description: nil, language: nil, metadata: nil, learning_opt_out: nil, system_settings: nil, intents: nil, entities: nil, dialog_nodes: nil, counterexamples: nil, append: nil)
+    def update_workspace(workspace_id:, name: nil, description: nil, language: nil, metadata: nil, learning_opt_out: nil, system_settings: nil, intents: nil, entities: nil, dialog_nodes: nil, counterexamples: nil, webhooks: nil, append: nil)
       raise ArgumentError.new("workspace_id must be provided") if workspace_id.nil?
 
       headers = {
@@ -338,7 +341,8 @@ module IBMWatson
         "intents" => intents,
         "entities" => entities,
         "dialog_nodes" => dialog_nodes,
-        "counterexamples" => counterexamples
+        "counterexamples" => counterexamples,
+        "webhooks" => webhooks
       }
 
       method_url = "/v1/workspaces/%s" % [ERB::Util.url_encode(workspace_id)]
@@ -1936,7 +1940,7 @@ module IBMWatson
     end
 
     ##
-    # @!method create_dialog_node(workspace_id:, dialog_node:, description: nil, conditions: nil, parent: nil, previous_sibling: nil, output: nil, context: nil, metadata: nil, next_step: nil, title: nil, type: nil, event_name: nil, variable: nil, actions: nil, digress_in: nil, digress_out: nil, digress_out_slots: nil, user_label: nil)
+    # @!method create_dialog_node(workspace_id:, dialog_node:, description: nil, conditions: nil, parent: nil, previous_sibling: nil, output: nil, context: nil, metadata: nil, next_step: nil, title: nil, type: nil, event_name: nil, variable: nil, actions: nil, digress_in: nil, digress_out: nil, digress_out_slots: nil, user_label: nil, disambiguation_opt_out: nil)
     # Create dialog node.
     # Create a new dialog node.
     #
@@ -1976,8 +1980,9 @@ 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.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
-    def create_dialog_node(workspace_id:, dialog_node:, description: nil, conditions: nil, parent: nil, previous_sibling: nil, output: nil, context: nil, metadata: nil, next_step: nil, title: nil, type: nil, event_name: nil, variable: nil, actions: nil, digress_in: nil, digress_out: nil, digress_out_slots: nil, user_label: nil)
+    def create_dialog_node(workspace_id:, dialog_node:, description: nil, conditions: nil, parent: nil, previous_sibling: nil, output: nil, context: nil, metadata: nil, next_step: nil, title: nil, type: nil, event_name: nil, variable: nil, actions: nil, digress_in: nil, digress_out: nil, digress_out_slots: nil, user_label: nil, disambiguation_opt_out: nil)
       raise ArgumentError.new("workspace_id must be provided") if workspace_id.nil?
 
       raise ArgumentError.new("dialog_node must be provided") if dialog_node.nil?
@@ -2009,7 +2014,8 @@ module IBMWatson
         "digress_in" => digress_in,
         "digress_out" => digress_out,
         "digress_out_slots" => digress_out_slots,
-        "user_label" => user_label
+        "user_label" => user_label,
+        "disambiguation_opt_out" => disambiguation_opt_out
       }
 
       method_url = "/v1/workspaces/%s/dialog_nodes" % [ERB::Util.url_encode(workspace_id)]
@@ -2065,7 +2071,7 @@ module IBMWatson
     end
 
     ##
-    # @!method update_dialog_node(workspace_id:, dialog_node:, new_dialog_node: nil, new_description: nil, new_conditions: nil, new_parent: nil, new_previous_sibling: nil, new_output: nil, new_context: nil, new_metadata: nil, new_next_step: nil, new_title: nil, new_type: nil, new_event_name: nil, new_variable: nil, new_actions: nil, new_digress_in: nil, new_digress_out: nil, new_digress_out_slots: nil, new_user_label: nil)
+    # @!method update_dialog_node(workspace_id:, dialog_node:, new_dialog_node: nil, new_description: nil, new_conditions: nil, new_parent: nil, new_previous_sibling: nil, new_output: nil, new_context: nil, new_metadata: nil, new_next_step: nil, new_title: nil, new_type: nil, new_event_name: nil, new_variable: nil, new_actions: nil, new_digress_in: nil, new_digress_out: nil, new_digress_out_slots: nil, new_user_label: nil, new_disambiguation_opt_out: nil)
     # Update dialog node.
     # Update an existing dialog node with new or modified data.
     #
@@ -2106,8 +2112,9 @@ 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.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
-    def update_dialog_node(workspace_id:, dialog_node:, new_dialog_node: nil, new_description: nil, new_conditions: nil, new_parent: nil, new_previous_sibling: nil, new_output: nil, new_context: nil, new_metadata: nil, new_next_step: nil, new_title: nil, new_type: nil, new_event_name: nil, new_variable: nil, new_actions: nil, new_digress_in: nil, new_digress_out: nil, new_digress_out_slots: nil, new_user_label: nil)
+    def update_dialog_node(workspace_id:, dialog_node:, new_dialog_node: nil, new_description: nil, new_conditions: nil, new_parent: nil, new_previous_sibling: nil, new_output: nil, new_context: nil, new_metadata: nil, new_next_step: nil, new_title: nil, new_type: nil, new_event_name: nil, new_variable: nil, new_actions: nil, new_digress_in: nil, new_digress_out: nil, new_digress_out_slots: nil, new_user_label: nil, new_disambiguation_opt_out: nil)
       raise ArgumentError.new("workspace_id must be provided") if workspace_id.nil?
 
       raise ArgumentError.new("dialog_node must be provided") if dialog_node.nil?
@@ -2139,7 +2146,8 @@ module IBMWatson
         "digress_in" => new_digress_in,
         "digress_out" => new_digress_out,
         "digress_out_slots" => new_digress_out_slots,
-        "user_label" => new_user_label
+        "user_label" => new_user_label,
+        "disambiguation_opt_out" => new_disambiguation_opt_out
       }
 
       method_url = "/v1/workspaces/%s/dialog_nodes/%s" % [ERB::Util.url_encode(workspace_id), ERB::Util.url_encode(dialog_node)]
@@ -2249,8 +2257,8 @@ module IBMWatson
     #   more information, see **Rate limiting**.
     # @param filter [String] A cacheable parameter that limits the results to those matching the specified
     #   filter. You must specify a filter query that includes a value for `language`, as
-    #   well as a value for `workspace_id` or `request.context.metadata.deployment`. For
-    #   more information, see the
+    #   well as a value for `request.context.system.assistant_id`, `workspace_id`, or
+    #   `request.context.metadata.deployment`. For more information, see the
     #   [documentation](https://cloud.ibm.com/docs/services/assistant?topic=assistant-filter-reference#filter-reference).
     # @param sort [String] How to sort the returned log events. You can sort by **request_timestamp**. To
     #   reverse the sort order, prefix the parameter value with a minus sign (`-`).

data/lib/ibm_watson/assistant_v2.rb

@@ -74,7 +74,10 @@ module IBMWatson
     # @!method create_session(assistant_id:)
     # Create a session.
     # Create a new session. A session is used to send user input to a skill and receive
-    #   responses. It also maintains the state of the conversation.
+    #   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).
     # @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
@@ -109,7 +112,9 @@ module IBMWatson
     ##
     # @!method delete_session(assistant_id:, session_id:)
     # Delete session.
-    # Deletes a session explicitly before it times out.
+    # 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)).
     # @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

data/lib/ibm_watson/discovery_v1.rb

@@ -1112,7 +1112,7 @@ module IBMWatson
     # @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.
@@ -1213,7 +1213,7 @@ module IBMWatson
     # @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.

data/lib/ibm_watson/discovery_v2.rb

@@ -0,0 +1,762 @@
+# frozen_string_literal: true
+
+# (C) Copyright IBM Corp. 2019.
+#
+# 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.
+
+# IBM Watson™ Discovery for IBM Cloud Pak for Data is a cognitive search and
+# content analytics engine that you can add to applications to identify patterns, trends
+# and actionable insights to drive better decision-making. Securely unify structured and
+# unstructured data with pre-enriched content, and use a simplified query language to
+# eliminate the need for manual filtering of results.
+
+require "concurrent"
+require "erb"
+require "json"
+require "ibm_cloud_sdk_core"
+require_relative "./common.rb"
+
+# Module for the Watson APIs
+module IBMWatson
+  ##
+  # The Discovery V2 service.
+  class DiscoveryV2 < IBMCloudSdkCore::BaseService
+    include Concurrent::Async
+    ##
+    # @!method initialize(args)
+    # Construct a new client for the Discovery service.
+    #
+    # @param args [Hash] The args to initialize with
+    # @option args version [String] The API version date to use with the service, in
+    #   "YYYY-MM-DD" format. Whenever the API is changed in a backwards
+    #   incompatible way, a new minor version of the API is released.
+    #   The service uses the API version for the date you specify, or
+    #   the most recent version before that date. Note that you should
+    #   not programmatically specify the current date at runtime, in
+    #   case the API has been updated since your application's release.
+    #   Instead, specify a version date that is compatible with your
+    #   application, and don't change it until your application is
+    #   ready for a later version.
+    # @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.
+    def initialize(args = {})
+      @__async_initialized__ = false
+      defaults = {}
+      defaults[:version] = nil
+      defaults[:service_url] = nil
+      defaults[:authenticator] = 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
+    end
+
+    #########################
+    # Collections
+    #########################
+
+    ##
+    # @!method list_collections(project_id:)
+    # List collections.
+    # Lists existing collections for the specified project.
+    # @param project_id [String] The ID of the project. This information can be found from the deploy page of the
+    #   Discovery administrative tooling.
+    # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
+    def list_collections(project_id:)
+      raise ArgumentError.new("project_id must be provided") if project_id.nil?
+
+      headers = {
+      }
+      sdk_headers = Common.new.get_sdk_headers("discovery", "V2", "list_collections")
+      headers.merge!(sdk_headers)
+
+      params = {
+        "version" => @version
+      }
+
+      method_url = "/v2/projects/%s/collections" % [ERB::Util.url_encode(project_id)]
+
+      response = request(
+        method: "GET",
+        url: method_url,
+        headers: headers,
+        params: params,
+        accept_json: true
+      )
+      response
+    end
+    #########################
+    # Queries
+    #########################
+
+    ##
+    # @!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).
+    # @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.
+    # @param filter [String] A cacheable query that excludes documents that don't mention the query content.
+    #   Filter searches are better for metadata-type searches and for assessing the
+    #   concepts in the data set.
+    # @param query [String] A query search returns all documents in your data set with full enrichments and
+    #   full text, but with the most relevant documents listed first. Use a query search
+    #   when you want to find the most relevant search results.
+    # @param natural_language_query [String] A natural language query that returns relevant documents by utilizing training
+    #   data and natural language understanding.
+    # @param aggregation [String] An aggregation search that returns an exact answer by combining query search with
+    #   filters. Useful for applications to build lists, tables, and time series. For a
+    #   full list of possible aggregations, see the Query reference.
+    # @param count [Fixnum] Number of results to return.
+    # @param _return [Array[String]] A list of the fields in the document hierarchy to return. If this parameter not
+    #   specified, then all top-level fields are returned.
+    # @param offset [Fixnum] The number of query results to skip at the beginning. For example, if the total
+    #   number of results that are returned is 10 and the offset is 8, it returns the last
+    #   two results.
+    # @param sort [String] A comma-separated list of fields in the document to sort on. You can optionally
+    #   specify a sort direction by prefixing the field with `-` for descending or `+` for
+    #   ascending. Ascending is the default sort direction if no prefix is specified. This
+    #   parameter cannot be used in the same query as the **bias** parameter.
+    # @param highlight [Boolean] When `true`, a highlight field is returned for each result which contains the
+    #   fields which match the query with `<em></em>` tags around the matching query
+    #   terms.
+    # @param spelling_suggestions [Boolean] When `true` and the **natural_language_query** parameter is used, the
+    #   **natural_language_query** parameter is spell checked. The most likely correction
+    #   is returned in the **suggested_query** field of the response (if one exists).
+    # @param table_results [QueryLargeTableResults] Configuration for table retrieval.
+    # @param suggested_refinements [QueryLargeSuggestedRefinements] Configuration for suggested refinements.
+    # @param passages [QueryLargePassages] Configuration for passage retrieval.
+    # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
+    def 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)
+      raise ArgumentError.new("project_id must be provided") if project_id.nil?
+
+      headers = {
+      }
+      sdk_headers = Common.new.get_sdk_headers("discovery", "V2", "query")
+      headers.merge!(sdk_headers)
+
+      params = {
+        "version" => @version
+      }
+
+      data = {
+        "collection_ids" => collection_ids,
+        "filter" => filter,
+        "query" => query,
+        "natural_language_query" => natural_language_query,
+        "aggregation" => aggregation,
+        "count" => count,
+        "return" => _return,
+        "offset" => offset,
+        "sort" => sort,
+        "highlight" => highlight,
+        "spelling_suggestions" => spelling_suggestions,
+        "table_results" => table_results,
+        "suggested_refinements" => suggested_refinements,
+        "passages" => passages
+      }
+
+      method_url = "/v2/projects/%s/query" % [ERB::Util.url_encode(project_id)]
+
+      response = request(
+        method: "POST",
+        url: method_url,
+        headers: headers,
+        params: params,
+        json: data,
+        accept_json: true
+      )
+      response
+    end
+
+    ##
+    # @!method get_autocompletion(project_id:, prefix:, collection_ids: nil, field: nil, count: nil)
+    # Get Autocomplete Suggestions.
+    # Returns completion query suggestions for the specified prefix.
+    # @param project_id [String] The ID of the project. This information can be found from the deploy page of the
+    #   Discovery administrative tooling.
+    # @param prefix [String] The prefix to use for autocompletion. For example, the prefix `Ho` could
+    #   autocomplete to `Hot`, `Housing`, or `How do I upgrade`. Possible completions are.
+    # @param collection_ids [Array[String]] Comma separated list of the collection IDs. If this parameter is not specified,
+    #   all collections in the project are used.
+    # @param field [String] The field in the result documents that autocompletion suggestions are identified
+    #   from.
+    # @param count [Fixnum] The number of autocompletion suggestions to return.
+    # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
+    def get_autocompletion(project_id:, prefix:, collection_ids: nil, field: nil, count: nil)
+      raise ArgumentError.new("project_id must be provided") if project_id.nil?
+
+      raise ArgumentError.new("prefix must be provided") if prefix.nil?
+
+      headers = {
+      }
+      sdk_headers = Common.new.get_sdk_headers("discovery", "V2", "get_autocompletion")
+      headers.merge!(sdk_headers)
+      collection_ids *= "," unless collection_ids.nil?
+
+      params = {
+        "version" => @version,
+        "prefix" => prefix,
+        "collection_ids" => collection_ids,
+        "field" => field,
+        "count" => count
+      }
+
+      method_url = "/v2/projects/%s/autocompletion" % [ERB::Util.url_encode(project_id)]
+
+      response = request(
+        method: "GET",
+        url: method_url,
+        headers: headers,
+        params: params,
+        accept_json: true
+      )
+      response
+    end
+
+    ##
+    # @!method query_notices(project_id:, filter: nil, query: nil, natural_language_query: nil, count: nil, offset: nil)
+    # Query system notices.
+    # Queries for notices (errors or warnings) that might have been generated by the
+    #   system. Notices are generated when ingesting documents and performing relevance
+    #   training.
+    # @param project_id [String] The ID of the project. This information can be found from the deploy page of the
+    #   Discovery administrative tooling.
+    # @param filter [String] A cacheable query that excludes documents that don't mention the query content.
+    #   Filter searches are better for metadata-type searches and for assessing the
+    #   concepts in the data set.
+    # @param query [String] A query search returns all documents in your data set with full enrichments and
+    #   full text, but with the most relevant documents listed first.
+    # @param natural_language_query [String] A natural language query that returns relevant documents by utilizing training
+    #   data and natural language understanding.
+    # @param count [Fixnum] Number of results to return. The maximum for the **count** and **offset** values
+    #   together in any one query is **10000**.
+    # @param offset [Fixnum] The number of query results to skip at the beginning. For example, if the total
+    #   number of results that are returned is 10 and the offset is 8, it returns the last
+    #   two results. The maximum for the **count** and **offset** values together in any
+    #   one query is **10000**.
+    # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
+    def query_notices(project_id:, filter: nil, query: nil, natural_language_query: nil, count: nil, offset: nil)
+      raise ArgumentError.new("project_id must be provided") if project_id.nil?
+
+      headers = {
+      }
+      sdk_headers = Common.new.get_sdk_headers("discovery", "V2", "query_notices")
+      headers.merge!(sdk_headers)
+
+      params = {
+        "version" => @version,
+        "filter" => filter,
+        "query" => query,
+        "natural_language_query" => natural_language_query,
+        "count" => count,
+        "offset" => offset
+      }
+
+      method_url = "/v2/projects/%s/notices" % [ERB::Util.url_encode(project_id)]
+
+      response = request(
+        method: "GET",
+        url: method_url,
+        headers: headers,
+        params: params,
+        accept_json: true
+      )
+      response
+    end
+
+    ##
+    # @!method list_fields(project_id:, collection_ids: nil)
+    # List fields.
+    # Gets a list of the unique fields (and their types) stored in the the specified
+    #   collections.
+    # @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]] Comma separated list of the collection IDs. If this parameter is not specified,
+    #   all collections in the project are used.
+    # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
+    def list_fields(project_id:, collection_ids: nil)
+      raise ArgumentError.new("project_id must be provided") if project_id.nil?
+
+      headers = {
+      }
+      sdk_headers = Common.new.get_sdk_headers("discovery", "V2", "list_fields")
+      headers.merge!(sdk_headers)
+      collection_ids *= "," unless collection_ids.nil?
+
+      params = {
+        "version" => @version,
+        "collection_ids" => collection_ids
+      }
+
+      method_url = "/v2/projects/%s/fields" % [ERB::Util.url_encode(project_id)]
+
+      response = request(
+        method: "GET",
+        url: method_url,
+        headers: headers,
+        params: params,
+        accept_json: true
+      )
+      response
+    end
+    #########################
+    # Component settings
+    #########################
+
+    ##
+    # @!method get_component_settings(project_id:)
+    # Configuration settings for components.
+    # Returns default configuration settings for components.
+    # @param project_id [String] The ID of the project. This information can be found from the deploy page of the
+    #   Discovery administrative tooling.
+    # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
+    def get_component_settings(project_id:)
+      raise ArgumentError.new("project_id must be provided") if project_id.nil?
+
+      headers = {
+      }
+      sdk_headers = Common.new.get_sdk_headers("discovery", "V2", "get_component_settings")
+      headers.merge!(sdk_headers)
+
+      params = {
+        "version" => @version
+      }
+
+      method_url = "/v2/projects/%s/component_settings" % [ERB::Util.url_encode(project_id)]
+
+      response = request(
+        method: "GET",
+        url: method_url,
+        headers: headers,
+        params: params,
+        accept_json: true
+      )
+      response
+    end
+    #########################
+    # Documents
+    #########################
+
+    ##
+    # @!method add_document(project_id:, collection_id:, file: nil, filename: nil, file_content_type: nil, metadata: nil, x_watson_discovery_force: nil)
+    # Add a document.
+    # Add a document to a collection with optional metadata.
+    #
+    #    Returns immediately after the system has accepted the document for processing.
+    #
+    #     * The user must provide document content, metadata, or both. If the request is
+    #   missing both document content and metadata, it is rejected.
+    #
+    #     * The user can set the **Content-Type** parameter on the **file** part to
+    #   indicate the media type of the document. If the **Content-Type** parameter is
+    #   missing or is one of the generic media types (for example,
+    #   `application/octet-stream`), then the service attempts to automatically detect the
+    #   document's media type.
+    #
+    #     * The following field names are reserved and will be filtered out if present
+    #   after normalization: `id`, `score`, `highlight`, and any field with the prefix of:
+    #   `_`, `+`, or `-`
+    #
+    #     * Fields with empty name values after normalization are filtered out before
+    #   indexing.
+    #
+    #     * Fields containing the following characters after normalization are filtered
+    #   out before indexing: `#` and `,`
+    #
+    #     If the document is uploaded to a collection that has it's data shared with
+    #   another collection, the **X-Watson-Discovery-Force** header must be set to `true`.
+    #
+    #
+    #    **Note:** Documents can be added with a specific **document_id** by using the
+    #   **_/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
+    #   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
+    #   rejected.
+    # @param filename [String] The filename for file.
+    # @param file_content_type [String] The content type of file.
+    # @param metadata [String] The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 MB
+    #   are rejected. Example:  ``` {
+    #     "Creator": "Johnny Appleseed",
+    #     "Subject": "Apples"
+    #   } ```.
+    # @param x_watson_discovery_force [Boolean] When `true`, the uploaded document is added to the collection even if the data for
+    #   that collection is shared with other collections.
+    # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
+    def add_document(project_id:, collection_id:, file: nil, filename: nil, file_content_type: nil, metadata: nil, x_watson_discovery_force: nil)
+      raise ArgumentError.new("project_id must be provided") if project_id.nil?
+
+      raise ArgumentError.new("collection_id must be provided") if collection_id.nil?
+
+      headers = {
+        "X-Watson-Discovery-Force" => x_watson_discovery_force
+      }
+      sdk_headers = Common.new.get_sdk_headers("discovery", "V2", "add_document")
+      headers.merge!(sdk_headers)
+
+      params = {
+        "version" => @version
+      }
+
+      form_data = {}
+
+      unless file.nil?
+        unless file.instance_of?(StringIO) || file.instance_of?(File)
+          file = file.respond_to?(:to_json) ? StringIO.new(file.to_json) : StringIO.new(file)
+        end
+        filename = file.path if filename.nil? && file.respond_to?(:path)
+        form_data[:file] = HTTP::FormData::File.new(file, content_type: file_content_type.nil? ? "application/octet-stream" : file_content_type, filename: filename)
+      end
+
+      form_data[:metadata] = HTTP::FormData::Part.new(metadata.to_s, content_type: "text/plain") unless metadata.nil?
+
+      method_url = "/v2/projects/%s/collections/%s/documents" % [ERB::Util.url_encode(project_id), ERB::Util.url_encode(collection_id)]
+
+      response = request(
+        method: "POST",
+        url: method_url,
+        headers: headers,
+        params: params,
+        form: form_data,
+        accept_json: true
+      )
+      response
+    end
+
+    ##
+    # @!method update_document(project_id:, collection_id:, document_id:, file: nil, filename: nil, file_content_type: nil, metadata: nil, x_watson_discovery_force: nil)
+    # Update a document.
+    # Replace an existing document or add a document with a specified **document_id**.
+    #   Starts ingesting a document with optional metadata.
+    #
+    #   If the document is uploaded to a collection that has it's data shared with another
+    #   collection, the **X-Watson-Discovery-Force** header must be set to `true`.
+    #
+    #   **Note:** When uploading a new document with this method it automatically replaces
+    #   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
+    #   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
+    #   rejected.
+    # @param filename [String] The filename for file.
+    # @param file_content_type [String] The content type of file.
+    # @param metadata [String] The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 MB
+    #   are rejected. Example:  ``` {
+    #     "Creator": "Johnny Appleseed",
+    #     "Subject": "Apples"
+    #   } ```.
+    # @param x_watson_discovery_force [Boolean] When `true`, the uploaded document is added to the collection even if the data for
+    #   that collection is shared with other collections.
+    # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
+    def update_document(project_id:, collection_id:, document_id:, file: nil, filename: nil, file_content_type: nil, metadata: nil, x_watson_discovery_force: nil)
+      raise ArgumentError.new("project_id must be provided") if project_id.nil?
+
+      raise ArgumentError.new("collection_id must be provided") if collection_id.nil?
+
+      raise ArgumentError.new("document_id must be provided") if document_id.nil?
+
+      headers = {
+        "X-Watson-Discovery-Force" => x_watson_discovery_force
+      }
+      sdk_headers = Common.new.get_sdk_headers("discovery", "V2", "update_document")
+      headers.merge!(sdk_headers)
+
+      params = {
+        "version" => @version
+      }
+
+      form_data = {}
+
+      unless file.nil?
+        unless file.instance_of?(StringIO) || file.instance_of?(File)
+          file = file.respond_to?(:to_json) ? StringIO.new(file.to_json) : StringIO.new(file)
+        end
+        filename = file.path if filename.nil? && file.respond_to?(:path)
+        form_data[:file] = HTTP::FormData::File.new(file, content_type: file_content_type.nil? ? "application/octet-stream" : file_content_type, filename: filename)
+      end
+
+      form_data[:metadata] = HTTP::FormData::Part.new(metadata.to_s, content_type: "text/plain") unless metadata.nil?
+
+      method_url = "/v2/projects/%s/collections/%s/documents/%s" % [ERB::Util.url_encode(project_id), ERB::Util.url_encode(collection_id), ERB::Util.url_encode(document_id)]
+
+      response = request(
+        method: "POST",
+        url: method_url,
+        headers: headers,
+        params: params,
+        form: form_data,
+        accept_json: true
+      )
+      response
+    end
+
+    ##
+    # @!method delete_document(project_id:, collection_id:, document_id:, x_watson_discovery_force: nil)
+    # Delete a document.
+    # If the given document ID is invalid, or if the document is not found, then the a
+    #   success response is returned (HTTP status code `200`) with the status set to
+    #   '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
+    #   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 x_watson_discovery_force [Boolean] When `true`, the uploaded document is added to the collection even if the data for
+    #   that collection is shared with other collections.
+    # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
+    def delete_document(project_id:, collection_id:, document_id:, x_watson_discovery_force: nil)
+      raise ArgumentError.new("project_id must be provided") if project_id.nil?
+
+      raise ArgumentError.new("collection_id must be provided") if collection_id.nil?
+
+      raise ArgumentError.new("document_id must be provided") if document_id.nil?
+
+      headers = {
+        "X-Watson-Discovery-Force" => x_watson_discovery_force
+      }
+      sdk_headers = Common.new.get_sdk_headers("discovery", "V2", "delete_document")
+      headers.merge!(sdk_headers)
+
+      params = {
+        "version" => @version
+      }
+
+      method_url = "/v2/projects/%s/collections/%s/documents/%s" % [ERB::Util.url_encode(project_id), ERB::Util.url_encode(collection_id), ERB::Util.url_encode(document_id)]
+
+      response = request(
+        method: "DELETE",
+        url: method_url,
+        headers: headers,
+        params: params,
+        accept_json: true
+      )
+      response
+    end
+    #########################
+    # Training data
+    #########################
+
+    ##
+    # @!method list_training_queries(project_id:)
+    # List training queries.
+    # List the training queries for the specified project.
+    # @param project_id [String] The ID of the project. This information can be found from the deploy page of the
+    #   Discovery administrative tooling.
+    # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
+    def list_training_queries(project_id:)
+      raise ArgumentError.new("project_id must be provided") if project_id.nil?
+
+      headers = {
+      }
+      sdk_headers = Common.new.get_sdk_headers("discovery", "V2", "list_training_queries")
+      headers.merge!(sdk_headers)
+
+      params = {
+        "version" => @version
+      }
+
+      method_url = "/v2/projects/%s/training_data/queries" % [ERB::Util.url_encode(project_id)]
+
+      response = request(
+        method: "GET",
+        url: method_url,
+        headers: headers,
+        params: params,
+        accept_json: true
+      )
+      response
+    end
+
+    ##
+    # @!method delete_training_queries(project_id:)
+    # Delete training queries.
+    # Removes all training queries for the specified project.
+    # @param project_id [String] The ID of the project. This information can be found from the deploy page of the
+    #   Discovery administrative tooling.
+    # @return [nil]
+    def delete_training_queries(project_id:)
+      raise ArgumentError.new("project_id must be provided") if project_id.nil?
+
+      headers = {
+      }
+      sdk_headers = Common.new.get_sdk_headers("discovery", "V2", "delete_training_queries")
+      headers.merge!(sdk_headers)
+
+      params = {
+        "version" => @version
+      }
+
+      method_url = "/v2/projects/%s/training_data/queries" % [ERB::Util.url_encode(project_id)]
+
+      request(
+        method: "DELETE",
+        url: method_url,
+        headers: headers,
+        params: params,
+        accept_json: false
+      )
+      nil
+    end
+
+    ##
+    # @!method create_training_query(project_id:, natural_language_query:, examples:, filter: nil)
+    # Create training query.
+    # Add a query to the training data for this project. The query can contain a filter
+    #   and natural language query.
+    # @param project_id [String] The ID of the project. This information can be found from the deploy page of the
+    #   Discovery administrative tooling.
+    # @param natural_language_query [String] The natural text query for the training query.
+    # @param examples [Array[TrainingExample]] Array of training examples.
+    # @param filter [String] The filter used on the collection before the **natural_language_query** is
+    #   applied.
+    # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
+    def create_training_query(project_id:, natural_language_query:, examples:, filter: nil)
+      raise ArgumentError.new("project_id must be provided") if project_id.nil?
+
+      headers = {
+      }
+      sdk_headers = Common.new.get_sdk_headers("discovery", "V2", "create_training_query")
+      headers.merge!(sdk_headers)
+
+      params = {
+        "version" => @version
+      }
+
+      data = {
+        "natural_language_query" => natural_language_query,
+        "examples" => examples,
+        "filter" => filter
+      }
+
+      method_url = "/v2/projects/%s/training_data/queries" % [ERB::Util.url_encode(project_id)]
+
+      response = request(
+        method: "POST",
+        url: method_url,
+        headers: headers,
+        params: params,
+        json: data,
+        accept_json: true
+      )
+      response
+    end
+
+    ##
+    # @!method get_training_query(project_id:, query_id:)
+    # Get a training data query.
+    # Get details for a specific training data query, including the query string and all
+    #   examples.
+    # @param project_id [String] The ID of the project. This information can be found from the deploy page of the
+    #   Discovery administrative tooling.
+    # @param query_id [String] The ID of the query used for training.
+    # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
+    def get_training_query(project_id:, query_id:)
+      raise ArgumentError.new("project_id must be provided") if project_id.nil?
+
+      raise ArgumentError.new("query_id must be provided") if query_id.nil?
+
+      headers = {
+      }
+      sdk_headers = Common.new.get_sdk_headers("discovery", "V2", "get_training_query")
+      headers.merge!(sdk_headers)
+
+      params = {
+        "version" => @version
+      }
+
+      method_url = "/v2/projects/%s/training_data/queries/%s" % [ERB::Util.url_encode(project_id), ERB::Util.url_encode(query_id)]
+
+      response = request(
+        method: "GET",
+        url: method_url,
+        headers: headers,
+        params: params,
+        accept_json: true
+      )
+      response
+    end
+
+    ##
+    # @!method update_training_query(project_id:, query_id:, natural_language_query:, examples:, filter: nil)
+    # Update a training query.
+    # Updates an existing training query and it's examples.
+    # @param project_id [String] The ID of the project. This information can be found from the deploy page of the
+    #   Discovery administrative tooling.
+    # @param query_id [String] The ID of the query used for training.
+    # @param natural_language_query [String] The natural text query for the training query.
+    # @param examples [Array[TrainingExample]] Array of training examples.
+    # @param filter [String] The filter used on the collection before the **natural_language_query** is
+    #   applied.
+    # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
+    def update_training_query(project_id:, query_id:, natural_language_query:, examples:, filter: nil)
+      raise ArgumentError.new("project_id must be provided") if project_id.nil?
+
+      raise ArgumentError.new("query_id must be provided") if query_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", "update_training_query")
+      headers.merge!(sdk_headers)
+
+      params = {
+        "version" => @version
+      }
+
+      data = {
+        "natural_language_query" => natural_language_query,
+        "examples" => examples,
+        "filter" => filter
+      }
+
+      method_url = "/v2/projects/%s/training_data/queries/%s" % [ERB::Util.url_encode(project_id), ERB::Util.url_encode(query_id)]
+
+      response = request(
+        method: "POST",
+        url: method_url,
+        headers: headers,
+        params: params,
+        json: data,
+        accept_json: true
+      )
+      response
+    end
+  end
+end