www.npmjs.com Open in urlscan Pro
104.17.176.171  Public Scan

Submitted URL: https://badge.fury.io/js/ludown
Effective URL: https://www.npmjs.com/package/ludown
Submission: On September 23 via api from US — Scanned from CA

Form analysis 1 forms found in the DOM

GET /search

<form id="search" method="GET" action="/search" class="_13c93d41 relative flex bg-transparent ph3 ph2 pv2 ph0-ns pv0-ns bt b--black-10 bn-ns">
  <div class="e82b10fd relative dde91b96">
    <div class="_2f299eeb nowrap flex"><span class="_705cdf4f db fl pl3 pr1"><svg width="15px" height="15px" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 18 18" aria-hidden="true">
          <g stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
            <g stroke="#777777" stroke-width="1.3">
              <g>
                <path d="M13.4044,7.0274 C13.4044,10.5494 10.5494,13.4044 7.0274,13.4044 C3.5054,13.4044 0.6504,10.5494 0.6504,7.0274 C0.6504,3.5054 3.5054,0.6504 7.0274,0.6504 C10.5494,0.6504 13.4044,3.5054 13.4044,7.0274 Z"></path>
                <path d="M11.4913,11.4913 L17.8683,17.8683"></path>
              </g>
            </g>
          </g>
        </svg></span><input type="search" role="combobox" name="q" hotkeys="[object Object]" placeholder="Search packages" aria-label="Search packages" aria-controls="typeahead-list-385962" aria-expanded="false" aria-activedescendant=""
        inputref="[object Object]" autocomplete="off" class="_390acbc5 f5 fw3 black relative" value="" element="input"></div>
  </div><button type="submit" class="_0da775bb bn pv2 ph4 f6 white pointer bn pv2 ph4 f6 white pointer" aria-label="Search">Search</button><input type="hidden" name="csrftoken" value="OEdLpRBYL6pfdynG-3LBZVUupdfr8fNXv7z2MeHkL8L">
</form>

Text Content

skip to:contentpackage searchsign in
❤
 * Pro
 * Teams
 * Pricing
 * Documentation

npm


Search
Sign UpSign In


LUDOWN

1.4.0 • Public • Published 5 years ago
 * Readme
 * Code Beta
 * 11 Dependencies
 * 5 Dependents
 * 47 Versions


THE NEW BF CLI REPLACES LEGACY STANDALONE TOOLS

The Bot Framework SDK team is happy to announce the General Availability of the
consolidated bot framework CLI tool bf-cli. The new BF CLI tool will replace
legacy standalone tools to manage Bot Framework bots and related services. The
old tools will be ported over in phases and all new features, bug fixes, and
further investments will focus on the new BF CLI. Old tools will still work for
the time being, but they are going to be deprecated in future releases.

Upon the release of Bot Framework SDK version 4.6 the following legacy tools
have been ported: Chatdown, QnAMaker, LuisGen, and LuDown.

To learn more about the BF CLI please visit the BF CLI github repository.

The following page is about a legacy tool.


LUDOWN



.lu files help describe language understanding components for your bot. LUDown
is a command line tool that helps convert .lu file(s) into JSON files that you
can then use to create your LUIS app or QnAMaker knowledge base.

Language Understanding (LUIS.ai) allows your application to understand what a
person wants in their own words. LUIS uses machine learning to allow developers
to build applications that can receive user input in natural language and
extract meaning from it.

QnA Maker enables you to go from FAQ to bot in minutes. With QnA Maker you can
build, train and publish a simple question and answer bot based on FAQ URLs,
structured documents or editorial content in minutes.

The .lu file and the LUDown tool serve several use cases:

 * Quick, simple and easy way to bootstrap language understanding for your bot.
 * Describe intents, entities, utterances and patterns for your bot in simple
   markdown documents.
 * The language understanding definition for your bot lives with the rest of
   your code. You can use other CLI tools like luis to create a new LUIS app
   using the .lu files.
 * Group language understanding documents by language and locale to easily
   manage localization.
 * Define question and answer pairs for your bot.
 * Works in conjunction with other Microsoft Bot Builder tools, like LUIS CLI
   and QnAMaker CLI.


PREREQUISITE

 * Node.js version 8.5 or higher


INSTALLATION

To install:

npm i -g ludown

Checkout the examples folder for example .lu files.

Also see the here to add Small talk/ chit-chat capabilities to your bot.


DOCS

 * Ludown commands
 * .lu File Format
 * Creating LUIS JSON model file
 * Creating QnA Maker KB model file
 * Recreating .lu files with Refresh command
 * Machine translating .lu files
 * Adding small talk/ chit-chat capabilities to your bot
 * Ludown as a library


USE LUDOWN AS A LIBRARY

Ludown can be used within a Node.js application as an imported library. Install
locally:

npm install ludown --save

In your node project:

const ludown = require('ludown');
const luContent1 = `# Greeting
- hi`;
const log = false;
const locale = 'en-us';
ludown.parser.parseFile(luContent1, log, locale)
    .then(function(parsedContent) {
        // Parsed LUIS object
        console.log(JSON.stringify(parsedContent.LUISJsonStructure, 2, null));
        // Parsed QnA content
        console.log(JSON.stringify(parsedContent.qnaJsonStructure, 2, null));
        // Additional files to parse
        console.log(JSON.stringify(parsedContent.additionalFilesToParse, 2, null));
    })
    .catch(function(err) {
        let errObj = new ludown.helperClasses.exception(err);
        // err is of type ludown.helperClasses.exception. 
        // Possible error codes are available under ludown.helperEnums.errorCodes
        if(errObj.errCode === ludown.helperEnums.errorCodes.INVALID_INPUT) {
            // do something specific to this error code
        } else {
            console.log(errObj.text);
        }
    })
 

Check out the full reference here


NIGHTLY BUILDS

Nightly builds are based on the latest development code which means they may or
may not be stable and probably won't be documented. These builds are better
suited for more experienced users and developers although everyone is welcome to
give them a shot and provide feedback.

You can get the latest nightly build of Ludown from the BotBuilder MyGet feed.
To install the nightly -

npm config set registry https://botbuilder.myget.org/F/botbuilder-tools-daily/npm/

Install using npm:

npm i -g ludown

To reset registry:

npm config set registry https://registry.npmjs.org/


README


KEYWORDS

none







PACKAGE SIDEBAR


INSTALL

npm i ludown


REPOSITORY

Gitgithub.com/Microsoft/botbuilder-tools


HOMEPAGE

github.com/Microsoft/botbuilder-tools#readme


DOWNLOADSWEEKLY DOWNLOADS

78


VERSION

1.4.0


LICENSE

MIT


UNPACKED SIZE

2.69 MB


TOTAL FILES

315


ISSUES

11


PULL REQUESTS

87


LAST PUBLISH

5 years ago


COLLABORATORS

 * 
 * 
 * 

Try on RunKit
Report malware


FOOTER


SUPPORT

 * Help
 * Advisories
 * Status
 * Contact npm


COMPANY

 * About
 * Blog
 * Press


TERMS & POLICIES

 * Policies
 * Terms of Use
 * Code of Conduct
 * Privacy