Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.asapp.com/llms.txt

Use this file to discover all available pages before exploring further.

The Previewer is a testing and simulation tool that allows you to try out different configurations of your GenerativeAgent’s behavior. The Previewer makes it easy to rapidly iterate on GenerativeAgent’s design and provides a quick tool to test GenerativeAgent’s capabilities.

​
Using Previewer

To use the Previewer, select one of two channels to start a conversation with GenerativeAgent:
  1. Voice: This allows you to speak directly to GenerativeAgent using your microphone. This is a great way to simulate a real conversation and test out how GenerativeAgent responds to natural language input.
  2. Chat: This allows you to type messages to GenerativeAgent. This is useful for testing specific inputs or for situations where speaking may not be ideal.

​
Previewer Modes

The Previewer has two modes that allow you to test different aspects of your GenerativeAgent’s behavior: Both modes allow you to have a conversation with GenerativeAgent and include features like the Turn Inspector, which gives you insight into the thoughts and actions of GenerativeAgent at each turn of the conversation. Simple Mode This mode provides a streamlined interface for testing basic conversations with GenerativeAgent. It is ideal for quickly iterating on your task and function configurations without needing to worry about the underlying details of the conversation.
Debug Mode This mode provides a more detailed interface that allows you to observe GenerativeAgent behavior during a conversation. Debug Mode is ideal for troubleshooting and refining your GenerativeAgent’s behavior.
To enable Debug Mode, simply toggle the “Debug mode” switch in the Previewer interface.

​
Previewer Environment

Choose the Environment that GenerativeAgent uses to test and preview a conversation with GenerativeAgent. Choose between:
  • Draft
  • Sandbox
  • Production

​
Previewer Branch

When you have multiple branches in your GenerativeAgent project, you can select which branch to use for testing in the Previewer. This allows you to test different versions of your GenerativeAgent’s behavior and compare the results. By default, the Previewer will use the main branch, but you can easily switch to any other branch in your project to test different configurations. A branch can exist in any environment, so you can test the same branch across different environments to compare how GenerativeAgent behaves in each one. To create a new branch:
  1. Navigate to the Branches section in the CXP.
  2. Click on “Create Branch”.
  3. Define the name of your branch, select the environment it belongs to, and choose the source branch from which it will be created.
  4. Click “Create Branch” to finalize the creation of your new branch.
Once your branch is created, you can switch to it in the Previewer to test your changes.

​
Test Scenario Type

When directly talking to GenerativeAgent, you can choose what kind of data GenerativeAgent will use for its function calls by selecting the “Scenario type”: Custom Test Scenario This uses the data from a previously created Test Scenario where you have already defined a simulated mock data that a function would return. This allows you to try out different Tasks and iterate on tasks definitions or on Functions without concern of hitting actual APIs. Most preview testing uses test scenarios as it is faster to design iterations. The External Endpoint is helpful for final QA testing and pre-launch validation. External Endpoint This will use the actual API Connections, allowing you to test GenerativeAgent using real APIs and data. When using the External Endpoint, you can provide:
  • User ID: This is an id of the user for the conversation. This is needed as ASAPP’s APIs require it and many APIs rely on it.
  • Task Name: The specific task for GenerativeAgent to enter.
  • Input Variables: This is the input variables data that GenerativeAgent will use to perform the Task.
    Input variables can be submitted as key-value pairs in JSON format.

​
Observing GenerativeAgent’s Behavior

When the debug mode is enabled in the Previewer, you can use the Turn Inspector to observe how GenerativeAgent processes instructions and makes decisions during a conversation. Previewer gives you insight into the actions that GenerativeAgent is taking with the Turn inspector. This includes its thoughts during the conversation, the Knowledge Base articles it references, and the API calls it makes. Use the Turn Inspector to examine how instructions are processed within GenerativeAgent. Turn Inspector includes detailed visibility into:
  • Active Task Configuration
  • Current reference variables
  • Precise instruction parsing
  • Function call context and parameters
  • Execution state at each conversational turn

​
Using Live Preview

The Live Preview feature allows you to test changes in real-time during a conversation. You have the ability to:
  • Regenerate a response: For a given bot response, regenerate it using the latest state of the draft settings.
  • Send a different message: For a given customer message, change what is sent to see how GenerativeAgent would respond with that conversation context.

​
Replaying Conversations

During testing and configuration, you may want to replay conversations while trying out changes or validating GenerativeAgent across new versions. In Previewer, you can save the conversation to replay it again in the future.

​
Next Steps

You may find one of the following sections helpful in advancing your integration:

Test Scenarios

Learn how to create Test Scenarios to simulate different conversation paths and test your GenerativeAgent’s behavior with different inputs and contexts.

Integrate GenerativeAgent

Learn how to integrate GenerativeAgent into your application and connect it to your data sources and APIs.