Difference between revisions of "Template:AI"

From SmartWiki
Jump to: navigation, search
(Syntax)
m (Using +AI with the Variable Processor)
Line 19: Line 19:
 
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'''.
 
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'''.
  
 +
===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:
Line 41: Line 42:
  
 
'''<u>Note:</u>''' Specifying a model is only available for OpenAi. If using Azure see last example where you specify a "Deployment ID".
 
'''<u>Note:</u>''' Specifying a model is only available for OpenAi. If using Azure see last example where you specify a "Deployment ID".
 +
 
||[[File:AI-Syntax-Prompt-Example.png|none|800px]]
 
||[[File:AI-Syntax-Prompt-Example.png|none|800px]]
 
|-
 
|-
Line 48: Line 50:
 
||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.png|none|800px]]
|-
+
|}
||Ask Azure AI (different AI vendor) a question
+
 
 +
===Azure AI===
 +
Azure AI can be used with the variable processor. 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:
 +
 
 +
[[File:AI-Syntax-Prompt-Example-6.png|none|800px]]
  
'''<u>Note:</u>'''  Some '''+AI''' features such as '''+AI Assistant''' and '''+AI Insight''' are not supported with Azure AI. "Deployment ID" is an optional parameter that refers to a specific Azure AI model. If left unspecified, the model configured within the '''Integration Key Management''' settings will be used.
+
These parameters are explained as follows:
  
||[[File:AI-Syntax-Prompt-Example-6.png|none|800px]]
+
* '''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 12:11, 22 February 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:

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.

OpenAI

Syntax

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

AI Syntax Format.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.png
Ask AI to write an email for a specific user using model gpt-4-0163

Note: Specifying a model is only available for OpenAi. If using Azure see last example where you specify a "Deployment ID".

AI-Syntax-Prompt-Example.png
Ask AI to fix the spelling of a message
AI-Syntax-Prompt-Example-2.png
Ask the AI to write a grant application summary
AI-Syntax-Prompt-Example-3.png

Azure AI

Azure AI can be used with the variable processor. 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.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!".