watson-developer-cloud 2.10.1

Before you begin

• You need an IBM Cloud account.

Installation

Note: We are moving to ibm-watson. All versions prior to v3.0.0 can still be found in watson-developer-cloud

To install, use pip or easy_install:

pipinstall--upgradewatson-developer-cloud

or

easy_install--upgradewatson-developer-cloud

Note the following:

1. If you run into permission issues try:

sudo-Hpipinstall--ignore-installedsixwatson-developer-cloud

For more details see #225

2. In case you run into problems installing the SDK in DSX, try

   !pip install --upgrade pip

   Restarting the kernel

For more details see #405

Examples

The examples folder has basic and advanced examples. The examples within each service assume that you already have service credentials.

Running in IBM Cloud

If you run your app in IBM Cloud, the SDK gets credentials from the `VCAP_SERVICES <https://console.bluemix.net/docs/services/watson/getting-started-variables.html>`__ environment variable.

Authentication

Watson services are migrating to token-based Identity and Access Management (IAM) authentication.

• With some service instances, you authenticate to the API by using `IAM <#iam>`__.

• In other instances, you authenticate by providing the `username and password <#username-and-password>`__ for the service instance.

Note: Authenticating with the X-Watson-Authorization-Token header is deprecated. The token continues to work with Cloud Foundry services, but is not supported for services that use Identity and Access Management (IAM) authentication. See here for details.

discovery = DiscoveryV1(version='2018-08-01')

exportIBM_CREDENTIALS_FILE="<path>"

# In the constructor, letting the SDK manage the IAM tokendiscovery = DiscoveryV1(version='2018-08-01', url='<url_as_per_region>', iam_apikey='<iam_apikey>', iam_url='<iam_url>') # optional - the default value is https://iam.bluemix.net/identity/token

# after instantiation, letting the SDK manage the IAM tokendiscovery = DiscoveryV1(version='2018-08-01', url='<url_as_per_region>')discovery.set_iam_apikey('<iam_apikey>')

# in the constructor, assuming control of managing IAM tokendiscovery = DiscoveryV1(version='2018-08-01', url='<url_as_per_region>', iam_access_token='<iam_access_token>')

# after instantiation, assuming control of managing IAM tokendiscovery = DiscoveryV1(version='2018-08-01', url='<url_as_per_region>')discovery.set_iam_access_token('<access_token>')

from watson_developer_cloud import DiscoveryV1# In the constructordiscovery = DiscoveryV1(version='2018-08-01', url='<url_as_per_region>', username='<username>', password='<password>')

# After instantiationdiscovery = DiscoveryV1(version='2018-08-01', url='<url_as_per_region>')discovery.set_username_and_password('<username>', '<password>')

Python version

Tested on Python 2.7, 3.4, 3.5, and 3.6.

Changes for v1.0

Version 1.0 focuses on the move to programmatically-generated code for many of the services. See the changelog for the details.

Changes for v2.0

DetailedResponse which contains the result, headers and HTTP status code is now the default response for all methods.

from watson_developer_cloud import AssistantV1assistant = AssistantV1( username='xxx', password='yyy', url='<url_as_per_region>', version='2018-07-10')response = assistant.list_workspaces(headers={'Custom-Header': 'custom_value'})print(response.get_result())print(response.get_headers())print(response.get_status_code())

See the changelog for the details.

Migration

This version includes many breaking changes as a result of standardizing behavior across the new generated services. Full details on migration from previous versions can be found here.

Configuring the http client (Supported from v1.1.0)

To set client configs like timeout use the with_http_config() function and pass it a dictionary of configs.

from watson_developer_cloud import AssistantV1assistant = AssistantV1( username='xxx', password='yyy', url='<url_as_per_region>', version='2018-07-10')assistant.set_http_config({'timeout': 100})response = assistant.message(workspace_id=workspace_id, input={ 'text': 'What\'s the weather like?'}).get_result()print(json.dumps(response, indent=2))

Disable SSL certificate verification

For ICP(IBM Cloud Private), you can disable the SSL certificate verification by:

service.disable_SSL_verification()

Sending request headers

Custom headers can be passed in any request in the form of a dict as:

headers = { 'Custom-Header': 'custom_value'}

For example, to send a header called Custom-Header to a call in Watson Assistant, pass the headers parameter as:

from watson_developer_cloud import AssistantV1assistant = AssistantV1( username='xxx', password='yyy', url='<url_as_per_region>', version='2018-07-10')response = assistant.list_workspaces(headers={'Custom-Header': 'custom_value'}).get_result()

Parsing HTTP response info

If you would like access to some HTTP response information along with the response model, you can set the set_detailed_response() to True. Since Python SDK v2.0, it is set to True

from watson_developer_cloud import AssistantV1assistant = AssistantV1( username='xxx', password='yyy', url='<url_as_per_region>', version='2018-07-10')assistant.set_detailed_response(True)response = assistant.list_workspaces(headers={'Custom-Header': 'custom_value'}).get_result()print(response)

This would give an output of DetailedResponse having the structure:

{ 'result': <response returned by service>, 'headers': { <http response headers> }, 'status_code': <http status code>}

You can use the get_result(), get_headers() and get_status_code() to return the result, headers and status code respectively.

Using Websockets

The Text to Speech service supports synthesizing text to spoken audio using web sockets with the synthesize_using_websocket. The Speech to Text service supports recognizing speech to text using web sockets with the recognize_using_websocket. These methods need a custom callback class to listen to events. Below is an example of synthesize_using_websocket. Note: The service accepts one request per connection.

from watson_developer_cloud.websocket import SynthesizeCallbackclass MySynthesizeCallback(SynthesizeCallback): def __init__(self): SynthesizeCallback.__init__(self) def on_audio_stream(self, audio_stream): return audio_stream def on_data(self, data): return datamy_callback = MySynthesizeCallback()service.synthesize_using_websocket('I like to pet dogs', my_callback, accept='audio/wav', voice='en-US_AllisonVoice' )

Dependencies

• requests

• python_dateutil >= 2.5.3

• responses for testing

• Following for web sockets support in speech to text

• websocket-client 0.48.0

Contributing

See CONTRIBUTING.md.

License

This library is licensed under the Apache 2.0 license.