Skip to content

Latest commit

 

History

History
250 lines (173 loc) · 8.63 KB

README.md

File metadata and controls

250 lines (173 loc) · 8.63 KB
Raw

AIBySimplicite module definition

Introduction

Exploratory module on the use of AI in Simplicite

Import

To import this module, you have two options:

Option 1: Git Repository

  1. Create a module named AIBySimplicite.
  2. Set the settings as:
{
	"origin": {
		"uri": "https://github.com/simplicitesoftware/module_ai.git"
	},
	"type": "git",
	"branch": "<6 or 6.1>"
}
  1. Click on the Import module button.

Option 2: App Store

  1. Navigate to the App Store in the Project domain.
  2. Go to the Tools tab.
  3. Select "AI integrations" from the list.
  4. Follow the on-screen instructions to import the module.

Configure

To configure the AI connection, utilize the configuring the wizard process in the AI assistant domain in extended mode.

Select the model (LLM) you wish to use, configure the API key, and the URL of your API:

Process steps
Step 1, Select LLM 1. Domain AI
2. Configuration process
3. Select the LLM you will use
Step 2, Set authent 4. Set your API key
5. If you use a dedied api set the endpoint of your API
Step 3, Other parameters See help for details
6. parametres
7. Depends of your LLM
Step 4, Monitoring of setup 8. recap of setup and ping result
9. you can test the chatbot

Follow the process:

After configuring, you will obtain the details of your now active configuration. This summary is available on the homepage of the domain.

Parameters details
hist_depth

Defines the number of messages in the history used for the context. The greater this number, the more tokens the request uses, but the more relevant is the response.

max_token

optional
Limits the number of tokens in the AI response.

default_max_token

Maximum number of tokens in a usual context.

code_max_token

Maximum number of tokens for technical calls.

wizzard

UI

  1. AI domain
  2. LLM and API configuration
  3. AI-assisted module creation or completion process
  4. Data generation process
  5. Chatbot for Business with context
  6. List of LLMs currently configurable.

Module generation

Use AI to co-create or update a module based on your business needs Module generation in AI assistant domain.

Data generation

Use AI to generate test data for a module. Data generation in AI assistant domain.

Business chatbot

A shortcut to a chatbot contextualized according to the form on which it is opened. The user must have AI_BUSINESS rights. The Personal data, Confidential data and Intimate fields are not sent to the AI.

Add ui context to chatbot

The chatbot can be contextualized to the current user's scope, including knowledge of the UI and business rules. To achieve you have to pregenerate the ui and rules description:

  • Open the settings of the scope to which you want to add a context (in the User interface => views => Home page submenu).
  • Go to the tab of the link with Group gui description.
  • Create a new Group gui description by choosing the desired language.
  • You can refine the description by selecting the groups to be considered for this description (by default, the groups of rights in the scope are taken into account).

Group gui parameters

  1. The chatbot open in this scope will have UI context
  2. The lang (to get context in the user language)
  3. Auto generated Description of the ui and the rules
  4. The descritpion will contaigne all visible domaine and object for the listed groupe with GUIDescription has yes

Important: remember to regenerate this description when there are changes to the rights and rules of your objects

Metrics

Generating AI graphs on a module's data In a view add an external page of source External object: AIMetricsChat?module=<you_module_name>

For detailed examples on how to generate modules, interact with business chatbots, and visualize metrics, please refer to the example available at the following link: Explore AI Assistant Prompt Examples

AIProvider business object definition

Fields

Name Type Required Updatable Personal Description
aiPrvProvider char(100) yes* yes -
aiPrvDefaultUrl url(100) yes yes -
aiPrvDataModel text(1000) yes yes -
aiPrvModelsUrl url(100) yes yes -
aiPrvHelp text(5000) yes -
aiPrvCompletionUrl url(100) yes yes -
aiPrvPingUrl url(100) yes -

AIGenData business process definition

Activities

  • EndHome:
  • Begin:
  • End:
  • IsParam:
  • NoParam:
  • SelectModule: Selection module
  • Confirm:
  • GenData: AI call for data gen

AIModuleCreate business process definition

Auomatic model generation process

Activities

  • Begin:
  • End:
  • EndHome:
  • Choice:
  • CreateModule:
  • TranslateDomain:
  • NewScope:
  • GrantUser:
  • isParam:
  • NoParam:
  • SelectModule: Selection module
  • SelectGroup: Selection group
  • SelectDomain: Selection Domain
  • interaction: Chat with the AI
  • Prompt: Direct chat with the AI
  • AI: AI for modeling
  • Generation: Module generation based on ia feedback
  • RemoveModule: Remove module

AiSettingsProcess business process definition

Activities

  • isGlobalParam:
  • Global:
  • SelectProvider:
  • Auth:
  • OtherParam:
  • Begin:
  • End:

AIChatBot external object definition

Chat interface

AIExpTool external object definition

Front tool

AIMetricsChat external object definition

AI contextual chat for personalised metrics. Use parameter "module" to specify context.

AiMonitoring external object definition

AIProcessResource external object definition

Process resource

AIPromptTool external object definition

Tool

AIRestAPI external object definition

Local API

AIShortcut external object definition

Chat in shortcut