Copilot Links Block
Generate and return a list of links with optional metadata
The Copilot Links block is a special component designed to be used with the Scout Copilot, designed to dynamically generate a list of links with associated metadata using Jinja templating. This block is particularly useful for creating collections of links with headers and controlling the number of displayed links, and sending them back to the client where a user is interacting with the Scout Copilot.
Configuration (Required)
The header text for the list. This is optional and defaults to “Links” if not provided.
A Jinja-compatible string that represents the list of links to be processed. This input is required and should be formatted as a list of dictionaries.
The maximum number of links to display. This is optional and defaults to 5 if not specified.
Outputs
The block returns a structured list of links with optional metadata, limited by the specified maximum number of links.
Usage Context
Use this block to dynamically create and display a list of links with metadata in your workflow. This is particularly useful for generating link collections that can be customized with headers and limited to a specific number of entries.
Best Practices
- Ensure the ‘list_of_links’ input is a valid Jinja template that renders to a list of dictionaries.
- Use the ‘limit’ input to control the number of links displayed, preventing overload of information.
- Utilize the ‘header’ input to provide context to the list of links, making it clear what the collection represents.