Admin Interface: This is the browser-based graphical user interface through which the
administrator controls the Admin Server.
Admin Server: This is the software that runs on the Catch-Phrase Host that the
administrator logs into and operates through
the browser-based Admin Interface.
Administrator: This is the person, likely you, who builds, maintains, launches and extends
NLIs over databases. This is for the benefit of users who actually access the NLIs through either the
NLI or via special purpose applications that access NLIs via REST API calls.
Column Properties: Column properties turn on or off functionalities attached
to columns in your .cphrase Files. These control for the types of natural language access a user gets to such
columns. For example, you may enable/disable the user from specifying filters like name contains "synth"
by including the property +contains. The default values for propertied are set in the NLI Parameter
file, but can be specialized in the .cphrase file.
Catch-Phrase AMI: This is the image on AWS marketplace that subscribers launch to run a
Catch-Phrase EC2.
Catch-Phrase EC2: This is Catch-Phrase Host that runs all the
Catch-Phrase software when deploying to AWS.
Catch-Phrase Host: This is the generic term for the actual machine (or virtual machine) that
all the Catch-Phrase software runs on. This could be an EC2 instance on AWS or a machine on premise.
Configuration: In the context here, a configuration refers to the total set of files that
define an NLI. These configurations are kept in the configs/ directory on the Catch-Phrase Host.
Thus the directory configs/geo/ is the configuration for the geoNLI.
Custom Constants Probes: These are constants elements that are defined in the .corpus file.
When an NLI is launched with such a corpus, then the constants probes appear on the Explorer of the Standard NLI Broweser.
If the user clicks on these then the returned list will appear in the sidebar where users can click on constants to
build questions on the search bar.
Developer: This is the person who builds custom integrations with outside applications. They do this
via writing code that calls the REST API. Often the administrator and the developer will be the same person.
Example Questions: These are questions that are provided in a .corpus file. When an NLI is
launched with a .corpus file, then all the example questions in the .corpus file may be displayed when the user
clicks on the Examples Button on the NLI.
File of type config.json: These files specify the flask configuration for either the Admin Server or for NLIs.
Most importantly these files are where you specify user names and passwords for logging into either the Admin Interface or
NLIs.
File of type .corpus:
These files specify a set of example questions that users can bring up in the NLI by striking the
examples button. They also specify the constants that can appear in the Explorer section of the standard NLI Broswer.
File of type .cphrase:
These files are the heart of configuration over a database. They specify the names and properties associated with
tables, columns and join paths.
File of type .log:
NLIs may produce log files that track the set of questions and commands users have issued.
File of type .json:
The <config-name>.json files in a configuration of name config-name specify the
NLI Parameters that launched NLIs will run with.
NLI: A Natural Language Interface. More specificially here an NLI is the running software
for a specific configuration (e.g. Geo) that may be accessed via the NLI
NLI Parameters:
These are parameters that are speficied in <config-name>.json files that set numerous global variables
within running NLIs.
NLI: This is the interface that users may use to access running NLIs.
It consists of a search bar where users may type or click build questions and commands. It also consists of an explorer on the
sidebar where users can explore the schema and bring in specfic constants to facilitate click building questions on the
search bar.
Paraphrases: These are Catch-Phrase's English descriptions of the SQL queries that it
generates in response to the user's question or command. These paraphrases are associates with answers, commands or,
in the case of ambiguity, a possible interpretation that the user must select from among others.
Remote Mode: This is a mode of operation where the database that is being accessed is on a
remote server. This is the most common usage mode of Catch-Phrase and is in contrast to Stand-alone mode
where the database is an SQLite database within the configuration.
REST API: This is the interface that developers may code API calls over to integrate Catch-Phrase NLIs into
arbitrary applications.
Stand-alone Mode: In Stand-Alone configuration there is no remote database. The database is an
SQLite database within the configuration. This database is built from a .cphrase file that the admin builds from
scratch through editing.
User:
The user is assumed to be a non-technical person who will access a database through the NLI.