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

Struttura dell'oggetto endpoint Agents

Questa pagina si applica all'endpoint agents.

Esempio

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

Questa configurazione abilita l'interfaccia di creazione per gli agenti.

recursionLimit

KeyTypeDescriptionExample
recursionLimitNumberImposta il numero predefinito di passaggi che un agente può eseguire in un'esecuzione.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.

Predefinito: 25

Esempio:

recursionLimit: 50

Per ulteriori informazioni sui passaggi dell'agente, consulta Max Agent Steps.

maxRecursionLimit

KeyTypeDescriptionExample
maxRecursionLimitNumberImposta il numero massimo assoluto di passaggi che un agente può eseguire in un'esecuzione.Defines the upper limit for the recursionLimit that can be set from the UI. This prevents users from setting excessively high values.

Predefinito: Se omesso, viene impostato sul valore di recursionLimit o su 50 se anche recursionLimit è omesso.

Esempio:

maxRecursionLimit: 100

Per ulteriori informazioni sui passaggi dell'agente, consulta Max Agent Steps.

titleTiming

KeyTypeDescriptionExample
titleTimingStringControlla quando vengono generati i titoli delle conversazioni per l'endpoint agents. Valori validi: "immediate" o "final".Defaults to "immediate".

Predefinito: "immediate"

Valori disponibili:

  • "immediate": Genera il titolo non appena la richiesta ha inizio, in parallelo con la risposta del modello, utilizzando il primo messaggio dell'utente.
  • "final": Posticipa la generazione del titolo fino al completamento della risposta completa. Questo preserva il comportamento legacy.

Esempio:

titleTiming: immediate

disableBuilder

KeyTypeDescriptionExample
disableBuilderBooleanControlla la visibilità e l'utilizzo dell'interfaccia builder per gli agenti.When set to `true`, disables the builder interface for the agent, limiting direct manual interaction.

Predefinito: false

Esempio:

disableBuilder: false

allowedProviders

KeyTypeDescriptionExample
allowedProvidersArray/List of StringsSpecifica un elenco di provider di endpoint (ad esempio, "openAI", "anthropic", "google") autorizzati all'uso con la funzionalità Agents.If defined, only agents configured with these providers can be initialized. If omitted or empty, all configured providers are allowed.

Predefinito: [] (lista vuota, tutti i provider consentiti)

Nota: Deve essere uno dei seguenti, o un nome di endpoint personalizzato come definito nella tua configurazione: - openAI, azureOpenAI, google, anthropic, assistants, azureAssistants, bedrock

Esempio:

allowedProviders:
  - openAI
  - google

capabilities

KeyTypeDescriptionExample
capabilitiesArray/List of StringsSpecifica le funzionalità dell'agente disponibili per tutti gli utenti per 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.

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

La chiamata a strumenti programmatica (Programmatic Tool Calling) è opzionale. Aggiungi programmatic_tools insieme a execute_code solo quando la tua distribuzione di Code Interpreter include il componente Tool Call Server.

Esempio:

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: Questo campo è facoltativo. Se omesso, il comportamento predefinito consiste nell'includere tutte le funzionalità elencate nel default.

skills

Controlla le impostazioni delle Skills a livello di endpoint per gli agenti.

KeyTypeDescriptionExample
skills.maxCatalogSkillsNumberLimita il numero di Skill accessibili attive esposte nel catalogo visibile al modello. Deve essere compreso tra 1 e 100.maxCatalogSkills: 20

Predefinito: Nessun limite configurato oltre al limite del catalogo di runtime.

Esempio:

skills:
  maxCatalogSkills: 20

Ciò non disabilita le Skills. Utilizza la funzionalità skills e l'ambito delle skill per singolo agente/Model Specs per controllare se le Skills sono disponibili.

maxCitations

KeyTypeDescriptionExample
maxCitationsNumberControlla il numero massimo totale di citazioni che possono essere incluse in una singola risposta dell'agente.When using file_search capability, limits the total number of source citations returned to prevent overwhelming responses while ensuring comprehensive coverage.

Predefinito: 30

Intervallo: 1-50

Esempio:

maxCitations: 30

maxCitationsPerFile

KeyTypeDescriptionExample
maxCitationsPerFileNumberLimita il numero massimo di citazioni che possono essere estratte da un singolo file.Ensures citation diversity by preventing any single file from dominating the citations, encouraging representation from multiple sources.

Predefinito: 7

Intervallo: 1-10

Esempio:

maxCitationsPerFile: 7

minRelevanceScore

KeyTypeDescriptionExample
minRelevanceScoreNumberImposta la soglia minima del punteggio di rilevanza affinché le fonti siano incluse nelle risposte.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.

Predefinito: 0.45 (soglia di rilevanza del 45%)

Intervallo: 0.0-1.0

Esempio:

minRelevanceScore: 0.45

Esempi di configurazione delle citazioni dei file

Configurazione predefinita (Bilanciata)

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

Fornisce citazioni complete evitando risposte eccessive e filtrando le corrispondenze di bassa qualità.

Configurazione rigorosa (Alta qualità)

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

Include solo citazioni altamente pertinenti con limiti rigorosi per risposte mirate.

Configurazione completa (Ricerca)

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

Estrazione massima di informazioni per attività di ricerca esaustive, includendo tutte le fonti indipendentemente dalla loro rilevanza.

Funzionalità degli Agent

Il campo capabilities ti consente di abilitare o disabilitare funzionalità specifiche per gli agenti. Le funzionalità disponibili sono:

  • deferred_tools: consente agli agenti di scoprire gli strumenti MCP differiti in fase di esecuzione invece di caricare ogni strumento nel contesto in anticipo.
  • programmatic_tools: Abilita la chiamata a strumenti programmatici (Programmatic Tool Calling) per gli strumenti MCP contrassegnati come Programmatic nel generatore di agenti (Agent Builder). Richiede execute_code e un deployment di Code Interpreter con il componente Tool Call Server. Questa funzionalità è facoltativa e non è abilitata per impostazione predefinita.
  • execute_code: Consente all'agente di eseguire codice.
  • file_search: Abilita l'agente a cercare e interagire con i file. Quando abilitato, il comportamento delle citazioni è controllato dalle impostazioni maxCitations, maxCitationsPerFile e minRelevanceScore.
  • web_search: Abilita la funzionalità di ricerca web per gli agenti, consentendo loro di cercare e recuperare informazioni da internet.
  • artifacts: Abilita l'agente a generare artefatti interattivi (componenti React, HTML, diagrammi Mermaid).
  • subagents: Abilita l'esecuzione di agenti secondari in contesti isolati. Vedi Subagents.
  • actions: Consente all'agente di eseguire azioni predefinite.
  • context: Abilita la funzionalità "Carica come testo" nella chat e il "Contesto file" per gli agenti, consentendo agli utenti di caricare file e far sì che il loro contenuto venga estratto e incluso direttamente nella conversazione.
  • skills: Abilita le Skills nel pannello laterale, l'invocazione manuale tramite $, le skills invocate dal modello e le allowlist delle skills per gli agenti. Vedi Skills.
  • tools: Concede all'agente l'accesso a vari strumenti.
  • chain: Abilita la funzionalità Beta per il concatenamento degli agenti, nota anche come flussi di lavoro Mixture-of-Agents (MoA).
  • ocr: Migliora facoltativamente "Carica come testo" nella chat e il "Contesto file" per gli agenti, consentendo ai file di essere caricati ed elaborati tramite OCR. Richiede la configurazione di un servizio OCR.

Specificando le funzionalità, puoi controllare le caratteristiche disponibili agli utenti quando interagiscono con gli agenti.

Esempio di configurazione

Ecco un esempio di configurazione dell'endpoint agents con funzionalità personalizzate e impostazioni di citazione dei file:

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 questo esempio:

  • L'interfaccia del builder è abilitata
  • Le citazioni dei file sono limitate a un totale di 20, con un massimo di 5 per file
  • Vengono incluse solo le fonti con una rilevanza pari o superiore al 60%
  • Gli agenti LibreChat hanno accesso all'esecuzione di codice, alla ricerca di file (con citazioni), a Skills, Subagents, azioni, artefatti, contesto dei file, servizi OCR se configurati e funzionalità di ricerca web.
  • Il Programmatic Tool Calling rimane disabilitato a meno che non si aggiunga la capability programmatic_tools insieme a execute_code

remoteApi

Configurazione per l'autenticazione dell'API Remote Agent. Controlla come i servizi esterni si autenticano quando chiamano gli endpoint dell'API Agents.

remoteApi.auth

KeyTypeDescriptionExample
authObjectConfigurazione dell'autenticazione per la Remote Agent API.Supports API key and/or OIDC Bearer token authentication. If omitted, only API key auth is active.

remoteApi.auth.apiKey

KeyTypeDescriptionExample
enabledBooleanAbilita l'autenticazione tramite chiave API per la Remote Agent API.When true, requests with a valid LibreChat API key are accepted. Can be used alongside or instead of OIDC.

Predefinito: true

remoteApi.auth.oidc

KeyTypeDescriptionExample
enabledBooleanAbilita l'autenticazione tramite token Bearer OIDC.When true, the middleware validates Bearer tokens against the configured OIDC issuer via JWKS.
issuerStringURL dell'issuer 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 dell'endpoint JWKS. Opzionale.If omitted, resolved automatically via {issuer}/.well-known/openid-configuration. You can also set OPENID_JWKS_URL as an alternative.
audienceStringPubblico del token previsto. Obbligatorio quando l'autenticazione OIDC è abilitata.Tokens must contain this value in their aud claim.
scopeStringValore di scope richiesto. Opzionale.If set, the token must contain this value in its scp or scope claim. Use this to distinguish token intent across different APIs.

Predefinito: enabled: false

Esempio - Solo OIDC:

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

Esempio - OIDC con fallback alla chiave 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à di risoluzione dell'URI JWKS è jwksUri esplicito, poi OPENID_JWKS_URL, e infine l'auto-discovery tramite {issuer}/.well-known/openid-configuration.

La corrispondenza utente OIDC utilizza il claim sub come ricerca primaria, con fallback ai claim email, preferred_username o upn. L'utente corrispondente deve già esistere in LibreChat.

Subagenti

Il campo subagents controlla quali agenti secondari isolati un agente principale può generare quando la funzionalità subagents è disponibile.

KeyTypeDescriptionExample
enabledBooleanAggiunge lo strumento di generazione di subagent a questo agente quando impostato su true. Predefinito: disabilitato.enabled: true
allowSelfBooleanConsente all'agente di generarsi in un nuovo contesto isolato. Predefinito: true.allowSelf: true
agent_idsArray/List of StringsAgenti specifici che questo agente può generare. Massimo: 10.agent_ids: ["agent_researcher"]
subagents:
  enabled: true
  allowSelf: true
  agent_ids:
    - 'agent_researcher'
    - 'agent_reviewer'

Per il comportamento e i limiti rivolti all'utente, consulta Subagents.

Note

  • Non è consigliato disabilitare l'interfaccia del builder a meno che non si stiano utilizzando i modelSpecs per definire un elenco di agenti tra cui scegliere.
  • La configurazione delle citazioni dei file (maxCitations, maxCitationsPerFile, minRelevanceScore) si applica solo quando la funzionalità file_search è abilitata.
  • Il punteggio di rilevanza viene calcolato utilizzando la similarità vettoriale, dove 1.0 rappresenta una corrispondenza perfetta e 0.0 rappresenta nessuna similarità.
  • I limiti di citazione aiutano a bilanciare il recupero completo delle informazioni con la qualità e le prestazioni della risposta.
  • La funzionalità context funziona senza configurazione OCR utilizzando metodi di analisi del testo. L'OCR migliora la qualità dell'estrazione quando configurato.
  • La funzionalità ocr richiede che sia configurato un servizio OCR (vedi Configurazione OCR).

Com’è questa guida?