Go SDK for IBM Watson services

Go (golang) client library to use the Watson Developer Cloud services.

Installation
Documentation
Status
Basic Usage
Testing
License
Contributing
[Authors and Contributors] (#authors)

Installation

Use the go tool to install the package (and a couple of dependencies):

go get github.com/liviosoares/go-watson-sdk/...

Documentation

Go API documentation @ godoc.org: https://godoc.org/github.com/liviosoares/go-watson-sdk
Watson Developer Cloud: http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/doc/

Status

There are tests covering a large portion of the Watson cloud services. However, the API of this package are subject to change, and I would consider it's current release to be alpha quality.

The following table shows the list of Watson services covered by the package, and the implemented version number:

Service	Major Version	Minor Version
Alchemy	(not currently versioned)
Authorization	`v1`
Concept Insights	`v2`
Conversation (experimental)	`v1`	`2016-05-19`
Dialog	`v1`
Document Conversion	`v1`	`2015-12-15`
Language Transalation	`v2`
Natural Language Classifier	`v1`
Personality Insights	`v2`
Retrieve and Rank	`v1`
Speech to Text	`v1`
Text to Speech	`v1`
Tone Analyzer	`v3`	`2016-02-11`
Visual Insights	`v1`
Visual Recognition	`v2`	`2015-12-02`

Basic Usage

For complete documentation, see the references above to the Godoc documentation.

A short example of connecting to the Watson Concept Insights service, using the watson package:

import (
       "github.com/liviosoares/go-watson-sdk/watson"
       "github.com/liviosoares/go-watson-sdk/watson/concept_insights"
)

// assumes $VCAP_SERVICES environment variable is set
client, err := concept_insights.NewClient(watson.Config{})
if err != nil {
    return err
}
// Gets the accounts using the `/concept-insights/api/v2/accounts` endpoint
accounts, err := client.ListAccounts()
if err != nil {
    return err
}
fmt.Println(accounts)

If you do not want to rely on the setup of the $VCAP_SERVICES environment variable, it's also possible to pass credential information explicitly in the NewClient() call:

import (
       "github.com/liviosoares/go-watson-sdk/watson"
       "github.com/liviosoares/go-watson-sdk/watson/concept_insights"
)

config := watson.Config{
    Credentials: watson.Credentials{
        Username: "... username ...",
        Password: "... password ...",
    },
}
client, err := concept_insights.NewClient(config)

Testing

To test the SDK, you must first obtain credentials for the specific services you would like to test. Please see the Watson Developer Cloud documentation to obtain credentials: https://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/doc/getting_started/gs-credentials.shtml

The .creds.sh file is a conveniently written version of the VCAP_SERVICES environment variable that can be sourced in a bash or sh shell session. Use your credentials to fill the specific service definitions in .creds.sh and source the file. The package will be able to parse and query the VCAP_SERVICES environment variable, extracting the appropriate username and password.

Then, to test all services use:

go test github.com/liviosoares/go-watson-sdk/watson/...

and to test a specific service, you can do, for example

go test github.com/liviosoares/go-watson-sdk/watson/concept_insights

License

This library is licensed under Apache 2.0. Full license text is available in LICENSE.

Contributing

Issues and pull requests are encouraged! Whenever applicable, please add a test in the appropriate service implementation, using one of the _test.go test files (or creating a new one).

Also, please review and digitally sign our Contributor License Agreement here: [go-watson-sdk CLA](https://cla-assistant.io/readme/badge/liviosoares/go-watson-sdk)

Authors

Livio Soares liviobs@gmail.com

liviosoares / go-watson-sdk

readme