AI Module Templates

3 min read

Overview

AI Module Templates are designed to define and configure modules that can be subsequently selected within the Space Management feature. By creating AI Module Templates users can define a preset of modules tailored to the needs of their company. This ensures that when setting up a new space, users can efficiently implement these modules with minimal or no adjustments needed to the configuration.

Module selection in the space management section based on AI Module Templates

It is important to note that these templates only serve as a starting point. When a user creates a Space and selects a Module Template, a copy of that Module is generated and linked to the Space. Therefore, changes made to the Module Templates do not affect any modules already in use within existing Spaces.

Feature Access

The system offers an interface tailored for developers, data scientists, and administrators to create, edit, and delete AI Module Templates. To access this interface, users must be assigned the role of admin.space.write in Zitadel. The feature is then accessible via an icon located in the top-level navigation on the left side of the screen.

Security & Compliance

AI Module templates are defined within a company. They can be only edited by users that are assigned to the role admin.space.write and can be viewed by users that have access to the space management section.

Default AI Module Templates

New organizations will automatically have the following default AI Module Templates available for use:

• Chat with GPT (reference in code: ExternalKnowledge)
• Context Memory Search (reference in code: ContextMemorySearch)
• Document Search (reference in code: SearchInVectorDB)
• Document Summarizer (reference in code: DocumentSummarizer)
• Email Writer (reference in code: EmailWriter)
• Investment Research Documents (reference in code: InvestmentResearchDocuments)
• Investment Research Table (reference in code: InvestmentResearchTable)
• Query Table (reference in code: QueryTable)
• Translate (reference in code: TranslatorV2)

Additionally, users have the ability to create custom AI Module Templates by referencing modules they have developed using the provided Software Development Kit (SDK).

Creating an AI Module Template

AI Module Templates can be created by clicking on the button “New AI Module” located in the header.

The following details should be entered:

• AI Module Name: The name of the AI Module Template will appear later on in the AI Assistant dropdown on the space page.

• Reference in code: AI Module Templates execute specific logic that is determined by the reference in code attribute. The reference in code value should either point to a module developed by Unique (a list of values can be checked here) or to a module developed via SDK.

• Custom Module: If the "reference in code" points to a custom module developed using the SDK, ensure the custom module checkbox is checked. If this box remains unchecked, the system assumes a pre-defined module is being used.

• If an AI Module Template is defined as custom, a "Custom" tag will be automatically appended to the module name in the UI for easy identification.

Custom tag UI example

• Configuration: Configuration parameters that will be used by the module need to be specified in JSON format.

• Definition: The definition includes additional parameters and a description of the module, which are essential for selecting the appropriate module during operations. Like the configuration, these details should also be provided in JSON format. For further information, refer to Tools.

• Weight: Defines the order of modules in the module selection prompt. The default value is set to 500, but this can be adjusted to prioritize certain modules over others in the list.

Editing & Deleting an AI Module Template

Once an AI Module Template is created, it will appear in the list of AI Module Templates and become available for editing.

From that point on, AI Module Templates can be edited or deleted as needed. Deleting an AI Module Template will not affect any spaces that are currently using it, as each space creates a copy of the template when using it.