|
2 | 2 | navigation_title: "Agents" |
3 | 3 | applies_to: |
4 | 4 | stack: preview 9.2 |
5 | | - deployment: |
6 | | - self: unavailable |
7 | 5 | serverless: |
8 | 6 | elasticsearch: preview |
9 | 7 | --- |
10 | 8 |
|
11 | | -# Agents |
| 9 | +# {{agent-builder}}: Agents |
12 | 10 |
|
13 | | -Agents are AI assistants that engage in natural language conversations with users and interact with your {{es}} data through tools. Each agent manages the conversation flow, interprets user requests, and provides responses based on its configured tools, instructions, and behavior settings. |
| 11 | +Agents engage in natural language conversations with users and interact with your {{es}} data through tools. |
| 12 | +Fundamentally, an agent is defined by its custom instructions and the set of tools it's assigned. |
| 13 | + |
| 14 | +Each agent manages the conversation flow, interprets user requests, and provides responses based on its configured tools, instructions, and behavior settings. |
14 | 15 |
|
15 | 16 | ## How agents work |
16 | 17 |
|
17 | 18 | When you ask a question to an agent, it analyzes your request, selects the most appropriate tool, and determines the right arguments to use. After receiving results, the agent evaluates the information and decides whether to use additional tools or formulate a response. This iterative process of tool selection, execution, and analysis continues until the agent can provide a complete answer. |
18 | 19 |
|
19 | | -{{agent-builder}} includes a default agent with access to all system tools. You can create specialized agents with custom instructions and selected tools to address specific use cases or workflows. |
| 20 | +{{agent-builder}} includes a default agent (named `Elastic AI Agent`) with access to all built-in tools. You can create specialized agents with custom instructions and selected tools to address specific use cases or workflows. |
| 21 | + |
| 22 | +## Manage your agents |
| 23 | + |
| 24 | +The **Agents** page provides a centralized view of all your agents. From this page you can: |
| 25 | + |
| 26 | +- View all your agents with their names and labels |
| 27 | +- Search for specific agents using the search bar |
| 28 | +- Filter agents by labels using the **Labels** dropdown |
| 29 | +- Create new agents using the **+ New agent** button |
| 30 | +- Start chatting with an agent or perform other actions |
| 31 | + - **Elastic AI Agent**: you can **chat** or **clone** the default agent using the chat or clone buttons. |
| 32 | + :::{image} images/chat-and-clone-buttons.png |
| 33 | + :alt: Chat with agent and clone agent buttons |
| 34 | + :width: 120px |
| 35 | + ::: |
| 36 | + - **Custom agents**: You can **chat**, **edit**, **clone**, or **delete** an agent from the management overview. |
| 37 | + :::{image} images/chat-edit-clone-delete.png |
| 38 | + :alt: Agent context menu showing Chat, Edit, Clone, and Delete options |
| 39 | + :width: 130px |
| 40 | + ::: |
| 41 | + |
| 42 | +## How to create a new agent |
| 43 | + |
| 44 | +Follow these steps to create a new agent: |
| 45 | + |
| 46 | +:::::{stepper} |
| 47 | +::::{step} Navigate to the Agents page |
| 48 | + |
| 49 | +Navigate to the **Agents** page to access the agent management interface. |
| 50 | + |
| 51 | +:::: |
| 52 | + |
| 53 | +::::{step} Create a new agent |
| 54 | + |
| 55 | +Click the **New agent** button to start creating a new agent. |
| 56 | + |
| 57 | +:::{image} images/new-agent-button.png |
| 58 | +:alt: Click the New agent button to create a new agent |
| 59 | +:width: 150px |
| 60 | +::: |
| 61 | + |
| 62 | + |
| 63 | +:::: |
| 64 | + |
| 65 | +::::{step} Configure essential settings |
| 66 | + |
| 67 | +Configure the essential agent settings in the **settings** tab: |
| 68 | + |
| 69 | +1. Enter an **Agent ID**, a unique identifier for reference in code. |
| 70 | +1. Add **Custom instructions**.<br><br>Custom instructions are appended to the system prompt that enables core agent features like visualization and citations. The custom instructions define the agent's personality and determine how it will interact with users and perform tasks. |
| 71 | + :::{note} |
| 72 | + Your custom instructions are added to the system prompt to define the agent's behavior. The system prompt enables core features like visualization and citations. |
| 73 | + ::: |
| 74 | + |
| 75 | +1. Set the **Display name** that users will see. |
| 76 | +1. Add a **Display description** to explain the agent's purpose |
| 77 | + |
| 78 | +:::: |
| 79 | + |
| 80 | +::::{step} Assign tools |
| 81 | + |
| 82 | +Switch to the **Tools** tab to assign [tools](tools.md) to your agent. |
| 83 | + |
| 84 | +Select the combination of built-in and custom tools available to the agent, based on your use case. |
| 85 | + |
| 86 | +:::: |
| 87 | + |
| 88 | +::::{step} Customize appearance (optional) |
| 89 | + |
| 90 | +Optionally customize the agent's appearance and organization: |
| 91 | + |
| 92 | +- Add **Labels** to organize your agents |
| 93 | +- Choose an **Avatar color** and **Avatar symbol** to help visually distinguish the agent |
| 94 | + |
| 95 | +:::: |
| 96 | + |
| 97 | +::::{step} Save your changes |
20 | 98 |
|
21 | | -## Create a new agent |
| 99 | +Click **Save** to create your agent, or **Save and chat** to create the agent and immediately start a conversation with it. |
22 | 100 |
|
23 | | -To create a new agent: |
| 101 | +:::{image} images/save-and-chat-buttons.png |
| 102 | +:alt: Save and Save and chat buttons |
| 103 | +:width: 270px |
| 104 | +::: |
24 | 105 |
|
25 | | -1. Navigate to the Agents subpage under **Chat** |
26 | | -2. Click the **New agent** button in the top right corner |
27 | | -3. Configure the agent settings: |
28 | | - - Enter an **Agent ID** - unique identifier for reference in code |
29 | | - - Add **Custom instructions** (optional) to guide the agent's behavior |
30 | | - - Add **Labels** (optional) to organize your agents |
31 | | - - Set the **Display name** that users will see |
32 | | - - Add a **Display description** to explain the agent's purpose |
33 | | - - Choose an **Avatar color** and **Avatar symbol** (both optional) |
34 | | -4. Switch to the **Tools** tab to assign [tools](tools.md) to the agent |
35 | | -5. Click the **Save** button to create your agent |
| 106 | +:::: |
| 107 | +::::: |
0 commit comments