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).
Review AIP Agent Studio documentation for an overview of AIP Agents, but follow the instructions below to add an AIP Agent to your workflow.
Choose the AIP Agent, the published version you want to be included, and whether agent reasoning should be shown.
Assuming you have properly configured at least one application variable in AIP Agent Studio, the option to map those application variables 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.
AIP Agents offer advantages over the legacy mode, including a configuration user interface in AIP Agent Studio, versioning, metrics, session history, downloading, and more. The legacy mode will not include any new features so we highly suggest migrating to AIP Agents. To make that process as easy as possible, we have added a Migrate option to the legacy mode of the widget. Legacy mode will soon be in sunset stage and all users should migrate as soon as possible.
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.
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.
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:
Playbook
object and get the play ID. Then, use it as input for the Tournament Play Evaluator tool.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.“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:
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).In this section, you can customize the widget's access to Workshop variables and configure the object types the widget should be aware of.
When setting up variables, make sure to do the following:
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.
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.
In setting up the AIP Interactive widget in legacy mode, we recommend the following considerations:
Note: AIP feature availability is subject to change and may differ between customers.