mirror of
https://github.com/LibreChat-AI/librechat.ai.git
synced 2026-03-27 10:48:32 +07:00
103ed0fffa
* 📧 docs: Mailgun API email configuration * 📝 docs: Update agents configuration note to include custom endpoint option
145 lines
5.0 KiB
Plaintext
145 lines
5.0 KiB
Plaintext
# Agents Endpoint Object Structure
|
|
|
|
This page applies to the [`agents`](/docs/features/agents) endpoint.
|
|
|
|
## Example
|
|
|
|
```yaml filename="Agents Endpoint"
|
|
endpoints:
|
|
agents:
|
|
recursionLimit: 50
|
|
maxRecursionLimit: 100
|
|
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", "artifacts", "ocr", "chain", "web_search"]
|
|
```
|
|
> This configuration enables the builder interface for agents.
|
|
|
|
## recursionLimit
|
|
|
|
<OptionTable
|
|
options={[
|
|
['recursionLimit', 'Number', 'Sets the default number of steps an agent can take in a run.', 'Controls recursion depth to prevent infinite loops. When limit is reached, raises GraphRecursionError. This value can be configured from the UI up to the maxRecursionLimit.'],
|
|
]}
|
|
/>
|
|
|
|
**Default:** `25`
|
|
|
|
**Example:**
|
|
```yaml filename="endpoints / agents / recursionLimit"
|
|
recursionLimit: 50
|
|
```
|
|
|
|
For more information about agent steps, see [Max Agent Steps](/docs/features/agents#max-agent-steps).
|
|
|
|
## maxRecursionLimit
|
|
|
|
<OptionTable
|
|
options={[
|
|
['maxRecursionLimit', 'Number', 'Sets the absolute maximum number of steps an agent can take in a run.', 'Defines the upper limit for the recursionLimit that can be set from the UI. This prevents users from setting excessively high values.'],
|
|
]}
|
|
/>
|
|
|
|
**Default:** If omitted, defaults to the value of recursionLimit or 25 if recursionLimit is also omitted.
|
|
|
|
**Example:**
|
|
```yaml filename="endpoints / agents / maxRecursionLimit"
|
|
maxRecursionLimit: 100
|
|
```
|
|
|
|
For more information about agent steps, see [Max Agent Steps](/docs/features/agents#max-agent-steps).
|
|
|
|
## disableBuilder
|
|
|
|
<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
|
|
```
|
|
|
|
## allowedProviders
|
|
|
|
<OptionTable
|
|
options={[
|
|
['allowedProviders', 'Array/List of Strings', 'Specifies a list of endpoint providers (e.g., "openAI", "anthropic", "google") that are permitted for use with the Agents feature.', 'If defined, only agents configured with these providers can be initialized. If omitted or empty, all configured providers are allowed.'],
|
|
]}
|
|
/>
|
|
|
|
**Default:** `[]` (empty list, all providers allowed)
|
|
|
|
**Note:** Must be one of the following, or a custom endpoint name as defined in your [configuration](/docs/configuration/librechat_yaml/object_structure/custom_endpoint#name):
|
|
- `openAI, azureOpenAI, google, anthropic, assistants, azureAssistants, bedrock`
|
|
|
|
**Example:**
|
|
```yaml filename="endpoints / agents / allowedProviders"
|
|
allowedProviders:
|
|
- openAI
|
|
- google
|
|
```
|
|
|
|
## capabilities
|
|
|
|
<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", "artifacts", "ocr", "chain", "web_search"]`
|
|
|
|
**Example:**
|
|
```yaml filename="endpoints / agents / capabilities"
|
|
capabilities:
|
|
- "execute_code"
|
|
- "file_search"
|
|
- "actions"
|
|
- "tools"
|
|
- "artifacts"
|
|
- "ocr"
|
|
- "chain"
|
|
- "web_search"
|
|
```
|
|
**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.
|
|
- **ocr**: Enables uploading files as additional context, leveraging Optical Character Recognition for extracting text from images and documents.
|
|
- **web_search**: Enables web search functionality for agents, allowing them to search and retrieve information from the internet.
|
|
|
|
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"
|
|
- "artifacts"
|
|
- "ocr"
|
|
- "web_search"
|
|
```
|
|
|
|
In this example, the builder interface for agents is disabled, and only the `execute_code`, `actions`, `ocr`, and `web_search` 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.
|