Configure Generative AI chat control to search using Generative AI

Configure the following settings to perform search using Generative AI.

Setting

Description

Header label

Enter the header label to be displayed at runtime. (Default: Generative AI Chat)

Search type

To execute the search based on Generative AI, select Generative AI.

Provider

Select the Generative AI provider to use, such as OpenAI or AI Agent. (Default: Tungsten)

The Provider list includes the AI providers configured in Integration > Generative AI. See Integrate Generative AI with TotalAgility.

If a Generative AI provider is not already configured, a warning message appears when you add the Generative AI chat control to a form.

When you select an AI Agent provider, lists for additionally input and output variables appear. You can set a static value or select a dynamic variable (form control, form variable, global variable, and Copilot Insights) for the input and output variables.

Source

Select one of the following options.

Option	Description
None (default)	The response from the AI provider is based on the input provided (plain text or variables).
Image	On the Document list, select a form control (Web capture control), form variable, or global variable of type String, and on the Mime type list, select a file type. The following mime types are supported: GIF, JPEG, and PNG. Mime type is not supported for form variables. When using images, make sure that your selected provider supports the use of images. control When you select an AI Agent or Custom LLM as the provider, at runtime: Document Content variable uses the content of the document as a base64 string. Document variable uses the instance ID of the document.
Text	The OCR text of the document is returned in a more logical reading order, resembling how a narrator would read it aloud. Instead of being presented in the "top-left to the bottom-right" order returned by OCR, the text is arranged more clearly and coherently. If the document contains layout text, such as a semi-structured document (for example, invoice or purchase order) or a fixed form, the document text can provide better results compared to using a Custom LLM provider. On the Document list, select the form control, form variable, or global variable. The response is generated based on the text passed as input. When you select an AI Agent or Custom LLM as the provider, at runtime: Input Prompt variable: Adds content of the image at the end of the input prompt. Document variable: Uses the instance ID of the document. The following file types are supported in the Transformation Designer for text source format in TotalAgility at runtime: TIFF (.tif), JPEG (.jpg), PNG (*.png), and PDF. When you set the source format as Text, the standard model configuration is used.
Inline image	Select the attachment icon  available at runtime to upload an image and ask a question about it. The thumbnail of the uploaded image is displayed. The response is generated based on the image provided at runtime. When you select an agent or Custom LLM as the provider, the Document Content variable uses the document content as a base64 string at runtime.

Persist conversation

If selected, the context persists during conversation. (Default: Clear)

Persisting the conversation increases the token usage that may result in exceeding the token limit. When the prompt exceeds the token limit, the earlier conversation history is automatically removed to manage the token limit.

Use response profile

If selected, enables adding a response profile, so that at runtime, your responses display in a specific word count or style. (Default: Clear)

Response profile

Provide an inline value, such as "Summarize the response in 20 words or less." or select a global variable, form variable, or form control.

Use seed

If selected, lets you dynamically set "Use seed" using a form variable (Boolean) or form control. (Default: Clear)

The seed value increases the likelihood of obtaining more consistent results from the AI provider across repeated requests, though not guaranteed.

Seed

Select a form variable or form control, or select a numeric value. (Default: 0 and Maximum: 32,767)

Include case data

If selected, lets you include case data for analysis when using Generative AI. (Default: Clear)

When you include case data, you are prompted to enhance your experience by providing descriptions for both the process and activities to achieve optimal results.

The "Include case data" option is not available when using a Custom LLM provider.

For Case identifier, select a variable (global variable, form variable, or form control) or provide an inline value for Case ref or Case ID.
A list of case data is displayed. By default, Key Case Details, History (full), Variables, and Notes options are selected. You can select the items from the list as needed.

At runtime, the case details are included in the information available to search and in the response.

Override default message

If selected, enables the Welcome message and Input help text boxes where you can enter a customized welcome message and help text to be displayed in the Chat control at runtime. (Default: Clear)

Option

Description

Welcome message

You can provide a static or dynamic value (form control, form variable, or global variable) or a combination of both.

For example, if you enter "Good day!" as the message, and a form variable called Name that contains the value "John Doe", the default "Hello <username>, how can I help you today?" is replaced with "Good day! John Doe" at runtime.

Input help text

Enter the help text to be displayed in the Chat window at runtime.

Response format

Select either option for response format.

HTML (default): Returns the response with HTML formatting, such as bullet points, headings, and bold text, to present structured content clearly and enhance readability.
None: Returns the response as plain text with no formatting.

On upgrading TotalAgility, the Response format is set to None.
This setting is not available when using Custom LLM or AI Agent providers.

Use MCP servers

If selected, lets you add MCP servers. (Default: Clear)

To add MCP servers, select Add. The Add MCP servers dialog box appears.
From the list of configured MCP servers, select the required servers. See Configure MCP server connection.
Select Done.

Audit conversation

If selected, the auditing of AI interactions is enabled. Prompt-response pairs are captured in the audit log while maintaining user anonymity to comply with data protection standards. (Default: Clear)

When you submit a prompt in a Generative AI chat control on a form using Generative AI as the search type, an entry is recorded in the audit log.

When you view the Generative AI chat control at runtime, the Copilot chat window appears with the following:

- "This conversation is being audited" message.
  
  This message appears if the "Audit conversation" setting is enabled.
- Learn more about the use of AI link. Select the link to know more about Tungsten Automation's commitment to responsible AI and compliance.
- A welcome message, "Hello <username>, how can I help you today?".
  
  You can modify the welcome message and input help text, customize the appearance of the chat window, such as the header color of the Copilot chat window, set an icon for Copilot, and more. See Generative AI chat control style.
When you enter any input, the response is streamed before it is displayed. You can select the Cancel button  to cancel the request. If you add an image or text as part of the input, such as uploading a car registration image and requesting the AI provider to get the registration number, the response is returned accordingly.
If MCP servers are used, you can perform MCP-related functions. For example, you can enter a prompt to upload the AI generated content or a document to SharePoint or Google Drive.
To clear the current conversation (including the context (if "Persist conversation" is selected in Search using Generative AI) and start a new one, select the New chat icon  in the top right corner of the Chat box.