Skip to main content

Agents

A guide to configuring custom NimbleBrain Agents

A
Written by Adam Piispanen
Updated over 7 months ago

The NimbleBrain Agent Tool enables users to create customizable agents that interact with Datasets to perform complex tasks or provide actionable insights. This section explains how to configure and improve your agents to maximize their effectiveness.


Navigating to Agents

  1. Locate Agents in the top-left navigation bar on the homepage and click on it.

  2. You will be redirected to the Agents page, where all previously created agents are listed.


Creating a New Agent

To create a new agent, follow these steps:

1. Start the Agent Creation Process

There are two ways to create a new agent:

  1. Click on the Create New Agent button in the top-left box on the page.

  2. Utilize preconfigured Templates found at the top of the Agents page next to My Own agents at the top of the page.

  1. Create New Agent from Templates

    If selecting to create an agent from a pre-configured template, select from the provided templates that best match your desired application.

    If no preconfigured agent aligns with your application, select the link below to create your own agent or simply press the + Create New Agent to create your own agent from scratch.

    Once your desired agent template has been selected, you will be redirected to the Create New Agent window with the template instructions pre-added.

    Follow the instructions for the + Create Process from this point on.

Create a New Agent from Scratch

Once the + Create New Agent button has been pressed, you will be prompted with the Create New Agent page. There are only four steps to create a new from scratch.

Follow these next steps and you will be interfacing with your agent in no time!

  1. Enter your desired agent name.

  2. Enter your agent description.

  3. Select your Agent Creativity Score.

  4. Connect your agent with folders that your agent will need to reference.

When completed, select Create Agent and start chatting with your agent!

1. Name Your Agent

  1. Enter a descriptive name for your agent (e.g., "Restaurant Menu Guide").

  2. Click Next to proceed.

2. Describe Your Agent

Configuring your agent description is one of the most important steps in ensuring your agent works accordingly. To ensure your agent description is configured in the best extent possible, reference the following procedure.

The Agent Description serves as the foundation for your Agent's functionality, guiding its operations and ensuring optimal performance.

To craft an effective description, clearly define the Agent's role, specify actionable tasks, and include relevant context about its knowledge base and target audience. Providing examples of expected outputs, defining constraints, and outlining the desired output format help ensure clarity and consistency. Emphasizing ethical and professional standards safeguards privacy and ensures compliance. Avoid vagueness, overcomplexity, and multiple types of responses to maximize the Agent's effectiveness.

Example Description:

"You are a conversational AI assistant designed to help diners explore our restaurant’s menu, make personalized meal recommendations, and assist with any questions. You have detailed knowledge of our menu, including dietary options such as vegetarian, vegan, and gluten-free dishes. Focus on answering customer inquiries clearly and concisely, providing suggestions based on preferences, and offering alternative options if items are unavailable. Ensure responses are polite, professional, and align with the restaurant’s brand tone.

For example:

  1. When asked, 'What vegan appetizers are available?' provide a complete list of all vegan-friendly starters.

  2. For a query like 'Suggest a wine pairing for the ribeye steak,' recommend wines based on our pairing guide.

Output format: Responses should be conversational and formatted in complete sentences. If relevant, include additional information such as preparation time or popular pairings. Respect customer preferences and dietary restrictions at all times."

3. Select Agent Creativity

Your agent creativity score directs your agent on how accurate vs creative it is to be with its responses.

Select the anticipated creativity of your agent on the slider below the agent persona and capabilities box. This slider will adjust the way your agent will respond. The score varies from 0 - being the most accurate agent and 10 - being the most creative agent. Scores in between these ranges will result in agents with a mixture of creativity and accuracy depending upon the respective score.

If the agent is to provide exact details from its source data, like a menu guide, you would want the more accurate score of 0. Whereas if you were looking for an agent that interprets information and provides unique context, you would most likely want a creative agent with a score of around 7-10.

ℹ️ Your agents can be edited after being created. If your agent does not respond as ideally desired, update your agent descriptions, creativity, or even sources at a later time!

4. Connect your Folders

Connecting your data to your agent is critical to ensure your agent knows what to reference when queried by your customers.

  1. Select the Connected Folders button at the bottom left of the Create New Agent page to configure your agent knowledge by providing your data sources to your newly configured agent!

  2. You can select one or more data folders as needed for your agent's application. The selected folders will be highlighted with a checkmark next to their name.

  3. Once all desired folders are selected, click Confirm Selection to finalize the setup.

⚠️ Select only the Folders that are relevant to the Agent's intended use. Adding additional Folders can reduce Agent accuracy and cause incorrect answers.


5. Deploy Your Agent

Once your Folders are connected, simply click Create Agent at the bottom right corner of the Create Agent page and begin conversing with your newly created agent!

🎆 Your agent is now ready to interact with your data! 🎆

However, for optimal performance, you should test and refine your agent further for best results.


To ensure your Agent is optimized for the best results, follow the Optimizing Agent Descriptions for Best Results guide below.


Checklist for Optimizing Descriptions

Use this checklist to review and refine your agent description:

Role: Is the agent’s role clearly defined?
Task: Are specific tasks outlined?
Context: Does the description include relevant background information?
Examples: Are examples provided to illustrate the desired output?
Constraints: Are there clear filters or conditions for the task?
Format: Is the output format explicitly described?
Ethics: Are ethical and professional standards emphasized?


Testing Your Agent for Optimal Performance

To ensure the Agent is functioning as intended and delivering desired and accurate results, it is necessary to test the Agent before it is utilized by customers and colleagues.

A full testing guide for Agents can be found below:

Basic steps for testing to ensure the Agent works as desired is:

  1. Test Basic Interactions

  2. Test Edge Cases

  3. Check Output Format

  4. Validate Output Data Accuracy

  5. Simulate Real-World Use Cases

  6. Collaborate for Feedback


Use your Agent

Now that your Agent is configured and tested, your Agent is ready to go!

Simply select the Chat tab at the top of the side bar and type your message in the prompt area on the page. Start by incorporating the @ symbol, then the agent name for the first question so the proper agent responds. After the agent name is added, ask your question and then click Send Message.

For example, a sample first question would be:

"@Restaurant Menu Guide What are tonight's daily specials?

You should then see your Agent's custom response to your inquiry.


API Documentation

To be added shortly...


Tools

To be added shortly...


Advanced Settings

To be added shortly...


Sharing your Agent

To share your agent, simply select the Share button in the top right corner of the Agent window.

You will be prompted with a dropdown that provides you with a public link that can be used by anyone who has access to the link.

Simply click select the "Anyone with the link can view" toggle and share the link to whomever you would like to interact with the Agent. The recipient of the link will only be able to chat with the agent and will not be able to configure or modify the Agent in anyway.


Troubleshooting

  • Agent Not Responding Properly: Revisit the agent by selecting the Agents tab and double clicking on the agent to open the edit agent window. Ensure the correct data sources and folders are linked and descriptions are accurate. Follow the Optimizing Agent Description for Best Results guide and the Testing your Agent for Optimal Performance guide to improve Agent responses.

  • Agent does not have Responses to Inquiries: Ensure that the proper data folder is configured and the sources of the data are accurate.

  • Keep Testing Agent: Continuously testing the agent is the best method to ensure the Agent is working as desired.

  • General Issues: Contact NimbleBrain Support for further assistance.


Support Contact Information

If you encounter any difficulties while configuring or improving your agents, please reach out to us through our various support networks.

Did this answer your question?