@activeai/triniti-cli

Triniti cli

A Command line utility for Triniti AI

---

• Prerequisites
• Installing
• Commands
• Usage
• Version check
• Configure
• FAQ
• Train
• Analytics
• Help

Prerequisites

Ensure you have the following prerequisites:

• You need an Triniti Cloud account.
• Install Node.js v10.x.x or above.

Installing

$ npm i -g @activeai/triniti-cli

Commands

• triniti-cli conf
• triniti-cli faq
• triniti-cli train
• triniti-cli analytics
• triniti-cli help

Usage

$ triniti-cli [COMMAND] [ ...args ]

Version check

USAGE
  $ triniti-cli (-v|--version|version)

Configure

Manage Triniti Cli configuration

Triniti Cli expects the following keys to be set.

1. api-key
2. api-secret
3. email-id
4. password
5. workspace-id

USAGE
  $ triniti-cli conf [KEY] [VALUE]

ARGUMENTS
  KEY       key of the config
  VALUE     value of the config

OPTIONS
  -d, --delete            delete the key
  -k, --key=key           key of the config
  -v, --value=value       value of the config


EXAMPLE

    list configurations
    $ triniti-cli conf

    Set a configuration
    $ triniti-cli conf [KEY] [VALUE]
    $ triniti-cli conf email-id test1

    Get a value configured
    $ triniti-cli conf [KEY]
    $ triniti-cli conf email-id

    Remove a configuration
    $ triniti-cli conf [KEY] -d
    $ triniti-cli conf email-id -d

FAQ

Add/Remove FAQs in the workspace

USAGE
  $ triniti-cli faq

OPTIONS
  -h, --help           show help for faq command
  -a, --add=add        add faq(s)
  -r, --remove=remove  remove faq
  -R, --removeAll      remove all FAQs

EXAMPLE

    Add faqs
    $ triniti-cli faq -a filename.csv

    Remove a faq
    $ triniti-cli faq -r faqId

    Remove all FAQs
    $ triniti-cli faq -R

Train

Train the AI models

USAGE
  $ triniti-cli train

OPTIONS
  -h, --help       show help for train command
  -s, --status     display current status of training
  -d, --days       display status of training for days configured
  -t, --type       shallow | full (default)

EXAMPLE

    Train AI models in the workspace
    $ triniti-cli train --type [full | shallow]

    Get the status of training
    $ triniti-cli train --status

    Get the status of training for specific number of days
    $ triniti-cli train --status --days=30

Analytics

Get Analytics

USAGE
  $ triniti-cli analytics 

OPTIONS
  -f, --filename   filename to save transcripts
  -i, --customerId Analytics for the specified customerId
  -t, --transcript Get the chat transcripts
  -u, --type of user
  

EXAMPLE

    get chat transcripts of a customer with customerId
    $ triniti-cli analytics -ti customerId 

    get chat transcripts of a customer with customerId saved to a file, given a filename
    $ triniti-cli analytics -ti customerId -f chat_transcripts.json

    get chat transcripts of a registered customer
    $ triniti-cli analytics analytics -ti registered_user_customerId -u registered

Help

Displays CLI help menu

USAGE
  $ triniti-cli help