SummaryTile Documentation

Overview

The SummaryTile component in Vantage is designed to generate AI-powered text summaries based on workflow data and a user-defined prompt. This component allows users to easily visualize concise summaries of complex datasets, enhancing the interactivity and analytical capability of dashboards. Additionally, the component includes a caching mechanism that retains summary data across tab switches, improving performance and user experience.

Purpose

• To generate and display AI-generated summaries reflecting workflow data.
• To allow users to input specific summary prompts for tailored outputs.
• To provide a consistent caching mechanism to prevent redundant data fetching.
• To deliver insights that help users understand key aspects of their data more effectively.

Settings

The SummaryTile component accepts several settings, which are described in detail below:

Detailed Explanation of Each Setting

1. title:

   • Type: String
   • Function: Sets the primary header of the tile. Changing this value modifies the visible title, allowing for dynamic user-defined titles.
   • Default: 'AI Summary'.

2. subtitle:

   • Type: String
   • Function: An optional setting that allows additional context to be displayed below the title. Useful for providing brief explanations or category context.
   • Default: undefined.

3. footerText:

   • Type: String
   • Function: A customizable footer area where disclaimers or notes can appear. Adjusting this text can enhance the user's understanding of the summary scope.
   • Default: undefined.

4. footerColor:

   • Type: String
   • Function: Sets the color of the footer text. This can reflect branding color schemes or importance and can influence user engagement.
   • Default: undefined.

5. workflowResults:

   • Type: Object
   • Function: Input for the tile containing data from previously executed workflows. This data serves as a basis for generating more accurate summaries.
   • Default: {}.

6. workflowId:

   • Type: String
   • Function: Identifies a specific workflow from which to pull data. Changing this will allow the component to re-fetch and show fresh summaries based on alternate workflows.
   • Default: undefined.

7. summaryPrompt:

   • Type: String
   • Function: Essential for setting the context of the summary output; modifying this will directly impact the content and focus of the AI's generated summary.
   • Default: undefined.

8. sourceDataSnapshot:

   • Type: Array
   • Function: This input allows the component to utilize a stored dataset taken at the tile's creation effectively. Making this data available can lead to quicker summarization if it contains relevant points.
   • Default: undefined.

How It Works

1. Data Fetching:

   • On initialization, the component attempts to fetch the workflow data using the provided workflowId. If data already exists from prior sessions, it uses that instead.

2. Summary Generation:

   • The AI summary is generated based on the active prompt, using a priority order to determine which dataset to process (sourceSnapshot, effectiveWorkflowData, etc.). The component interacts with a backend API by sending the data along with the user's prompt.

3. Caching:

   • The component caches the generated summaries to optimize the user experience by reducing API calls when the tile is revisited.

4. Error Handling:

   • Depending on the states of loading, errors, or missing prompts, appropriate messages and actions are provided to guide the user.

Use Cases & Examples

Use Case #1: Real-time Business Insights

A business analyst uses the SummaryTile to summarize sales data from various regions for quick decision-making during executive meetings.

Use Case #2: Project Progress Reporting

A project manager configures the SummaryTile to summarize progress reports generated weekly from workflow evaluations, offering stakeholders a concise overview.

Use Case #3: Restaurant Feedback Analysis

A restaurant manager collects customer review data through a workflow and uses the SummaryTile to generate summaries of customer sentiments, identifying key areas for improvement.

Example Configuration for Use Case #1

For the real-time business insights use case, consider the following configuration:

{
    "title": "Sales Overview Q3",
    "subtitle": "AI-Driven Insights",
    "footerText": "Generated by AI",
    "footerColor": "#4A90E2",
    "workflowResults": {
        "12345": [ /* pre-fetched data objects */ ]
    },
    "workflowId": "1234-abcd-5678-efgh",
    "summaryPrompt": "Summarize the sales performance by region for Q3.",
    "sourceDataSnapshot": []
}

In this example, the title is oriented towards the quarterly sales overview. The summaryPrompt guides the AI to provide targeted insights for sales representatives and management to review during the ongoing Q3.

Additional Relevant Details

• AI Integration: The SummaryTile leverages AI model provider APIs to enhance data summaries, creating outputs that may vary based on the selected refinement and context of the input data.
• Billing Impact: Utilizing AI services can incur costs based on the computational resources and API calls made during summary generation, which can impact overall operating expenses associated with this functionality in the Vantage platform.