Python client library to quickly get started with the various Watson APIs services.
Table of Contents
To install, use pip
or easy_install
:
pip install --upgrade watson-developer-cloud
or
easy_install --upgrade watson-developer-cloud
Note the following:
a) If you run into permission issues try:
sudo -H pip install --ignore-installed six watson-developer-cloud
For more details see #225
b) In case you run into problems installing the SDK in DSX, try
!pip install --upgrade pip
Restarting the kernel
For more details see #405
The examples folder has basic and advanced examples. The examples within each service assume that you already have service credentials.
If you run your app in IBM Cloud, the SDK gets credentials from the VCAP_SERVICES
environment variable.
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.
- In other instances, you authenticate by providing the username and password for the service instance.
- Visual Recognition uses a form of API key only with instances created before May 23, 2018. Newer instances of Visual Recognition use IAM.
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:
- Go to the IBM Cloud Dashboard page.
- Either click an existing Watson service instance or click Create.
- Click Show to view your service credentials.
- Copy the
url
and eitherapikey
orusername
andpassword
.
IBM Cloud is migrating to token-based Identity and Access Management (IAM) authentication. IAM authentication uses a service API key to get an access token that is passed with the call. Access tokens are valid for approximately one hour and must be regenerated.
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.
# In the constructor, letting the SDK manage the IAM token
discovery = DiscoveryV1(version='2017-10-16',
iam_api_key='<iam_api_key>',
iam_url='<iam_url>') # optional - the default value is https://iam.ng.bluemix.net/identity/token
# after instantiation, letting the SDK manage the IAM token
discovery = DiscoveryV1(version='2017-10-16')
discovery.set_iam_api_key('<iam_api_key>')
# in the constructor, assuming control of managing IAM token
discovery = DiscoveryV1(version='2017-10-16',
iam_access_token='<iam_access_token>')
# after instantiation, assuming control of managing IAM token
discovery = DiscoveryV1(version='2017-10-16')
discovery.set_iam_access_token('<access_token>')
from watson_developer_cloud import DiscoveryV1
# In the constructor
discovery = DiscoveryV1(version='2017-10-16', username='<username>', password='<password>')
# After instantiation
discovery = DiscoveryV1(version='2017-10-16')
discovery.set_username_and_password('<username>', '<password>')
Important: This type of authentication works only with Visual Recognition instances created before May 23, 2018. Newer instances of Visual Recognition use IAM.
from watson_developer_cloud import VisualRecognitionV3
# In the constructor
visual_recognition = VisualRecognitionV3(version='2018-05-22', api_key='<api_key>')
# After instantiation
visual_recognition = VisualRecognitionV3(version='2018-05-22')
visual_recognition.set_api_key('<api_key>')
Tested on Python 2.7, 3.4, 3.5, and 3.6.
Version 1.0 focuses on the move to programmatically-generated code for many of the services. See the changelog for the details.
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.
To set client configs like timeout use the with_http_config()
function and pass it a dictionary of configs.
from watson_developer_cloud import AssistantV1
assistant = AssistantV1(
username='xxx',
password='yyy',
version='2017-04-21')
assistant.set_http_config({'timeout': 100})
response = assistant.message(workspace_id=workspace_id, input={
'text': 'What\'s the weather like?'})
print(json.dumps(response, indent=2))
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 AssistantV1
assistant = AssistantV1(
username='xxx',
password='yyy',
version='2017-04-21')
response = assistant.list_workspaces(headers={'Custom-Header': 'custom_value'})
If you would like access to some HTTP response information along with the response model, you can set the set_detailed_response()
to True
from watson_developer_cloud import AssistantV1
assistant = AssistantV1(
username='xxx',
password='yyy',
version='2017-04-21')
assistant.set_detailed_response(True)
response = assistant.list_workspaces(headers={'Custom-Header': 'custom_value'})
print(response)
This would give an output of DetailedResponse
having the structure:
{
'result': <response returned by service>,
'headers': { <http response headers> }
}
You can use the get_result()
and get_headers()
to return the result and headers respectively.
- requests
python_dateutil
>= 2.5.3- responses for testing
- Following for web sockets support in speech to text
autobahn
>= 0.10.9Twisted
>= 13.2.0pyOpenSSL
>= 16.2.0service-identity
>= 17.0.0
See CONTRIBUTING.md.
This library is licensed under the Apache 2.0 license.