Skip to main content
LibreChat is joining ClickHouse to power the open-source Agentic Data Stack šŸŽ‰ Learn more
LibreChat

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: false

Esta configuração habilita a interface do construtor para agentes.

recursionLimit

KeyTypeDescriptionExample
recursionLimitNumberDefine 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: 50

Para mais informaƧƵes sobre as etapas do agente, consulte Max Agent Steps.

maxRecursionLimit

KeyTypeDescriptionExample
maxRecursionLimitNumberDefine 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: 100

Para mais informaƧƵes sobre as etapas do agente, consulte Max Agent Steps.

titleTiming

KeyTypeDescriptionExample
titleTimingStringControla 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: immediate

disableBuilder

KeyTypeDescriptionExample
disableBuilderBooleanControla 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: false

allowedProviders

KeyTypeDescriptionExample
allowedProvidersArray/List of StringsEspecifica 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
  - google

capabilities

KeyTypeDescriptionExample
capabilitiesArray/List of StringsEspecifica 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.

KeyTypeDescriptionExample
skills.maxCatalogSkillsNumberLimita 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: 20

Isso 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

KeyTypeDescriptionExample
maxCitationsNumberControla 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: 30

maxCitationsPerFile

KeyTypeDescriptionExample
maxCitationsPerFileNumberLimita 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: 7

minRelevanceScore

KeyTypeDescriptionExample
minRelevanceScoreNumberDefine 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.45

Exemplos de Configuração de Citação de Arquivos

Configuração Padrão (Balanceada)

endpoints:
  agents:
    maxCitations: 30
    maxCitationsPerFile: 7
    minRelevanceScore: 0.45

Fornece 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.7

Inclui apenas citaƧƵes altamente relevantes com limites rigorosos para respostas focadas.

Configuração Abrangente (Pesquisa)

endpoints:
  agents:
    maxCitations: 50
    maxCitationsPerFile: 10
    minRelevanceScore: 0.0

Extraçã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_code e 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, maxCitationsPerFile e minRelevanceScore.
  • 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_tools junto com execute_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

KeyTypeDescriptionExample
authObjectConfiguraçã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

KeyTypeDescriptionExample
enabledBooleanHabilitar 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

KeyTypeDescriptionExample
enabledBooleanHabilitar autenticação por token Bearer OIDC.When true, the middleware validates Bearer tokens against the configured OIDC issuer via JWKS.
issuerStringURL 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.
jwksUriStringURL do endpoint JWKS. Opcional.If omitted, resolved automatically via {issuer}/.well-known/openid-configuration. You can also set OPENID_JWKS_URL as an alternative.
audienceStringPúblico-alvo do token esperado. Obrigatório quando a autenticação OIDC estÔ habilitada.Tokens must contain this value in their aud claim.
scopeStringValor 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-id

Exemplo - 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-id

A 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.

KeyTypeDescriptionExample
enabledBooleanAdiciona a ferramenta de criação de subagentes a este agente quando verdadeiro. Padrão: desativado.enabled: true
allowSelfBooleanPermite que o agente crie a si mesmo em um novo contexto isolado. Padrão: true.allowSelf: true
agent_idsArray/List of StringsAgentes 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 capacidade file_search estĆ” 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 context funciona 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 ocr requer que um serviƧo de OCR seja configurado (veja Configuração de OCR).

Como estĆ” este guia?