ibm_watson 0.16.1 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d2c9980960aa7f5e93261dfd84391198197f4191ee2864507e184ee834a0b88
-  data.tar.gz: 987566c62ec16426e87ed44bd7b72bc30950b9ff4118b93c855822ced185f188
+  metadata.gz: 39527e09ad94eb91baf66ef1539c84bb1189e3f716fe9a331d87b8d3718be34d
+  data.tar.gz: dc8dea01d68683c4b4274b42c7d87e79818423ba9b6cfd643e4734de22136e61
 SHA512:
-  metadata.gz: aef365e17e9e0eded4dc83e61284921de703d958f7ecc4748765804b160a1ef1980bbb45cf01bb008649cc05bf4b96269cfa0de4d8da3e5259dc064d90312704
-  data.tar.gz: c2ab26dfd878aeea7873a44d7dab5e0827b89af49f58a060b03e939303d39d3dfe63007278b0f40b9bb379551c75f689bfcfbbaf71553672c9b160792137a678
+  metadata.gz: cff3d3cc8cc96b4be31731ccd030d36f2e4ca519a4952ae53d9f4195a78982e262c443d190fabbca5c515bf4cd2bf225ce4f77c7459fae923e021ddb3aaa1a5f
+  data.tar.gz: e2ca88a6ec674b1b853146cbb01521a61bad2cde784db37172387413ba0722e30df0e3b6690839e06351feba9d14cb4c19ee7b257fbea7ff5b6609c8aea0af6b

data/README.md

@@ -29,10 +29,12 @@ Ruby gem to quickly get started with the various [IBM Watson][wdc] services.
   * [Ruby version](#ruby-version)
   * [Contributing](#contributing)
   * [License](#license)
+  * [Featured Projects](#featured-projects)
 
 </details>
 
 ## Before you begin
+
 * You need an [IBM Cloud][ibm-cloud-onboarding] account.
 
 ## Installation
@@ -71,6 +73,7 @@ Watson services are migrating to token-based Identity and Access Management (IAM
 - In other instances, you authenticate by providing the **[username and password](#username-and-password)** for the service instance.
 
 ### 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](https://cloud.ibm.com/) page.
@@ -79,17 +82,17 @@ To find out which authentication to use, view the service credentials. You find
 
  On this page, you should be able to see your credentials for accessing your service instance.
 
- ### Supplying credentials
+### Supplying credentials
 
  There are two ways to supply the credentials you found above to the SDK for authentication.
 
- #### Credential file (easier!)
+#### 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.
+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):
+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
+- 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:
@@ -110,7 +113,8 @@ export IBM_CREDENTIALS_FILE="<path>"
 
  where `<path>` is something like `/home/user/Downloads/<file_name>.env`.
 
- #### Manually
+#### 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
@@ -120,7 +124,7 @@ IBM Cloud is migrating to token-based Identity and Access Management (IAM) authe
 You supply either an IAM service **API key** or an **access token**:
 
 - Use the API key to have the SDK manage the lifecycle of the access token. The SDK requests an access token, ensures that the access token is valid, and refreshes it if necessary.
-- Use the access token if you want to manage the lifecycle yourself. For details, see [Authenticating with IAM tokens](https://console.bluemix.net/docs/services/watson/getting-started-iam.html).
+- Use the access token if you want to manage the lifecycle yourself. For details, see [Authenticating with IAM tokens](https://cloud.ibm.com/docs/services/watson?topic=watson-iam).
 
 #### Supplying the IAM API key
 
@@ -129,7 +133,7 @@ You supply either an IAM service **API key** or an **access token**:
 discovery = IBMWatson::DiscoveryV1.new(
   version: "2017-10-16",
   iam_apikey: "<iam_apikey>",
-  iam_url: "<iam_url>" # optional - the default value is https://iam.ng.bluemix.net/identity/token
+  iam_url: "<iam_url>" # optional - the default value is https://iam.cloud.ibm.com/identity/token
 )
 ```
 
@@ -140,6 +144,7 @@ discovery.iam_apikey(iam_apikey: "<iam_apikey>")
 ```
 
 #### Supplying the access token
+
 ```ruby
 # in the constructor, assuming control of managing IAM token
 discovery = IBMWatson::DiscoveryV1.new(
@@ -155,6 +160,7 @@ discovery.iam_access_token(iam_access_token: "<access_token>")
 ```
 
 ### Username and password
+
 ```ruby
 require "ibm_watson"
 include IBMWatson
@@ -170,11 +176,14 @@ discovery.password = "<password>"
 ```
 
 ## Sending requests asynchronously
+
 Requests can be sent asynchronously. There are two asynchronous methods available for the user, `async` & `await`. When used, these methods return an [Ivar][ivar] object.
+
 * To call a method asynchronously, simply insert `.await` or `.async` into the call: `service.translate` would be `service.async.translate`
 * To access the response from an [Ivar][ivar] object called `future`, simply call `future.value`
 
 When `await` is used, the request is made synchronously.
+
 ```ruby
 speech_to_text = IBMWatson::SpeechToTextV1.new(
   username: "username",
@@ -189,6 +198,7 @@ output = future.value # The response is accessible at future.value
 ```
 
 When `async` is used, the request is made asynchronously
+
 ```ruby
 speech_to_text = IBMWatson::SpeechToTextV1.new(
   username: "username",
@@ -205,6 +215,7 @@ output = future.value
 ```
 
 ## Sending request headers
+
 Custom headers can be passed in any request in the form of a `Hash` as a parameter to the `headers` chainable method. For example, to send a header called `Custom-Header` to a call in Watson Assistant, pass the headers as a parameter to the `headers` chainable method:
 ```ruby
 require "ibm_watson"
@@ -222,7 +233,9 @@ response = assistant.headers(
 ```
 
 ## Parsing HTTP response info
+
 HTTP requests all return `DetailedResponse` objects that have a `result`, `status`, and `headers`
+
 ```ruby
 require "ibm_watson"
 include IBMWatson
@@ -325,6 +338,7 @@ thr = Thread.new do # Start the websocket inside of a thread
 end
 thr.join # Wait for the thread to finish before ending the program or running other code
 ```
+
 Note: `recognize_with_websocket` has been **deprecated** in favor of **`recognize_using_websocket`**
 
 ## Ruby version
@@ -341,12 +355,20 @@ See [CONTRIBUTING.md][CONTRIBUTING].
 
 This library is licensed under the [Apache 2.0 license][license].
 
+## Featured projects
+
+Here are some projects that have been using the SDK:
+
+* [GuardianCity](https://github.com/TalentoBogotaFedesoft/ULIBRE-061-grupo-2)
+
+We'd love to highlight cool open-source projects that use this SDK! If you'd like to get your project added to the list, feel free to make an issue linking us to it.
+
 [wdc]: http://www.ibm.com/watson/developercloud/
-[ibm_cloud]: https://console.bluemix.net
-[watson-dashboard]: https://console.bluemix.net/dashboard/apps?category=ai
+[ibm_cloud]: https://cloud.ibm.com/
+[watson-dashboard]: https://cloud.ibm.com/catalog?category=ai
 [examples]: https://github.com/watson-developer-cloud/ruby-sdk/tree/master/examples
 [CONTRIBUTING]: https://github.com/watson-developer-cloud/ruby-sdk/blob/master/CONTRIBUTING.md
 [license]: http://www.apache.org/licenses/LICENSE-2.0
-[vcap_services]: https://console.bluemix.net/docs/services/watson/getting-started-variables.html
-[ibm-cloud-onboarding]: http://console.bluemix.net/registration?target=/developer/watson&cm_sp=WatsonPlatform-WatsonServices-_-OnPageNavLink-IBMWatson_SDKs-_-Ruby
+[vcap_services]: https://cloud.ibm.com/docs/services/watson?topic=watson-vcapServices
+[ibm-cloud-onboarding]: http://cloud.ibm.com/registration?target=/developer/watson&cm_sp=WatsonPlatform-WatsonServices-_-OnPageNavLink-IBMWatson_SDKs-_-Ruby
 [ivar]: http://ruby-concurrency.github.io/concurrent-ruby/Concurrent/IVar.html