The C-Phrase Admin Server

A quick tour of the main C-Phrase administration tool

Your actions to create, edit, launch and monitor NLIs are via the Admin Server. On the main navigation bar, from left to right, NLIs is where you launch natural language interfaces, Create is where you create new configurations over databases and Edit is where you edit and extend existing configurations. On the far right is a link to documentation, a logout button and finally the C-Phrase logo which, if hovered over, shows the current version of C-Phrase.

NLIs page

The NLIs page lets you launch natural language interfaces (NLIs) and shows those currently running. To launch an NLI, select configuration/examples/port combinations and click 'Launch'. In the screen above, the administrator has already launched four NLIs using four different configurations. These NLIs can be accessed through the browser via the given NLI link on the left. Logs of user interactions can be accessed by clicking on corresponding log icons. In this case only the interface 'F1' is being logged.

Create configuration page

Broadly speaking, there are two alternative modes to using C-Phrase: remote and stand-alone. In remote mode a natural language interface (NLI) is configured for an existing remote relational database. In stand-alone mode a database and NLI configuration are created entirely within the Admin Server interface and hosted on the C-Phrase Server.

In the left half of the Create page you can create a configuration for a remote database by specifying the configuration name, database engine, connection parameters and some characterization of the remote database. Here we see this being specified for the example World database. In the upper right portion of the page administrators can create an empty stand-alone configuration that they can extend further via editing. Finally, in the bottom right portion of the page, you can upload earlier or backed-up configurations. You will do this as you upgrade to newer versions of C-Phrase.

Edit configurations page

The edit configurations page is where you do the bulk of your work. On the left, you select a configuration folder, which then gives a set of applicable actions on the right. In the screen above the you have selected the 'world' configuration. By clicking the action 'Edit', you can open the tree editor for the .cphrase file for world (see screen blow). The 'Copy','Rename' and 'Remove' actions apply to the entire directory of the current configuration. 'Launch NLI' takes the administrator to the NLIs page with the current configuration selected. 'Add Question Set' will let the administrator build up a set of example natural questions to present to users. You can click 'Build DB from .cphrase' and the tables and state within the .cphrase file will be added to the existing database (Note since the account on the remote database is readonly, this would fail for world). For stand-alone configurations an SQLite database is built directly from the .cphrase configuration. A related operation is to 'Load DB into .cphrase'. This updates the current .cphrase file with the state of the current database. This operation is dangerous for large databases because it literally will copy the contents of the database into the .cphrase file. The 'Download ZIP' action downloads a .zip file containing the entire configuration directory. This operation lets administrators back-up their configurations as well as migrate configurations to newer C-Phrase EC2 instances. Finally, in the area at the bottom, administrators may upload specific files and sub-directories into the currently selected configuration directory. Normally this will be CSV files that the administrator is ingesting into the database.

In the screen above, you have clicked on the edit action and the .cphrase tree editor is brought up for the World configuration. This is where you build and edit a .cphrase file. The operations in this editor are fairly straightforward provided one has studied in detail the .cphrase file format. Once you have updated and saved a configuration, you must launch or restart an NLI for users to make use it.

The simplest type of customization is to rework and extend the words and phrases that match database tables, columns and foreign keys. These phrases may be edited, removed or extended. You may also explicitly add values to your configuration to provide custom names to specific values (e.g. "Bean town" is a synonym for the city name "Boston").

In the screen above the contents of the world configuration directory are displayed in the directory navigator. There are several distinct file types that are relevant:

Finally the root config.json file at the root of directory explorer to the left, one can change the administration user and password afterwhich one must manually restart Admin Server.

Documentation Page

The documentation page always points to the latest version of the documentation hosted at https://c-phrase.com/documentation