Comparing version 0.1.0 to 0.1.1
{ | ||
"name": "geist", | ||
"version": "0.1.0", | ||
"description": "Build virtual assistants for the web", | ||
"homepage": "https://github.com/syntheticore/geist", | ||
"author": "Björn Breitgoff <syntheticore@gmail.com>", | ||
"license": "MIT", | ||
"repository": { | ||
"type": "git", | ||
"url": "git://github.com/syntheticore/geist.git" | ||
}, | ||
"bugs": { | ||
"url": "https://github.com/syntheticore/geist/issues" | ||
}, | ||
"main": "geist.js", | ||
"scripts": { | ||
"test": "make test" | ||
}, | ||
"dependencies": { | ||
"eakwell": "^0.1.0", | ||
"natural": "^0.2.1", | ||
"rsvp": "^3.1.0", | ||
"ssml": "0.0.3" | ||
}, | ||
"devDependencies": { | ||
"chai": "^2.2.0", | ||
"codeclimate-test-reporter": "^0.1.1", | ||
"istanbul": "^0.3.13", | ||
"mocha": "^2.2.1" | ||
}, | ||
"keywords": [ | ||
"ai", | ||
"chat bot", | ||
"speech", | ||
"recognition", | ||
"synthesis", | ||
"virtual", | ||
"assistant", | ||
"siri", | ||
"cortana" | ||
] | ||
"version": "0.1.1", | ||
"main": "index.js", | ||
"license": "MIT" | ||
} |
@@ -1,90 +0,1 @@ | ||
# Geist | ||
[![npm version](https://badge.fury.io/js/geist.svg)](http://badge.fury.io/js/geist) [![Build Status](https://travis-ci.org/syntheticore/geist.svg?branch=master)](https://travis-ci.org/syntheticore/geist) [![Dependency Status](https://david-dm.org/syntheticore/geist.svg)](https://david-dm.org/syntheticore/geist) [![Code Climate](https://codeclimate.com/github/syntheticore/geist/badges/gpa.svg)](https://codeclimate.com/github/syntheticore/geist) | ||
Build virtual assistants for the web | ||
Designed for use with Browserify | ||
## Installation | ||
npm install geist --save | ||
## Usage | ||
```JavaScript | ||
var geist = require('geist'); | ||
// Describe your assistant | ||
var hal = new geist.Mind('HAL 9000', { | ||
// Language is taken from the document if not specified here | ||
language: 'en-US', | ||
// Keep listening all the time if you like | ||
continuous: true, | ||
// Define generic concepts for recognition and/or answer text generation | ||
// You can either use template strings or functions to determine a match | ||
concepts: { | ||
TOD: ["morning | afternoon | evening | night", function() { | ||
// Current time of day | ||
var hours = new Date().getHours(); | ||
if(hours < 12) return 'morning'; | ||
else if(hours <= 16) return 'afternoon'; | ||
else if(hours <= 22) return 'evening'; | ||
else return 'night'; | ||
}], | ||
JOKE: [undefined, function() { | ||
// Random joke | ||
return _.pick(jokes); | ||
}] | ||
}, | ||
// Define your action handlers | ||
actions: { | ||
MESSAGE: function(person, text) { | ||
// Send message... | ||
} | ||
}, | ||
// Build the actual conversation | ||
conversation: { | ||
// Use alternatives to make recognition flexible and output diverse | ||
"Thank('s | you)" : "You're welcome! | No problem!", | ||
// Reference general concepts in your conversation and influence TTS using emotions | ||
"Open #ARTICLE * [pod bay] door[s]" : "I'm sorry, #HUMAN. %SAD(I'm afraid I can't do that)", | ||
// Create your own concepts and reference them | ||
"(Tell [me] | [Do] you know) a joke" : "How about this one: #JOKE", | ||
// Allow greetings before other text and greet back before continuing | ||
"(Hi | Hello | Good #TOD) [#NAME] [...]" : "(Hello | Good #TOD), #HUMAN! ...", | ||
// Use $variables to extract information | ||
"[(Send | write | new) [a]] message to {$person: *}" : { "What message would you like to send to $person?" : { | ||
// Drill down into conversations to retrieve additional information | ||
"{$message: *}" : { "Shall is send \"$message \" to $person?" : { | ||
// Call action handler | ||
"#YES" : "!MESSAGE($person, $message) It's out!", | ||
// Ask for the message again | ||
"#NO" : "Sorry, <-", | ||
// Back to top level | ||
"#CANCEL" : "Ok, not sending it. <--" | ||
}} | ||
}}, | ||
// Make sure at least one phrase catches everything | ||
"*" : "Excuse me!? | Can you please repeat that, #HUMAN?" | ||
} | ||
}); | ||
// Start listening to the users voice | ||
// The user will be asked for access to her microphone | ||
hal.listen(function(interimText) { | ||
// Visualize speech recognition process.. | ||
}, function(text) { | ||
// Show final recognized text... | ||
}, function(answer) { | ||
// (Answer is being spoken using TTS) | ||
// Display answer as well if you like... | ||
}); | ||
// Stop speaking and listening immediately | ||
hal.stop(); | ||
``` | ||
## License | ||
MIT | ||
# geist |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Empty package
Supply chain riskPackage does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
New author
Supply chain riskA new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.
Found 1 instance in 1 package
No contributors or author data
MaintenancePackage does not specify a list of contributors or an author in package.json.
Found 1 instance in 1 package
No bug tracker
MaintenancePackage does not have a linked bug tracker in package.json.
Found 1 instance in 1 package
No repository
Supply chain riskPackage does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.
Found 1 instance in 1 package
No website
QualityPackage does not have a website.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
0
0
93
2
0
2
1
1
3
- Removedeakwell@^0.1.0
- Removednatural@^0.2.1
- Removedrsvp@^3.1.0
- Removedssml@0.0.3
- Removedapparatus@0.0.10(transitive)
- Removedeakwell@0.1.8(transitive)
- Removednatural@0.2.1(transitive)
- Removedrsvp@3.6.2(transitive)
- Removedssml@0.0.3(transitive)
- Removedsylvester@0.0.21(transitive)
- Removedunderscore@1.13.71.5.2(transitive)
- Removedxmlbuilder@2.1.0(transitive)