Estrutura do Objeto do endpoint Agents
Esta pƔgina se aplica ao endpoint agents.
Exemplo
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.
# Add "programmatic_tools" with "execute_code" to enable Programmatic Tool Calling for MCP tools.
# capabilities: ["deferred_tools", "execute_code", "file_search", "web_search", "artifacts", "subagents", "actions", "context", "skills", "tools", "chain", "ocr"]
# (optional) File citation configuration for file_search capability
maxCitations: 30 # Maximum total citations in responses (1-50)
maxCitationsPerFile: 7 # Maximum citations from each file (1-10)
minRelevanceScore: 0.45 # Minimum relevance score threshold (0.0-1.0)
titleTiming: immediate
skills:
maxCatalogSkills: 20
remoteApi:
auth:
oidc:
enabled: falseEsta configuração habilita a interface do construtor para agentes.
recursionLimit
| Key | Type | Description | Example |
|---|---|---|---|
| recursionLimit | Number | Define o número padrão de passos que um agente pode realizar em uma execução. | 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. |
Padrão: 25
Exemplo:
recursionLimit: 50Para mais informaƧƵes sobre as etapas do agente, consulte Max Agent Steps.
maxRecursionLimit
| Key | Type | Description | Example |
|---|---|---|---|
| maxRecursionLimit | Number | Define o número mÔximo absoluto de passos que um agente pode executar em uma execução. | Defines the upper limit for the recursionLimit that can be set from the UI. This prevents users from setting excessively high values. |
Padrão: Se omitido, assume o valor de recursionLimit ou 50 se recursionLimit também for omitido.
Exemplo:
maxRecursionLimit: 100Para mais informaƧƵes sobre as etapas do agente, consulte Max Agent Steps.
titleTiming
| Key | Type | Description | Example |
|---|---|---|---|
| titleTiming | String | Controla quando os tĆtulos das conversas sĆ£o gerados para o endpoint agents. Valores vĆ”lidos: "immediate" ou "final". | Defaults to "immediate". |
Padrão: "immediate"
Valores DisponĆveis:
"immediate": Gera o tĆtulo assim que a solicitação Ć© iniciada, em paralelo com a resposta do modelo, usando a primeira mensagem do usuĆ”rio."final": Adia a geração do tĆtulo atĆ© que a resposta completa seja concluĆda. Isso preserva o comportamento legado.
Exemplo:
titleTiming: immediatedisableBuilder
| Key | Type | Description | Example |
|---|---|---|---|
| disableBuilder | Boolean | Controla a visibilidade e o uso da interface do construtor para agentes. | When set to `true`, disables the builder interface for the agent, limiting direct manual interaction. |
Padrão: false
Exemplo:
disableBuilder: falseallowedProviders
| Key | Type | Description | Example |
|---|---|---|---|
| allowedProviders | Array/List of Strings | Especifica uma lista de provedores de endpoint (por exemplo, "openAI", "anthropic", "google") que têm permissão para uso com o recurso de Agents. | If defined, only agents configured with these providers can be initialized. If omitted or empty, all configured providers are allowed. |
Padrão: [] (lista vazia, todos os provedores permitidos)
Nota: Deve ser um dos seguintes, ou um nome de endpoint personalizado conforme definido em sua configuração: - openAI, azureOpenAI, google, anthropic, assistants, azureAssistants, bedrock
Exemplo:
allowedProviders:
- openAI
- googlecapabilities
| Key | Type | Description | Example |
|---|---|---|---|
| capabilities | Array/List of Strings | Especifica as capacidades de agente disponĆveis para todos os usuĆ”rios para o endpoint agents. | 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. |
Padrão: ["deferred_tools", "execute_code", "file_search", "web_search", "artifacts", "subagents", "actions", "context", "skills", "tools", "chain", "ocr"]
O Programmatic Tool Calling é opcional (opt-in). Adicione programmatic_tools junto com execute_code apenas quando sua implantação do Code Interpreter incluir o componente Tool Call Server.
Exemplo:
capabilities:
- 'deferred_tools'
# Optional: enables Programmatic Tool Calling for MCP tools marked Programmatic in the Agent Builder.
# Requires execute_code and a Code Interpreter deployment with the Tool Call Server component.
# - 'programmatic_tools'
- 'execute_code'
- 'file_search'
- 'web_search'
- 'artifacts'
- 'subagents'
- 'actions'
- 'context'
- 'skills'
- 'tools'
- 'chain'
- 'ocr'Nota: Este campo é opcional. Se omitido, o comportamento padrão é incluir todas as capacidades listadas no default.
skills
Controla as configuraƧƵes de Skills em nĆvel de endpoint para agentes.
| Key | Type | Description | Example |
|---|---|---|---|
| skills.maxCatalogSkills | Number | Limita o nĆŗmero de Skills acessĆveis ativas expostas no catĆ”logo visĆvel ao modelo. Deve estar entre 1 e 100. | maxCatalogSkills: 20 |
Padrão: Nenhum limite configurado além do limite do catÔlogo de tempo de execução.
Exemplo:
skills:
maxCatalogSkills: 20Isso nĆ£o desativa as Skills. Use a capacidade skills e o escopo de skill por agente/model-spec para controlar se as Skills estĆ£o disponĆveis.
maxCitations
| Key | Type | Description | Example |
|---|---|---|---|
| maxCitations | Number | Controla o nĆŗmero mĆ”ximo total de citaƧƵes que podem ser incluĆdas em uma Ćŗnica resposta do agente. | When using file_search capability, limits the total number of source citations returned to prevent overwhelming responses while ensuring comprehensive coverage. |
Padrão: 30
Intervalo: 1-50
Exemplo:
maxCitations: 30maxCitationsPerFile
| Key | Type | Description | Example |
|---|---|---|---|
| maxCitationsPerFile | Number | Limita o nĆŗmero mĆ”ximo de citaƧƵes que podem ser extraĆdas de qualquer arquivo individual. | Ensures citation diversity by preventing any single file from dominating the citations, encouraging representation from multiple sources. |
Padrão: 7
Intervalo: 1-10
Exemplo:
maxCitationsPerFile: 7minRelevanceScore
| Key | Type | Description | Example |
|---|---|---|---|
| minRelevanceScore | Number | Define o limite mĆnimo de pontuação de relevĆ¢ncia para que as fontes sejam incluĆdas nas respostas. | Filters out low-quality matches based on vector similarity scores. Higher values (e.g., 0.7) ensure only highly relevant sources are cited, while lower values (e.g., 0.0) include all sources regardless of quality. |
Padrão: 0.45 (limite de relevância de 45%)
Intervalo: 0.0-1.0
Exemplo:
minRelevanceScore: 0.45Exemplos de Configuração de Citação de Arquivos
Configuração Padrão (Balanceada)
endpoints:
agents:
maxCitations: 30
maxCitationsPerFile: 7
minRelevanceScore: 0.45Fornece citações abrangentes, evitando respostas excessivas e filtrando correspondências de baixa qualidade.
Configuração Estrita (Alta Qualidade)
endpoints:
agents:
maxCitations: 10
maxCitationsPerFile: 3
minRelevanceScore: 0.7Inclui apenas citaƧƵes altamente relevantes com limites rigorosos para respostas focadas.
Configuração Abrangente (Pesquisa)
endpoints:
agents:
maxCitations: 50
maxCitationsPerFile: 10
minRelevanceScore: 0.0Extração mÔxima de informações para tarefas de pesquisa exaustivas, incluindo todas as fontes, independentemente da relevância.
Capacidades dos Agentes
O campo capabilities permite que vocĆŖ habilite ou desabilite funcionalidades especĆficas para agentes. As capacidades disponĆveis sĆ£o:
- deferred_tools: Permite que agentes descubram ferramentas MCP adiadas em tempo de execução, em vez de carregar todas as ferramentas no contexto antecipadamente.
- programmatic_tools: Habilita a Chamada de Ferramentas ProgramƔticas para ferramentas MCP marcadas como Programmatic no Agent Builder. Requer
execute_codee uma implementação de Code Interpreter com o componente Tool Call Server. Esta funcionalidade é opcional e não estÔ habilitada por padrão. - execute_code: Permite que o agente execute código.
- file_search: Permite que o agente pesquise e interaja com arquivos. Quando ativado, o comportamento de citação é controlado pelas configurações
maxCitations,maxCitationsPerFileeminRelevanceScore. - web_search: Habilita a funcionalidade de pesquisa na web para agentes, permitindo que eles pesquisem e recuperem informaƧƵes da internet.
- artifacts: Permite que o agente gere artefatos interativos (componentes React, HTML, diagramas Mermaid).
- subagents: Habilita execuƧƵes de agentes filhos em contexto isolado. Veja Subagents.
- actions: Permite que o agente execute aƧƵes predefinidas.
- context: Habilita a funcionalidade "Upload as Text" no chat e "File Context" para agentes, permitindo que os usuĆ”rios enviem arquivos e tenham seu conteĆŗdo extraĆdo e incluĆdo diretamente na conversa.
- skills: Habilita Skills no painel lateral, invocação manual com
$, skills invocadas pelo modelo e listas de permissão de skills de agentes. Veja Skills. - tools: Concede ao agente acesso a vÔrias ferramentas.
- chain: Habilita o recurso Beta para encadeamento de agentes, tambƩm conhecido como fluxos de trabalho Mixture-of-Agents (MoA).
- ocr: Opcionalmente aprimora o "Upload as Text" no chat e o "File Context" para agentes, permitindo que arquivos sejam enviados e processados com OCR. Requer que um serviƧo de OCR seja configurado.
Ao especificar as capabilities, vocĆŖ pode controlar os recursos disponĆveis para os usuĆ”rios ao interagir com agentes.
Exemplo de Configuração
Aqui estÔ um exemplo de configuração do endpoint agents com capacidades personalizadas e configurações de citação de arquivos:
endpoints:
agents:
disableBuilder: false
# File citation configuration
maxCitations: 20
maxCitationsPerFile: 5
minRelevanceScore: 0.6
# Custom capabilities
capabilities:
# Optional: enables Programmatic Tool Calling for MCP tools marked Programmatic in the Agent Builder.
# - 'programmatic_tools'
- 'execute_code'
- 'file_search'
- 'skills'
- 'subagents'
- 'actions'
- 'artifacts'
- 'context'
- 'ocr'
- 'web_search'Neste exemplo:
- A interface do construtor estĆ” habilitada
- As citações de arquivos são limitadas a um total de 20, com no mÔximo 5 por arquivo
- Apenas fontes com 60%+ de relevĆ¢ncia sĆ£o incluĆdas
- Os agentes do LibreChat têm acesso à execução de código, pesquisa de arquivos (com citações), Skills, Subagentes, ações, artefatos, contexto de arquivos, serviços de OCR (se configurados) e recursos de pesquisa na web.
- O Programmatic Tool Calling permanece desativado, a menos que vocĆŖ adicione a capacidade
programmatic_toolsjunto comexecute_code
remoteApi
Configuração para autenticação da API de Agentes Remotos. Controla como serviços externos se autenticam ao chamar os endpoints da API de Agentes.
remoteApi.auth
| Key | Type | Description | Example |
|---|---|---|---|
| auth | Object | Configuração de autenticação para a Remote Agent API. | Supports API key and/or OIDC Bearer token authentication. If omitted, only API key auth is active. |
remoteApi.auth.apiKey
| Key | Type | Description | Example |
|---|---|---|---|
| enabled | Boolean | Habilitar autenticação por chave de API para a Remote Agent API. | When true, requests with a valid LibreChat API key are accepted. Can be used alongside or instead of OIDC. |
Padrão: true
remoteApi.auth.oidc
| Key | Type | Description | Example |
|---|---|---|---|
| enabled | Boolean | Habilitar autenticação por token Bearer OIDC. | When true, the middleware validates Bearer tokens against the configured OIDC issuer via JWKS. |
| issuer | String | URL do emissor OIDC. | The base URL of your OIDC provider, such as a Keycloak realm URL. Used for token issuer validation and JWKS discovery if jwksUri is not set. |
| jwksUri | String | URL do endpoint JWKS. Opcional. | If omitted, resolved automatically via {issuer}/.well-known/openid-configuration. You can also set OPENID_JWKS_URL as an alternative. |
| audience | String | Público-alvo do token esperado. Obrigatório quando a autenticação OIDC estÔ habilitada. | Tokens must contain this value in their aud claim. |
| scope | String | Valor de escopo obrigatório. Opcional. | If set, the token must contain this value in its scp or scope claim. Use this to distinguish token intent across different APIs. |
Padrão: enabled: false
Exemplo - Apenas OIDC:
endpoints:
agents:
remoteApi:
auth:
apiKey:
enabled: false
oidc:
enabled: true
issuer: https://auth.example.com/realms/myrealm
audience: my-client-idExemplo - OIDC com fallback de chave de API:
endpoints:
agents:
remoteApi:
auth:
apiKey:
enabled: true
oidc:
enabled: true
issuer: https://auth.example.com/realms/myrealm
# jwksUri is optional and auto-discovered if omitted
jwksUri: https://auth.example.com/realms/myrealm/protocol/openid-connect/certs
audience: my-client-idA prioridade de resolução do JWKS URI Ć© o jwksUri explĆcito, seguido por OPENID_JWKS_URL e, por fim, a descoberta automĆ”tica via {issuer}/.well-known/openid-configuration.
O mapeamento de usuƔrios OIDC usa a claim sub como busca primƔria, com fallback para as claims email, preferred_username ou upn. O usuƔrio correspondente jƔ deve existir no LibreChat.
Subagentes
O campo subagents controla quais agentes filhos isolados um agente pai pode gerar quando a capacidade subagents estĆ” disponĆvel.
| Key | Type | Description | Example |
|---|---|---|---|
| enabled | Boolean | Adiciona a ferramenta de criação de subagentes a este agente quando verdadeiro. Padrão: desativado. | enabled: true |
| allowSelf | Boolean | Permite que o agente crie a si mesmo em um novo contexto isolado. Padrão: true. | allowSelf: true |
| agent_ids | Array/List of Strings | Agentes especĆficos que este agente pode gerar. MĆ”ximo: 10. | agent_ids: ["agent_researcher"] |
subagents:
enabled: true
allowSelf: true
agent_ids:
- 'agent_researcher'
- 'agent_reviewer'Para comportamento e limites voltados ao usuƔrio, veja Subagents.
Notas
- NĆ£o Ć© recomendado desativar a interface do construtor, a menos que vocĆŖ esteja usando modelSpecs para definir uma lista de agentes para escolha.
- A configuração de citação de arquivos (
maxCitations,maxCitationsPerFile,minRelevanceScore) só se aplica quando a capacidadefile_searchestÔ habilitada. - A pontuação de relevância é calculada usando similaridade vetorial, onde 1.0 representa uma correspondência perfeita e 0.0 representa nenhuma similaridade.
- Os limites de citação ajudam a equilibrar a recuperação abrangente de informações com a qualidade e o desempenho da resposta.
- A capacidade
contextfunciona sem configuração de OCR usando métodos de anÔlise de texto. O OCR aprimora a qualidade da extração quando configurado. - A funcionalidade
ocrrequer que um serviço de OCR seja configurado (veja Configuração de OCR).
Como estĆ” este guia?