@azure/cognitiveservices-luis-runtime

LUISRuntimeClient Library with typescript type definitions for node.js and browser.

4.0.1
Source
npm

Version published: 5 years ago

Maintainers: 6

Created: 6 years ago

Source

An isomorphic javascript sdk for - LUISRuntimeClient

This package contains an isomorphic SDK for LUISRuntimeClient.

Currently supported environments

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

How to Install

npm install @azure/cognitiveservices-luis-runtime

How to use

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

Install @azure/ms-rest-azure-js

npm install @azure/ms-rest-azure-js

Sample code

import { CognitiveServicesCredentials } from "@azure/ms-rest-azure-js";
import { LUISRuntimeClient } from "@azure/cognitiveservices-luis-runtime";

let authoringKey = process.env["luis-authoring-key"];
const creds = new CognitiveServicesCredentials(authoringKey);

// check the following link to find your region
// https://docs.microsoft.com/en-us/azure/cognitive-services/luis/luis-reference-regions
const region = "<your-region>";
const client = new LUISRuntimeClient(creds, "https://" + region + ".api.cognitive.microsoft.com/");

const appId = "<your-app-id>"; // replace this with your appId.
const versionId = "0.1"; // replace with version of your luis application. Initial value will be 0.1

const predictionRequest = {
  query: "testquery",
  options: {
    datetimeReference: new Date(),
    overridePredictions: true
  },
  externalEntities: [
    {
      entityName: "testentityName",
      startIndex: 1,
      entityLength: 1,
      resolution: {}
    }
  ],
  dynamicLists: [
    {
      listEntityName: "testlistEntityName",
      requestLists: [
        {
          name: "testname",
          canonicalForm: "testcanonicalForm",
          synonyms: ["testsynonyms"]
        }
      ]
    }
  ]
};
const verbose = true;
const showAllIntents = true;

client.prediction
  .getVersionPrediction(appId, versionId, predictionRequest, { verbose, showAllIntents })
  .then((result) => {
    console.log("The result is:");
    console.log(result);
  })
  .catch((err) => {
    console.error(err);
  });

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

Sample code

index.html

<!DOCTYPE html>
<html lang="en">
  <head>
    <title>@azure/cognitiveservices-luis-runtime sample</title>
    <script src="node_modules/@azure/ms-rest-js/dist/msRest.browser.js"></script>
    <script src="node_modules/@azure/cognitiveservices-luis-runtime/dist/cognitiveservices-luis-runtime.js"></script>
    <script type="text/javascript">
      let authoringKey = process.env["luis-authoring-key"];
      const creds = new msRest.ApiKeyCredentials({ inHeader: { 'Ocp-Apim-Subscription-Key': authoringKey } });


      // check the following link to find your region
      // https://docs.microsoft.com/en-us/azure/cognitive-services/luis/luis-reference-regions
      const region = "<your-region>";
      const client = new Azure.CognitiveservicesLuisRuntime.LUISRuntimeClient(
        creds,
        "https://" + region + ".api.cognitive.microsoft.com/"
      );

      const appId = "<your-app-id>"; // replace this with your appId.
      const versionId = "0.1"; // replace with version of your luis application. Initial value will be 0.1

      const predictionRequest = {
        query: "testquery",
        options: {
          datetimeReference: new Date(),
          overridePredictions: true
        },
        externalEntities: [
          {
            entityName: "testentityName",
            startIndex: 1,
            entityLength: 1,
            resolution: {}
          }
        ],
        dynamicLists: [
          {
            listEntityName: "testlistEntityName",
            requestLists: [
              {
                name: "testname",
                canonicalForm: "testcanonicalForm",
                synonyms: ["testsynonyms"]
              }
            ]
          }
        ]
      };
      const verbose = true;
      const showAllIntents = true;

      client.prediction
        .getVersionPrediction(appId, versionId, predictionRequest, { verbose, showAllIntents })
        .then((result) => {
          console.log("The result is:");
          console.log(result);
        })
        .catch((err) => {
          console.error(err);
        });
    </script>
  </head>
  <body></body>
</html>

Microsoft Azure SDK for Javascript

Impressions

Keywords

FAQs

What is @azure/cognitiveservices-luis-runtime?

Is @azure/cognitiveservices-luis-runtime well maintained?

Package last updated on 29 Aug 2019

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install