Skip to content
Draft
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 @@ -26,19 +26,19 @@
The process of tool selection, execution, and analysis consumes tokens. To understand how usage is calculated, refer to [Token usage in Elastic Agent Builder](monitor-usage.md).
:::

{{agent-builder}} includes a default agent (named `Elastic AI Agent`) with access to all built-in tools. You can [create custom agents](custom-agents.md) with custom instructions and selected tools to address specific use cases or workflows.
{{agent-builder}} includes a default agent named `Elastic AI Agent`. You can [create custom agents](custom-agents.md) with custom instructions and selected tools to address specific use cases or workflows.

You can also use pre-configured [built-in agents](builtin-agents-reference.md) that are specialized for common use cases.

## Built-in agents

{{agent-builder}} includes pre-configured built-in agents optimized for common use cases:
{{agent-builder}} includes pre-configured built-in agents optimized for common use cases.

- **[Elastic AI Agent](builtin-agents-reference.md#elastic-ai-agent)**: The default general-purpose agent with access to all platform core tools
- **[Elastic AI Agent](builtin-agents-reference.md#elastic-ai-agent)**: The default general-purpose agent
- **[Observability Agent](builtin-agents-reference.md#observability-agent)**: Specialized for logs, metrics, and traces
- **[Threat Hunting Agent](builtin-agents-reference.md#threat-hunting-agent)**: Specialized for security alert analysis

Built-in agents cannot be modified or deleted. To customize one, you can clone it and create a custom agent.

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

View workflow job for this annotation

GitHub Actions / preview / vale

Elastic.Clone: Use `clone` only when referring to cloning a GitHub repository or creating a copy that is linked to the original. Often confused with 'copy' and 'duplicate'.

Built-in agents are space-agnostic and are available in all [{{kib}} spaces](/deploy-manage/manage-spaces.md).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,33 +14,82 @@

# {{agent-builder}} built-in agents reference

This page lists the built-in agents available in {{agent-builder}}. Built-in agents are pre-configured by Elastic with specific instructions and tools to handle common use cases.
Built-in agents are pre-configured by Elastic with specific instructions and tools to handle common use cases.

::::{applies-switch}

::::{applies-item} { stack: ga 9.4+, serverless: ga }

Built-in agents cannot be modified or deleted. To customize one, you can clone it and [create a custom agent](custom-agents.md#create-a-new-agent).

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

View workflow job for this annotation

GitHub Actions / preview / vale

Elastic.Clone: Use `clone` only when referring to cloning a GitHub repository or creating a copy that is linked to the original. Often confused with 'copy' and 'duplicate'.

The **Elastic AI Agent** is not a built-in agent in this version. It is a standard persisted default agent that is space-aware and editable. Refer to [Elastic AI Agent](#elastic-ai-agent) for details.

::::

::::{applies-item} { stack: preview =9.2, ga 9.3 }

:::{tip}
You cannot modify or delete built-in agents. To customize one, you can clone it and [create a custom agent](custom-agents.md#create-a-new-agent).

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

View workflow job for this annotation

GitHub Actions / preview / vale

Elastic.Clone: Use `clone` only when referring to cloning a GitHub repository or creating a copy that is linked to the original. Often confused with 'copy' and 'duplicate'.
:::

::::

::::

## Availability

The availability of specific agents depends on your solution view or serverless project type.

::::{applies-switch}

:::{applies-item} { stack: ga 9.4+, serverless: ga }

Built-in agents are space-agnostic: they are available across all [{{kib}} spaces](/deploy-manage/manage-spaces.md). The default [Elastic AI Agent](#elastic-ai-agent) is an exception: it is created automatically per space and is only available in the space where it was created.

:::

:::{applies-item} { stack: preview =9.2, ga 9.3 }

Built-in agents are space-agnostic: they are available across all [{{kib}} spaces](/deploy-manage/manage-spaces.md).

:::

::::

:::{note}
{{product.observability}} and {{product.security}} users must opt-in to use {{agent-builder}}. To learn more, refer to [](/explore-analyze/ai-features/ai-chat-experiences/ai-agent-or-ai-assistant.md#switch-between-chat-experiences).
:::

## Elastic AI Agent
```{applies_to}
stack: preview =9.2, ga 9.3
stack: preview =9.2, ga 9.3+
serverless: ga
```

::::{applies-switch}

:::{applies-item} { stack: ga 9.4+, serverless: ga }

The **Elastic AI Agent** is the default general-purpose agent for {{es}}. Unlike the other built-in agents, it is a standard persisted agent that is automatically created in each [{{kib}} space](/deploy-manage/manage-spaces.md) when first accessed.

Because the default agent is space-aware, you can customize it independently for each space. You can change its instructions, adjust which tools it has access to, or clone it as a starting point for a new agent.

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

View workflow job for this annotation

GitHub Actions / preview / vale

Elastic.Clone: Use `clone` only when referring to cloning a GitHub repository or creating a copy that is linked to the original. Often confused with 'copy' and 'duplicate'.

**Default assigned tools:**
* All [**Platform core tools**](./tools/builtin-tools-reference.md#platform-core-tools)

:::

:::{applies-item} { stack: preview =9.2, ga 9.3 }

The **Elastic AI Agent** is the default general-purpose agent for {{es}}. It is designed to help with a wide range of tasks, from writing {{esql}} queries to exploring your data indices.

**Assigned tools:**
* All [**Platform core tools**](./tools/builtin-tools-reference.md#platform-core-tools)

:::

::::

## Observability Agent
```{applies_to}
stack: preview 9.3
Expand Down
2 changes: 1 addition & 1 deletion explore-analyze/ai-features/agent-builder/chat.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ This takes you to the chat GUI:

### Start a chat and select an 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.
Use the text input area to chat with an agent in real time. Check the agent selector to see which agent is active. To switch agents, refer to [Select a different agent](#select-a-different-agent).

:::{image} images/agent-builder-chat-input.png
:screenshot:
Expand Down
4 changes: 2 additions & 2 deletions explore-analyze/ai-features/agent-builder/custom-agents.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
Custom agents enable you to create specialized AI assistants tailored to your specific use cases and workflows. Unlike [built-in agents](builtin-agents-reference.md), which are pre-configured by Elastic, custom agents give you full control over instructions, tools, and behavior.

:::{note}
Built-in agents are immutable and cannot be edited. To customize agent behavior, you need to create a custom agent by cloning an agent or creating a new one from scratch.
Built-in agents are immutable and cannot be edited. To customize agent behavior, you need to create a custom agent by cloning an agent or creating a new one from scratch. The **Elastic AI Agent** is an exception {applies_to}`stack: ga 9.4+`: as the default agent for each space, it can be edited directly.
:::

Custom agents are space-aware: they are only available in the [{{kib}} space](/deploy-manage/manage-spaces.md) where they were created. In contrast, built-in agents are available across all spaces.
Expand Down Expand Up @@ -107,7 +107,7 @@
:::

:::{note}
These management options apply only to custom agents. Built-in agents like the **Elastic AI Agent** can only be chatted with or cloned, not edited or deleted.
These management options apply only to custom agents and the Elastic AI Agent {applies_to}`stack: ga 9.4+`. Other built-in agents can only be chatted with or cloned, not edited or deleted.

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

View workflow job for this annotation

GitHub Actions / preview / vale

Elastic.Clone: Use `cloned` only when referring to cloning a GitHub repository or creating a copy that is linked to the original. Often confused with 'copy' and 'duplicate'.
:::

## Best practices for custom agents
Expand Down
2 changes: 1 addition & 1 deletion explore-analyze/ai-features/agent-builder/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ If you're not ready to add your own data, you can:

::::{step} Start a conversation

The **Agent Chat** UI provides a conversational interface where you can interact with agents and explore your data using natural language. {{agent-builder}} includes a default agent named `Elastic AI Agent` with access to all built-in tools, so you can begin chatting immediately.
The **Agent Chat** UI provides a conversational interface where you can interact with agents and explore your data using natural language. A default agent is available to chat with immediately.

Learn more in [Agent Chat](chat.md).

Expand Down
2 changes: 1 addition & 1 deletion explore-analyze/ai-features/agent-builder/permissions.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ Learn more about [API keys](/deploy-manage/api-keys/elasticsearch-api-keys.md).

### Working with spaces

{{agent-builder}} respects {{kib}} spaces when enabled. Conversations, custom agents, and custom tools are scoped to the current space. Built-in agents are space-agnostic and are available in all spaces.
{{agent-builder}} respects {{kib}} spaces when enabled. Conversations, custom agents, and custom tools are scoped to the current space. Built-in agents are space-agnostic and are available in all spaces. The default Elastic AI Agent is an exception {applies_to}`stack: ga 9.4+`: it is a standard persisted agent that is space-aware and automatically created per space.

When configuring roles or API keys, specify the space in the application privileges resources (for example, `"resources": ["space:production"]`). Users and API keys cannot access resources in other spaces.

Expand Down
Loading