Note |
---|
Work in progress |
The Agentic platform The AI Agent Platform allows you to create your own agents, customized to the needs of your teams, with each agent having specific instructions and tools to use.
...
An agent is comprised of the following elements:
General information
A name, used to call the agent in the chat with “@”;A type, such as HR, Customer support, etc.
An avatar (or agent image) that will be displayed next to the agent’s name in the chat;
A brief description of what the agent is used for. This description will be displayed on the agent’s presentation card and may help users choose an agent;
A series of instructions that category that designates the context in which the agent is mostly used.
A series of instructions defining therole of the agent, its tasks, what data it has access to, etc. The purpose of the instructions is to guide the agent in the way they should answer;An AI
Info |
---|
Learn how to write instructions for your agents here. |
A model (also known as a an LLM or Large Language Model), which is used to retrieve relevant information and generate the answer to the user’s query.
Guardrails, which are predefined guidelines or rules ensuring that an agent operates safely and effectively.
Data sources
Data linked to an agent, such as documents, websites, knowledge bases, etc. allowing the agent to provide accurate and relevant insights.
Skills
one or more skills that define what the agent can do;
One or more data sources, including documents and external integrations (such as websites or knowledge bases), that the agent should utilize to deliver accurate and relevant information.
Info |
---|
Learn more about data sources here. |
One or several tools that determine what an agent can do;
Info |
---|
Learn more about tools here. |
Tutorial
Iframe | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Build your first agent
Determine your agent’s purpose
Before creating you create and configuring set up your agent, you need to do some preliminary thinking by determining it's important to consider a few key factors. Start by defining your use case and how the agent will be usedutilized. Below Here are the important some essential questions to help you should think about to properly configure your agent effectively:
What is the main primary purpose of my agent?
What persona should my agent assumeit adopt?
Who will use my be using the agent?
What tasks will it have need to perform?
What data should it leverageaccess?
Create a new agent
To create an agent starting from the home page, navigate to theBuild > Agents menu item, then click the Create an agent button. You can also click the Create an agent button on the top right of the page.
...
You can either create a new agent from scratch or by using a template. In this example, we will create an agent
...
This page will focus on the agent’s creation from scratch by clicking the New agent/Start from scratch button.
– example screenshot to do --
the button in the From scratch section.
Info |
---|
To learn how to create an agent using a template, visit this page: /wiki/spaces/AGENTIC/pages/4033871960. |
...
General information
Begin by providing general information about your agent, such as:
a its name, starting with the @ symbol, e.g. @CustomerSupport.
an avatar that will be displayed next to the agent’s name in the chat.
a type, which will categorize your agent and such as Customer Support for example. The agent’s name must be short and descriptive at the same time.
a dedicated agent image.To edit the image,click the default logo to open a right panel where you can choose a background color and choose an icon among the ones provided.
a category, which will make it easier for users to find agents relevant to their use case. For instance, an agent with the HR type means that it should be is used for HR tasks.a short description of its purpose
Info |
---|
You can find the list of available categories on this page: Pre-built agents. |
the instructions your agents should follow such as role, its tasks, what data it has access to, etc.
Info |
---|
Visit this page to learn how to write constructive instructions, as well as the best practices : TODOfor writing instructions: How to write instructions for your agents. |
the AI model to use for your agent. Choose one amongst among the ones proposed in the list.
...
Info |
---|
Visit this page to see the available models, their characteristics as well as recommendations on choosing the right model for your tasks: TODO. |
the guardrails to apply to your agent. You can choose several amongst the ones proposed.
...
Data sources
Next, you should select the data source(s), such as external integrations or documents your agent should have access to. Make sure that you only add data sources relevant to the agent’s tasks and avoid adding irrelevant data. Remember that quality is better than quantity.
Note that data sources might not be needed depending on your agent’s purpose.
You can either select an existing data source or add a new one if the one you want is not available in the list.
...
You have the option of:
adding an external integration:
Click the External integrations card;
Select the integrations you want to add;
Info |
---|
Note that you can also create a new integration by clicking the Add external integration button next to the search bar via this page. |
...
adding a document:
Click the Documents card;
Click Add Documents, select the documents you want to add, and click Add Documents once more. Note that you can also upload new documents before adding them to the agent by clicking the Upload document button.
Provide a description of the documents explaining why your agent should search the documents.
...
Info |
---|
Visit these pages to learn how to create data sources for your agent to use: /wiki/spaces/AGENTIC/pages/4032004100. |
– example screenshot to do --
Add the skills
Select the skills your agent should be able to access to perform different tasks.
Info |
---|
Visit this page for more information about the available skills: TODO. |
– example screenshot to do --
...
Tools
You can add one or more tools to your agent by clicking the Tools card and selecting the correct tools for your use case.
...
Publish your agent
Finally, it’s tome time to decide who can access your agent. Click the Next button on the bottom right of the page to access the Publish step.
Here, you can define the access and permissions, the agent’s description, and the preset questions.
Access and permissions
You can share choose who can edit your agent with specific people and teams or give everyone access to use or edit and who can chat with them:
Builders: anyone with an Agent builder within your organization can edit or chat with the agent.
PrivateCreator: the agent is will only be available to you.
Company: the agent is available to you and your colleagues company-wide.Shared: the agent is available to specific users designated by you.
...
the creator of this agent for editing or chatting.
Users (only for chatting): anyone in my organization with an account can chat with the agent.
Agent description
You can add a short description to your agent to indicate to users what the agent can do. This description will be displayed in the chat interface and visible to all users.
Preset questions
You can add up to three preset questions, whose purpose is to guide the user on how to query the agent. You can put them in any order by dragging them in the position you want.
...
Finally, click Create on the bottom right to finalize the creation of your agent.
Test your agent
Once you have finished the configuration of your agent, you can test it by accessing the Chat and invoking your agent to discuss with them, or you can click the Chat with agent icon next to your agent in the agent list.
...