docs: Follow up tweaks to AI docs (#30060)
Follow up to https://github.com/zed-industries/zed/pull/29747 Release Notes: - N/A
This commit is contained in:
parent
264097e253
commit
f7511c3f65
4 changed files with 55 additions and 54 deletions
|
@ -39,7 +39,7 @@
|
|||
|
||||
# AI
|
||||
|
||||
- [Overview](./ai/ai.md)
|
||||
- [Overview](./ai/overview.md)
|
||||
- [Agent Panel](./ai/agent-panel.md)
|
||||
- [Tools](./ai/tools.md)
|
||||
- [Model Temperature](./ai/temperature.md)
|
||||
|
|
|
@ -7,7 +7,7 @@ To open the Agent Panel, use the `agent: new thread` action in [the Command Pale
|
|||
|
||||
If you're using the Agent Panel for the first time, you'll need to [configure at least one LLM provider](./configuration.md#providers).
|
||||
|
||||
## Overview
|
||||
## Overview {#overview}
|
||||
|
||||
After you've configured some LLM providers, you're ready to start working with the Agent Panel.
|
||||
|
||||
|
@ -17,18 +17,18 @@ If you need extra room to type, you can expand the message editor with {#kb agen
|
|||
You should start to see the responses stream in with indications of which [tools](/ai/tools.md) the AI is using to fulfill your prompt.
|
||||
For example, if the AI chooses to perform an edit, you will see a card with the diff.
|
||||
|
||||
### Editing Messages
|
||||
### Editing Messages {#editing-messages}
|
||||
|
||||
Any message that you send to the AI is editable.
|
||||
You can click on the card that contains your message and re-submit it with an adjusted prompt and/or new pieces of context.
|
||||
|
||||
### Checkpoints
|
||||
### Checkpoints {#checkpoints}
|
||||
|
||||
Every time the AI performs an edit, you should see a "Restore Checkpoint" button to the top of your message.
|
||||
This allows you to return your code base to the state it was in prior to that message.
|
||||
This is usually valuable if the AI's edit doesn't go in the right direction.
|
||||
|
||||
### Navigating History
|
||||
### Navigating History {#navigating-history}
|
||||
|
||||
To quickly navigate through recently opened threads, use the {#kb agent::ToggleNavigationMenu} binding, when focused on the panel's editor, or click the hamburger icon button at the top left of the panel to open the dropdown that shows you the six most recent interactions with the LLM.
|
||||
|
||||
|
@ -36,7 +36,7 @@ The items in this menu work similarly to tabs, and closing them from there doesn
|
|||
|
||||
You can also view all historical conversations with the `View All` option from within the same menu or by reaching for the {#kb agent::OpenHistory} binding.
|
||||
|
||||
### Reviewing Changes
|
||||
### Reviewing Changes {#reviewing-changes}
|
||||
|
||||
If you are using a profile that includes write tools, and the agent has made changes to your project, you'll notice the Agent Panel surfaces the fact that edits have been applied.
|
||||
|
||||
|
@ -46,7 +46,7 @@ Reviewing includes the option to accept or reject each edit, or accept or reject
|
|||
Diffs with changes also appear in individual buffers.
|
||||
So, if your active tab had changes added by the AI, you'll see diffs with the same accept/reject controls as in the multi-buffer.
|
||||
|
||||
## Adding Context
|
||||
## Adding Context {#adding-context}
|
||||
|
||||
Although Zed's agent is very efficient at reading through your code base to autonomously pick up relevant files, directories, and other context, manually adding context is still usually encouraged as a way to speed up and improve the AI's response quality.
|
||||
|
||||
|
@ -57,7 +57,7 @@ You can even add previous threads as context with the `@thread` command, or by s
|
|||
|
||||
Images are also supported, and pasting them over in the panel's editor works.
|
||||
|
||||
### Token Usage
|
||||
### Token Usage {#token-usage}
|
||||
|
||||
Zed surfaces how many tokens you are consuming for your currently active thread in the panel's toolbar.
|
||||
Depending on how many pieces of context you add, your token consumption can grow rapidly.
|
||||
|
@ -65,23 +65,23 @@ Depending on how many pieces of context you add, your token consumption can grow
|
|||
With that in mind, once you get close to the model's context window, we'll display a banner on the bottom of the message editor offering to start a new thread with the current one summarized and added as context.
|
||||
You can also do this at any time with an ongoing thread via the "Agent Options" menu on the top right.
|
||||
|
||||
## Changing Models
|
||||
## Changing Models {#changing-models}
|
||||
|
||||
After you've configured your LLM providers—either via [a custom API key](/ai/custom-api-keys.md) or through [Zed's hosted models](/ai/models.md)—you can switch between them by clicking on the model selector on the message editor or by using the {#kb agent::ToggleModelSelector} keybinding.
|
||||
|
||||
## Using Tools
|
||||
## Using Tools {#using-tools}
|
||||
|
||||
The new Agent Panel supports tool calling, which enables agentic collaboration with AI.
|
||||
Zed comes with [several built-in tools](/ai/tools.md) that allow models to perform tasks such as searching through your codebase, editing files, running commands, and others.
|
||||
|
||||
You can also extend the set of available tools via [MCP Servers](/ai/mcp.md).
|
||||
|
||||
### Profiles
|
||||
### Profiles {#profiles}
|
||||
|
||||
Profiles introduce a way to group tools.
|
||||
Zed offers three built-in profiles and you can create as many custom ones as you want.
|
||||
|
||||
#### Built-in Profiles
|
||||
#### Built-in Profiles {#built-in-profiles}
|
||||
|
||||
- `Write`: A profile with tools to allow the LLM to write to your files and run terminal commands. This one essentially has all built-in tools turned on.
|
||||
- `Ask`: A profile with read-only tools. Best for asking questions about your code base without the fear of the agent making changes.
|
||||
|
@ -89,7 +89,7 @@ Zed offers three built-in profiles and you can create as many custom ones as you
|
|||
|
||||
You can explore the exact tools enabled in each profile by clicking on the profile selector button > `Configure Profiles…` > the one you want to check out.
|
||||
|
||||
#### Custom Profiles
|
||||
#### Custom Profiles {#custom-profiles}
|
||||
|
||||
You may find yourself in a situation where the built-in profiles don't quite fit your specific needs.
|
||||
Zed's Agent Panel allows for building custom profiles.
|
||||
|
@ -104,7 +104,7 @@ Zed will store this profile in your settings using the same profile name as the
|
|||
|
||||
All custom profiles can be edited via the UI or by hand under the `assistant.profiles` key in your `settings.json` file.
|
||||
|
||||
### Model Support
|
||||
### Model Support {#model-support}
|
||||
|
||||
Tool calling needs to be individually supported by each model and model provider.
|
||||
Therefore, despite the presence of tools, some models may not have the ability to pick them up yet in Zed.
|
||||
|
@ -115,12 +115,12 @@ We may prioritize which ones to focus on based on popularity and user feedback,
|
|||
|
||||
All [Zed's hosted models](./models.md) support tool calling out-of-the-box.
|
||||
|
||||
### MCP Servers
|
||||
### MCP Servers {#mcp-servers}
|
||||
|
||||
Similarly to the built-in tools, some models may not support all tools included in a given MCP Server.
|
||||
Zed's UI will inform about this via a warning icon that appears close to the model selector.
|
||||
|
||||
## Text Threads
|
||||
## Text Threads {#text-threads}
|
||||
|
||||
["Text threads"](./text-threads.md) present your conversation with the LLM in a different format—as raw text.
|
||||
With text threads, you have full control over the conversation data.
|
||||
|
@ -129,12 +129,12 @@ You can remove and edit responses from the LLM, swap roles, and include more con
|
|||
For users who have been with us for some time, you'll notice that text threads are our original assistant panel—users love it for the control it offers.
|
||||
We do not plan to deprecate text threads, but it should be noted that if you want the AI to write to your code base autonomously, that's only available in the newer, and now default, "Threads".
|
||||
|
||||
### Text Thread History
|
||||
### Text Thread History {#text-thread-history}
|
||||
|
||||
Content from text thread are saved to your file system.
|
||||
Visit [the dedicated docs](./text-threads.md#history) for more info.
|
||||
|
||||
## Errors and Debugging
|
||||
## Errors and Debugging {#errors-and-debugging}
|
||||
|
||||
In case of any error or strange LLM response behavior, the best way to help the Zed team debug is by reaching for the `agent: open thread as markdown` action and attaching that data as part of your issue on GitHub.
|
||||
|
||||
|
@ -142,7 +142,7 @@ This action exposes the entire thread in the form of Markdown and allows for dee
|
|||
|
||||
You can also open threads as Markdown by clicking on the file icon button, to the right of the thumbs down button, when focused on the panel's editor.
|
||||
|
||||
## Feedback
|
||||
## Feedback {#feedback}
|
||||
|
||||
Every change we make to Zed's system prompt and tool set, needs to be backed by an eval with good scores.
|
||||
|
||||
|
|
|
@ -1,35 +1 @@
|
|||
# AI
|
||||
|
||||
Zed offers various features that integrate LLMs smoothly into the editor.
|
||||
|
||||
## Setting up AI in Zed
|
||||
|
||||
- [Models](./models.md): Information about the various language models available in Zed.
|
||||
|
||||
- [Configuration](./configuration.md): Configure the Agent, and set up different language model providers like Anthropic, OpenAI, Ollama, Google AI, and more.
|
||||
|
||||
- [Custom API Keys](./custom-api-keys.md): How to use your own API keys with the AI features.
|
||||
|
||||
- [Subscription](./subscription.md): Information about Zed's subscriptions and other billing related information.
|
||||
|
||||
- [Privacy and Security](./privacy-and-security.md): Understand how Zed handles privacy and security with AI features.
|
||||
|
||||
## Agentic Editing
|
||||
|
||||
- [Agent Panel](./agent-panel.md): Create and collaboratively edit new threads, and manage interactions with language models.
|
||||
|
||||
- [Rules](./rules.md): How to define rules for AI interactions.
|
||||
|
||||
- [Tools](./tools.md): Explore the tools that enhance the AI's capabilities to interact with your codebase.
|
||||
|
||||
- [Model Context Protocol](./mcp.md): Learn about context servers that enhance the Assistant's capabilities.
|
||||
|
||||
- [Inline Assistant](./inline-assistant.md): Discover how to use the agent to power inline transformations directly within your code editor and terminal.
|
||||
|
||||
## Edit Prediction
|
||||
|
||||
- [Edit Prediction](./edit-prediction.md): Learn about Zed's Edit Prediction feature that helps autocomplete your code.
|
||||
|
||||
## Text Thread Interface
|
||||
|
||||
- [Text Threads](./text-threads.md): Learn about an alternative text-based interface for interacting with language models.
|
||||
# Overview
|
||||
|
|
35
docs/src/ai/overview.md
Normal file
35
docs/src/ai/overview.md
Normal file
|
@ -0,0 +1,35 @@
|
|||
# AI
|
||||
|
||||
Zed offers various features that integrate LLMs smoothly into the editor.
|
||||
|
||||
## Setting up AI in Zed
|
||||
|
||||
- [Models](./models.md): Information about the various language models available in Zed.
|
||||
|
||||
- [Configuration](./configuration.md): Configure the Agent, and set up different language model providers like Anthropic, OpenAI, Ollama, Google AI, and more.
|
||||
|
||||
- [Custom API Keys](./custom-api-keys.md): How to use your own API keys with the AI features.
|
||||
|
||||
- [Subscription](./subscription.md): Information about Zed's subscriptions and other billing related information.
|
||||
|
||||
- [Privacy and Security](./privacy-and-security.md): Understand how Zed handles privacy and security with AI features.
|
||||
|
||||
## Agentic Editing
|
||||
|
||||
- [Agent Panel](./agent-panel.md): Create and collaboratively edit new threads, and manage interactions with language models.
|
||||
|
||||
- [Rules](./rules.md): How to define rules for AI interactions.
|
||||
|
||||
- [Tools](./tools.md): Explore the tools that enhance the AI's capabilities to interact with your codebase.
|
||||
|
||||
- [Model Context Protocol](./mcp.md): Learn about context servers that enhance the Assistant's capabilities.
|
||||
|
||||
- [Inline Assistant](./inline-assistant.md): Discover how to use the agent to power inline transformations directly within your code editor and terminal.
|
||||
|
||||
## Edit Prediction
|
||||
|
||||
- [Edit Prediction](./edit-prediction.md): Learn about Zed's Edit Prediction feature that helps autocomplete your code.
|
||||
|
||||
## Text Threads
|
||||
|
||||
- [Text Threads](./text-threads.md): Learn about an alternative, text-based interface for interacting with language models.
|
Loading…
Add table
Add a link
Reference in a new issue