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

• Before you begin
• Installing the Watson .NET Standard SDK
• Documentation
• Questions
• Open Source @ IBM
• License
• Contributing

Ensure you have the following prerequisites:

• You need an IBM Cloud account.
• Install Visual Studio for Windows or Visual Studio Code for OSX or Linux.
• Install .NET Core.

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

• Assistant V1
• Assistant V2
• Compare Comply
• Conversation (deprecated - Use Assistant V1 or Assistant V2)
• Discovery
• Language Translator V3
• Natural Language Understanding
• Natural Language Classifier
• Personality Insights
• Speech to Text
• Text to Speech
• Tone Analyzer
• Visual Recognition

Or manually here.

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.

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.

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.

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

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

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

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

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

There are two ways to supply the credentials you found above to the SDK for authentication.

With a credential file, you just need to put the file in the right place and the SDK will do the work of parsing it and authenticating. You can get this file by clicking the Download button for the credentials in the Manage tab of your service instance.

The file downloaded will be called ibm-credentials.env. This is the name the SDK will search for and must be preserved unless you want to configure the file path (more on that later). The SDK will look for your ibm-credentials.env file in the following places (in order):

• Your system's home directory
• The top-level directory of the project you're using the SDK in

As long as you set that up correctly, you don't have to worry about setting any authentication options in your code. So, for example, if you created and downloaded the credential file for your Discovery instance, you just need to do the following:

AssistantService assistantService = new AssistantService();
var listWorkspacesResult = assistantService.ListWorkspaces();

And that's it!

If you're using more than one service at a time in your code and get two different ibm-credentials.env files, just put the contents together in one ibm-credentials.env file and the SDK will handle assigning credentials to their appropriate services.

If you would like to configure the location/name of your credential file, you can set an environment variable called IBM_CREDENTIALS_FILE. This will take precedence over the locations specified above. Here's how you can do that:

export IBM_CREDENTIALS_FILE="<path>"

where <path> is something like /home/user/Downloads/<file_name>.env.

If you'd prefer to set authentication values manually in your code, the SDK supports that as well. The way you'll do this depends on what type of credentials your service instance gives you.

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);
}

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
}

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>");
}

Click here for documentation by release and branch.

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.

Find more open source projects on the IBM Github Page.

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

See CONTRIBUTING.md.