🆕🆕🆕.NET Standard library to access Watson Services.
Latest commit 945ed4e Sep 21, 2018

README.md

Watson Developer Cloud .NET Standard SDK

Build status Coverage Status wdc-community.slack.com CLA assistant semantic-release

The .Net SDK uses the Watson Developer Cloud services, a collection of REST APIs and SDKs that use cognitive computing to solve complex problems.

Table of Contents

Before you begin

Ensure you have the following prerequisites:

Installing the Watson .NET Standard SDK

You can get the latest SDK packages through NuGet. Installation instructions can be found in the ReadMe of each package.

Or manually here.

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.
  • 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.

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 page.
  2. Either click an existing Watson service instance or click Create resource > AI and create a service instance.
  3. Copy the url and either apikey or username and password. Click Show if the credentials are masked.

In your code, you can use these values in the service constructor or with a method call after instantiating your service.

IAM

Some services use 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. If you want to switch to API key override your stored IAM credentials with an IAM API key.

Supplying the IAM API key

void Example()
{
    TokenOptions iamAssistantTokenOptions = new TokenOptions()
    {
        IamApiKey = "<iam-apikey>",
        ServiceUrl = "<service-endpoint>"
    };

    _assistant = new AssistantService(iamAssistantTokenOptions, "<version-date>");
}

Supplying the access token

void Example()
{
    TokenOptions iamAssistantTokenOptions = new TokenOptions()
    {
        IamAccessToken = "<iam-access-token>"
    };

    _assistant = new AssistantService(iamAssistantTokenOptions, "<version-date>");
}

Username and password

void Example()
{
    _assistant = new AssistantService("<username>", "<password>", "<version-date>");
}

API key

Important: This type of authentication works only with Visual Recognition instances created before May 23, 2018. Newer instances of Visual Recognition use IAM.

void Example()
{
    _visualRecognition = new VisualRecognitionService("<apikey>", "<version-date>");
}

Custom Request Headers

You can send custom request headers by adding them to the customData object.

void Example()
{
    AssistantService assistant = new AssistantService("<username>", "<password>", "<version-date>");

    //  Create customData object
    Dictionary<string, object> customData = new Dictionary<string, object>();
    //  Create a dictionary of custom headers
    Dictionary<string, string> customHeaders = new Dictionary<string, string>();
    //  Add to the header dictionary
    customHeaders.Add("X-Watson-Metadata", "customer_id=some-assistant-customer-id");
    //  Add the header dictionary to the custom data object
    customData.Add(Constants.String.CUSTOM_REQUEST_HEADERS, customHeaders);

    var results = assistant.Message("<workspace-id>", "<message-request>", customData: customData);
}

Response Headers

You can get the response headers and the raw json response in the result object.

void Example()
{
    AssistantService assistant = new AssistantService("<username>", "<password>", "<version-date>");
    var results = assistant.Message("<workspace-id>", "<message-request>");
    
    var responseHeaders = results.ResponseHeaders;  //  The response headers
    var responseJson = results.ResponseJson;        //  The raw response json
}

Self signed certificates

You can disable SSL verification on calls to Watson (only do this if you really mean to!).

void Example()
{
    AssistantService assistant = new AssistantService("<username>", "<password>", "<version-date>");
    assistant.SendAsInsecure(true);
    var results = assistant.Message("<workspace-id>", "<message-request>");
}

Documentation

Click here for documentation by release and branch.

Questions

If you are having difficulties using the APIs or have a question about the IBM Watson Services, please ask a question on dW Answers or Stack Overflow.

Open Source @ IBM

Find more open source projects on the IBM Github Page.

License

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

Contributing

See CONTRIBUTING.md.