An interface object is the configuration or the screen for agent that will be shown in the Workspace. Once this object is created, underlying agent will be appeared in the Workspace with defined interface. Currently, Interface definition supports only a Form-type.
- Open TD Console.
- Navigate to AI Agent Foundry.
- Select a Project.
- Select Interfaces and then select Create interface.
- Populate a form
| Field | Description |
|---|---|
| Interface Name | The name of this interface, which will be shown in the Workspace |
| Agent name | Underlying Agent name |
Prompt template | The input text that will be given to the agent when the user clicks a Generate button in the Workspace. The text should refer to the populated data in the form. The variable name given to the form item can be referred to using Accordion Fields: When using an Accordion layout element, fields inside the accordion must be referenced using nested notation: For example, if an accordion has Field ID |
- Click a Next Button and move to the Form definition
- Place necessary form items in the form designer and populate the necessary configuration in the Properties panel on the right side
- Click the Apply button to apply a change
- Click the Create button to complete
Click the Toolkit button on the top left side to open the list of form items.
Form item has its own configuration. Not all configurations need to be set up, except for the Field ID , which is a variable name for this form item and must be referred to by the Prompt template. Also the form item has configuration both for English and Japanese. Japanese configuration is used when the Japanese language is selected on the TD Console.
Belew is the example configuration of Basic text.
| Field | Description |
|---|---|
| Field ID | Variable name referenced in the prompt template. |
| Text Type | Choose Basic text or Text area. |
| Label | Title shown above the input. |
| Description | Additional helper text describing the field. |
| Placeholder | Placeholder text displayed inside the input. |
| Hint | Tooltip text shown when hovering the ? icon. |
| Disabled | Displays the field as disabled. |
| Read only | Shows the value without allowing edits. |
| Required | Marks the field as required. |
| Default value | Initial value populated in the input. |
Accordion is a layout element that allows you to group multiple form items together in a collapsible section. This is useful for organizing related fields and improving form readability.
When referencing fields inside an accordion in the prompt template, you must use nested notation: {{accordion_id.field_id}}.
For example:
- Accordion Field ID:
customer_details - Field inside accordion:
customer_name - Reference in prompt template:
{{customer_details.customer_name}}
Below is the example prompt template and form definition for an agent that generates an AIDA marketing funnel. The agent is assumed to generate text output based on the information of Company Name, Industry, Product, and Marketing Detail.
To render the generated content in the form based interface, agent must have output function with output type: Artifact. About Artifact, please refer to Add Outputs
Create AIDA story from the following information
- Comapny Name: {{company_name}}
- Industry: {{industry_info}}
- Product: {{product_info}}
- Marketing Detail: {{marketing_detail}}
| Form item (label) | Form ID |
|---|---|
| Company Name | company_name |
| Industry | industry_info |
| Product | product_info |
| Marketing Detail | marketing_detail |