Difference between revisions of "Template:AI"

From SmartWiki
Jump to: navigation, search
m (Interactive Mode)
(Using +AI with the Variable Processor)
(22 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 insight models can quickly provide answers that involve aggregation, summarization, and prediction without the need to spend time constructing list view filters and reports.
 +
* '''+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 using a call-and-response 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.
+
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 with or 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=
Line 13: Line 18:
 
To get started setting up +AI integration, be sure to [[Enabling +AI Within Your System|read our page on enabling +AI within the system]].
 
To get started setting up +AI integration, be sure to [[Enabling +AI Within Your System|read our page on enabling +AI within the system]].
  
==Interactive Mode==
+
==Using +AI with the Variable Processor==
The AI interactive mode (also known as Work with +AI) can be enabled on organization profiles, user profiles, and UTA records. To learn more about this feature, read our page on [[Work with +AI|Work with +AI]]. To learn about a similar feature for internal users, read our page on our [[+AI Insights|+AI Insights]] feature.
+
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'''.
  
==Automation Mode==
 
===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'''.
 
  
 +
'''Note''': In the @ai() there must be no spaces between parameters and commas.
 +
 +
===OpenAI===
 
====Syntax====
 
====Syntax====
 
The syntax used for prompts in web page views and workflows is:
 
The syntax used for prompts in web page views and workflows is:
  
[[File:AI Syntax Format.png|none|800px]]
+
[[File:AI-Syntax-Format-New.png|none|800px]]
  
 
These parameters are explained as follows:
 
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-3.5 will be used by default.
+
* '''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.
 
* '''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!".
 
* '''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!".
Line 37: Line 42:
 
|-
 
|-
 
||Ask AI to write an email for a specific user
 
||Ask AI to write an email for a specific user
||[[File:AI-Syntax-Prompt-Example-1.png|none|800px]]
+
||[[File:AI-Syntax-Prompt-Example-1-New.png|none|800px]]
 
|-
 
|-
||Ask AI to write an email for a specific user using model gpt-3.5-turbo-instruct
+
||Ask AI to write an email for a specific user using model gpt-4-0163
||[[File:AI-Syntax-Prompt-Example-1.5.png|none|800px]]
+
||[[File:AI-Syntax-Prompt-Example-New.png|none|800px]]
 
|-
 
|-
 
||Ask AI to fix the spelling of a message
 
||Ask AI to fix the spelling of a message
||[[File:AI-Syntax-Prompt-Example-2.png|none|800px]]
+
||[[File:AI-Syntax-Prompt-Example-2-New.png|none|800px]]
 
|-
 
|-
 
||Ask the AI to write a grant application summary
 
||Ask the AI to write a grant application summary
||[[File:AI-Syntax-Prompt-Example-3.png|none|800px]]
+
||[[File:AI-Syntax-Prompt-Example-3-New.png|none|800px]]
 
|}
 
|}
  
=Frequently Asked Questions=
+
===Azure AI===
======Which AI vendor does SmartSimple use?======
+
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.
SmartSimple is flexible enough to integrate with different third-party AI vendors. Currently, our integration supports OpenAI's text-davinci-003 model by default.
 
  
======Can we use a different vendor other than OpenAI?======
+
====Syntax====
If you would like to integrate with a different vendor, reach out to our Platform Solutions team or your account manager for more details.
+
When using Azure AI, the syntax used within the variable processor is:
  
======Can we use our own finetuned model or a different model with OpenAI?======
+
[[File:AI-Syntax-Prompt-Example-6-New.png|none|800px]]
Yes. You can use your preferred custom model within the AI's automation mode by modifying the opening syntax. For example, if you wanted to use use your own custom model with OpenAI, you can specify it in the syntax like so:
 
[[File:AI-Syntax-Prompt-Example-5.png|none|800px]]
 
  
======Who is responsible for the data that is used with the AI feature?======
+
These parameters are explained as follows:
As with any third-party service accessible through SmartSimple, it is up to the data controller (client) to understand the implications of using any data processor.
 
  
=Settings Explained=
+
* '''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.
These settings are found within the interactive mode of '''+AI'''.
+
* '''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!".
==General Tab==
 
The following settings are available on the '''General''' tab:
 
 
 
{| class="wikitable"
 
|-
 
!|Setting
 
!|Description
 
|-
 
||'''Instruction Caption'''
 
||The title given to the instruction box that appears above the AI chat window.
 
|-
 
||'''Instruction Content'''
 
||Any instructions to be displayed. Clicking the "Sample Instructions" link will populate this field with default instruction text.
 
|}
 
 
 
==Template Settings==
 
This following settings are available when creating a template:
 
 
 
{| class="wikitable"
 
|-
 
!|Setting
 
!|Description
 
|-
 
||'''Display Order'''
 
||The order in which the template appears in the '''Template''' dropdown with smaller numbers corresponding to being listed closer to the top.
 
|-
 
||'''Name'''
 
||The name of the template. It is not displayed to the end user.
 
|-
 
||'''Caption'''
 
||The name of the template as it appears in the '''Template''' dropdown.
 
|-
 
||'''Template'''
 
||The content of the template or what you want to ask the AI to do. For example, "Summarize the project goals in 50 words or less".
 
|}
 
 
 
[[Category:Interface]]
 

Revision as of 04:18, 25 April 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 insight models can quickly provide answers that involve aggregation, summarization, and prediction without the need to spend time constructing list view filters and reports.
  • +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() 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!".