watson_developer_cloud.watson_service module

load_from_vcap_services(service_name)

exception WatsonException

Bases: Exception

Custom exception class for Watson Services.

exception WatsonApiException(code, message, info=None, httpResponse=None)

Bases: watson_developer_cloud.watson_service.WatsonException

Custom exception class for errors returned from Watson APIs.

Parameters

• code (int) – The HTTP status code returned.

• message (str) – A message describing the error.

• info (dict) – A dictionary of additional information about the error.

• httpResponse (response) – response

exception WatsonInvalidArgument

Bases: watson_developer_cloud.watson_service.WatsonException

datetime_to_string(datetime)

Serializes a datetime to a string. :param datetime: datetime value :return: string. containing iso8601 format date string

string_to_datetime(string)

Deserializes string to datetime. :param string: string containing datetime in iso8601 format :return: datetime.

get_error_message(response)

Gets the error message from a JSON response. :return: the error message :rtype: string

class DetailedResponse(response=None, headers=None, status_code=None)

Bases: object

Custom class for detailed response returned from Watson APIs.

Parameters

• response (Response) – Either json response or http Response as requested.

• headers (dict) – A dict of response headers

• status_code (str) – HTTP response code

get_result()

get_headers()

get_status_code()

class WatsonService(vcap_services_name, url, username=None, password=None, use_vcap_services=True, api_key=None, iam_apikey=None, iam_access_token=None, iam_url=None, display_name=None)

Bases: object

load_from_credential_file(service_name, separator='=')

Initiates the credentials based on the credential file

Parameters

• service_name (str) – The service name

• separator (str) – the separator for key value pair

set_username_and_password(username=None, password=None)

set_api_key(api_key)

set_token_manager(iam_apikey=None, iam_access_token=None, iam_url=None)

set_iam_access_token(iam_access_token)

set_iam_url(iam_url)

set_iam_apikey(iam_apikey)

set_url(url)

set_default_headers(headers)

Set http headers to be sent in every request. :param headers: A dictionary of header names and values

set_http_config(http_config)

Sets the http client config like timeout, proxies, etc.

disable_SSL_verification()

set_detailed_response(detailed_response)

static unpack_id(dictionary, label_id)

request(method, url, accept_json=False, headers=None, params=None, json=None, data=None, files=None, **kwargs)