Merge pull request #82 from watson-developer-cloud/release-5-2019

v1.1

Author: mamoonraja

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

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

examples/discovery_v2.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "json"
+require "ibm_watson/authenticators"
+require "ibm_watson/discovery_v2"
+
+## Important: Discovery v2 is only available on Cloud Pak for Data. ##
+
+## Authentication ##
+## Option 1: username/password
+# authenticator = IBMWatson::Authenticators::CloudPakForDataAuthenticator.new(
+#   username: "{username}",
+#   password: "{password}",
+#   url: "{authentication_url}",
+#   disable_ssl: true
+# )
+
+## Option 2: bearer token
+authenticator = IBMWatson::Authenticators::BearerTokenAuthenticator.new(
+  bearer_token: "{token}"
+)
+
+discovery = IBMWatson::DiscoveryV2.new(
+  authenticator: authenticator,
+  version: "2019-11-21"
+)
+discovery.service_url = "{service_url}"
+discovery.configure_http_client(disable_ssl_verification: true)
+
+collections = discovery.list_collections(
+  project_id: "{project_id}"
+).result
+
+puts JSON.pretty_generate(collections)
+
+query_response = discovery.query(
+  project_id: "{project_id}",
+  count: 10
+).result
+puts JSON.pretty_generate(query_response)
+
+autocomplete_response = discovery.get_autocompletion(
+  project_id: "{project_id}",
+  prefix: "hi how are "
+)
+puts JSON.pretty_generate(autocomplete_response)

ibm_watson.gemspec

@@ -36,7 +36,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "eventmachine", "~> 1.2"
   spec.add_runtime_dependency "faye-websocket", "~> 0.10"
   spec.add_runtime_dependency "http", "~> 4.1.0"
-  spec.add_runtime_dependency "ibm_cloud_sdk_core", "~> 1.0"
+  spec.add_runtime_dependency "ibm_cloud_sdk_core", "~> 1.1"
   spec.add_runtime_dependency "jwt", "~> 2.2.1"
 
   spec.add_development_dependency "bundler", "~> 1.16"

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")

lib/ibm_watson/assistant_v1.rb

@@ -177,7 +177,7 @@ def list_workspaces(page_limit: nil, sort: nil, cursor: nil, include_audit: nil)
     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 @@ def list_workspaces(page_limit: nil, sort: nil, cursor: nil, include_audit: nil)
     # @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 @@ def create_workspace(name: nil, description: nil, language: nil, metadata: nil,
         "intents" => intents,
         "entities" => entities,
         "dialog_nodes" => dialog_nodes,
-        "counterexamples" => counterexamples
+        "counterexamples" => counterexamples,
+        "webhooks" => webhooks
       }
 
       method_url = "/v1/workspaces"
@@ -282,7 +284,7 @@ def get_workspace(workspace_id:, export: nil, include_audit: nil, sort: nil)
     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 @@ def get_workspace(workspace_id:, export: nil, include_audit: nil, sort: nil)
     # @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 @@ def get_workspace(workspace_id:, export: nil, include_audit: nil, sort: nil)
     #   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 @@ def update_workspace(workspace_id:, name: nil, description: nil, language: nil,
         "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 @@ def list_dialog_nodes(workspace_id:, page_limit: nil, sort: nil, cursor: nil, in
     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 @@ def list_dialog_nodes(workspace_id:, page_limit: nil, sort: nil, cursor: nil, in
     # @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 @@ def create_dialog_node(workspace_id:, dialog_node:, description: nil, conditions
         "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 @@ def get_dialog_node(workspace_id:, dialog_node:, include_audit: nil)
     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 @@ def get_dialog_node(workspace_id:, dialog_node:, include_audit: nil)
     # @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 @@ def update_dialog_node(workspace_id:, dialog_node:, new_dialog_node: nil, new_de
         "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 @@ def list_logs(workspace_id:, sort: nil, filter: nil, page_limit: nil, cursor: ni
     #   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 (`-`).

lib/ibm_watson/assistant_v2.rb

@@ -74,7 +74,10 @@ def initialize(args = {})
     # @!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 @@ def create_session(assistant_id:)
     ##
     # @!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