AIP Analyst Workshop widget

AIP Analyst can be embedded as a Workshop widget to provide AI-powered analysis capabilities directly in Workshop modules. The widget supports extensive configuration options to control data access, tool availability, and user interface customization.

Widget configuration

The AIP Analyst widget can be configured to customize the analysis experience for your users. Configuration is organized into several sections that control how the widget behaves and what capabilities are available.

Base configuration

The base configuration controls the fundamental behavior of the AIP Analyst widget:

• Custom system prompt: Provide specific instructions that guide the agent's behavior for this particular widget instance. Use this to set analytical focus, define response style, or establish domain-specific guidelines. This can be a static value or connected to a Workshop variable for dynamic prompts.
• Default model: Override the application default with a specific AI model for this widget. This ensures consistent behavior across all users of your Workshop module.
• Suggested prompts: Define a set of pre-populated prompts that appear when the chat is empty. These help guide users toward common questions or analytical workflows relevant to your use case.

Input configuration

Input configuration allows you to pre-load context and trigger analyses automatically:

• Preloaded resources: Add Foundry resources including object sets, notepad documents, object types, functions, action types, Workshop modules, datasets, and media items. Preloading context gives users immediate access to relevant data without manual searching.
• User message: Connect a Workshop variable to automatically start an analysis. When the variable changes, AIP Analyst begins processing the new query without user intervention. This enables dynamic, event-driven analyses within your Workshop application.

Output configuration

Output configuration enables you to extract analysis results into Workshop variables for use in other parts of your application:

• Last object set: Capture the most recent object set produced during analysis.
• Last user message: Extract the user's most recent question.
• All user messages: Retrieve the complete list of user questions from the session.
• Last analyst message: Capture AIP Analyst's final response.
• All analyst messages: Extract all responses generated by the agent.
• All vega chart specs: Extract all Vega visualization specifications as strings, enabling you to render charts elsewhere in your Workshop module.
• All messages: Retrieve all messages from the session, with an option to include input context items.
• Active tab agent running: A boolean indicating whether the agent is currently running in the active tab. Use this to show loading states or disable inputs while analysis is in progress.

These outputs can drive visualizations, filters, or downstream logic in your Workshop module.

Interaction configuration

You can configure actions that trigger in response to analysis events:

• On user message sent: Execute a Foundry action each time a user sends a message. The action receives the user's message text and the chat session identifier as inputs. You can optionally display a toast notification when the action runs.
• On agent stopped: Execute a Foundry action when the agent completes its response. The action receives the chat session identifier as input. This is useful for triggering downstream workflows, such as saving analysis results or notifying other systems.

Tool configuration

Tool configuration allows you to control AIP Analyst's capabilities and scope:

• Default enabled tools: Select which tools are enabled by default when the widget loads. This lets you disable tools that are not relevant to your use case.
• Ontology restriction: Limit the widget to a specific ontology. When set, AIP Analyst can only discover and analyze data from this ontology, preventing access to unrelated data.
• Object type groups: Further restrict searches to specific object type groups within the ontology. This improves performance and focuses the agent on relevant portions of large ontologies.
• Compass projects: Restrict searches to resources within specific Compass projects or folders.
• Object type statuses: Filter which object types are discoverable based on their status: Endorsed, Active, Experimental, Deprecated, or Example.
• Object type visibilities: Filter which object types are discoverable based on their visibility: Prominent, Normal, or Hidden.
• Enable memories: When enabled on the ontology, allow the agent to search and recall memories from previous interactions.
• Enable memory creation: Allow the agent to create new memories during analysis sessions.
• Semantic search threshold: Set the minimum confidence threshold for semantic search results (from 0.0 to 1.0). Higher values return fewer but more relevant results.

View configuration

View configuration controls which interface elements are visible to users, allowing you to create streamlined experiences tailored to your use case. Available options include:

• Hide tabs: Remove the chat tab headers for a single-session experience.
• Hide PDF export: Remove the PDF export button from the interface.
• Hide outline: Remove the analysis outline sidebar.
• Hide input area: Remove the chat input field, useful for display-only configurations where analysis is triggered by Workshop variables.
• Hide configure tools: Remove the tool configuration button.
• Hide record audio: Remove the audio recording button from the input area.
• Hide add context: Remove the manual context addition button.
• Hide model selector: Remove the AI model selector.
• Hide token estimator: Remove the token usage estimator.
• Hide validation mode: Remove the validation mode toggle.
• Default tools collapsed: Collapse tool results by default, showing only the tool name rather than full results.
• Input placeholder: Set custom placeholder text for the chat input field.
• Empty state configuration: Customize the appearance of the empty chat state with a custom title, description, and icon or image.

Session persistence

By default, the AIP Analyst widget preserves the chat session when you navigate away from the widget and return. This means your conversation history, context items, and tool results are maintained across page navigation within the same Workshop module. The session is tied to the widget instance, so returning to the same page restores the full analysis state.

If you want the chat to reset each time a user navigates away, enable the Clear chat on unmount option in the view configuration. When enabled, the session is discarded when the widget is removed from the page and a fresh session begins on return.

Best practices

When configuring the AIP Analyst widget for your Workshop module, consider the following approaches:

• Preload context for faster results: Adding relevant object types, datasets, or object sets in the input configuration eliminates initial search time and guides users toward the right data.
• Use custom system prompts for specialized analysis: Tailor the agent's behavior by providing domain-specific instructions or analytical frameworks in the system prompt.
• Connect variables for automated workflows: Link Workshop variables to the user message input to create dynamic, event-driven analyses that respond to user interactions elsewhere in your module.
• Extract outputs to drive downstream logic: Use output variables to incorporate AIP Analyst results into other visualizations, filters, or analytical components.
• Limit scope for focused analysis: Apply ontology, object type group, and Compass project restrictions when building purpose-specific applications to improve performance and prevent access to irrelevant data.
• Streamline the interface: Hide advanced features and controls when building guided experiences for non-technical users.
• Use interaction hooks for integration: Configure the On user message sent and On agent stopped actions to trigger downstream workflows, such as logging analysis activity or saving results.
• Provide suggested prompts: Define suggested prompts to guide users toward common questions and reduce the barrier to starting an analysis.