{"id":13801162,"url":"https://github.com/watson-developer-cloud/node-sdk","last_synced_at":"2025-05-12T13:28:21.288Z","repository":{"id":24438448,"uuid":"27840307","full_name":"watson-developer-cloud/node-sdk","owner":"watson-developer-cloud","description":":comet: Node.js library to access IBM Watson services.","archived":false,"fork":false,"pushed_at":"2025-04-26T23:58:46.000Z","size":294046,"stargazers_count":1485,"open_issues_count":18,"forks_count":668,"subscribers_count":83,"default_branch":"master","last_synced_at":"2025-05-04T09:37:13.311Z","etag":null,"topics":["conversation-service","hacktoberfest","ibm-watson-services","javascript","language-translation","natural-language","typescript","watson"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/ibm-watson","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/watson-developer-cloud.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2014-12-10T21:20:48.000Z","updated_at":"2025-02-08T13:26:59.000Z","dependencies_parsed_at":"2024-02-26T18:02:49.228Z","dependency_job_id":"1ec45993-3a70-4c43-a179-184b3644bd3b","html_url":"https://github.com/watson-developer-cloud/node-sdk","commit_stats":{"total_commits":2360,"total_committers":124,"mean_commits":"19.032258064516128","dds":0.7720338983050847,"last_synced_commit":"2e2844106b482f71c6ff970de95b0fbfcacb9af1"},"previous_names":[],"tags_count":263,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/watson-developer-cloud%2Fnode-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/watson-developer-cloud%2Fnode-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/watson-developer-cloud%2Fnode-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/watson-developer-cloud%2Fnode-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/watson-developer-cloud","download_url":"https://codeload.github.com/watson-developer-cloud/node-sdk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253747321,"owners_count":21957739,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["conversation-service","hacktoberfest","ibm-watson-services","javascript","language-translation","natural-language","typescript","watson"],"created_at":"2024-08-04T00:01:20.184Z","updated_at":"2025-05-12T13:28:21.248Z","avatar_url":"https://github.com/watson-developer-cloud.png","language":"TypeScript","readme":"# Watson APIs Node.js SDK\n\n[![Build and Test](https://github.com/watson-developer-cloud/node-sdk/workflows/Build%20and%20Test/badge.svg?branch=master)](https://github.com/watson-developer-cloud/node-sdk/actions?query=workflow%3A\"Build+and+Test\")\n[![Deploy and Publish](https://github.com/watson-developer-cloud/node-sdk/workflows/Deploy%20and%20Publish/badge.svg?branch=master)](https://github.com/watson-developer-cloud/node-sdk/actions?query=workflow%3A%22Deploy+and+Publish%22)\n[![codecov](https://codecov.io/gh/watson-developer-cloud/node-sdk/branch/master/graph/badge.svg)](https://codecov.io/gh/watson-developer-cloud/node-sdk)\n[![npm-version](https://img.shields.io/npm/v/ibm-watson.svg)](https://www.npmjs.com/package/ibm-watson)\n[![npm-downloads](https://img.shields.io/npm/dm/ibm-watson.svg)](https://www.npmjs.com/package/ibm-watson)\n[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)\n\n## Deprecated builds\n[![Build Status](https://secure.travis-ci.org/watson-developer-cloud/node-sdk.svg?branch=master)](http://travis-ci.org/watson-developer-cloud/node-sdk)\n\nNode.js client library to use the Watson APIs.\n\n## Before you begin\n* You need an [IBM Cloud][ibm-cloud-onboarding] account.\n\n## Prerequisites\n- **Node \u003e= 20**: This SDK is tested with Node versions 16 and up. It may work on previous versions but this is not officially supported.\n\n## Installation\n\n```sh\nnpm install ibm-watson\n```\n\n## Usage\n\n```js\nimport AssistantV2 from 'ibm-watson/assistant/v2';\nimport { IamAuthenticator } from 'ibm-watson/auth';\n\nconst assistantClient = new AssistantV2({\n  authenticator: new IamAuthenticator({ apikey: '{apikey}' }),\n  version: '{version}',\n});\n\n// ...\n\n```\n\nThe [examples][examples] folder has basic and advanced examples. The examples within each service assume that you already have [service credentials](#getting-credentials).\n\n### Client-side usage\n\nStarting with v5.0.0, the SDK should work in the browser, out of the box, with most bundlers.\n\nSee the `examples/` folder for [Browserify](http://browserify.org/) and [Webpack](http://webpack.github.io/) client-side SDK examples (with server-side generation of auth tokens.)\n\nNote: not all services currently support CORS, and therefore not all services can be used client-side.\nOf those that do, most require an auth token to be generated server-side via the [Authorization Service](#authorization).\n\n## Authentication\nWatson services are migrating to token-based Identity and Access Management (IAM) authentication.\n\n- With some service instances, you authenticate to the API by using **[IAM](#iam)**.\n- In other instances, you authenticate by providing the **[username and password](#username-and-password)** for the service instance.\n- If you are using a Watson service on ICP, you will need to authenticate in [a specific way](#icp).\n- If you are using a Watson service on AWS, you will need to authenticate using [mcsp](#mcsp).\n\nAuthentication is accomplished using dedicated Authenticators for each authentication scheme. Import authenticators from `ibm-watson/auth` or rely on externally-configured credentials which will be read from a credentials file or environment variables.\n\nTo learn more about the Authenticators and how to use them with your services, see [the detailed documentation](https://github.com/IBM/node-sdk-core/blob/master/Authentication.md).\n\n### Getting credentials\n\nTo find out which authentication to use, view the service credentials. You find the service credentials for authentication the same way for all Watson services:\n\n1.  Go to the IBM Cloud [Dashboard](https://cloud.ibm.com/) page.\n2.  Either click an existing Watson service instance in your [resource list](https://cloud.ibm.com/resources) or click [**Create resource \u003e AI**](https://cloud.ibm.com/catalog?category=ai) and create a service instance.\n3. Click on the **Manage** item in the left nav bar of your service instance.\n\nOn this page, you should be able to see your credentials for accessing your service instance.\n\nIn your code, you can use these values in the service constructor or with a method call after instantiating your service.\n\n### Supplying credentials\n\nThere are two ways to supply the credentials you found above to the SDK for authentication:\n- Allow the credentials to be automatically read from the environment\n- Instantiate an authenticator with explicit credentials and use it to create your service\n\n#### Credentials file (easier!)\n\nWith a credentials 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.\n\nThe 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):\n\n- Directory provided by the environment variable `IBM_CREDENTIALS_FILE`\n- Your system's home directory\n- Your current working directory (the directory Node is executed from)\n\nAs 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 Assistant instance, you just need to do the following:\n\n```js\nconst AssistantV2 = require('ibm-watson/assistant/v2');\nconst assistant = new AssistantV2({ version: '2024-08-25' });\n```\n\nAnd that's it!\n\nIf 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.\n\n**Special Note**: Due to legacy issues in Assistant V1 and V2, the following parameter `serviceName` must be added when creating the service object:\n```js\nconst AssistantV2 = require('ibm-watson/assistant/v2');\nconst assistant = new AssistantV2({\n  version: '2024-08-25',\n  serviceName: 'assistant',\n})\n```\n\nIt is worth noting that if you are planning to rely on VCAP_SERVICES for authentication then the `serviceName` parameter **MUST** be removed otherwise VCAP_SERVICES will not be able to authenticate you. See [Cloud Authentication Prioritization](#cloud-authentication-prioritization) for more details.\n\nIf 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:\n\n```bash\nexport IBM_CREDENTIALS_FILE=\"\u003cpath\u003e\"\n```\n\nwhere `\u003cpath\u003e` is something like `/home/user/Downloads/\u003cfile_name\u003e.env`. If you just provide a path to a directory, the SDK will look for a file called `ibm-credentials.env` in that directory.\n\n#### Manually\n\nThe SDK also supports setting credentials manually in your code, using an Authenticator.\n\n##### IAM\n\nSome 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.\n\nTo use IAM authentication, you must use an `IamAuthenticator` or a `BearerTokenAuthenticator`.\n- Use the `IamAuthenticator` 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.\n- Use the `BearerTokenAuthenticator` if you want to manage the lifecycle yourself. For details, see [Authenticating with IAM tokens](https://cloud.ibm.com/docs/watson/getting-started-iam.html). If you want to switch your authenticator, you must override the `authenticator` property directly.\n\n##### ICP\n\nTo use the SDK in a Cloud Pak, use the `CloudPakForDataAuthenticator`. This will require a username, password, and URL.\n\n##### MCSP\n\nTo use the SDK through a third party cloud provider (such as AWS), use the `MCSPAuthenticator`. This will require the base endpoint URL for the MCSP token service (e.g. https://iam.platform.saas.ibm.com) and an apikey. \n\n```js\nimport AssistantV2 from 'ibm-watson/assistant/v2'\nimport { McspAuthenticator } from 'ibm-watson/auth';\n\n# In the constructor, letting the SDK manage the token\nconst authenticator = new McspAuthenticator({\n    url: 'token_service_endpoint',\n    apikey: 'apikey',\n})\nconst assistant = AssistantV2(version='2024-08-25',\n                        authenticator=authenticator)\nassistant.setServiceUrl('\u003curl_as_per_region\u003e')\n```\n\n### Cloud Authentication Prioritization\n\nWhen uploading your application to IBM Cloud there is a certain priority Watson services will use when looking for proper credentials. The order is as follows:\n1. Programmatic (i.e. IamAuthenticator)\n2. Credentials File\n3. VCAP_SERVICES (an environment variable used by IBM Cloud, details found [here](https://cloud.ibm.com/docs/cloud-foundry-public?topic=cloud-foundry-public-deployingapps#app_env))\n\n## Setting the Service URL\nYou can set or reset the base URL after constructing the client instance using the `setServiceUrl` method:\n\n```js\nconst AssistantV2 = require('ibm-watson/assistant/v2');\n\nconst assistant = AssistantV2({\n/* authenticator, version, etc... */\n});\n\nassistant.setServiceUrl('\u003cnew url\u003e');\n```\n\n## Promises\n\nAll SDK methods are asynchronous, as they are making network requests to Watson services. To handle receiving the data from these requests, the SDK offers support with Promises.\n```js\nconst AssistantV2 = require('ibm-watson/assistant/v2');\n\nconst assistant = new AssistantV2({\n/* authenticator, version, serviceUrl, etc... */\n});\n\n// using Promises\nassistant.listAssistants()\n  .then(body =\u003e {\n    console.log(JSON.stringify(body, null, 2));\n  })\n  .catch(err =\u003e {\n    console.log(err);\n  });\n\n// using Promises provides the ability to use async / await\nasync function callAssistant() { // note that callAssistant also returns a Promise\n  const body = await assistant.listAssistants();\n}\n```\n\n## Sending request headers\n\nCustom headers can be passed with any request. Each method has an optional parameter `headers` which can be used to pass in these custom headers, which can override headers that we use as parameters.\n\nFor example, this is how you can pass in custom headers to Watson Assistant service. In this example, the `'custom'` value for `'Accept-Language'` will override the default header for `'Accept-Language'`, and the `'Custom-Header'` while not overriding the default headers, will additionally be sent with the request.\n\n```js\nconst assistant = new watson.AssistantV2({\n/* authenticator, version, serviceUrl, etc... */\n});\n\nassistant.message({\n  workspaceId: 'something',\n  input: {'text': 'Hello'},\n  headers: {\n    'Custom-Header': 'custom',\n    'Accept-Language': 'custom'\n  }\n})\n  .then(response =\u003e {\n    console.log(JSON.stringify(response.result, null, 2));\n  })\n  .catch(err =\u003e {\n    console.log('error: ', err);\n  });\n```\n\n## Parsing HTTP response\n\nThe SDK now returns the full HTTP response by default for each method.\n\nHere is an example of how to access the response headers for Watson Assistant:\n\n```js\nconst assistant = new AssistantV2({\n/* authenticator, version, serviceUrl, etc... */\n});\n\nassistant.message(params).then(\n  response =\u003e {\n    console.log(response.headers);\n  },\n  err =\u003e {\n    console.log(err);\n    /*\n      `err` is an Error object. It will always have a `message` field\n      and depending on the type of error, it may also have the following fields:\n      - body\n      - headers\n      - name\n      - code\n    */\n  }\n);\n```\n\n### Global Transaction ID\nEvery SDK call returns a response with a transaction ID in the `X-Global-Transaction-Id` header. Together with the service instance region, this ID helps support teams troubleshoot issues from relevant logs.\n\n#### HTTP Example\n```js\nconst assistant = new AssistantV2({\n/* authenticator, version, serviceUrl, etc... */\n});\n\nassistant.message(params).then(\n  response =\u003e {\n    console.log(response.headers['X-Global-Transaction-Id']);\n  },\n  err =\u003e {\n    console.log(err);\n  }\n);\n```\n\n#### WebSocket Example\n```js\nconst speechToText = new SpeechToTextV1({\n/* authenticator, version, serviceUrl, etc... */\n});\nconst recognizeStream = recognizeUsingWebSocket(params);\n\n// getTransactionId returns a Promise that resolves to the ID\nrecognizeStream.getTransactionId().then(\n  globalTransactionId =\u003e console.log(globalTransactionId),\n  err =\u003e console.log(err),\n);\n```\n\nHowever, the transaction ID isn't available when the API doesn't return a response for some reason. In that case, you can set your own transaction ID in the request. For example, replace `\u003cmy-unique-transaction-id\u003e` in the following example with a unique transaction ID.\n\n```js\nconst assistant = new AssistantV2({\n/* authenticator, version, serviceUrl, etc... */\n});\n\nassistant.message({\n  workspaceId: 'something',\n  input: {'text': 'Hello'},\n  headers: {\n    'X-Global-Transaction-Id': '\u003cmy-unique-transaction-id\u003e'\n  }\n}).then(\n  response =\u003e {\n    console.log(response.headers['X-Global-Transaction-Id']);\n  },\n  err =\u003e {\n    console.log(err);\n  }\n);\n```\n\n## Data collection opt-out\n\nBy default, [all requests are logged](https://cloud.ibm.com/docs/watson/getting-started-logging.html). This can be disabled of by setting the `X-Watson-Learning-Opt-Out` header when creating the service instance:\n\n```js\nconst myInstance = new watson.WhateverServiceV1({\n  /* authenticator, version, serviceUrl, etc... */\n  headers: {\n    \"X-Watson-Learning-Opt-Out\": true\n  }\n});\n```\n\n## Configuring the HTTPS Agent\nThe SDK provides the user with full control over the HTTPS Agent used to make requests. This is available for both the service client and the authenticators that make network requests (e.g. `IamAuthenticator`). Outlined below are a couple of different scenarios where this capability is needed. Note that this functionality is for Node environments only - these configurtions will have no effect in the browser.\n\n### Use behind a corporate proxy\nTo use the SDK (which makes HTTPS requests) behind an HTTP proxy, a special tunneling agent must be used. Use the package [`tunnel`](https://github.com/koichik/node-tunnel/) for this. Configure this agent with your proxy information, and pass it in as the HTTPS agent in the service constructor. Additionally, you must set `proxy` to `false` in the service constructor. If using an Authenticator that makes network requests (IAM or CP4D), you must set these fields in the Authenticator constructor as well.\n\nSee this example configuration:\n```js\nconst tunnel = require('tunnel');\nconst AssistantV2 = require('ibm-watson/assistant/v2');\nconst { IamAuthenticator } = require('ibm-watson/auth');\n\nconst httpsAgent = tunnel.httpsOverHttp({\n  proxy: {\n    host: 'some.host.org',\n    port: 1234,\n  },\n});\n\nconst assistant = new AssistantV2({\n  authenticator: new IamAuthenticator({\n    apikey: 'fakekey-1234'\n    httpsAgent, // not necessary if using Basic or BearerToken authentication\n    proxy: false,\n  }),\n  version: '2024-08-25',\n  httpsAgent,\n  proxy: false,\n});\n```\n\n### Sending custom certificates\nTo send custom certificates as a security measure in your request, use the `cert`, `key`, and/or `ca` properties of the HTTPS Agent. See [this documentation](https://nodejs.org/api/tls.html#tls_tls_createsecurecontext_options) for more information about the options. Note that the entire contents of the file must be provided - not just the file name.\n```js\nconst AssistantV2 = require('ibm-watson/assistant/v2');\nconst { IamAuthenticator } = require('ibm-watson/auth');\n\nconst certFile = fs.readFileSync('./my-cert.pem');\nconst keyFile = fs.readFileSync('./my-key.pem');\n\nconst assistant = new AssistantV2({\n  authenticator: new IamAuthenticator({\n    apikey: 'fakekey-1234',\n    httpsAgent: new https.Agent({\n      key: keyFile,\n      cert: certFile,\n    })\n  }),\n  version: '2024-08-25',\n  httpsAgent: new https.Agent({\n    key: keyFile,\n    cert: certFile,\n  }),\n});\n```\n\n### Disabling SSL Verification\n\nThe HTTP client can be configured to disable SSL verification. **Note that this has serious security implications - only do this if you really mean to!** ⚠️\n\nTo do this, set `disableSslVerification` to `true` in the service constructor and/or authenticator constructor, like below:\n\n```js\nconst assistant = new AssistantV2({\n  serviceUrl: '\u003cservice_url\u003e',\n  version: '\u003cversion-date\u003e',\n  authenticator: new IamAuthenticator({ apikey: '\u003capikey\u003e', disableSslVerification: true }), // this will disable SSL verification for requests to the token endpoint\n  disableSslVerification: true, // this will disable SSL verification for any request made with this client instance\n});\n```\n\n### All other configuration options\nTo see all possible https agent configuration options go to this [link](https://node.readthedocs.io/en/latest/api/https/#httpsrequestoptions-callback) for the quickest and most readable format. For even more detailed information, you can go to the Node documentation [here](https://nodejs.org/api/http.html#httprequestoptions-callback)\n\n## Documentation\n\nYou can find links to the documentation at https://cloud.ibm.com/developer/watson/documentation. Find the service that you're interested in, click **API reference**, and then select the **Node** tab.\n\n## Questions\n\nIf you have issues with the APIs or have a question about the Watson services, see [Stack Overflow](https://stackoverflow.com/questions/tagged/ibm-watson+node.js).\n\n## IBM Watson services\n\n### Assistant v2\n\nUse the [Assistant][assistant] service to determine the intent of a message.\n\nNote: You must first create a workspace via IBM Cloud. See [the documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-index#about) for details.\n\n```js\nconst AssistantV2 = require('ibm-watson/assistant/v2');\nconst { IamAuthenticator } = require('ibm-watson/auth');\n\nconst assistant = new AssistantV2({\n  authenticator: new IamAuthenticator({ apikey: '\u003capikey\u003e' }),\n  serviceUrl: 'https://api.us-south.assistant.watson.cloud.ibm.com',\n  version: '2018-09-19'\n});\n\nassistant.message(\n  {\n    input: { text: \"What's the weather?\" },\n    assistantId: '\u003cassistant id\u003e',\n    sessionId: '\u003csession id\u003e',\n  })\n  .then(response =\u003e {\n    console.log(JSON.stringify(response.result, null, 2));\n  })\n  .catch(err =\u003e {\n    console.log(err);\n  });\n```\n\n### Assistant v1\n\nUse the [Assistant][assistant] service to determine the intent of a message.\n\nNote: You must first create a workspace via IBM Cloud. See [the documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-index#about) for details.\n\n```js\nconst AssistantV2 = require('ibm-watson/assistant/v2');\nconst { IamAuthenticator } = require('ibm-watson/auth');\n\nconst assistant = new AssistantV2({\n  authenticator: new IamAuthenticator({ apikey: '\u003capikey\u003e' }),\n  serviceUrl: 'https://api.us-south.assistant.watson.cloud.ibm.com',\n  version: '2024-08-25'\n});\n\nassistant.message(\n  {\n    input: { text: \"What's the weather?\" },\n    workspaceId: '\u003cworkspace id\u003e'\n  })\n  .then(response =\u003e {\n    console.log(JSON.stringify(response.result, null, 2));\n  })\n  .catch(err =\u003e {\n    console.log(err);\n  });\n```\n\n### Discovery v2\n\nUse the [Discovery Service][discovery] to search and analyze structured and unstructured data.\n\n```js\nconst DiscoveryV2 = require('ibm-watson/discovery/v2');\nconst { IamAuthenticator } = require('ibm-watson/auth');\n\nconst discovery = new DiscoveryV2({\n  authenticator: new IamAuthenticator({ apikey: '\u003capikey\u003e' }),\n  serviceUrl: 'https://api.us-south.discovery.watson.cloud.ibm.com',\n  version: '2019-11-22'\n});\n\ndiscovery.query(\n  {\n    projectId: '\u003cproject_id\u003e',\n    collectionId: '\u003ccollection_id\u003e',\n    query: 'my_query'\n  })\n  .then(response =\u003e {\n    console.log(JSON.stringify(response.result, null, 2));\n  })\n  .catch(err =\u003e {\n    console.log(err);\n  });\n```\n\n\n### Natural Language Understanding\n\n[Natural Language Understanding](https://cloud.ibm.com/docs/services/natural-language-understanding/getting-started.html) is a collection of natural language processing APIs that help you understand sentiment, keywords, entities, high-level concepts and more.\n\n```js\nconst fs = require('fs');\nconst NaturalLanguageUnderstandingV1 = require('ibm-watson/natural-language-understanding/v1');\nconst { IamAuthenticator } = require('ibm-watson/auth');\n\nconst nlu = new NaturalLanguageUnderstandingV1({\n  authenticator: new IamAuthenticator({ apikey: '\u003capikey\u003e' }),\n  version: '2018-04-05',\n  serviceUrl: 'https://api.us-south.natural-language-understanding.watson.cloud.ibm.com'\n});\n\nnlu.analyze(\n  {\n    html: file_data, // Buffer or String\n    features: {\n      concepts: {},\n      keywords: {}\n    }\n  })\n  .then(response =\u003e {\n    console.log(JSON.stringify(response.result, null, 2));\n  })\n  .catch(err =\u003e {\n    console.log('error: ', err);\n  });\n```\n\n\n### Speech to Text\n\nUse the [Speech to Text][speech_to_text] service to recognize the text from a `.wav` file.\n\n```js\nconst fs = require('fs');\nconst SpeechToTextV1 = require('ibm-watson/speech-to-text/v1');\nconst { IamAuthenticator } = require('ibm-watson/auth');\n\nconst speechToText = new SpeechToTextV1({\n  authenticator: new IamAuthenticator({ apikey: '\u003capikey\u003e' }),\n  serviceUrl: 'https://api.us-south.speech-to-text.watson.cloud.ibm.com'\n});\n\nconst params = {\n  // From file\n  audio: fs.createReadStream('./resources/speech.wav'),\n  contentType: 'audio/l16; rate=44100'\n};\n\nspeechToText.recognize(params)\n  .then(response =\u003e {\n    console.log(JSON.stringify(response.result, null, 2));\n  })\n  .catch(err =\u003e {\n    console.log(err);\n  });\n\n// or streaming\nfs.createReadStream('./resources/speech.wav')\n  .pipe(speechToText.recognizeUsingWebSocket({ contentType: 'audio/l16; rate=44100' }))\n  .pipe(fs.createWriteStream('./transcription.txt'));\n```\n\n\n### Text to Speech\n\nUse the [Text to Speech][text_to_speech] service to synthesize text into an audio file.\n\n```js\nconst fs = require('fs');\nconst TextToSpeechV1 = require('ibm-watson/text-to-speech/v1');\nconst { IamAuthenticator } = require('ibm-watson/auth');\n\nconst textToSpeech = new TextToSpeechV1({\n  authenticator: new IamAuthenticator({ apikey: '\u003capikey\u003e' }),\n  serviceUrl: 'https://api.us-south.text-to-speech.watson.cloud.ibm.com'\n});\n\nconst params = {\n  text: 'Hello from IBM Watson',\n  voice: 'en-US_AllisonVoice', // Optional voice\n  accept: 'audio/wav'\n};\n\n// Synthesize speech, correct the wav header, then save to disk\n// (wav header requires a file length, but this is unknown until after the header is already generated and sent)\n// note that `repairWavHeaderStream` will read the whole stream into memory in order to process it.\n// the method returns a Promise that resolves with the repaired buffer\ntextToSpeech\n  .synthesize(params)\n  .then(response =\u003e {\n    const audio = response.result;\n    return textToSpeech.repairWavHeaderStream(audio);\n  })\n  .then(repairedFile =\u003e {\n    fs.writeFileSync('audio.wav', repairedFile);\n    console.log('audio.wav written with a corrected wav header');\n  })\n  .catch(err =\u003e {\n    console.log(err);\n  });\n\n\n// or, using WebSockets\ntextToSpeech.synthesizeUsingWebSocket(params);\nsynthStream.pipe(fs.createWriteStream('./audio.ogg'));\n// see more information in examples/text_to_speech_websocket.js\n```\n\n## Unauthenticated requests\nThe SDK always expects an authenticator to be passed in. To make an unautuhenticated request, use the `NoAuthAuthenticator`.\n\n```js\nconst watson = require('ibm-watson');\nconst { NoAuthAuthenticator } = require('ibm-watson/auth');\n\nconst assistant = new watson.AssistantV2({\n  authenticator: new NoAuthAuthenticator(),\n});\n```\n\n## Debug\n\nThis library relies on the `axios` npm module written by\n[axios](https://github.com/axios/axios) to call the Watson Services. To debug the apps, add\n'axios' to the `NODE_DEBUG` environment variable:\n\n```sh\n$ NODE_DEBUG='axios' node app.js\n```\nwhere `app.js` is your Node.js file.\n\n## Tests\n\nRunning all the tests:\n```sh\n$ npm test\n```\n\nRunning a specific test:\n```sh\n$ jest '\u003cpath to test\u003e'\n```\n\n## Open source @ IBM\n[Find more open source projects on the IBM Github Page.](http://ibm.github.io/)\n\n## Contributing\nSee [CONTRIBUTING](https://github.com/watson-developer-cloud/node-sdk/blob/master/.github/CONTRIBUTING.md).\n\n## Featured Projects\nWe love to highlight cool open-source projects that use this SDK! If you'd like to get your project added to the list, feel free to make an issue linking us to it.\n- [Watson Speech to Text Demo App](https://github.com/watson-developer-cloud/speech-to-text-nodejs)\n- [Watson Assistant Demo App](https://github.com/watson-developer-cloud/assistant-demo)\n- [CLI tool for Watson Assistant](https://github.com/Themandunord/IWAC)\n\n## License\nThis library is licensed under Apache 2.0. Full license text is available in\n[COPYING][license].\n\n[assistant]: https://www.ibm.com/cloud/watson-assistant/\n[discovery]: https://www.ibm.com/cloud/watson-discovery\n[text_to_speech]: https://www.ibm.com/watson/services/text-to-speech/\n[speech_to_text]: https://www.ibm.com/watson/services/speech-to-text/\n[examples]: https://github.com/watson-developer-cloud/node-sdk/tree/master/examples\n[ibm-cloud-onboarding]: http://cloud.ibm.com/registration?target=/developer/watson\u0026cm_sp=WatsonPlatform-WatsonServices-_-OnPageNavLink-IBMWatson_SDKs-_-Node\n","funding_links":[],"categories":["TypeScript","Data \u0026 AI"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwatson-developer-cloud%2Fnode-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwatson-developer-cloud%2Fnode-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwatson-developer-cloud%2Fnode-sdk/lists"}