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

Structuur van het Agents endpoint-object

Deze pagina is van toepassing op het agents endpoint.

Voorbeeld

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

Deze configuratie schakelt de builder-interface voor agents in.

recursionLimit

KeyTypeDescriptionExample
recursionLimitNumberStelt het standaard aantal stappen in dat een agent kan zetten in een run.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.

Standaard: 25

Voorbeeld:

recursionLimit: 50

Voor meer informatie over agent-stappen, zie Max Agent Steps.

maxRecursionLimit

KeyTypeDescriptionExample
maxRecursionLimitNumberStelt het absolute maximum aantal stappen in dat een agent kan zetten in een run.Defines the upper limit for the recursionLimit that can be set from the UI. This prevents users from setting excessively high values.

Standaard: Indien weggelaten, wordt standaard de waarde van recursionLimit gebruikt, of 50 als recursionLimit ook is weggelaten.

Voorbeeld:

maxRecursionLimit: 100

Voor meer informatie over agent-stappen, zie Max Agent Steps.

titleTiming

KeyTypeDescriptionExample
titleTimingStringBepaalt wanneer gesprektitels worden gegenereerd voor het agents endpoint. Geldige waarden: "immediate" of "final".Defaults to "immediate".

Standaard: "immediate"

Beschikbare waarden:

  • "immediate": Genereert de titel zodra het verzoek start, parallel aan het antwoord van het model, met behulp van het eerste bericht van de gebruiker.
  • "final": Stelt het genereren van de titel uit totdat het volledige antwoord is voltooid. Dit behoudt het legacy-gedrag.

Voorbeeld:

titleTiming: immediate

disableBuilder

KeyTypeDescriptionExample
disableBuilderBooleanBeheert de zichtbaarheid en het gebruik van de builder-interface voor agents.When set to `true`, disables the builder interface for the agent, limiting direct manual interaction.

Standaard: false

Voorbeeld:

disableBuilder: false

allowedProviders

KeyTypeDescriptionExample
allowedProvidersArray/List of StringsSpecificeert een lijst met endpoint providers (bijv. "openAI", "anthropic", "google") die zijn toegestaan voor gebruik met de Agents-functie.If defined, only agents configured with these providers can be initialized. If omitted or empty, all configured providers are allowed.

Standaard: [] (lege lijst, alle providers toegestaan)

Let op: Moet een van de volgende zijn, of een aangepaste endpoint-naam zoals gedefinieerd in uw configuratie: - openAI, azureOpenAI, google, anthropic, assistants, azureAssistants, bedrock

Voorbeeld:

allowedProviders:
  - openAI
  - google

capabilities

KeyTypeDescriptionExample
capabilitiesArray/List of StringsSpecificeert de agent-mogelijkheden die beschikbaar zijn voor alle gebruikers voor het 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.

Standaard: ["deferred_tools", "execute_code", "file_search", "web_search", "artifacts", "subagents", "actions", "context", "skills", "tools", "chain", "ocr"]

Programmatic Tool Calling is opt-in. Voeg programmatic_tools toe naast execute_code alleen wanneer jouw Code Interpreter-implementatie de Tool Call Server-component bevat.

Voorbeeld:

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'

Let op: Dit veld is optioneel. Indien weggelaten, is het standaardgedrag om alle mogelijkheden op te nemen die in de standaard worden vermeld.

skills

Beheert endpoint-level Skills-instellingen voor agents.

KeyTypeDescriptionExample
skills.maxCatalogSkillsNumberBeperkt het aantal actieve toegankelijke Skills die worden blootgesteld in de voor het model zichtbare catalogus. Moet tussen 1 en 100 liggen.maxCatalogSkills: 20

Standaard: Geen geconfigureerde limiet buiten de runtime cataloguslimiet.

Voorbeeld:

skills:
  maxCatalogSkills: 20

Dit schakelt Skills niet uit. Gebruik de skills capability en per-agent/model-spec skill scoping om te bepalen of Skills beschikbaar zijn.

maxCitations

KeyTypeDescriptionExample
maxCitationsNumberBeheert het maximale totaal aantal citaten dat in één enkel agent-antwoord kan worden opgenomen.When using file_search capability, limits the total number of source citations returned to prevent overwhelming responses while ensuring comprehensive coverage.

Standaard: 30

Bereik: 1-50

Voorbeeld:

maxCitations: 30

maxCitationsPerFile

KeyTypeDescriptionExample
maxCitationsPerFileNumberBeperkt het maximale aantal citaten dat uit een enkel bestand kan worden geëxtraheerd.Ensures citation diversity by preventing any single file from dominating the citations, encouraging representation from multiple sources.

Standaard: 7

Bereik: 1-10

Voorbeeld:

maxCitationsPerFile: 7

minRelevanceScore

KeyTypeDescriptionExample
minRelevanceScoreNumberStelt de minimale relevantiescore-drempel in voor bronnen die in antwoorden moeten worden opgenomen.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.

Standaard: 0.45 (45% relevantiedrempel)

Bereik: 0.0-1.0

Voorbeeld:

minRelevanceScore: 0.45

Voorbeelden van configuratie voor bestandscitatie

Standaardconfiguratie (Gebalanceerd)

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

Biedt uitgebreide bronvermeldingen terwijl overvolle antwoorden worden voorkomen en resultaten van lage kwaliteit worden gefilterd.

Strikte configuratie (Hoge kwaliteit)

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

Bevat alleen zeer relevante bronvermeldingen met strikte limieten voor gerichte antwoorden.

Uitgebreide configuratie (Onderzoek)

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

Maximale informatie-extractie voor uitgebreide onderzoekstaken, inclusief alle bronnen, ongeacht de relevantie.

Agent-mogelijkheden

Het capabilities veld stelt je in staat om specifieke functionaliteiten voor agents in of uit te schakelen. De beschikbare capabilities zijn:

  • deferred_tools: Hiermee kunnen agents deferred MCP-tools ontdekken tijdens runtime in plaats van elke tool vooraf in de context te laden.
  • programmatic_tools: Schakelt Programmatic Tool Calling in voor MCP-tools die in de Agent Builder als Programmatic zijn gemarkeerd. Vereist execute_code en een Code Interpreter-implementatie met de Tool Call Server-component. Deze mogelijkheid is opt-in en is standaard niet ingeschakeld.
  • execute_code: Staat de agent toe om code uit te voeren.
  • file_search: Stelt de agent in staat om bestanden te doorzoeken en ermee te werken. Wanneer ingeschakeld, wordt het gedrag van citaten beheerd door de instellingen maxCitations, maxCitationsPerFile en minRelevanceScore.
  • web_search: Schakelt webzoekfunctionaliteit in voor agents, waardoor ze informatie van het internet kunnen zoeken en ophalen.
  • artifacts: Hiermee kan de agent interactieve artifacts genereren (React-componenten, HTML, Mermaid-diagrammen).
  • subagents: Maakt geïsoleerde context-child agent runs mogelijk. Zie Subagents.
  • actions: Staat de agent toe om vooraf gedefinieerde acties uit te voeren.
  • context: Schakelt de "Upload als tekst"-functionaliteit in de chat in, evenals "Bestandscontext" voor agents, waardoor gebruikers bestanden kunnen uploaden en de inhoud ervan kunnen laten extraheren en direct in het gesprek kunnen opnemen.
  • skills: Schakelt Skills in in het zijpaneel, handmatige $ aanroepen, door modellen aangeroepen skills en allowlists voor agent-skills. Zie Skills.
  • tools: Geeft de agent toegang tot verschillende tools.
  • chain: Schakelt de bètafunctie in voor agent-chaining, ook wel bekend als Mixture-of-Agents (MoA) workflows.
  • ocr: Verbetert optioneel "Uploaden als tekst" in de chat en "Bestandscontext" voor agents, waardoor bestanden kunnen worden geüpload en verwerkt met OCR. Vereist dat een OCR-service is geconfigureerd.

Door de mogelijkheden (capabilities) te specificeren, kun je de functies beheren die beschikbaar zijn voor gebruikers wanneer zij met agents communiceren.

Voorbeeldconfiguratie

Hier is een voorbeeld van het configureren van de agents endpoint met aangepaste mogelijkheden en instellingen voor bestandscitatie:

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'

In dit voorbeeld:

  • De builder interface is ingeschakeld
  • Bestandscitaties zijn beperkt tot in totaal 20, met een maximum van 5 per bestand
  • Alleen bronnen met 60%+ relevantie worden opgenomen
  • LibreChat Agents hebben toegang tot code-uitvoering, bestandszoekopdrachten (met bronvermeldingen), Skills, Subagents, actions, artifacts, bestandscontext, ocr-services indien geconfigureerd, en webzoekmogelijkheden.
  • Programmatic Tool Calling blijft uitgeschakeld tenzij je de programmatic_tools capability toevoegt naast execute_code

remoteApi

Configuratie voor Remote Agent API-authenticatie. Bepaalt hoe externe services zich authenticeren bij het aanroepen van de Agents API-endpoints.

remoteApi.auth

KeyTypeDescriptionExample
authObjectAuthenticatieconfiguratie voor de Remote Agent API.Supports API key and/or OIDC Bearer token authentication. If omitted, only API key auth is active.

remoteApi.auth.apiKey

KeyTypeDescriptionExample
enabledBooleanSchakel API-sleutelauthenticatie in voor de Remote Agent API.When true, requests with a valid LibreChat API key are accepted. Can be used alongside or instead of OIDC.

Standaard: true

remoteApi.auth.oidc

KeyTypeDescriptionExample
enabledBooleanSchakel OIDC Bearer token-authenticatie in.When true, the middleware validates Bearer tokens against the configured OIDC issuer via JWKS.
issuerStringOIDC issuer URL.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.
jwksUriStringJWKS endpoint URL. Optioneel.If omitted, resolved automatically via {issuer}/.well-known/openid-configuration. You can also set OPENID_JWKS_URL as an alternative.
audienceStringVerwachte token-doelgroep. Vereist wanneer OIDC-authenticatie is ingeschakeld.Tokens must contain this value in their aud claim.
scopeStringVereiste scope-waarde. Optioneel.If set, the token must contain this value in its scp or scope claim. Use this to distinguish token intent across different APIs.

Standaard: enabled: false

Voorbeeld - Alleen OIDC:

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

Voorbeeld - OIDC met API-sleutel fallback:

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

De prioriteit voor JWKS URI-resolutie is expliciet jwksUri, daarna OPENID_JWKS_URL, en vervolgens automatische detectie via {issuer}/.well-known/openid-configuration.

OIDC-gebruikerskoppeling gebruikt de sub claim als primaire opzoekmethode, met een fallback naar email, preferred_username of upn claims. De gekoppelde gebruiker moet al bestaan in LibreChat.

Subagents

Het subagents veld bepaalt welke geïsoleerde sub-agents een parent-agent kan aanmaken wanneer de subagents functionaliteit beschikbaar is.

KeyTypeDescriptionExample
enabledBooleanVoegt de subagent spawn tool toe aan deze agent wanneer true. Standaard: uitgeschakeld.enabled: true
allowSelfBooleanStelt de agent in staat om zichzelf in een nieuwe, geïsoleerde context te starten. Standaard: true.allowSelf: true
agent_idsArray/List of StringsSpecifieke agents die deze agent mag aanmaken. Maximum: 10.agent_ids: ["agent_researcher"]
subagents:
  enabled: true
  allowSelf: true
  agent_ids:
    - 'agent_researcher'
    - 'agent_reviewer'

Voor gebruikersgericht gedrag en limieten, zie Subagents.

Opmerkingen

  • Het wordt niet aanbevolen om de builder-interface uit te schakelen, tenzij je modelSpecs gebruikt om een lijst met agents te definiëren waaruit gekozen kan worden.
  • De configuratie voor bestandscitatie (maxCitations, maxCitationsPerFile, minRelevanceScore) is alleen van toepassing wanneer de file_search capability is ingeschakeld.
  • De relevantiescore wordt berekend met behulp van vectorsimilariteit, waarbij 1.0 een perfecte match vertegenwoordigt en 0.0 geen enkele gelijkenis.
  • Citatielimieten helpen bij het balanceren van uitgebreide informatieverzameling met de kwaliteit en prestaties van het antwoord.
  • De context functionaliteit werkt zonder OCR-configuratie door gebruik te maken van tekst-parsingmethoden. OCR verbetert de extractiekwaliteit wanneer dit geconfigureerd is.
  • De ocr functionaliteit vereist dat een OCR-service wordt geconfigureerd (zie OCR Configuration).

Hoe is deze gids?