Skip to main content
LibreChat is joining ClickHouse to power the open-source Agentic Data Stack 🎉 Learn more
LibreChat

Structure de l'objet endpoint Agents

Cette page s'applique Ă  l'endpoint agents.

Exemple

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

Cette configuration active l'interface de création pour les agents.

recursionLimit

KeyTypeDescriptionExample
recursionLimitNumberDéfinit le nombre par défaut d'étapes qu'un agent peut effectuer lors d'une exécution.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.

Par défaut : 25

Exemple :

recursionLimit: 50

Pour plus d'informations sur les étapes de l'agent, consultez Max Agent Steps.

maxRecursionLimit

KeyTypeDescriptionExample
maxRecursionLimitNumberDéfinit le nombre maximal absolu d'étapes qu'un agent peut effectuer lors d'une exécution.Defines the upper limit for the recursionLimit that can be set from the UI. This prevents users from setting excessively high values.

Par défaut : Si omis, utilise la valeur de recursionLimit ou 50 si recursionLimit est également omis.

Exemple :

maxRecursionLimit: 100

Pour plus d'informations sur les étapes de l'agent, consultez Max Agent Steps.

titleTiming

KeyTypeDescriptionExample
titleTimingStringContrĂŽle le moment oĂč les titres de conversation sont gĂ©nĂ©rĂ©s pour l'endpoint agents. Valeurs valides : "immediate" ou "final".Defaults to "immediate".

Par défaut : "immediate"

Valeurs disponibles :

  • "immediate" : GĂ©nĂšre le titre dĂšs que la requĂȘte commence, en parallĂšle avec la rĂ©ponse du modĂšle, en utilisant le premier message de l'utilisateur.
  • "final" : DiffĂšre la gĂ©nĂ©ration du titre jusqu'Ă  ce que la rĂ©ponse complĂšte soit terminĂ©e. Cela prĂ©serve le comportement hĂ©ritĂ©.

Exemple :

titleTiming: immediate

disableBuilder

KeyTypeDescriptionExample
disableBuilderBooleanContrÎle la visibilité et l'utilisation de l'interface de création pour les agents.When set to `true`, disables the builder interface for the agent, limiting direct manual interaction.

Par défaut : false

Exemple :

disableBuilder: false

allowedProviders

KeyTypeDescriptionExample
allowedProvidersArray/List of StringsSpécifie une liste de fournisseurs d'endpoint (par exemple, "openAI", "anthropic", "google") autorisés pour une utilisation avec la fonctionnalité Agents.If defined, only agents configured with these providers can be initialized. If omitted or empty, all configured providers are allowed.

Par défaut : [] (liste vide, tous les fournisseurs sont autorisés)

Remarque : Doit ĂȘtre l'un des Ă©lĂ©ments suivants, ou un nom de endpoint personnalisĂ© tel que dĂ©fini dans votre configuration : - openAI, azureOpenAI, google, anthropic, assistants, azureAssistants, bedrock

Exemple :

allowedProviders:
  - openAI
  - google

capabilities

KeyTypeDescriptionExample
capabilitiesArray/List of StringsSpécifie les capacités d'agent disponibles pour tous les utilisateurs pour l'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.

Par défaut : ["deferred_tools", "execute_code", "file_search", "web_search", "artifacts", "subagents", "actions", "context", "skills", "tools", "chain", "ocr"]

L'appel d'outils programmatique (Programmatic Tool Calling) est une fonctionnalité optionnelle. Ajoutez programmatic_tools aux cÎtés de execute_code uniquement lorsque votre déploiement de l'interpréteur de code inclut le composant Tool Call Server.

Exemple :

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'

Remarque : Ce champ est facultatif. S'il est omis, le comportement par défaut consiste à inclure toutes les capacités listées dans le défaut.

skills

ContrĂŽle les paramĂštres de Skills au niveau de l'endpoint pour les agents.

KeyTypeDescriptionExample
skills.maxCatalogSkillsNumberLimite le nombre de Skills accessibles et actifs exposĂ©s dans le catalogue visible par le modĂšle. Doit ĂȘtre compris entre 1 et 100.maxCatalogSkills: 20

Par défaut : Aucune limite configurée au-delà de la limite du catalogue d'exécution.

Exemple :

skills:
  maxCatalogSkills: 20

Ceci ne désactive pas les Skills. Utilisez la capacité skills et la définition de portée des skills par agent/Model Specs pour contrÎler si les Skills sont disponibles.

maxCitations

KeyTypeDescriptionExample
maxCitationsNumberContrĂŽle le nombre total maximal de citations pouvant ĂȘtre incluses dans une seule rĂ©ponse de l'agent.When using file_search capability, limits the total number of source citations returned to prevent overwhelming responses while ensuring comprehensive coverage.

Par défaut : 30

Plage : 1-50

Exemple :

maxCitations: 30

maxCitationsPerFile

KeyTypeDescriptionExample
maxCitationsPerFileNumberLimite le nombre maximal de citations pouvant ĂȘtre extraites d'un seul fichier.Ensures citation diversity by preventing any single file from dominating the citations, encouraging representation from multiple sources.

Par défaut : 7

Plage : 1-10

Exemple :

maxCitationsPerFile: 7

minRelevanceScore

KeyTypeDescriptionExample
minRelevanceScoreNumberDéfinit le seuil de score de pertinence minimal pour que les sources soient incluses dans les réponses.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.

Par défaut : 0.45 (seuil de pertinence de 45 %)

Plage : 0.0-1.0

Exemple :

minRelevanceScore: 0.45

Exemples de configuration de citation de fichiers

Configuration par dĂ©faut (ÉquilibrĂ©e)

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

Fournit des citations complÚtes tout en évitant les réponses surchargées et en filtrant les correspondances de faible qualité.

Configuration stricte (Haute qualité)

endpoints:
  agents:
    maxCitations: 10
    maxCitationsPerFile: 3
    minRelevanceScore: 0.7

Inclut uniquement des citations hautement pertinentes avec des limites strictes pour des réponses ciblées.

Configuration complĂšte (Recherche)

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

Extraction d'informations maximale pour des tùches de recherche exhaustives, incluant toutes les sources indépendamment de leur pertinence.

Capacités des agents

Le champ capabilities vous permet d'activer ou de désactiver des fonctionnalités spécifiques pour les agents. Les capacités disponibles sont :

  • deferred_tools : Permet aux agents de dĂ©couvrir les outils MCP diffĂ©rĂ©s au moment de l'exĂ©cution au lieu de charger chaque outil dans le contexte au prĂ©alable.
  • programmatic_tools : Active l'appel de programme par outils (Programmatic Tool Calling) pour les outils MCP marquĂ©s comme Programmatic dans l'Agent Builder. NĂ©cessite execute_code et un dĂ©ploiement de Code Interpreter avec le composant Tool Call Server. Cette fonctionnalitĂ© est optionnelle et n'est pas activĂ©e par dĂ©faut.
  • execute_code : Permet Ă  l'agent d'exĂ©cuter du code.
  • file_search : Permet Ă  l'agent de rechercher et d'interagir avec des fichiers. Lorsqu'il est activĂ©, le comportement des citations est contrĂŽlĂ© par les paramĂštres maxCitations, maxCitationsPerFile et minRelevanceScore.
  • web_search : Active la fonctionnalitĂ© de recherche web pour les agents, leur permettant de rechercher et de rĂ©cupĂ©rer des informations sur Internet.
  • artifacts : Permet Ă  l'agent de gĂ©nĂ©rer des artefacts interactifs (composants React, HTML, diagrammes Mermaid).
  • subagents : Permet l'exĂ©cution d'agents enfants dans un contexte isolĂ©. Voir Subagents.
  • actions: Permet Ă  l'agent d'effectuer des actions prĂ©dĂ©finies.
  • context : Active la fonctionnalitĂ© « TĂ©lĂ©charger en tant que texte » dans le chat, ainsi que le « Contexte de fichier » pour les agents, permettant aux utilisateurs de tĂ©lĂ©charger des fichiers et de faire extraire leur contenu pour l'inclure directement dans la conversation.
  • skills : Active les Skills dans le panneau latĂ©ral, l'invocation manuelle via $, les skills invoquĂ©s par le modĂšle et les listes d'autorisation de skills pour les agents. Voir Skills.
  • tools : Accorde Ă  l'agent l'accĂšs Ă  divers outils.
  • chain : Active la fonctionnalitĂ© bĂȘta pour le chaĂźnage d'agents, Ă©galement connue sous le nom de flux de travail Mixture-of-Agents (MoA).
  • ocr : AmĂ©liore optionnellement « TĂ©lĂ©verser en tant que texte » dans le chat, ainsi que le « Contexte de fichier » pour les agents, permettant aux fichiers d'ĂȘtre tĂ©lĂ©versĂ©s et traitĂ©s avec l'OCR. NĂ©cessite la configuration d'un service OCR.

En spécifiant les capacités, vous pouvez contrÎler les fonctionnalités disponibles pour les utilisateurs lorsqu'ils interagissent avec des agents.

Exemple de configuration

Voici un exemple de configuration de l'endpoint agents avec des capacités personnalisées et des paramÚtres de citation de fichiers :

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'

Dans cet exemple :

  • L'interface du constructeur est activĂ©e
  • Les citations de fichiers sont limitĂ©es Ă  20 au total, avec un maximum de 5 par fichier.
  • Seules les sources ayant une pertinence de 60 % ou plus sont incluses
  • Les agents LibreChat ont accĂšs Ă  l'exĂ©cution de code, Ă  la recherche de fichiers (avec citations), aux Skills, aux Subagents, aux actions, aux artifacts, au contexte de fichier, aux services OCR s'ils sont configurĂ©s, ainsi qu'aux capacitĂ©s de recherche web.
  • L'appel d'outils programmatique reste dĂ©sactivĂ© Ă  moins que vous n'ajoutiez la capacitĂ© programmatic_tools en plus de execute_code

remoteApi

Configuration pour l'authentification de l'API Remote Agent. ContrĂŽle la maniĂšre dont les services externes s'authentifient lors de l'appel des endpoints de l'API Agents.

remoteApi.auth

KeyTypeDescriptionExample
authObjectConfiguration de l'authentification pour l'API Remote Agent.Supports API key and/or OIDC Bearer token authentication. If omitted, only API key auth is active.

remoteApi.auth.apiKey

KeyTypeDescriptionExample
enabledBooleanActiver l'authentification par clé API pour l'API Remote Agent.When true, requests with a valid LibreChat API key are accepted. Can be used alongside or instead of OIDC.

Par défaut : true

remoteApi.auth.oidc

KeyTypeDescriptionExample
enabledBooleanActiver l'authentification par jeton Bearer OIDC.When true, the middleware validates Bearer tokens against the configured OIDC issuer via JWKS.
issuerStringURL de l'émetteur 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 du endpoint JWKS. Optionnel.If omitted, resolved automatically via {issuer}/.well-known/openid-configuration. You can also set OPENID_JWKS_URL as an alternative.
audienceStringPublic cible du jeton attendu. Requis lorsque l'authentification OIDC est activée.Tokens must contain this value in their aud claim.
scopeStringValeur de portée requise. Optionnel.If set, the token must contain this value in its scp or scope claim. Use this to distinguish token intent across different APIs.

Par défaut : enabled: false

Exemple - OIDC uniquement :

endpoints:
  agents:
    remoteApi:
      auth:
        apiKey:
          enabled: false
        oidc:
          enabled: true
          issuer: https://auth.example.com/realms/myrealm
          audience: my-client-id

Exemple - OIDC avec repli sur clé 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

La priorité de résolution de l'URI JWKS est l'attribut explicite jwksUri, suivi de OPENID_JWKS_URL, puis de la découverte automatique via {issuer}/.well-known/openid-configuration.

La correspondance des utilisateurs OIDC utilise la revendication sub comme recherche principale, avec une solution de repli vers les revendications email, preferred_username ou upn. L'utilisateur correspondant doit déjà exister dans LibreChat.

Sous-agents

Le champ subagents contrÎle quels agents enfants isolés un agent parent peut générer lorsque la fonctionnalité subagents est disponible.

KeyTypeDescriptionExample
enabledBooleanAjoute l'outil de génération de sous-agent à cet agent lorsque défini sur true. Par défaut : désactivé.enabled: true
allowSelfBooleanPermet Ă  l'agent de se gĂ©nĂ©rer lui-mĂȘme dans un contexte isolĂ© et nouveau. Par dĂ©faut : true.allowSelf: true
agent_idsArray/List of StringsAgents spécifiques que cet agent peut générer. Maximum : 10.agent_ids: ["agent_researcher"]
subagents:
  enabled: true
  allowSelf: true
  agent_ids:
    - 'agent_researcher'
    - 'agent_reviewer'

Pour le comportement et les limites cÎté utilisateur, consultez Subagents.

Notes

  • Il n'est pas recommandĂ© de dĂ©sactiver l'interface du gĂ©nĂ©rateur Ă  moins que vous n'utilisiez modelSpecs pour dĂ©finir une liste d'agents parmi lesquels choisir.
  • La configuration des citations de fichiers (maxCitations, maxCitationsPerFile, minRelevanceScore) s'applique uniquement lorsque la fonctionnalitĂ© file_search est activĂ©e.
  • Le score de pertinence est calculĂ© en utilisant la similaritĂ© vectorielle, oĂč 1.0 reprĂ©sente une correspondance parfaite et 0.0 reprĂ©sente aucune similaritĂ©.
  • Les limites de citation aident Ă  Ă©quilibrer la rĂ©cupĂ©ration d'informations complĂštes avec la qualitĂ© et la performance des rĂ©ponses.
  • La fonctionnalitĂ© context fonctionne sans configuration OCR en utilisant des mĂ©thodes d'analyse de texte. L'OCR amĂ©liore la qualitĂ© de l'extraction lorsqu'il est configurĂ©.
  • La fonctionnalitĂ© ocr nĂ©cessite la configuration d'un service OCR (voir Configuration OCR).

Que pensez-vous de ce guide ?