-
Notifications
You must be signed in to change notification settings - Fork 83
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* feat: Add agents feature toggle to configuration documentation * docs: v1.1.9 agents config * docs: Clarify permissions for accessing agent instructions and tools
- Loading branch information
1 parent
d1e6596
commit c67e4ac
Showing
7 changed files
with
117 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
- Added [Agents](/docs/features/agents) related configurations: | ||
- [Interface-level toggle for Agents](/docs/configuration/librechat_yaml/object_structure/interface#agents), enabling/disabling Agents for all users | ||
- [Agent Endpoint-level configuration](/docs/configuration/librechat_yaml/object_structure/agents) for Agent options and capabilities |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
date: 2024/12/11 | ||
title: ⚙️ Config v1.1.9 | ||
--- | ||
|
||
import { ChangelogHeader } from '@/components/changelog/ChangelogHeader' | ||
import Content from '@/components/changelog/content/config_v1.1.9.mdx' | ||
|
||
<ChangelogHeader /> | ||
|
||
--- | ||
|
||
<Content /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
81 changes: 81 additions & 0 deletions
81
pages/docs/configuration/librechat_yaml/object_structure/agents.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
# Agents Endpoint Object Structure | ||
|
||
This page applies to the [`agents`](/docs/features/agents) endpoint. | ||
|
||
## Example | ||
|
||
```yaml filename="Agents Endpoint" | ||
endpoints: | ||
agents: | ||
disableBuilder: false | ||
# (optional) Agent Capabilities available to all users. Omit the ones you wish to exclude. Defaults to list below. | ||
# capabilities: ["execute_code", "file_search", "actions", "tools"] | ||
``` | ||
> This configuration enables the builder interface for agents. | ||
## disableBuilder | ||
|
||
**Key:** | ||
<OptionTable | ||
options={[ | ||
['disableBuilder', 'Boolean', 'Controls the visibility and use of the builder interface for agents.', 'When set to `true`, disables the builder interface for the agent, limiting direct manual interaction.'], | ||
]} | ||
/> | ||
|
||
**Default:** `false` | ||
|
||
**Example:** | ||
```yaml filename="endpoints / agents / disableBuilder" | ||
disableBuilder: false | ||
``` | ||
## capabilities | ||
**Key:** | ||
<OptionTable | ||
options={[ | ||
['capabilities', 'Array/List of Strings', 'Specifies the agent capabilities available to all users for the agents endpoint.', 'Defines the agent capabilities that are available to all users for the agents endpoint. You can omit the capabilities you wish to exclude from the list.'], | ||
]} | ||
/> | ||
**Default:** `["execute_code", "file_search", "actions", "tools"]` | ||
|
||
**Example:** | ||
```yaml filename="endpoints / agents / capabilities" | ||
capabilities: | ||
- "execute_code" | ||
- "file_search" | ||
- "actions" | ||
- "tools" | ||
``` | ||
**Note:** This field is optional. If omitted, the default behavior is to include all the capabilities listed in the default. | ||
|
||
## Agent Capabilities | ||
|
||
The `capabilities` field allows you to enable or disable specific functionalities for agents. The available capabilities are: | ||
|
||
- **execute_code**: Allows the agent to execute code. | ||
- **file_search**: Enables the agent to search and interact with files. | ||
- **actions**: Permits the agent to perform predefined actions. | ||
- **tools**: Grants the agent access to various tools. | ||
|
||
By specifying the capabilities, you can control the features available to users when interacting with agents. | ||
|
||
## Example Configuration | ||
|
||
Here is an example of configuring the `agents` endpoint with custom capabilities: | ||
|
||
```yaml filename="Agents Endpoint" | ||
endpoints: | ||
agents: | ||
disableBuilder: false | ||
capabilities: | ||
- "execute_code" | ||
- "actions" | ||
``` | ||
|
||
In this example, the builder interface for agents is disabled, and only the `execute_code` and `actions` capabilities are enabled. | ||
|
||
## Notes | ||
|
||
- It's not recommended to disable the builder interface unless you are using [modelSpecs](/docs/configuration/librechat_yaml/object_structure/model_specs) to define a list of agents to choose from. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters