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

Struktur des Agents Endpoint-Objekts

Diese Seite gilt für den agents endpoint.

Beispiel

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

Diese Konfiguration aktiviert die Builder-Oberfläche für Agents.

recursionLimit

KeyTypeDescriptionExample
recursionLimitNumberLegt die Standardanzahl der Schritte fest, die ein Agent in einem Durchlauf ausführen kann.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.

Standard: 25

Beispiel:

recursionLimit: 50

Weitere Informationen zu Agent-Schritten finden Sie unter Max Agent Steps.

maxRecursionLimit

KeyTypeDescriptionExample
maxRecursionLimitNumberLegt die absolute Höchstanzahl an Schritten fest, die ein Agent in einem Durchlauf ausführen kann.Defines the upper limit for the recursionLimit that can be set from the UI. This prevents users from setting excessively high values.

Standard: Falls weggelassen, wird standardmäßig der Wert von recursionLimit verwendet oder 50, falls recursionLimit ebenfalls weggelassen wurde.

Beispiel:

maxRecursionLimit: 100

Weitere Informationen zu Agent-Schritten finden Sie unter Max Agent Steps.

titleTiming

KeyTypeDescriptionExample
titleTimingStringSteuert, wann Konversationstitel für den agents endpoint generiert werden. Gültige Werte: "immediate" oder "final".Defaults to "immediate".

Standard: "immediate"

Verfügbare Werte:

  • "immediate": Generiert den Titel, sobald die Anfrage beginnt, parallel zur Antwort des Modells, unter Verwendung der ersten Nachricht des Benutzers.
  • "final": Stellt die Titelgenerierung zurück, bis die vollständige Antwort abgeschlossen ist. Dies bewahrt das ursprüngliche Verhalten.

Beispiel:

titleTiming: immediate

disableBuilder

KeyTypeDescriptionExample
disableBuilderBooleanSteuert die Sichtbarkeit und Nutzung der Builder-Oberfläche für Agents.When set to `true`, disables the builder interface for the agent, limiting direct manual interaction.

Standard: false

Beispiel:

disableBuilder: false

allowedProviders

KeyTypeDescriptionExample
allowedProvidersArray/List of StringsGibt eine Liste von endpoint-Anbietern (z. B. "openAI", "anthropic", "google") an, die für die Verwendung mit der Agents-Funktion zulässig sind.If defined, only agents configured with these providers can be initialized. If omitted or empty, all configured providers are allowed.

Standard: [] (leere Liste, alle Anbieter erlaubt)

Hinweis: Muss einer der folgenden Werte sein oder ein benutzerdefinierter endpoint-Name, wie in Ihrer Konfiguration definiert: - openAI, azureOpenAI, google, anthropic, assistants, azureAssistants, bedrock

Beispiel:

allowedProviders:
  - openAI
  - google

capabilities

KeyTypeDescriptionExample
capabilitiesArray/List of StringsLegt die Agent-Funktionen fest, die allen Benutzern für den agents endpoint zur Verfügung stehen.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.

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

Programmatic Tool Calling ist optional. Fügen Sie programmatic_tools neben execute_code nur dann hinzu, wenn Ihre Code Interpreter-Bereitstellung die Tool Call Server-Komponente enthält.

Beispiel:

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'

Hinweis: Dieses Feld ist optional. Wenn es weggelassen wird, besteht das Standardverhalten darin, alle Funktionen einzubeziehen, die in der Standardeinstellung aufgeführt sind.

skills

Steuert die Skills-Einstellungen auf Endpoint-Ebene für Agents.

KeyTypeDescriptionExample
skills.maxCatalogSkillsNumberBegrenzt die Anzahl der aktiven, zugänglichen Skills, die im für das Modell sichtbaren Katalog angezeigt werden. Muss zwischen 1 und 100 liegen.maxCatalogSkills: 20

Standard: Kein konfiguriertes Limit über das Laufzeit-Kataloglimit hinaus.

Beispiel:

skills:
  maxCatalogSkills: 20

Dies deaktiviert nicht die Skills. Verwenden Sie die skills capability und die Skill-Eingrenzung pro Agent/Model Specs, um zu steuern, ob Skills verfügbar sind.

maxCitations

KeyTypeDescriptionExample
maxCitationsNumberSteuert die maximale Gesamtzahl an Zitaten, die in einer einzelnen Agentenantwort enthalten sein können.When using file_search capability, limits the total number of source citations returned to prevent overwhelming responses while ensuring comprehensive coverage.

Standard: 30

Bereich: 1-50

Beispiel:

maxCitations: 30

maxCitationsPerFile

KeyTypeDescriptionExample
maxCitationsPerFileNumberBegrenzt die maximale Anzahl an Zitaten, die aus einer einzelnen Datei extrahiert werden können.Ensures citation diversity by preventing any single file from dominating the citations, encouraging representation from multiple sources.

Standard: 7

Bereich: 1-10

Beispiel:

maxCitationsPerFile: 7

minRelevanceScore

KeyTypeDescriptionExample
minRelevanceScoreNumberLegt den Mindestwert für die Relevanzbewertung von Quellen fest, die in Antworten einbezogen werden sollen.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.

Standard: 0.45 (45% Relevanz-Schwellenwert)

Bereich: 0.0-1.0

Beispiel:

minRelevanceScore: 0.45

Beispiele für die Konfiguration von Dateizitaten

Standardkonfiguration (Ausgewogen)

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

Bietet umfassende Zitate, verhindert gleichzeitig übermäßig lange Antworten und filtert minderwertige Übereinstimmungen heraus.

Strenge Konfiguration (Hohe Qualität)

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

Enthält nur hochrelevante Zitate mit strikten Begrenzungen für fokussierte Antworten.

Umfassende Konfiguration (Recherche)

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

Maximale Informationsgewinnung für umfassende Rechercheaufgaben, einschließlich aller Quellen, unabhängig von ihrer Relevanz.

Agent-Funktionen

Das Feld capabilities ermöglicht es Ihnen, spezifische Funktionalitäten für Agents zu aktivieren oder zu deaktivieren. Die verfügbaren Funktionen sind:

  • deferred_tools: Ermöglicht es Agenten, verzögerte MCP-Tools zur Laufzeit zu entdecken, anstatt jedes Tool vorab in den Kontext zu laden.
  • programmatic_tools: Aktiviert den programmatischen Tool-Aufruf (Programmatic Tool Calling) für MCP-Tools, die im Agent Builder als Programmatic markiert sind. Erfordert execute_code und eine Code Interpreter-Bereitstellung mit der Tool Call Server-Komponente. Diese Funktion ist optional und standardmäßig nicht aktiviert.
  • execute_code: Ermöglicht dem Agenten, Code auszuführen.
  • file_search: Ermöglicht dem Agenten, Dateien zu durchsuchen und mit ihnen zu interagieren. Wenn diese Funktion aktiviert ist, wird das Zitierverhalten durch die Einstellungen maxCitations, maxCitationsPerFile und minRelevanceScore gesteuert.
  • web_search: Aktiviert die Websuchfunktion für Agents, wodurch diese Informationen aus dem Internet suchen und abrufen können.
  • artifacts: Ermöglicht es dem Agenten, interaktive Artefakte (React-Komponenten, HTML, Mermaid-Diagramme) zu generieren.
  • subagents: Ermöglicht isolierte Child-Agent-Ausführungen mit eigenem Kontext. Siehe Subagents.
  • actions: Erlaubt dem Agenten, vordefinierte Aktionen auszuführen.
  • context: Aktiviert die Funktion „Als Text hochladen“ im Chat sowie den „Dateikontext“ für Agents, wodurch Benutzer Dateien hochladen können, deren Inhalt extrahiert und direkt in die Konversation einbezogen wird.
  • skills: Aktiviert Skills in der Seitenleiste, manuelle $-Aufrufe, von Modellen aufgerufene Skills und Agent-Skill-Allowlists. Siehe Skills.
  • tools: Gewährt dem Agenten Zugriff auf verschiedene Tools.
  • chain: Aktiviert die Beta-Funktion für Agent-Chaining, auch bekannt als Mixture-of-Agents (MoA)-Workflows.
  • ocr: Verbessert optional „Als Text hochladen“ im Chat sowie den „Dateikontext“ für Agents, wodurch Dateien hochgeladen und mittels OCR verarbeitet werden können. Erfordert die Konfiguration eines OCR-Dienstes.

Durch die Angabe der capabilities können Sie die Funktionen steuern, die Benutzern bei der Interaktion mit Agents zur Verfügung stehen.

Beispielkonfiguration

Hier ist ein Beispiel für die Konfiguration des agents endpoint mit benutzerdefinierten Fähigkeiten und Einstellungen für Dateizitate:

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 diesem Beispiel:

  • Die Builder-Schnittstelle ist aktiviert
  • Dateizitate sind auf insgesamt 20 begrenzt, mit maximal 5 pro Datei
  • Nur Quellen mit einer Relevanz von 60%+ werden einbezogen
  • LibreChat Agents haben Zugriff auf Code-Ausführung, Dateisuche (mit Zitaten), Skills, Subagents, Aktionen, Artefakte, Dateikontext, OCR-Dienste (sofern konfiguriert) sowie Web-Suchfunktionen.
  • Programmatic Tool Calling bleibt deaktiviert, es sei denn, Sie fügen die programmatic_tools Capability zusammen mit execute_code hinzu.

remoteApi

Konfiguration für die Authentifizierung der Remote Agent API. Steuert, wie sich externe Dienste authentifizieren, wenn sie die Agents API-Endpunkte aufrufen.

remoteApi.auth

KeyTypeDescriptionExample
authObjectAuthentifizierungskonfiguration für die Remote Agent API.Supports API key and/or OIDC Bearer token authentication. If omitted, only API key auth is active.

remoteApi.auth.apiKey

KeyTypeDescriptionExample
enabledBooleanAktiviere die API-Schlüssel-Authentifizierung für die Remote Agent API.When true, requests with a valid LibreChat API key are accepted. Can be used alongside or instead of OIDC.

Standard: true

remoteApi.auth.oidc

KeyTypeDescriptionExample
enabledBooleanOIDC Bearer-Token-Authentifizierung aktivieren.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. Optional.If omitted, resolved automatically via {issuer}/.well-known/openid-configuration. You can also set OPENID_JWKS_URL as an alternative.
audienceStringErwartete Token-Zielgruppe. Erforderlich, wenn OIDC-Authentifizierung aktiviert ist.Tokens must contain this value in their aud claim.
scopeStringErforderlicher Scope-Wert. Optional.If set, the token must contain this value in its scp or scope claim. Use this to distinguish token intent across different APIs.

Standard: enabled: false

Beispiel - Nur OIDC:

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

Beispiel - OIDC mit API-Key-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

Die Priorität bei der Auflösung des JWKS URI ist explizit jwksUri, dann OPENID_JWKS_URL, und schließlich die automatische Erkennung über {issuer}/.well-known/openid-configuration.

Die OIDC-Benutzerzuordnung verwendet den sub-Claim als primäre Suche, mit Fallback auf die Claims email, preferred_username oder upn. Der zugeordnete Benutzer muss bereits in LibreChat existieren.

Subagents

Das Feld subagents steuert, welche isolierten untergeordneten Agenten ein übergeordneter Agent erstellen kann, wenn die Funktion subagents verfügbar ist.

KeyTypeDescriptionExample
enabledBooleanFügt diesem Agenten das Subagent-Spawn-Tool hinzu, wenn auf true gesetzt. Standard: deaktiviert.enabled: true
allowSelfBooleanErlaubt es dem Agenten, sich selbst in einem neuen, isolierten Kontext zu starten. Standard: true.allowSelf: true
agent_idsArray/List of StringsSpezifische Agents, die dieser Agent erstellen kann. Maximum: 10.agent_ids: ["agent_researcher"]
subagents:
  enabled: true
  allowSelf: true
  agent_ids:
    - 'agent_researcher'
    - 'agent_reviewer'

Für benutzerseitiges Verhalten und Limits siehe Subagents.

Hinweise

  • Es wird nicht empfohlen, das Builder-Interface zu deaktivieren, es sei denn, Sie verwenden modelSpecs, um eine Liste von Agents zu definieren, aus denen ausgewählt werden kann.
  • Die Konfiguration für Dateizitate (maxCitations, maxCitationsPerFile, minRelevanceScore) gilt nur, wenn die file_search-Funktion aktiviert ist.
  • Der Relevanz-Score wird mithilfe von Vektorähnlichkeit berechnet, wobei 1.0 eine perfekte Übereinstimmung und 0.0 keine Ähnlichkeit darstellt.
  • Zitierlimits helfen dabei, ein Gleichgewicht zwischen umfassender Informationsbeschaffung sowie Antwortqualität und Leistung zu finden.
  • Die context-Funktion funktioniert ohne OCR-Konfiguration mithilfe von Text-Parsing-Methoden. OCR verbessert die Extraktionsqualität, wenn es konfiguriert ist.
  • Die ocr Funktion erfordert die Konfiguration eines OCR-Dienstes (siehe OCR Configuration).

Wie finden Sie diese Anleitung?