This package has been deprecated

Author message:

This package has been deprecated. See https://learn.microsoft.com/bing/search-apis for details on how to use Bing Search Services.

@azure/cognitiveservices-spellcheck
TypeScript icon, indicating that this package has built-in type declarations

3.0.1 • Public • Published

An isomorphic javascript sdk for - SpellCheckClient

This package contains an isomorphic SDK for SpellCheckClient.

Currently supported environments

  • Node.js version 6.x.x or higher
  • Browser JavaScript

How to Install

npm install @azure/cognitiveservices-spellcheck

How to use

nodejs - Authentication, client creation and spellChecker as an example written in TypeScript.

Install @azure/ms-rest-azure-js
npm install @azure/ms-rest-azure-js
Sample code

The following sample performs a spell check on the text - 'Bill Gatos'. The result will return a suggestion of 'Gates'. To know more, refer to the Azure Documentation on Spell Check

const { SpellCheckClient } = require("@azure/cognitiveservices-spellcheck");
const { CognitiveServicesCredentials } = require("@azure/ms-rest-azure-js");

async function main() {
  const spellCheckKey = process.env["spellCheckKey"] || "<spellCheckKey>";
  const spellCheckEndPoint =
    process.env["spellCheckEndPoint"] || "<spellCheckEndPoint>";
  const cognitiveServiceCredentials = new CognitiveServicesCredentials(
    spellCheckKey
  );
  const client = new SpellCheckClient(cognitiveServiceCredentials, {
    endpoint: spellCheckEndPoint
  });

  const options = {
    mode: "proof",
    pragma: "no-cache"
  };

  client
    .spellChecker("Bill Gatos", options)
    .then(result => {
      console.log("The result is: ");
      result.flaggedTokens.forEach(flaggedToken => {
        flaggedToken.suggestions.forEach(suggestion => {
          console.log(suggestion);
        });
      });
    })
    .catch(err => {
      console.log("An error occurred:");
      console.error(err);
    });
}

main();

browser - Authentication, client creation and spellChecker as an example written in JavaScript.

Sample code
  • index.html
<!DOCTYPE html>
<html lang="en">
  <head>
    <title>@azure/cognitiveservices-spellcheck sample</title>
    <script src="node_modules/@azure/ms-rest-js/dist/msRest.browser.js"></script>
    <script src="node_modules/@azure/cognitiveservices-spellcheck/dist/cognitiveservices-spellcheck.js"></script>
    <script type="text/javascript">
      const spellcheckKey = "<YOUR_SPELL_CHECK_KEY>";
      const spellcheckEndPoint = "<YOUR_SPELL_CHECK_ENDPOINT>";
      const cognitiveServiceCredentials = new msRest.ApiKeyCredentials({
        inHeader: {
          "Ocp-Apim-Subscription-Key": spellcheckKey
        }
      });
      const client = new Azure.CognitiveservicesSpellcheck.SpellCheckClient(
        cognitiveServiceCredentials,
        {
          endpoint: spellcheckEndPoint
        }
      );

      const options = {
        mode: "proof",
        pragma: "no-cache"
      };

      client
        .spellChecker("Bill Gatos", options)
        .then(result => {
          console.log("The result is: ");
          result.flaggedTokens.forEach(flaggedToken => {
            flaggedToken.suggestions.forEach(suggestion => {
              console.log(suggestion);
            });
          });
        })
        .catch(err => {
          console.log("An error occurred:");
          console.error(err);
        });
    </script>
  </head>
  <body></body>
</html>

Related projects

Impressions

Package Sidebar

Install

npm i @azure/cognitiveservices-spellcheck

Weekly Downloads

37

Version

3.0.1

License

MIT

Unpacked Size

206 kB

Total Files

34

Last publish

Collaborators

  • amarzavery
  • azure-sdk
  • veronicagg
  • vladbarosan