Giter VIP home page Giter VIP logo

pb-node's Introduction

Note: breaking changes have been introduced in v2.0.0. If you want to old version, you can still install v1.0.1 from NPM.

pb-node

Pandorabots API module for Node.js. Please read the documentation for further information regarding naming conventions and file types.

You will need both a user_key and app_id, which you can get from your account on our legacy AIAAS developer portal, or sign up as a Premium user on our Pandorabots platform.

Installation

$ npm install pb-node

Usage

var Pandorabot = require('pb-node');

var options = {
  url: '{hostname: https://aiaas.pandorabots.com | https://api.pandorabots.com}',
  app_id: **************,
  user_key: ************,
  botname: *************
};

var bot = new Pandorabot(options);

Methods

List all bots

bot.list(function(err, res) {
  if (!err) console.log(res);
});

Create a bot

bot.create(function(err, res) {
  if (!err) console.log(res);
});

Delete a bot

bot.delete(function(err, res) {
  if (!err) console.log(res);
});

Upload a file

var file = './example.aiml';

bot.upload(file, function(err, res) {
  if (!err) console.log(res);
});

Get a file

var file = 'example.aiml';

bot.getFile(file, function(err, file) {
  if (!err) console.log(file);
});

Remove a file

var file = 'example.aiml';

bot.remove(file, function(err, res) {
  if (!err) console.log(res);
});

Get a bot

bot.get(function(err, res) {
  if (!err) console.log(res);
});

You can download your bot's files as a .zip by passing true as the first parameter:

bot.get(true, function(err, res) {
  if (!err) console.log(res);
});

Compile a bot

bot.compile(function(err, res) {
  if (!err) console.log(res);
});

Talk

The input parameter is required. All others are optional:

var talkParams = {
  client_name: YOUR_CLIENT_NAME,
  sessionid: YOUR_SESSION_ID,
  input: YOUR_INPUT,
  extra: BOOLEAN,
  trace: BOOLEAN,
  recent: BOOLEAN
}

bot.talk(talkParams, function (err, res) {
  if (!err) console.log(res);
});

Anonymous talk

Use this API to create a new client_name. Then, store this value and pass it in to future talk requests:

bot.atalk({ input: 'hello' }, function(err, res) {
  if (!err) console.log(res);
});

Development

$ npm install --development

Run tests with mocha:

$ npm test

pb-node's People

Contributors

djfdev avatar pandorabots-admin avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.