@ibm-cloud/watsonx-ai

Build Status npm-version semantic-release

IBM watsonx.ai Node.js SDK

Node.js client library to interact with IBM watsonx.ai service.

Table of Contents

Overview

The IBM watsonx.ai Node.js SDK allows developers to programmatically interact with the IBM watsonx.ai service.

Prerequisites

  • You need an IBM Cloud (SaaS offering) or have access to IBM Cloud Pak® for Data (on-prem offering).
  • You need to have an access to watsonx.ai service in either of above environments.
  • Node.js >=14: This SDK is tested with Node.js versions 14 and up. It may work on previous versions but this is not officially supported.

Installation

npm install @ibm-cloud/watsonx-ai

Using the SDK

For general SDK usage information, please see this link

IBM watsonx.ai Node.js SDK documentation can be found here

This library requires configuration with a service URL and platform credentials to authenticate to your account.

There are several ways to set these authentication properties.

With environment variables

You can set the following environment variables for chosen authentication type.

IAM authentication

WATSONX_AI_AUTH_TYPE=iam
WATSONX_AI_APIKEY=<YOUR-APIKEY>

Bearer token authentication

WATSONX_AI_AUTH_TYPE=bearertoken
WATSONX_AI_BEARER_TOKEN=<YOUR-BEARER-TOKEN>

CP4D authentication

WATSONX_AI_AUTH_TYPE=cp4d
WATSONX_AI_USERNAME=<YOUR_USERNAME>
WATSONX_AI_PASSWORD=<YOUR_PASSWORD>
WATSONX_AI_URL=url

If any troubles regarding SSL verification appear, such as "Error: self-signed certificate in certificate chain", please try setting up environment variables as below:

WATSONX_AI_DISABLE_SSL=true
WATSONX_AI_AUTH_DISABLE_SSL=true

With an external credentials file

To use an external configuration file, please see the general SDK usage information for guidance. Additionally, please see the following template files for:

With programmatic approach

To learn more about how to use programmatic authentication, see the Node.js SDK Core document about authentication.

Code examples

Basic example - text generation/inference

The following code examples authenticate with the environment variables. Please set environment variables before proceeding with examples:

const { WatsonXAI } = require('@ibm-cloud/watsonx-ai');

// Service instance
const watsonxAIService = WatsonXAI.newInstance({
    version: '2024-05-31',
    serviceUrl: 'https://us-south.ml.cloud.ibm.com',
});

const textGenRequestParametersModel = {
    max_new_tokens: 100,
};

const params = {
    input: 'Generate a short greeting for project kick-off meeting.',
    modelId: 'ibm/granite-13b-chat-v2',
    projectId: '<YOUR_PROJECT_ID>',
    parameters: textGenRequestParametersModel,
};

try {
    const textGeneration = watsonxAIService
    .generateText(params)
    .then((res) => {
        console.log("\n\n***** TEXT RESPONSE FROM MODEL *****");
        console.log(res.result.results[0].generated_text);
    })
} catch (err) {
    console.warn(err);
}

When you run this code, you should see result similar to the following output:

***** TEXT RESPONSE FROM MODEL *****
Welcome to the project kick-off meeting. I'm glad you could make it.

More examples

For more examples, please refer to the following directory, which contains self-contained examples of several flows, where you could use this SDK in.

Questions

If you are having difficulties using this SDK or have a question about the IBM Cloud services, please ask a question at Stack Overflow.

Issues

If you encounter an issue with the SDK, you are welcome to submit a bug report. Before that, please search for similar issues. It's possible someone has already encountered this issue.

Open source @ IBM

Find more open source projects on the IBM Github Page

Contributing

See CONTRIBUTING.

License

This project is released under the Apache 2.0 license. The license's full text can be found in LICENSE.

Settings

Member Visibility

Theme

On This Page

IBM watsonx.ai Node.js SDK