ECOChat User Manual

ECOChat Administration Manual

1. Introduction, context and objectives

ECOChat is Pangeanic's framework to create virtual assistants and deploy them for use by organization users in a secure and controlled way.

ECOChat is based on three components:

• Generative AI: Technology based on LLMs (Large Language Models) for understanding and generating languages.
• RAG (Retrieval Augmented Generation): Gives the LLM context to generate text output based on customer-provided documents.
• ECO: Pangeanic corporate platform used to convey language processing to an organization.

Deployment Modes

To deploy the framework in an organization, 3 different modes are possible:

• SaaS: The framework is a Service, operated and managed by Pangeanic. The same infrastructure is used to provide services to multiple customers/organizations.
• Dedicated SaaS: Same as the SaaS but the infrastructure is not shared with other customers, and access restrictions (firewall, bastion,...) are defined and audited by the customer.
• On-Premises: The infrastructure is owned and managed by the customer.

In all but the simplest case where the organization has a single Assistant and no users (anonymous access), the Application administration is in charge of the Instance Admin who can delegate some of the tasks to User Admins and Data Admins.

1.1. Tasks in charge of the Administrators

User Admins

• Create and manage users
• Create and manage User Groups
• Manage the membership of users to User Groups

Data Admins

• Create and manage new sources, a source is either a document or a website
• Create and manage collections, a collection is a group of sources
• Manage the relation between collections and sources
• Request the refresh/update of a source (indexation)
• Create and manage assistants
• Manage the relation of assistants and the collections they will use as references and knowledge map
• Manage the relation between assistants and the User Groups with access to them

Instance Admins

• All the tasks that can be completed by either Data Admins or User Admins
• Create and manage Data Admins and User Admins

2. The Administration Interface

2.1. Accessing the interface

The interface is a web application in the admin URL, typically: https://ecochat.pangeanic.com/adm/admin

Logging in

To log in, enter email address and password in the dialog.

2.2. The Instance Main Page

After logging in, all admin profiles will get to the main instance page which gives information about the setup:

The data appearing in the page:

• Use Status: Describes if limits of usage are exceeded, in that case the instance goes on stall mode, limiting speed.
• Prod Status: ON/OFF all the functionalities.
• Counters: The usage counters overall
• Limits: The limiting thresholds
• Assistants: The list of defined assistants

Only the Instance Admin has the possibility to edit / delete the instance root values using top-right icons.

Data Admins and User Admins have read access to all the info but only write/update/delete to the entities they control.

Options menu

Admins have options to display/manage other entities, the left side menu shows the possibilities:

• The Instance option will navigate to the Main Instance Page.
• The Assistants option will navigate to the Assistants page.
• The Prompts will show you the pre-defined prompts (system and task prompts) used by the assistants.
• Users option to manage Users.
• User Groups, to manage User groups.
• Collections and Sources to manage these entities.
• Query Logs to access the log of requests and answers.

3. Managing Assistants

3.1. Main Assistants page

The Main Assistants page shows the list of defined assistants:

For every assistant the listed information:

• Name and description
• Access Type:
  • a PUBLIC assistant has no access requirements, the use is anonymous
  • an INTERNAL assistant can be accessed by ANY authenticated user
  • a RESTRICTED assistant will require the user to be member of a User Group and the User Group to be granted access to the assistant
• Type, gives some info about the Assistant functionality, for instance:
  • Chatbot
  • Q&A
  • Search
  • Content Generation
• Pre-Prompt, the prompt used

3.2. The Assistant page

To know more about an assistant or manage it you access the assistant page clicking on the 'view' button.

The Assistant Page contains:

• The extra info configuring the interface
• The list of collections defining the info/doc repository that will be used
• The list of User Groups that can access the assistant

Top-right we have the actions that can be used to get the Queries log, update and delete.

Update and delete options can only be used by Data Admins or Instance Admins.

3.3. The Update Assistant Page

Apart from changing the different attributes of the Assistant, it is possible to edit the list of User Groups and Collections associated with the Assistant.

All changes are effective after the Save button is pressed.

4. Managing Prompts

Prompts are in fact pre-prompts that will be added to the user prompt.

4.1. The Prompts list page

List all available prompts for the assistants.

Data and Instance Admins can edit the prompts and can add new ones.

4.2. The Prompt page

Shows the System and Task prompt

5. Managing Users

5.1. The Users List Page

The list of the instance users appears:

The Role can be:

• User: The basic type, they can only use the assistants granted: all PUBLIC, all INTERNAL and all RESTRICTED if they belong to the right User Groups.
• User Admin
• Data Admin
• Instance Admin
• Manager*
• Super admin*

(* only for SaaS ECOChats)

The APIKey is an alphanumerical string that is a shared secret that can be used to do API requests.

6. Managing User Groups

6.1. The List of User Groups page

A User Group has a name, a description. Several users belong to it and the group has access to some assistants.

The list has this info:

• Name
• Description
• Number of users
• Number of assistants

The add button, top right allows the creation of a new group (functionality restricted to User and Instance Admins).

It is possible to 'view' a User Group accessing from the list with the 'eye' button.

6.2. User Group page

Contains two lists:

• The user list
• The Assistants list

A click in the assistant number (left of the assistant row) gives access to the assistant details.

Top-right provides access to the update and delete functions.

7. Managing Sources

A source is a document (a file), a website or a single web page.

To create a source the procedure is:

1. Upload the file or define the URL
2. Let the system index the source

Indexing a source can take minutes or hours.

7.1. The Source List page

A list of the sources available for collections:

Types can be:

• WEB: a single web page
• WEB-recursive: a list of pages, scanned from a root URL/page
• File: a document

Index column is the index status. Status: is ENABLE if source can be reindexed and DISABLE if sources can be deleted

7.2. Adding a new Source

Clicking on the add button (top-right of source list page) we have the dialogs to add a new source.

Depending on the source type you choose you get different forms:

• For a File you can select the document from your computer
• For a website you enter the reference (https://......) and decide if you want a single page or the full hierarchy

7.3. The source page

Contains the full information for the source.

8. Managing Collections

A collection is a set of sources. You need to define collections because Assistants only accept them to be the repository they base the answers on.

A collection can be used by more than one assistant.

8.1. The list of collections page

New collections can be created with the add button top-right.

When a collection is created we can add one or more sources.

8.2. The collection page

When accessing the collection page the whole collection is shown.

List of sources and List of Assistants.

The relationship assistant-collection can be of different types:

• Normal: The sources of the collection are used by the assistant to generate the answer, the references will appear in the answer and the documents can be downloaded
• Limited: The sources of the collection are used by the assistant to generate the answer, the references will appear in the answer, but the documents can NOT be downloaded
• Restricted: The sources of the collection are used by the assistant to generate the answer, but references are not shown nor can be downloaded

9. Managing Logs

To see the logs, the list of questions and answers the users have requested, choose from the left menu the Query Logs option.

Top-left there is a selector allowing to restrict the assistant that was used.