ibm_watson 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77be503c0c2580751176c1ffaae4f1bf60b44c7941580800f14d6a5313e40437
-  data.tar.gz: 6ce107373c372c8ff4f275dd62f402878dc440bf624706d8177a4620f92698f3
+  metadata.gz: 0bd35c50ae41bcbfd37e8979725fa1c735802adaa9547a85f317bd8b06facfbb
+  data.tar.gz: 99f6e5162166498402863f91e4aa657df34dbced4b6ac785b55fcb1a7a61998a
 SHA512:
-  metadata.gz: 9db32ad31b000f454618880bcc0237d75e9980dcfb7c394645fae954e12fdd3919a2e22c2623911c8f28d272b5791b35503fdc596627579698bbdef9591c6b08
-  data.tar.gz: 76cf957d401eff267742da48026ed16ab592a5b37573cd8a487183f14a94f8e7e377bacd68e5e460f3e87c461cde4595b2f97fc35ec73e1df1d1a1e7629e0beb
+  metadata.gz: d43788276fa776b4ef6921243f02512d5a42ed82cf9925dab9ae5bae6941491aa27f2e15eddd531101d891dd74cd511a296383663b4f6aaab3dd6cf4bf19eaca
+  data.tar.gz: e5f3692a356b306135b394e61f614041cadfe42a81cfabd4aaf4ffc89e9940b9fa0658e4b22c46843300fbf5498dbeaf22d0ce6064a3236f6c40e316c15e76d6

data/README.md

@@ -61,7 +61,7 @@ The [examples][examples] folder has basic and advanced examples. The examples wi
 
 ## Running in IBM Cloud
 
-If you run your app in IBM Cloud, the SDK gets credentials from the [`VCAP_SERVICES`][vcap_services] environment variable. 
+If you run your app in IBM Cloud, the SDK gets credentials from the [`VCAP_SERVICES`][vcap_services] environment variable.
 
 ## Authentication
 
@@ -73,9 +73,45 @@ Watson services are migrating to token-based Identity and Access Management (IAM
 ### Getting credentials
 To find out which authentication to use, view the service credentials. You find the service credentials for authentication the same way for all Watson services:
 
-1. Go to the IBM Cloud [Dashboard][watson-dashboard] page.
-1. Either click an existing Watson service instance or click [**Create resource > AI**](https://console.bluemix.net/catalog/?category=ai) and create a service instance.
-1. Copy the `url` and either `apikey` or `username` and `password`. Click **Show** if the credentials are masked.
+1. Go to the IBM Cloud [Dashboard](https://cloud.ibm.com/) page.
+1. Either click an existing Watson service instance in your [resource list](https://cloud.ibm.com/resources) or click [**Create resource > AI**](https://cloud.ibm.com/catalog?category=ai) and create a service instance.
+1. Click on the **Manage** item in the left nav bar of your service instance.
+
+ On this page, you should be able to see your credentials for accessing your service instance.
+
+ ### Supplying credentials
+
+ There are two ways to supply the credentials you found above to the SDK for authentication.
+
+ #### Credential file (easier!)
+
+ With a credential file, you just need to put the file in the right place and the SDK will do the work of parsing and authenticating. You can get this file by clicking the **Download** button for the credentials in the **Manage** tab of your service instance.
+
+ The file downloaded will be called `ibm-credentials.env`. This is the name the SDK will search for and **must** be preserved unless you want to configure the file path (more on that later). The SDK will look for your `ibm-credentials.env` file in the following places (in order):
+
+ - Your system's home directory
+- The top-level directory of the project you're using the SDK in
+
+ As long as you set that up correctly, you don't have to worry about setting any authentication options in your code. So, for example, if you created and downloaded the credential file for your Discovery instance, you just need to do the following:
+
+ ```ruby
+discovery = DiscoveryV1(version: "2018-08-01")
+```
+
+ And that's it!
+
+ If you're using more than one service at a time in your code and get two different `ibm-credentials.env` files, just put the contents together in one `ibm-credentials.env` file and the SDK will handle assigning credentials to their appropriate services.
+
+ If you would like to configure the location/name of your credential file, you can set an environment variable called `IBM_CREDENTIALS_FILE`. **This will take precedence over the locations specified above.** Here's how you can do that:
+
+ ```bash
+export IBM_CREDENTIALS_FILE="<path>"
+```
+
+ where `<path>` is something like `/home/user/Downloads/<file_name>.env`.
+
+ #### Manually
+If you'd prefer to set authentication values manually in your code, the SDK supports that as well. The way you'll do this depends on what type of credentials your service instance gives you.
 
 ### IAM
 

data/lib/ibm_watson/assistant_v1.rb

@@ -82,6 +82,7 @@ module IBMWatson
       args[:vcap_services_name] = "conversation"
       super
       @version = args[:version]
+      args[:display_name] = "Assistant"
     end
 
     #########################
@@ -95,7 +96,7 @@ module IBMWatson
     #
     #   There is no rate limit for this operation.
     # @param workspace_id [String] Unique identifier of the workspace.
-    # @param input [InputData] The user input.
+    # @param input [InputData] An input object that includes the input text.
     # @param alternate_intents [Boolean] Whether to return more than one intent. Set to `true` to return all matching
     #   intents.
     # @param context [Context] State information for the conversation. To maintain state, include the context
@@ -116,6 +117,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=message"
 
       params = {
         "version" => @version,
@@ -165,6 +167,7 @@ module IBMWatson
     def list_workspaces(page_limit: nil, include_count: nil, sort: nil, cursor: nil, include_audit: nil)
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=list_workspaces"
 
       params = {
         "version" => @version,
@@ -213,6 +216,7 @@ module IBMWatson
     def create_workspace(name: nil, description: nil, language: nil, intents: nil, entities: nil, dialog_nodes: nil, counterexamples: nil, metadata: nil, learning_opt_out: nil, system_settings: nil)
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=create_workspace"
 
       params = {
         "version" => @version
@@ -267,6 +271,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=get_workspace"
 
       params = {
         "version" => @version,
@@ -325,6 +330,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=update_workspace"
 
       params = {
         "version" => @version,
@@ -371,6 +377,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=delete_workspace"
 
       params = {
         "version" => @version
@@ -416,6 +423,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=list_intents"
 
       params = {
         "version" => @version,
@@ -463,6 +471,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=create_intent"
 
       params = {
         "version" => @version
@@ -510,6 +519,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=get_intent"
 
       params = {
         "version" => @version,
@@ -554,6 +564,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=update_intent"
 
       params = {
         "version" => @version
@@ -595,6 +606,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=delete_intent"
 
       params = {
         "version" => @version
@@ -640,6 +652,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=list_examples"
 
       params = {
         "version" => @version,
@@ -687,6 +700,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=create_example"
 
       params = {
         "version" => @version
@@ -732,6 +746,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=get_example"
 
       params = {
         "version" => @version,
@@ -776,6 +791,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=update_example"
 
       params = {
         "version" => @version
@@ -819,6 +835,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=delete_example"
 
       params = {
         "version" => @version
@@ -861,6 +878,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=list_counterexamples"
 
       params = {
         "version" => @version,
@@ -905,6 +923,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=create_counterexample"
 
       params = {
         "version" => @version
@@ -947,6 +966,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=get_counterexample"
 
       params = {
         "version" => @version,
@@ -984,6 +1004,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=update_counterexample"
 
       params = {
         "version" => @version
@@ -1024,6 +1045,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=delete_counterexample"
 
       params = {
         "version" => @version
@@ -1069,6 +1091,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=list_entities"
 
       params = {
         "version" => @version,
@@ -1120,6 +1143,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=create_entity"
 
       params = {
         "version" => @version
@@ -1169,6 +1193,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=get_entity"
 
       params = {
         "version" => @version,
@@ -1215,6 +1240,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=update_entity"
 
       params = {
         "version" => @version
@@ -1258,6 +1284,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=delete_entity"
 
       params = {
         "version" => @version
@@ -1301,6 +1328,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=list_mentions"
 
       params = {
         "version" => @version,
@@ -1350,6 +1378,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=list_values"
 
       params = {
         "version" => @version,
@@ -1398,7 +1427,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/assistant/entities.html#creating-entities).
+    #   [documentation](https://cloud.ibm.com/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)
@@ -1410,6 +1439,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=create_value"
 
       params = {
         "version" => @version
@@ -1461,6 +1491,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=get_value"
 
       params = {
         "version" => @version,
@@ -1508,7 +1539,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/assistant/entities.html#creating-entities).
+    #   [documentation](https://cloud.ibm.com/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?
@@ -1519,6 +1550,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=update_value"
 
       params = {
         "version" => @version
@@ -1565,6 +1597,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=delete_value"
 
       params = {
         "version" => @version
@@ -1612,6 +1645,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=list_synonyms"
 
       params = {
         "version" => @version,
@@ -1660,6 +1694,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=create_synonym"
 
       params = {
         "version" => @version
@@ -1707,6 +1742,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=get_synonym"
 
       params = {
         "version" => @version,
@@ -1752,6 +1788,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=update_synonym"
 
       params = {
         "version" => @version
@@ -1797,6 +1834,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=delete_synonym"
 
       params = {
         "version" => @version
@@ -1838,6 +1876,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=list_dialog_nodes"
 
       params = {
         "version" => @version,
@@ -1881,7 +1920,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/assistant/dialog-overview.html#complex).
+    #   [documentation](https://cloud.ibm.com/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.
@@ -1907,6 +1946,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=create_dialog_node"
 
       params = {
         "version" => @version
@@ -1965,6 +2005,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=get_dialog_node"
 
       params = {
         "version" => @version,
@@ -2005,7 +2046,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/assistant/dialog-overview.html#complex).
+    #   [documentation](https://cloud.ibm.com/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.
@@ -2031,6 +2072,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=update_dialog_node"
 
       params = {
         "version" => @version
@@ -2087,6 +2129,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=delete_dialog_node"
 
       params = {
         "version" => @version
@@ -2120,7 +2163,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/assistant/filter-reference.html#filter-query-syntax).
+    #   [documentation](https://cloud.ibm.com/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.
@@ -2129,6 +2172,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=list_logs"
 
       params = {
         "version" => @version,
@@ -2162,7 +2206,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/assistant/filter-reference.html#filter-query-syntax).
+    #   [documentation](https://cloud.ibm.com/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.
@@ -2173,6 +2217,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=list_all_logs"
 
       params = {
         "version" => @version,
@@ -2206,7 +2251,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/assistant/information-security.html).
+    #   security](https://cloud.ibm.com/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:)
@@ -2214,6 +2259,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V1;operation_id=delete_user_data"
 
       params = {
         "version" => @version,

data/lib/ibm_watson/assistant_v2.rb

@@ -82,6 +82,7 @@ module IBMWatson
       args[:vcap_services_name] = "conversation"
       super
       @version = args[:version]
+      args[:display_name] = "Assistant"
     end
 
     #########################
@@ -105,6 +106,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V2;operation_id=create_session"
 
       params = {
         "version" => @version
@@ -141,6 +143,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V2;operation_id=delete_session"
 
       params = {
         "version" => @version
@@ -174,7 +177,7 @@ module IBMWatson
     #
     #   **Note:** Currently, the v2 API does not support creating assistants.
     # @param session_id [String] Unique identifier of the session.
-    # @param input [MessageInput] The user input.
+    # @param input [MessageInput] An input object that includes the input text.
     # @param context [MessageContext] State information for the conversation.
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def message(assistant_id:, session_id:, input: nil, context: nil)
@@ -184,6 +187,7 @@ module IBMWatson
 
       headers = {
       }
+      headers["X-IBMCloud-SDK-Analytics"] = "service_name=conversation;service_version=V2;operation_id=message"
 
       params = {
         "version" => @version