Changes

Template:AI

3,558 bytes removed, 3 May
m
Using +AI with the Variable Processor
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 currently available AI features and the configuration essentials of interfacing with the integration, outline AI through the two modes (automation and interactive), and delineate some sample scenariosVariable 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.* '''[[+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.There are two modes * '''+AI Assistant:''' Execute actions at the record level such as updating statuses, modifying field values, or creating new fields, activities, and associations. Instead of operation when using SmartSimple Cloud 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 To learn more, read our article on a single object such as a grant application or review. In this scenario, the user can interact with the [[Enabling +AI in a call-and-response kind of model. The user might ask the Within Your System|enabling +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.* '''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 within 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=
==Setting up +AI Integration==
If you are interested in adding '''To get started setting up +AI''' functionality to your SmartSimple Cloud instance, reach out to your account manager or contact our Platform Solutions team. They can set up an integration key so that your SmartSimple instance is able to communicate with a third-party LLM vendor, such as OpenAI’s ChatGPT. They will be able sure to enable '''[[Enabling +AI''' by going to '''Global Settings''' > '''Integrations''' tab > Toggle Within Your System|read our page on '''Enable AI'''. ==Interactive Mode==The AI interactive mode is made available through the '''Work with enabling +AI''' feature which can be enabled on nearly every record in within the system, including organization profiles, user profiles, and UTA records. ===Configuring Interactive Mode===To configure the AI on a particular UTA, go to '''UTA Settings''' > '''Level 1/2/3''' tab > '''AI'''. On this page, custom instructions and templates can be set up. On the '''Permissions & Availability''' tab, users can set access to the feature by role, record type, or record status. Once permissions have been set up, navigate to the desired UTA record and select '''Tools''' > '''Work with +AI''' in the top action bar. This will open a modal window into which you can enter your prompts and adjust the '''Temperature''' setting. ===Setting up Templates===To create a template, go to '''UTA Settings''' > '''Level 1/2/3''' tab > '''AI''' > Click the '''New Template''' button. Under the''' General''' tab, the template can be given a '''Name''', '''Caption''', and template content. Access permissions can be set for each template under the '''Permissions & Availability''' tab. When making templates that reference specific record fields, be sure to use the '''Field Name''' rather than the '''Caption'''. For example, to ask the AI to translate the content of a specific field into French, enter: <code>Translate this text into French: “@FieldName@”</code> When deciding which prompts to use in a template, it can be helpful to test the prompts by going to any UTA record and clicking '''Tools''' > '''Configuration Mode''' > '''Variable Syntax Helper'''. Here, you can test your expressions and see if your variables resolve correctly]].
===Best Practices for Prompts=Using +AI with the Variable Processor==Some best practices for [https://helpOnce '''+AI''' integration has been set up, the automation mode can be used in various areas of the system.openaiThe existing SmartSimple variable processor has been modified in order to allow you to interface with the third-party AI vendor.com/en/articles/6654000-best-practices-for-prompt-engineering-To familiarize yourself with-openai-api prompt engineering] have been listed the syntax and possible statements, you can test the syntax using the '''Variable Syntax Helper''' by OpenAI:opening a object record and going to '''Tools''' > '''Configuration Mode''' > '''Variable Syntax Helper'''.
* Put the instructions at the start of the prompt and use double quotation marks ( " " ) to separate the instructions from the context
* Be specific and descriptive about the desired outcome, including details about context, length, format, style, etc
* Provide an example or desired format in the prompt if necessary
==Automation Mode=====Configuring Automation Mode===Once '''+AINote''' integration has been set up: In the @ai() function call, the automation mode can there must 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 AI server. To familiarize yourself with the syntax no spaces between parameters 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'''commas.
===OpenAI===
====Syntax====
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 service:model''' : (Optional) The name of the AI service model being used. If left empty, OpenAI will be used as default.* '''AI function:''' Set by the intended use of the input textservice. If the text service is meant to be static, set OpenAI and the value to "text". If the text model is meant to left unspecified, ChatGPT-4 will be edited used by the AI, set the value to "edit"default.* '''temperature:''' Set : 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:''' Optional parameter when using the edit AI function. <u>'''Note:'''</u> If The natural language prompt for the AI function parameter has been set to "edit", you must pass instructions to the instruction parameter on how the text should be edited in natural language. For example, "fix the grammarspelling: how are yu tday?", or "make this in Translate the style of a poem", or "translate this following into Japanese: hello, world!".
{| class="wikitable"
|-
||Ask AI to write an email for a specific user
||[[File:AI-Syntax-Prompt-Example-1-New.png|none|800px]]|-||Ask AI to write an email for a specific user using model gpt-4-0163||[[File:AI-Syntax-Prompt-Example-New.png|none|800px]]
|-
||Ask AI to fix the spelling of a message
||image[[File:AI-Syntax-Prompt-Example-2-New.png|none|800px]]
|-
||Ask the AI to write a grant application summary
||image[[File:AI-Syntax-Prompt-Example-3-New.png|none|800px]]
|}
=Configuration - Advanced==Azure AI=SubSection====SubSection===Settings Explained===General Tab==The following settings are available on Azure AI can be used with the variable processor, custom field creation, and '''+AI Directive'''General. Some ''' tab:+AI''' features such as '''+AI Assistant''' and '''+AI Insight''' are not supported with Azure AI.
{| class="wikitable"|-!|Setting!|Description|-||'''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'''||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.|-||'''Login Title'''||Text entered here appears above the area where you authenticate. Typically the word "Login" is entered into this field.|-||'''Content Title'''||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".===Syntax====|-||'''Content Text'''||Text entered here appears below the content title. Typically this area is used to describe who you areWhen using Azure AI, what you do and what the system is syntax used for. Example: "XYZ group provides grants to non-profits in within the USA. Register to gain access to the system and apply for funding."|-||'''Logout Redirect URL'''||This variable processor 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==This following settings are available when creating a template[[File:AI-Syntax-Prompt-Example-6-New.png|none|800px]]
{| class="wikitable"|-||'''Section'''||Choose to show or hide the '''Privacy Policies''' for your system on the login page only.|-||'''Section Title'''||This input only appears if you These parameters 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.|}explained as follows:
[[Category* '''Deployment ID''':Interface]](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!".
Smartstaff
2,091
edits