ibm_watson 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43dff6c6d57f43207b327503a557e87744ba951da5b1027c1a7d2a7648397cf8
-  data.tar.gz: 8f61cc4482ff4c611603c1ecfa9c2b33bc725d2540674d4ea35df3b448c49f22
+  metadata.gz: 77be503c0c2580751176c1ffaae4f1bf60b44c7941580800f14d6a5313e40437
+  data.tar.gz: 6ce107373c372c8ff4f275dd62f402878dc440bf624706d8177a4620f92698f3
 SHA512:
-  metadata.gz: 03ca644a872301a195f429c410b19401ce68fc6503145da8362f1e8a4d07f09404c748de5bd15decd750c0ac3a5b85fd9c9c1a9e184bb0efff02e01c5d5df9c6
-  data.tar.gz: 262432903b74bba5abe80671e9646a8064824077c4114d5d3cd9148f9fb014e77e98f508aa9247890cb328cc855c9a501fe7727d887f7330987b130ba43076e3
+  metadata.gz: 9db32ad31b000f454618880bcc0237d75e9980dcfb7c394645fae954e12fdd3919a2e22c2623911c8f28d272b5791b35503fdc596627579698bbdef9591c6b08
+  data.tar.gz: 76cf957d401eff267742da48026ed16ab592a5b37573cd8a487183f14a94f8e7e377bacd68e5e460f3e87c461cde4595b2f97fc35ec73e1df1d1a1e7629e0beb

data/README.md

@@ -35,8 +35,6 @@ Ruby gem to quickly get started with the various [IBM Watson][wdc] services.
 ## Before you begin
 * You need an [IBM Cloud][ibm-cloud-onboarding] account.
 
-> Watson Assistant v2 API is released in beta. For details, see the ["Introducing Watson Assistant"](https://www.ibm.com/blogs/watson/2018/03/the-future-of-watson-conversation-watson-assistant/) blog post.
-
 ## Installation
 
 Install the gem:
@@ -250,6 +248,23 @@ assistant.configure_http_client(
 )
 ```
 
+The HTTP client can be configured to disable SSL verification. Note that this has serious security implications - only do this if you really mean to! ⚠️
+
+To do this, pass `disable_ssl` as `true` in `configure_http_client()`, like below:
+
+```ruby
+require "ibm_watson/assistant_v1"
+include IBMWatson
+
+service = AssistantV1.new(
+  version: "<version>",
+  username: "<username>",
+  password: "<password>",
+)
+
+service.configure_http_client(disable_ssl: true)
+```
+
 ## Using Websockets
 
 The Speech-to-Text service supports websockets with the `recognize_using_websocket` method. The method accepts a custom callback class. The `eventmachine` loop that the websocket uses blocks the main thread by default. Here is an example of using the websockets method:

data/lib/ibm_watson/assistant_v1.rb

@@ -1398,7 +1398,7 @@ module IBMWatson
     #   patterns (as indicated by **type**), but not both. A pattern is a regular
     #   expression no longer than 512 characters. For more information about how to
     #   specify a pattern, see the
-    #   [documentation](https://console.bluemix.net/docs/services/conversation/entities.html#creating-entities).
+    #   [documentation](https://console.bluemix.net/docs/services/assistant/entities.html#creating-entities).
     # @param value_type [String] Specifies the type of value.
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def create_value(workspace_id:, entity:, value:, metadata: nil, synonyms: nil, patterns: nil, value_type: nil)
@@ -1508,7 +1508,7 @@ module IBMWatson
     #   patterns (as indicated by **type**), but not both. A pattern is a regular
     #   expression no longer than 512 characters. For more information about how to
     #   specify a pattern, see the
-    #   [documentation](https://console.bluemix.net/docs/services/conversation/entities.html#creating-entities).
+    #   [documentation](https://console.bluemix.net/docs/services/assistant/entities.html#creating-entities).
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def update_value(workspace_id:, entity:, value:, new_value: nil, new_metadata: nil, new_type: nil, new_synonyms: nil, new_patterns: nil)
       raise ArgumentError.new("workspace_id must be provided") if workspace_id.nil?
@@ -1881,7 +1881,7 @@ module IBMWatson
     # @param previous_sibling [String] The ID of the previous dialog node.
     # @param output [DialogNodeOutput] The output of the dialog node. For more information about how to specify dialog
     #   node output, see the
-    #   [documentation](https://console.bluemix.net/docs/services/conversation/dialog-overview.html#complex).
+    #   [documentation](https://console.bluemix.net/docs/services/assistant/dialog-overview.html#complex).
     # @param context [Object] The context for the dialog node.
     # @param metadata [Object] The metadata for the dialog node.
     # @param next_step [DialogNodeNextStep] The next step to execute following this dialog node.
@@ -2005,7 +2005,7 @@ module IBMWatson
     # @param new_previous_sibling [String] The ID of the previous sibling dialog node.
     # @param new_output [DialogNodeOutput] The output of the dialog node. For more information about how to specify dialog
     #   node output, see the
-    #   [documentation](https://console.bluemix.net/docs/services/conversation/dialog-overview.html#complex).
+    #   [documentation](https://console.bluemix.net/docs/services/assistant/dialog-overview.html#complex).
     # @param new_context [Object] The context for the dialog node.
     # @param new_metadata [Object] The metadata for the dialog node.
     # @param new_next_step [DialogNodeNextStep] The next step to execute following this dialog node.
@@ -2120,7 +2120,7 @@ module IBMWatson
     #   reverse the sort order, prefix the parameter value with a minus sign (`-`).
     # @param filter [String] A cacheable parameter that limits the results to those matching the specified
     #   filter. For more information, see the
-    #   [documentation](https://console.bluemix.net/docs/services/conversation/filter-reference.html#filter-query-syntax).
+    #   [documentation](https://console.bluemix.net/docs/services/assistant/filter-reference.html#filter-query-syntax).
     # @param page_limit [Fixnum] The number of records to return in each page of results.
     # @param cursor [String] A token identifying the page of results to retrieve.
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
@@ -2162,7 +2162,7 @@ module IBMWatson
     #   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
-    #   [documentation](https://console.bluemix.net/docs/services/conversation/filter-reference.html#filter-query-syntax).
+    #   [documentation](https://console.bluemix.net/docs/services/assistant/filter-reference.html#filter-query-syntax).
     # @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 (`-`).
     # @param page_limit [Fixnum] The number of records to return in each page of results.
@@ -2206,7 +2206,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://console.bluemix.net/docs/services/conversation/information-security.html).
+    #   security](https://console.bluemix.net/docs/services/assistant/information-security.html).
     # @param customer_id [String] The customer ID for which all data is to be deleted.
     # @return [nil]
     def delete_user_data(customer_id:)

data/lib/ibm_watson/discovery_v1.rb

@@ -785,7 +785,7 @@ module IBMWatson
       response
     end
     #########################
-    # Expansions
+    # Query modifications
     #########################
 
     ##
@@ -1009,6 +1009,82 @@ module IBMWatson
       )
       nil
     end
+
+    ##
+    # @!method create_stopword_list(environment_id:, collection_id:, stopword_file:, stopword_filename: nil)
+    # Create stopword list.
+    # Upload a custom stopword list to use with the specified collection.
+    # @param environment_id [String] The ID of the environment.
+    # @param collection_id [String] The ID of the collection.
+    # @param stopword_file [File] The content of the stopword list to ingest.
+    # @param stopword_filename [String] The filename for stopword_file.
+    # @return [DetailedResponse] A `DetailedResponse` object representing the response.
+    def create_stopword_list(environment_id:, collection_id:, stopword_file:, stopword_filename: nil)
+      raise ArgumentError.new("environment_id must be provided") if environment_id.nil?
+
+      raise ArgumentError.new("collection_id must be provided") if collection_id.nil?
+
+      raise ArgumentError.new("stopword_file must be provided") if stopword_file.nil?
+
+      headers = {
+      }
+
+      params = {
+        "version" => @version
+      }
+
+      form_data = {}
+
+      unless stopword_file.instance_of?(StringIO) || stopword_file.instance_of?(File)
+        stopword_file = stopword_file.respond_to?(:to_json) ? StringIO.new(stopword_file.to_json) : StringIO.new(stopword_file)
+      end
+      stopword_filename = stopword_file.path if stopword_filename.nil? && stopword_file.respond_to?(:path)
+      form_data[:stopword_file] = HTTP::FormData::File.new(stopword_file, content_type: "application/octet-stream", filename: stopword_filename)
+
+      method_url = "/v1/environments/%s/collections/%s/word_lists/stopwords" % [ERB::Util.url_encode(environment_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 delete_stopword_list(environment_id:, collection_id:)
+    # Delete a custom stopword list.
+    # Delete a custom stopword list from the collection. After a custom stopword list is
+    #   deleted, the default list is used for the collection.
+    # @param environment_id [String] The ID of the environment.
+    # @param collection_id [String] The ID of the collection.
+    # @return [nil]
+    def delete_stopword_list(environment_id:, collection_id:)
+      raise ArgumentError.new("environment_id must be provided") if environment_id.nil?
+
+      raise ArgumentError.new("collection_id must be provided") if collection_id.nil?
+
+      headers = {
+      }
+
+      params = {
+        "version" => @version
+      }
+
+      method_url = "/v1/environments/%s/collections/%s/word_lists/stopwords" % [ERB::Util.url_encode(environment_id), ERB::Util.url_encode(collection_id)]
+
+      request(
+        method: "DELETE",
+        url: method_url,
+        headers: headers,
+        params: params,
+        accept_json: true
+      )
+      nil
+    end
     #########################
     # Documents
     #########################
@@ -2461,6 +2537,7 @@ module IBMWatson
     #   -  `salesforce` indicates the credentials are used to connect to Salesforce.
     #   -  `sharepoint` indicates the credentials are used to connect to Microsoft
     #   SharePoint Online.
+    #   -  `web_crawl` indicates the credentials are used to perform a web crawl.
     # @param credential_details [CredentialDetails] Object containing details of the stored credentials.
     #
     #   Obtain credentials for your source from the administrator of the source.
@@ -2542,6 +2619,7 @@ module IBMWatson
     #   -  `salesforce` indicates the credentials are used to connect to Salesforce.
     #   -  `sharepoint` indicates the credentials are used to connect to Microsoft
     #   SharePoint Online.
+    #   -  `web_crawl` indicates the credentials are used to perform a web crawl.
     # @param credential_details [CredentialDetails] Object containing details of the stored credentials.
     #
     #   Obtain credentials for your source from the administrator of the source.
@@ -2597,6 +2675,133 @@ module IBMWatson
 
       method_url = "/v1/environments/%s/credentials/%s" % [ERB::Util.url_encode(environment_id), ERB::Util.url_encode(credential_id)]
 
+      response = request(
+        method: "DELETE",
+        url: method_url,
+        headers: headers,
+        params: params,
+        accept_json: true
+      )
+      response
+    end
+    #########################
+    # gatewayConfiguration
+    #########################
+
+    ##
+    # @!method list_gateways(environment_id:)
+    # List Gateways.
+    # List the currently configured gateways.
+    # @param environment_id [String] The ID of the environment.
+    # @return [DetailedResponse] A `DetailedResponse` object representing the response.
+    def list_gateways(environment_id:)
+      raise ArgumentError.new("environment_id must be provided") if environment_id.nil?
+
+      headers = {
+      }
+
+      params = {
+        "version" => @version
+      }
+
+      method_url = "/v1/environments/%s/gateways" % [ERB::Util.url_encode(environment_id)]
+
+      response = request(
+        method: "GET",
+        url: method_url,
+        headers: headers,
+        params: params,
+        accept_json: true
+      )
+      response
+    end
+
+    ##
+    # @!method create_gateway(environment_id:, name: nil)
+    # Create Gateway.
+    # Create a gateway configuration to use with a remotely installed gateway.
+    # @param environment_id [String] The ID of the environment.
+    # @param name [String] User-defined name.
+    # @return [DetailedResponse] A `DetailedResponse` object representing the response.
+    def create_gateway(environment_id:, name: nil)
+      raise ArgumentError.new("environment_id must be provided") if environment_id.nil?
+
+      headers = {
+      }
+
+      params = {
+        "version" => @version
+      }
+
+      data = {
+        "name" => name
+      }
+
+      method_url = "/v1/environments/%s/gateways" % [ERB::Util.url_encode(environment_id)]
+
+      response = request(
+        method: "POST",
+        url: method_url,
+        headers: headers,
+        params: params,
+        json: data,
+        accept_json: true
+      )
+      response
+    end
+
+    ##
+    # @!method get_gateway(environment_id:, gateway_id:)
+    # List Gateway Details.
+    # List information about the specified gateway.
+    # @param environment_id [String] The ID of the environment.
+    # @param gateway_id [String] The requested gateway ID.
+    # @return [DetailedResponse] A `DetailedResponse` object representing the response.
+    def get_gateway(environment_id:, gateway_id:)
+      raise ArgumentError.new("environment_id must be provided") if environment_id.nil?
+
+      raise ArgumentError.new("gateway_id must be provided") if gateway_id.nil?
+
+      headers = {
+      }
+
+      params = {
+        "version" => @version
+      }
+
+      method_url = "/v1/environments/%s/gateways/%s" % [ERB::Util.url_encode(environment_id), ERB::Util.url_encode(gateway_id)]
+
+      response = request(
+        method: "GET",
+        url: method_url,
+        headers: headers,
+        params: params,
+        accept_json: true
+      )
+      response
+    end
+
+    ##
+    # @!method delete_gateway(environment_id:, gateway_id:)
+    # Delete Gateway.
+    # Delete the specified gateway configuration.
+    # @param environment_id [String] The ID of the environment.
+    # @param gateway_id [String] The requested gateway ID.
+    # @return [DetailedResponse] A `DetailedResponse` object representing the response.
+    def delete_gateway(environment_id:, gateway_id:)
+      raise ArgumentError.new("environment_id must be provided") if environment_id.nil?
+
+      raise ArgumentError.new("gateway_id must be provided") if gateway_id.nil?
+
+      headers = {
+      }
+
+      params = {
+        "version" => @version
+      }
+
+      method_url = "/v1/environments/%s/gateways/%s" % [ERB::Util.url_encode(environment_id), ERB::Util.url_encode(gateway_id)]
+
       response = request(
         method: "DELETE",
         url: method_url,