Home › API Reference

API Reference

The modules and classes that make up the Violet conversation platform.

ConversationEngine

The main class you interact with. Orchestrates parsing scripts, processing inputs, filling goals, and producing responses.

InputMgr

Processes inputs (data from Alexa/Google) and calls the intents defined in your Violet scripts.

OutputMgr

Builds the output back to the platform, driven by calls from your scripts to the Response class.

ScriptParser

Parses the HTML-inspired Violet Conversation Flow language into structures the engine can execute.

Response

The object passed into your resolve handlers — say(), prompts, and goal control for a single turn.

violet (script API)

The top-level script API: respondTo(), defineGoal(), addTopLevelGoal() and friends.

violetStorePG

Store plugin for persisting conversation and application data in PostgreSQL.

violetStoreSF

Store plugin for reading and writing data in Salesforce objects.

FlowScriptCompiler

Compiles the Conversation Flow document into the runtime representation used by the engine.

Full generated docs and source are available on GitHub.