Configuration of a Generative AI chat control

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 of additionally added 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.

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

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.

1. For Case identifier, select a variable (global variable, form variable, or form control) or provide an inline value for Case ref or Case ID.

2. 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.

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)

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.

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

1. To add MCP servers, click Add. The Add MCP servers dialog box appears.

2. From the list of configured MCP servers, select the required servers. See Configure MCP server connection.

3. Click Done.

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

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

To execute the search based on the AI knowledge base, select AI Knowledge Base.

Select the configured AI knowledge base provider. (Default: Tungsten) See Integrate with AI knowledge base.

The list of indexes from the selected AI knowledge base integration appears.

Select an index from the list indexes that are associated with the selected AI knowledge base provider.

If selected, allows you to override the maximum number of documents configured when configuring the AI knowledge base integration. (Default: Clear)

See Integrate TotalAgility with AI Knowledge Base.

Specify the maximum number of documents to override. (Default: 5)

The filter fields in the AI knowledge base determines relevant sources, formulates queries to retrieve information, and ranks the retrieved information based on relevance and reliability to ensure a well-informed response.

You can add one or more filter fields to create advanced search filters for more flexible and precise results.

1. Click , expand the Name box and select a filterable field.

   In addition to the following system index fields: Job ID,Case ID, and Case Ref, the index fields that are configured as filterable in the AI knowledge base integration appear in the Name box. For example, if you select a Job ID, the knowledge base search is performed based on documents associated with that job ID.

2. On the Operator list, select the field operator to use. Available operators are: Equals, Not equals, Greater than, Greater than or equal, Less than, Less than or equal, All excluding, and Any.

   "All excluding" and "Any" field operators are only available if the index field type is set to "String collection" while adding indexes in the AI knowledge base integration.

3. On the Value list, select a global variable, form variable or a form control, or click  and provide an inline value,

4. Click Add.

   The filter field is added. Add more fields an needed.

   To edit a filter field, select the field and click  and modify the required fields. To delete a field, select the field and click .

   The data object fields are not supported in an AI knowledge base search filter.

Filter operator

Select the Filter operator to use. Available options are: And or Or.

Content fields

You can define the fields that are used during search and passed to the LLM. This gives you greater control over the data included in search and retrieval operations. The chunk text field is always included automatically as search input.

• Click , expand the Name box and select a filterable field.

  In addition to the following system index fields: Job ID,Case ID, and Case Ref, the index fields that are configured as retrievable in the AI knowledge base integration appear in the Name box.

  In the AI knowledge base integration, you must configure the retrievable field as searchable for it to appear in the Name box.

• Click Add.

  The retrievable filter field is added. Add more fields an needed. You can edit or delete the fields.

Override query type

If selected, allows you to select a different query type and overrides the query type set at the integration-level.

By default, the Query type list populates the query type set in the selected AI knowledge base integration.

Select a different query type to override. The following query types are available: Simple, Semantic, Vector, Vector simple hybrid, and Vector semantic hybrid.

At runtime, the query type defined at the control level takes precedence over the query type set at the integration level.

Define vectorized fields that are used during the knowledge base search.

To add vectorized fields:

• In the Name box, click the down arrow  to expand the list, and select an index field. The fields that are configured as vectorized, searchable, and retrievable only appear in the Name box.

• Click Add.

  The field appears under Vectorized fields. You can edit or delete the fields.

  If you import a form from an earlier version of TotalAgility or upgrade TotalAgility , the retrievable fields and vector fields lists are empty by default. You can configure the fields as needed.

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

If selected, lets you include case data for analysis when using the AI knowledge base. (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.

1. For Case identifier, select a variable (global variable, form variable, or form control) or provide an inline value for Case ref or Case ID.

2. 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 also included in the response.

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 window at runtime. (Default: Clear)

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.

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

1. To add MCP servers, click Add. The Add MCP servers dialog box appears.

2. From the list of configured MCP servers, select the required servers. See Configure MCP server connection.

3. Click Done.

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

Save the event.