mirror of
https://github.com/LibreChat-AI/librechat.ai.git
synced 2026-03-27 10:48:32 +07:00
214d8bb281
* 🌍 docs: Add OCR configuration documentation and object structure * 🌍 docs: Enhance OCR capabilities documentation and add new feature details * 🌍 docs: Add OCR configuration details and update links in documentation * 🌍 docs: Update OCR configuration details and enhance documentation for new features * 🌍 docs: Add OCR capability details and update changelog for new text extraction features * 🌍 docs: Clarify OCR processing details in agent context and update documentation for text extraction * 🌍 docs: Update OCR documentation title and enhance configuration details for Mistral model * fix: example OCR `mistralModel` and clarifying comment on configuration
99 lines
3.2 KiB
Plaintext
99 lines
3.2 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
|
|
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", "ocr"]
|
|
```
|
|
> This configuration enables the builder interface for agents.
|
|
|
|
## recursionLimit
|
|
|
|
<OptionTable
|
|
options={[
|
|
['recursionLimit', 'Number', 'Sets the maximum number of super-steps the graph can execute during a single execution.', 'Controls recursion depth to prevent infinite loops. When limit is reached, raises GraphRecursionError.'],
|
|
]}
|
|
/>
|
|
|
|
**Default:** `25`
|
|
|
|
**Example:**
|
|
```yaml filename="endpoints / agents / recursionLimit"
|
|
recursionLimit: 50
|
|
```
|
|
|
|
## 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
|
|
```
|
|
|
|
## 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", "ocr"]`
|
|
|
|
**Example:**
|
|
```yaml filename="endpoints / agents / capabilities"
|
|
capabilities:
|
|
- "execute_code"
|
|
- "file_search"
|
|
- "actions"
|
|
- "tools"
|
|
- "ocr"
|
|
```
|
|
**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.
|
|
|
|
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"
|
|
- "ocr"
|
|
```
|
|
|
|
In this example, the builder interface for agents is disabled, and only the `execute_code`, `actions`, and `ocr` 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.
|