Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,14 @@
- Start chatting with an agent or perform other actions:
- **Elastic AI Agent**: you can **chat** or **clone** the default agent using the chat or clone buttons. The default agent cannot be edited directly.
:::{image} images/chat-and-clone-buttons.png
:screenshot:
:alt: Chat with agent and clone agent buttons
:width: 120px
:::
- **Custom agents**: You can **chat**, **edit**, **clone**, or **delete** an agent from the management overview.
:::{image} images/chat-edit-clone-delete.png
:screenshot:
:alt: Agent context menu showing Chat, Edit, Clone, and Delete options

Check notice on line 49 in explore-analyze/ai-features/agent-builder/agent-builder-agents.md

View workflow job for this annotation

GitHub Actions / preview / vale

Elastic.WordChoice: Consider using 'copy' instead of 'Clone', unless the term is in the UI.
:width: 130px
:::

Expand All @@ -64,6 +66,7 @@
Select the **New agent** button to being creating a new agent.

:::{image} images/new-agent-button.png
:screenshot:
:alt: Select the New agent button to create a new agent
:width: 150px
:::
Expand Down Expand Up @@ -108,6 +111,7 @@
Select **Save** to create your agent, or **Save and chat** to create the agent and immediately begin a conversation with it.

:::{image} images/save-and-chat-buttons.png
:screenshot:
:alt: Save and Save and chat buttons
:width: 270px
:::
Expand Down
86 changes: 74 additions & 12 deletions explore-analyze/ai-features/agent-builder/chat.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,13 @@ applies_to:

The chat GUI and programmatic interfaces enable real-time communication where you can ask questions, request data analysis, and receive immediate responses from your configured agents.

<!--
:::{note}
TODO: Uncomment once page is live.
The chat UI is available in both standalone and flyout modes. For more information, refer to [Chat UI modes](standalone-and-flyout-modes.md).
:::
-->

## Get started

:::{tip}
Expand All @@ -26,42 +33,97 @@ You can also search for **Agent Builder** in the [global search bar](/explore-an
This takes you to the chat GUI:

:::{image} images/agent-builder-chat-UI-get-started.png
:::
:screenshot:
:alt: The main Agent Chat GUI showing the chat window, message input box, and agent selection panel
:::

## Agent Chat GUI

### Chat and select agent

Use the text input area to chat with an agent in real time. By default, you chat with the built-in Elastic AI Agent.

:::{note}
Conversations with agents consume tokens. To understand how usage is calculated, refer to [Token usage in Elastic Agent Builder](monitor-usage.md).
:::

:::{image} images/agent-builder-chat-input.png
:screenshot:
:alt: Text input area for chatting with agents
:width: 850px
:width: 650px
:::

#### Agent selector
:::{note}
Conversations with agents consume tokens. To understand how usage is calculated, refer to [Token usage in Elastic Agent Builder](monitor-usage.md).
:::

#### Select a different agent
```{applies_to}
stack: ga 9.3+
```

Use the agent selector to switch agents, to navigate to the agent management section, or to create a new agent.
Use the agent selector to switch agents, to navigate to the agent management section, or to create a new agent. An agent's behavior is defined by its custom instructions and available tools. Switch agents when you need different capabilities for your tasks.

:::{image} images/agent-builder-agent-selector.png
:screenshot:
:alt: Agent selector dropdown and message input field
:width: 850px
:width: 650px
:::

#### Select a different model
```{applies_to}
stack: ga 9.3+
```

Use the model selector to switch the underlying [model](models.md) the agent uses to generate responses. Switch models to prioritize faster responses, lower costs, or more complex reasoning, depending on your use case.

:::{image} images/model-selector.png
:alt: Image description
:width: 650px
:screenshot:
:::

### Access key actions
```{applies_to}
stack: ga 9.3+
```

This menu is your hub for key management actions. You can quickly access important pages from here.

:::{image} images/more-actions.png
:screenshot:
:alt: More actions menu button
:width: 150px
:::

This opens a panel with links to key actions and management pages including agent, tool, and settings management.

:::{image} images/more-actions-menu-options.png
:screenshot:
:alt: The expanded more options menu panel
:width: 250px
:::

### Find conversation history

Use the left sidebar to access previous conversations.
Use the chat history panel to access previous conversations.

:::{image} images/agent-builder-chat-history.png
:screenshot:
:alt: Chat history panel showing conversation list
:width: 250px
:width: 450px
:::

### Inspect tool calls and reasoning

Expand the **Reasoning** section to see how the agent handles your request. This provides a detailed breakdown of the agent's reasoning steps, the tool calls it makes, and the responses it receives. The agent runs tools in a loop until it achieves its goal or [exceeds the maximum conversation length](limitations-known-issues.md#conversation-length-exceeded).

:::{image} images/reasoning-steps.png
:screenshot:
:alt: Reasoning panel showing tool calls and execution steps
:width: 650px
:::

Select **Inspect response** to view detailed information about individual tool calls and responses.

Select **View JSON** to view the full raw response data. For more information, refer to [Monitor token usage](monitor-usage.md).

## Agent Chat API

The Agent Chat API provides programmatic access to chat functionality through REST endpoints.
Expand All @@ -72,7 +134,7 @@ For a quick overview of the REST API for conversations, refer to [Chat and conve

### API reference

For the complete API reference, refer to the [Kibana API reference](https://www.elastic.co/docs/api/doc/kibana/operation/operation-get-agent-builder-conversations).
For the complete API reference, refer to the [{{kib}} API reference](https://www.elastic.co/docs/api/doc/kibana/operation/operation-get-agent-builder-conversations).



Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions explore-analyze/ai-features/agent-builder/tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,7 @@
2. Click **New tool**.

:::{image} images/new-tool-button.png
:screenshot:
:alt: New tool button for creating custom tools
:width: 150px
:::
Expand All @@ -119,6 +120,7 @@
- Select **Save and test** to create the tool and immediately open the testing interface

:::{image} images/tool-save-save-and-test-buttons.png
:screenshot:
:alt: Save and Save and test buttons for tool creation
:width:250px
:::
Expand All @@ -133,6 +135,7 @@
2. Click the test icon (play button) associated with your tool.

:::{image} images/test-icon.png
:screenshot:
:alt: Test icon (play button) for running tool tests
:width: 150px
:::
Expand Down Expand Up @@ -164,6 +167,7 @@
Find the list of available tools on the **Tools** landing page in the UI, or use [Tools API](kibana-api.md#tools).

:::{image} images/tools-overview.png
:screenshot:
:alt: Tools landing page showing the list of available tools with their descriptions and actions
:width:800px
:::
Expand Down Expand Up @@ -208,7 +212,8 @@
The **Tools** UI provides a **Copy your MCP server URL** button for easy access.

:::{image} images/copy-mcp-server-url-button.png
:screenshot:
:alt: Copy MCP server URL button for easy configuration of external clients

Check notice on line 216 in explore-analyze/ai-features/agent-builder/tools.md

View workflow job for this annotation

GitHub Actions / preview / vale

Elastic.WordChoice: Consider using 'efficient' instead of 'easy', unless the term is in the UI.
:width: 250px
:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,8 @@ FROM books

You can ask the LLM to infer the parameters for the query or add them manually.

:::{image} ../images/create-esql-tool-query.png
:::{image} ../images/create-esql-tool-query.png
:screenshot:
:alt: Creating an ES|QL tool with a parameterized query
:::

Expand Down
Loading