From c67e4ac2d75ba9e6333adc0f8acf832fda782590 Mon Sep 17 00:00:00 2001 From: Danny Avila Date: Wed, 11 Dec 2024 17:29:18 -0500 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=98=20docs:=20Add=20Agents=20Config=20?= =?UTF-8?q?(#178)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * feat: Add agents feature toggle to configuration documentation * docs: v1.1.9 agents config * docs: Clarify permissions for accessing agent instructions and tools --- .../changelog/content/config_v1.1.9.mdx | 3 + pages/changelog/config_v1.1.9.mdx | 13 +++ .../configuration/librechat_yaml/index.mdx | 3 +- .../librechat_yaml/object_structure/_meta.ts | 3 +- .../object_structure/agents.mdx | 81 +++++++++++++++++++ .../object_structure/config.mdx | 3 + pages/docs/features/agents.mdx | 14 +++- 7 files changed, 117 insertions(+), 3 deletions(-) create mode 100644 components/changelog/content/config_v1.1.9.mdx create mode 100644 pages/changelog/config_v1.1.9.mdx create mode 100644 pages/docs/configuration/librechat_yaml/object_structure/agents.mdx diff --git a/components/changelog/content/config_v1.1.9.mdx b/components/changelog/content/config_v1.1.9.mdx new file mode 100644 index 000000000..3fdf1ecb7 --- /dev/null +++ b/components/changelog/content/config_v1.1.9.mdx @@ -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 diff --git a/pages/changelog/config_v1.1.9.mdx b/pages/changelog/config_v1.1.9.mdx new file mode 100644 index 000000000..177f052b5 --- /dev/null +++ b/pages/changelog/config_v1.1.9.mdx @@ -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' + + + +--- + + diff --git a/pages/docs/configuration/librechat_yaml/index.mdx b/pages/docs/configuration/librechat_yaml/index.mdx index 01be7d7b0..46da894d0 100644 --- a/pages/docs/configuration/librechat_yaml/index.mdx +++ b/pages/docs/configuration/librechat_yaml/index.mdx @@ -15,7 +15,8 @@ This file enables the integration of custom AI endpoints, enabling you to connec - **Endpoint Integration**: Seamlessly integrate with a variety of AI providers compliant with OpenAI API standards, including Mistral AI, reverse proxies, and more. - **Advanced Customization**: Configure file handling, rate limiting, user registration, and interface elements to align with your preferences and requirements. - **Model Specifications**: Define detailed model configurations, presets, and behaviors to deliver a tailored AI experience. -- **Assistants Integration**: Leverage the power of OpenAI's Assistants, with options to customize capabilities, polling intervals, and timeouts. +- **Agents**: Use Provider-agnostic, no-code assistants, with options to customize capabilities. +- **Assistants Integration**: Leverage the power of OpenAI's Assistants API, with options to customize capabilities, polling intervals, and timeouts. - **Azure OpenAI Support**: Integrate with Azure OpenAI Service, enabling access to multiple deployments, region models, and serverless inference endpoints.
diff --git a/pages/docs/configuration/librechat_yaml/object_structure/_meta.ts b/pages/docs/configuration/librechat_yaml/object_structure/_meta.ts index 1f3c076b4..09806e71c 100644 --- a/pages/docs/configuration/librechat_yaml/object_structure/_meta.ts +++ b/pages/docs/configuration/librechat_yaml/object_structure/_meta.ts @@ -4,8 +4,9 @@ export default { interface: 'Interface (UI)', model_specs: 'Model Specs', registration: 'Registration', + agents: 'Agents', aws_bedrock: 'AWS Bedrock', - assistants_endpoint: 'Assistants Endpoint', + assistants_endpoint: 'Assistants API', custom_endpoint: 'Custom Endpoint', azure_openai: 'Azure OpenAI', model_config: 'Azure Model Config', diff --git a/pages/docs/configuration/librechat_yaml/object_structure/agents.mdx b/pages/docs/configuration/librechat_yaml/object_structure/agents.mdx new file mode 100644 index 000000000..d3f98ccc3 --- /dev/null +++ b/pages/docs/configuration/librechat_yaml/object_structure/agents.mdx @@ -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:** + + +**Default:** `false` + +**Example:** +```yaml filename="endpoints / agents / disableBuilder" +disableBuilder: false +``` + +## capabilities + +**Key:** + + +**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. diff --git a/pages/docs/configuration/librechat_yaml/object_structure/config.mdx b/pages/docs/configuration/librechat_yaml/object_structure/config.mdx index f1bede12b..553974b50 100644 --- a/pages/docs/configuration/librechat_yaml/object_structure/config.mdx +++ b/pages/docs/configuration/librechat_yaml/object_structure/config.mdx @@ -226,6 +226,7 @@ see also: ['prompts', 'Boolean', 'Enables or disables all prompt-related features for all users', ''], ['bookmarks', 'Boolean', 'Enables or disables all bookmarks-related features for all users', ''], ['multiConvo', 'Boolean', 'Enables or disables all "multi convo", AKA multiple response streaming, related features for all users', ''], + ['agents', 'Boolean', 'Enables or disables all agents features for all users', ''], ]} /> @@ -267,6 +268,7 @@ see: [Model Specs Object Structure](/docs/configuration/librechat_yaml/object_st ['azureOpenAI', 'Object', 'Azure OpenAI endpoint-specific configuration', ''], ['assistants', 'Object', 'Assistants endpoint-specific configuration.', ''], ['azureAssistants', 'Object', 'Azure Assistants endpoint-specific configuration.', ''], + ['agents', 'Object', 'Agents endpoint-specific configuration.', ''], ]} /> @@ -275,3 +277,4 @@ see: [Model Specs Object Structure](/docs/configuration/librechat_yaml/object_st - [Custom Endpoint Object Structure](/docs/configuration/librechat_yaml/object_structure/custom_endpoint) - [Azure OpenAI Endpoint Object Structure](/docs/configuration/librechat_yaml/object_structure/azure_openai) - [Assistants Endpoint Object Structure](/docs/configuration/librechat_yaml/object_structure/assistants_endpoint) +- [Agents](/docs/configuration/librechat_yaml/object_structure/agents) diff --git a/pages/docs/features/agents.mdx b/pages/docs/features/agents.mdx index 7cfde71c1..4dffce814 100644 --- a/pages/docs/features/agents.mdx +++ b/pages/docs/features/agents.mdx @@ -103,7 +103,19 @@ Individual users can: - Control editing permissions for shared agents - Manage access to their created agents -*Note: Only original authors and administrators can delete shared agents* +### Notes + +- Instructions, model parameters, attached files, and tools are only exposed to the user if they have editing permissions + - An agent may leak any attached data, whether instructions or files, through conversation--make sure your instructions are robust against this +- Only original authors and administrators can delete shared agents +- Agents are private to authors unless shared + +## Optional Configuration + +LibreChat allows admins to configure the use of agents via the [`librechat.yaml`](/docs/configuration/librechat_yaml) file: + +- Disable Agents for all users (including admins): [more info](/docs/configuration/librechat_yaml/object_structure/interface) +- Customize agent capabilities using: [more info](/docs/configuration/librechat_yaml/object_structure/agents) ## Best Practices