Skip to content

Latest commit

 

History

History
90 lines (64 loc) · 2.69 KB

README.md

File metadata and controls

90 lines (64 loc) · 2.69 KB
Raw

cognigy-hammer

An extension development suite for CognigyAI. Not affiliated with Cognigy or its subsidiaries.

Project seeks to eliminate the need of managing nodes dependencies and establish a standard for better development of CognigyAI extensions.

Live examples

Prerequisites:

  • Linux/macOS
  • Git
  • Node >= 18
  • NPM >= 9

Setup

$ npm i -g cognigy-hammer

$ cognigy-hammer create scaffold

Features

  • CLI to easily create new project, nodes, connections.
  • Nodes types and hierarchy are injected automatically based on directory structure.
  • Connections and Nodes are imported automatically.
  • Helper function for setting the next node.

CLI overview

Usage: cognigy-hammer [options] [command]

An extension development suite for CognigyAI.

Options:
  -V, --version    output the version number
  -h, --help       display help for command

Commands:
  list <entity>    List current nodes / connections.
  create <entity>  Guided way to create a new entity.
  delete <entity>  Guided way to delete an existing entity.
  help [command]   display help for command

Standard

Directory structure

  • Nodes are stored in ./src/nodes
  • Connections are stored in ./src/connections
  • Assets used at runtime are stored in ./src/assets

Each node can have N children nodes. The former are stored in a directory located at the same tree level as the parent.

src
├── assets
│   └── extension-map.js
├── connections
│   └── dbs
│       ├── Mongo.ts
│       └── MySQL.ts
└── nodes
    ├── Parent
    │   ├── Child1.ts
    │   ├── Child2
    │   │   └── Child3.ts
    │   └── Child2.ts
    └── Parent.ts

Node rules

  • One parent node can have N child nodes.
  • One parent node must not share its children nodes with other parent nodes. While CognigyAI chart supports this variant and other mixed ones, a custom implementation and/or directory scheme is required from development side for it, which is not in the scope of this package.

In above example, Parent1 and Parent2 cannot share the same Child2.

Demo project

https://github.com/tgbv/cognigy-reddit-explorer