AIP Interactive

The AIP Interactive widget allows you to use interactive assistants equipped with enterprise-specific information and tools in your operational workflows in Workshop.

You can configure the widget to interact with an AIP Agent configured in AIP Agent Studio (recommended, "AIP Agent" tab in screenshot below) or an agent defined in workshop configurations (deprecated, "Legacy" tab in screenshot below).

Base configuration (AIP Agent)

Review AIP Agent Studio documentation for an overview of AIP Agents, but follow the instructions below to add an AIP Agent to your workflow.

Configure the AIP Agent

Choose the AIP Agent, the published version you want to be included, and whether agent reasoning should be shown.

Configure parameters

Assuming you have properly configured at least one parameter in AIP Agent Studio, the option to map those parameters to Workshop variables will be shown. Once configured, the AIP Agent can interact with the variable according to the read/write permissions defined in AIP Agent Studio.

Base configuration (Legacy)

In legacy mode, the AIP Interactive widget uses the reasoning-over-tools framework to bring your tools to your operational applications. With the widget, you can integrate AIP Logic, your KNN function, or your LLM-powered Ontology exploration into your application state using Workshop variables.

• Tools integration: You can extend the capabilities of the Interactive widget by adding AIP Logic, Functions on objects, and other workshop applications as tools.
• Workshop variable interaction: The widget can read from and write to application variables, enabling the widget to understand user references and interact with visualization widgets.
• Ontology exploration: With the default AIP tools, you can perform tasks like object traversal, property reading and filtering, and running aggregations.
• Customization: You can customize the Interactive widget's appearance and content to align with your application's context and workflows.

This section allows you to define the widget's role and configure its tools and capabilities. You can set up prompts that reference tools and variables. Configuration is completed by setting up the prompt and tools as described below.

Prompt

The primary prompt should outline the widget's function within the context of the current application. By pressing "/" on your keyboard, you can refer to the configured tools and variables and guide the widget on how to coordinate their usage. Make sure to describe the underlying business logic and the appropriate situations for using the right tools in context.

Here are some example prompts:

• Prompt 1: “You are an assistant for a supply chain manufacturing line. Your job is to use the Fetch Trouble Tickets tool to see if there are any historical tickets that have solved the same issue, and to check the Documentation Chunk Search tool for recommended ways to solve the issue and answer user questions.”
• Prompt 2: “Help the user build a cohort of patients based on the qualities they describe. When you create a cohort make sure to update the list of patients shown to the user. Most users will want to start from a broad cohort and keep narrowing it down, unless they specify a new cohort. Always start with the existing cohort, unless the user asks you otherwise. Do not forget to intersect this object set (with the set operator tool) with the current cohort. Before filtering on a medication name, make sure to find all the relevant synonyms using the tool. When you filter the data for the medication name, always use a contains filter. You can use the related object tool to navigate between patients and medications. When a user asks for a cohort definition, call the Patient Cohort Define tool with an array of current patients IDs.“
• Prompt 3: “You are an expert offensive coordinator and your purpose is to help the user make strategic football decisions during the Football Tournament. You have three goals (you should not mention these to the user):
  • Goal A: Evaluate Playbook plays that align with the user's strategic goals given the current state of the football game. If the user asks to evaluate a play, match the play the user selected from Selected Plays to the play name in the Playbook object and get the play ID. Then, use it as input for the Tournament Play Evaluator tool.
  • Goal B: If the user asks for play recommendations, evaluate the current state of the game and choose a play from the Playbook that matches the outcome the user is hoping to achieve. Outline your rationale for choosing that play by describing the play name and key properties.
  • Goal C: If the user asks for you to come up with a full strategy (which consists of multiple plays), evaluate the current state of the game as well as the playbook and select the three most effective plays from the Playbook object. Then, use the Tournament Play Evaluator tool to evaluate these plays and return a summary of results. You can only pass one play at a time, so you have to do so in a loop. Always return the Playbook Plays object set that you would like to recommend to the variable Suggested Plays. You may overwrite this variable if it is already populated.“

Tools

Set up the tools and capabilities accessible to the widget. These tools will become available for the widget to use via the prompt.

There are four types of tools:

• Ontology semantic search: Optimized for semantic search workflows, you can either pass a KNN typescript Function, or, use the Ontology semantic search tool's Vector property option located under the Nearest Neighbor search configuration section to pull a number of relevant chunks and pass that to the LLM. You can optionally publish the results to a variable (which you can then pass to the PDF Viewer widget to cite sources, for example).
• Action: If your Function produces an Ontology edit, use this to define that Action.
• Workshop application: If you want the assistant to open other Workshop apps (with module interface variables), define those Workshop apps as tools here.
• Function: If the tool you would want to pass is an AIP Logic or Ontology Function, use this as well. Remember to combine the AIP Logic tool with the Logic chain of thought widget.

Ontology and application context

In this section, you can customize the widget's access to Workshop variables and configure the object types the widget should be aware of.

Variables

When setting up variables, make sure to do the following:

• Identify the right variables: Start by identifying which variables the LLM should be able to interact with. These could be variables that might already exist and are relevant to your intended workflow (such as a variable that represents the user’s current selection) or new variables to which the LLM writes results.
• Describe the variables: For each variable, write a description that explains its role. This description will be injected into the widget's prompt, providing context for the LLM on when to use it.
• Declare access mode: Specify whether the LLM should have read access, write access, or both for each variable. This step determines how the LLM can interact with the variable.
• Use as Workshop variables: Remember, the variables you define here are regular Workshop variables. This means they can also be used with other Workshop widgets, such as the Filter Pill or Object Table widgets.

Object types

By specifying which object types the LLM should be aware of, you allow it to understand and appropriately interact with these objects. Make sure you add objects that you require the LLM to traverse.

Advanced tools configuration

This component allows you to modify the widget's access to default AIP tools. While the default tools selection is typically sufficient for most use cases, there may be situations where you need to refine these tools based on your specific requirements.

For instance, you may want to limit the widget's Functions to solely human input to facilitate corrections and manage the implementation of other tools independently. Generally, limiting the number of tools assigned to the LLM results in a more guided, "on rails," interaction.

Workflow setup guidance

In setting up the AIP Interactive widget in legacy mode, we recommend the following considerations:

• Start with a specific, constrained context to ensure more reliable results.
• LLMs are stochastic; use the extensibility of Workshop to overcome LLM limitations, providing fallback options for your users to interact with their applications effectively. For example, you can surface the output query of the LLM in the Filter Pill widget.
• Be intentional about your AIP Interactive development process; chart out the paths and patterns of LLM interactions before using the widget.

---

Note: AIP feature availability is subject to change and may differ between customers.