Difference between revisions of "Template:AI"

From SmartWiki
Jump to: navigation, search
m (→‎Configuration - Essentials)
m (→‎Using +AI with the Variable Processor)
(95 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
The SmartSimple Cloud '''+AI''' integration gives you the ability to utilize large language models (LLM) from within our business process automation platform. LLMs may be utilized to improve productivity, processes, and outcomes. This article will walk-through how-to setup the integration, outline the two modes (automation and interactive), and delineate some sample scenarios.
+
The SmartSimple Cloud '''+AI''' integration gives you the ability to utilize large language models (LLM) from within our business process automation platform. LLMs may be utilized to improve productivity, processes, and outcomes. This article will walk-through currently available AI features and the configuration essentials of interfacing with the AI through the Variable Processor.
  
 +
=Overview=
 +
There are a number of AI features that can be implemented within SmartSimple including:
  
−
=Overview=
+
* '''[[+AI Directive]]:''' A multi-faceted feature that be used in conjunction with natural language, scripts and the variable processor to perform many time saving tasks such as analyzing text and automatically populating custom fields, summarizing and translating text, populating custom fields with internet-extracted data, converting text into other formats, comparing application requests with program objectives and providing a score, and much more.
−
There are two modes of operation when using SmartSimple Cloud '''+AI''':
+
* '''[[+AI Insights]]:''' Create your own custom AI model for data analysis and reporting across multiple records within a UTA. Trained '''+AI Insight''' models can quickly provide answers that involve aggregation, summarization, and prediction without the need to spend time constructing list view filters and reports. Alternatively create a custom model at the organization level, available in your system header. '''+AI Insight''' models at the Organization level contain uploaded training data.
 +
* '''+AI Assistant:''' Execute actions at the record level such as updating statuses, modifying field values, or creating new fields, activities, and associations. Instead of finding a field and changing a value, use the hands-free voice interface to update the desired field.
 +
* '''+AI Workflow''': Streamline your workflow process by creating workflow tasks from natural language instructions with AI assistance, eliminating the need for manual task creation and connection.
 +
* '''[[+AI Vision]]:''' Upload an image and have the AI answer specific questions regarding the image contents without having to open and examine the image yourself.
 +
* '''[[Work with +AI]]:''' Interact with the AI at the record level in a conversational manner. Users have the option to use pre-made templates and prompt libraries to expedite common processes.
 +
* '''[[+AI Transcription]]:''' Generate text transcriptions of audio and visual media.
  
−
* '''Interactive Mode:''' This mode of operation occurs on a single object such as a grant application or review. In this scenario, the user can interact with the AI in a call-and-response kind of model. The user might ask the AI to help them rewrite content, translate content into another language, or make content more concise. The user can ask questions (prompts) and follow up with more related questions. The user can also be presented with optional predefined templates to streamline common tasks or actions.
+
To learn more, read our article on [[Enabling +AI Within Your System|enabling +AI within your system]].
−
* '''Automation Mode:''' This mode of operation can occur in various areas of the platform. In this scenario, the system is configured to automatically interact with your chosen 3rd party LLM vendor to do something without manual intervention. For example, the system can be configured to automatically generate an executive summary of an application or a summary of the reviewers’ comments. Applications could be prescreened and recommended or the AI could suggest reviewers with subject matter expertise related to the application.
 
  
 
=Configuration - Essentials=
 
=Configuration - Essentials=
 
==Setting up +AI Integration==
 
==Setting up +AI Integration==
−
==Interactive Mode==
+
To get started setting up +AI integration, be sure to [[Enabling +AI Within Your System|read our page on enabling +AI within the system]].
−
===Configuring Interactive Mode===
 
−
===Setting up Templates===
 
−
===Best Practices for Prompts===
 
  
−
==Automation Mode==
+
==Using +AI with the Variable Processor==
−
===Configuring Automation Mode===
+
Once '''+AI''' integration has been set up, the automation mode can be used in various areas of the system. The existing SmartSimple variable processor has been modified in order to allow you to interface with the third-party AI vendor. To familiarize yourself with the syntax and possible statements, you can test the syntax using the '''Variable Syntax Helper''' by opening a object record and going to '''Tools''' > '''Configuration Mode''' > '''Variable Syntax Helper'''.
−
===Syntax===
 
  
−
=Configuration - Advanced=
+
 
−
==SubSection==
+
'''Note''': In the @ai() function call, there must be no spaces between parameters and commas.
−
==SubSection==
+
 
−
=Settings Explained=
+
===OpenAI===
−
==General Tab==
+
====Syntax====
−
The following settings are available on the '''General''' tab:
+
The syntax used for prompts in web page views and workflows is:
 +
 
 +
[[File:AI-Syntax-Format-New.png|none|800px]]
 +
 
 +
These parameters are explained as follows:
 +
 
 +
* '''AI model''': (Optional) The name of the AI model being used by the service. If the service is OpenAI and the model is left unspecified, ChatGPT-4 will be used by default.
 +
* '''temperature''': Sets the desired level of randomness of the generated text, where a value of "0" is the most conservative while a value of "9" is the most random.
 +
* '''instruction''': The natural language prompt for the AI. For example, "fix the spelling: how are yu tday?" or "Translate the following into Japanese: hello, world!".
  
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
−
!|Setting
+
!|Example Scenario
−
!|Description
+
!|Syntax
−
|-
 
−
||'''Language'''
 
−
||Each login page must have a single language which you can select from the dropdown.
 
−
|-
 
−
||'''Is Default Login Page'''
 
−
||By default, when a user goes to your system's URL without the Language ID, they will be directed to the '''English US''' language login page. If you want users to go to a different language login page by default, toggle this setting on for the login page with your desired language. Note: only one login page can be set as the default.
 
−
|-
 
−
||'''Page Layout'''
 
−
||Leave this setting on '''Default''' unless you specifically need to customize the HTML to your login page as it will ensure you will always have the latest and greatest looking login page. If you choose '''Custom''' you will get a '''Template''' tab where you can modify the underlying HTML of the login page. Note if you opt to go custom, you may need to manually update your login pages to take advantage of improvements or changes in functionality.
 
 
|-
 
|-
−
||'''Page Title'''
+
||Ask AI to write an email for a specific user
−
||This is the title your browser displays on it’s title bar or page tab. This text is used to populate the title tag in the HTML of the login page. Typically your organization's name is entered into this field.
+
||[[File:AI-Syntax-Prompt-Example-1-New.png|none|800px]]
 
|-
 
|-
−
||'''Login Title'''
+
||Ask AI to write an email for a specific user using model gpt-4-0163
−
||Text entered here appears above the area where you authenticate. Typically the word "Login" is entered into this field.
+
||[[File:AI-Syntax-Prompt-Example-New.png|none|800px]]
 
|-
 
|-
−
||'''Content Title'''
+
||Ask AI to fix the spelling of a message
−
||Text entered here appears above the custom message on the right area of the screen. Typically this is replaced with something like "Welcome to XYZ".
+
||[[File:AI-Syntax-Prompt-Example-2-New.png|none|800px]]
 
|-
 
|-
−
||'''Content Text'''
+
||Ask the AI to write a grant application summary
−
||Text entered here appears below the content title. Typically this area is used to describe who you are, what you do and what the system is used for. Example: "XYZ group provides grants to non-profits in the USA. Register to gain access to the system and apply for funding."
+
||[[File:AI-Syntax-Prompt-Example-3-New.png|none|800px]]
−
|-
 
−
||'''Logout Redirect URL'''
 
−
||This is the page the user gets redirected to once they logout. Enter a URL such as ''https://www.smartsimple.com/'' or leave it blank to have the user redirected back to your system’s login page by default.
 
 
|}
 
|}
  
−
==Template Settings==
+
===Azure AI===
−
This following settings are available when creating a template:
+
Azure AI can be used with the variable processor, custom field creation, and '''+AI Directive'''. Some '''+AI''' features such as '''+AI Assistant''' and '''+AI Insight''' are not supported with Azure AI.
  
−
{| class="wikitable"
+
====Syntax====
−
|-
+
When using Azure AI, the syntax used within the variable processor is:
−
||'''Section'''
+
 
−
||Choose to show or hide the '''Privacy Policies''' for your system on the login page only.
+
[[File:AI-Syntax-Prompt-Example-6-New.png|none|800px]]
−
|-
+
 
−
||'''Section Title'''
+
These parameters are explained as follows:
−
||This input only appears if you are using the '''Default''' page layout with privacy policies on. Typically people enter "Learn more about our".
 
−
|-
 
−
||'''Button Label'''
 
−
||This input only appears if you are using the '''Default''' page layout with '''Privacy Policies''' on. Enter the name you want to give the button that will open your systems policies that you define. Typically people enter "Privacy and Security Policies" for the button text.
 
−
|}
 
  
−
[[Category:Interface]]
+
* '''Deployment ID''': (Optional) The deployment ID of the Azure model being used. If the deployment ID is left unspecified, the model configured within the '''Integration Key Management''' settings will be used by default.
 +
* '''temperature''': Sets the desired level of randomness of the generated text, where a value of "0" is the most conservative while a value of "9" is the most random.
 +
* '''instruction''': The natural language prompt for the AI. For example, "fix the spelling: how are yu tday?" or "Translate the following into Japanese: hello, world!".

Revision as of 14:57, 3 May 2024

The SmartSimple Cloud +AI integration gives you the ability to utilize large language models (LLM) from within our business process automation platform. LLMs may be utilized to improve productivity, processes, and outcomes. This article will walk-through currently available AI features and the configuration essentials of interfacing with the AI through the Variable Processor.

Overview

There are a number of AI features that can be implemented within SmartSimple including:

  • +AI Directive: A multi-faceted feature that be used in conjunction with natural language, scripts and the variable processor to perform many time saving tasks such as analyzing text and automatically populating custom fields, summarizing and translating text, populating custom fields with internet-extracted data, converting text into other formats, comparing application requests with program objectives and providing a score, and much more.
  • +AI Insights: Create your own custom AI model for data analysis and reporting across multiple records within a UTA. Trained +AI Insight models can quickly provide answers that involve aggregation, summarization, and prediction without the need to spend time constructing list view filters and reports. Alternatively create a custom model at the organization level, available in your system header. +AI Insight models at the Organization level contain uploaded training data.
  • +AI Assistant: Execute actions at the record level such as updating statuses, modifying field values, or creating new fields, activities, and associations. Instead of finding a field and changing a value, use the hands-free voice interface to update the desired field.
  • +AI Workflow: Streamline your workflow process by creating workflow tasks from natural language instructions with AI assistance, eliminating the need for manual task creation and connection.
  • +AI Vision: Upload an image and have the AI answer specific questions regarding the image contents without having to open and examine the image yourself.
  • Work with +AI: Interact with the AI at the record level in a conversational manner. Users have the option to use pre-made templates and prompt libraries to expedite common processes.
  • +AI Transcription: Generate text transcriptions of audio and visual media.

To learn more, read our article on enabling +AI within your system.

Configuration - Essentials

Setting up +AI Integration

To get started setting up +AI integration, be sure to read our page on enabling +AI within the system.

Using +AI with the Variable Processor

Once +AI integration has been set up, the automation mode can be used in various areas of the system. The existing SmartSimple variable processor has been modified in order to allow you to interface with the third-party AI vendor. To familiarize yourself with the syntax and possible statements, you can test the syntax using the Variable Syntax Helper by opening a object record and going to Tools > Configuration Mode > Variable Syntax Helper.


Note: In the @ai() function call, there must be no spaces between parameters and commas.

OpenAI

Syntax

The syntax used for prompts in web page views and workflows is:

AI-Syntax-Format-New.png

These parameters are explained as follows:

  • AI model: (Optional) The name of the AI model being used by the service. If the service is OpenAI and the model is left unspecified, ChatGPT-4 will be used by default.
  • temperature: Sets the desired level of randomness of the generated text, where a value of "0" is the most conservative while a value of "9" is the most random.
  • instruction: The natural language prompt for the AI. For example, "fix the spelling: how are yu tday?" or "Translate the following into Japanese: hello, world!".
Example Scenario Syntax
Ask AI to write an email for a specific user
AI-Syntax-Prompt-Example-1-New.png
Ask AI to write an email for a specific user using model gpt-4-0163
AI-Syntax-Prompt-Example-New.png
Ask AI to fix the spelling of a message
AI-Syntax-Prompt-Example-2-New.png
Ask the AI to write a grant application summary
AI-Syntax-Prompt-Example-3-New.png

Azure AI

Azure AI can be used with the variable processor, custom field creation, and +AI Directive. Some +AI features such as +AI Assistant and +AI Insight are not supported with Azure AI.

Syntax

When using Azure AI, the syntax used within the variable processor is:

AI-Syntax-Prompt-Example-6-New.png

These parameters are explained as follows:

  • Deployment ID: (Optional) The deployment ID of the Azure model being used. If the deployment ID is left unspecified, the model configured within the Integration Key Management settings will be used by default.
  • temperature: Sets the desired level of randomness of the generated text, where a value of "0" is the most conservative while a value of "9" is the most random.
  • instruction: The natural language prompt for the AI. For example, "fix the spelling: how are yu tday?" or "Translate the following into Japanese: hello, world!".
Retrieved from ‘https://wiki.smartsimple.com/index.php?title=Template:AI&oldid=42553’