node package manager
Painless code sharing. npm Orgs help your team discover, share, and reuse code. Create a free org »

cognitive-services

Microsoft® Cognitive Services SDK for Node.JS

By Josh Balfour

npm-version npm-installs dev-deps issues

Description

Unofficial SDK for Microsoft® Cognitive Services written for Node.JS. Usage of Microsoft® Cognitive Services is bound by their Terms and Conditions.

Getting Started

To get started first sign up and grab your API keys. Then figure out which API you want to use, you can find descriptions here.

To use this SDK in your project, run npm install cognitive-services --save.

Then make a JS file in your project directory and add the following:

const cognitiveServices = require('cognitive-services');

You are now ready to use the APIs, for example:

const parameters = {
    "mode": "proof",
    "mkt": "en-us"
}
 
const body = "Text=Bill+Gatas"
 
const client = new cognitiveServices.bingSpellCheck({
    apiKey: "YOUR-API-KEY",
    endpoint: "YOUR-ENDPOINT"
})
 
client.spellCheck({
    parameters,
    body
}).then(response => {
    console.log(response);
})

If you want to see more examples of use you can see within the test folder.

Contributing

  1. Download the source code and run npm install.
  2. Update the file tests/config.js with your own API keys.
  3. Run gulp test.

Supported APIs

  • Knowledge
    • Academic knowledge
    • Entity Linking
    • Recommendations
    • Knowledge exploration
    • QnA maker
    • Custom decision service
  • Language
    • Bing spell check
    • Text analytics
    • Web language model
    • LUIS
    • Translator Text
    • Linguistic Analysis
  • Search
    • Bing Autosuggest
    • Bing Image Search
    • Bing News Search
    • Bing Video Search
    • Bing Web Search
    • Bing Custom Search
    • Bing Entity Search
  • Speech
    • Speaker recognition
    • Translator
    • Bing Speech
    • Custom speech service
  • Vision
    • Computer vision
    • Emotion
    • Face
    • Video
    • Content moderator
    • Custom vision service
    • Video indexer

License

Copyright (c) 2016, Josh Balfour

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

Legal

Microsoft, Microsoft Cognitive Services, and Windows are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. This project was done without the knowledge or endorsement of Microsoft®.