Struktura obiektu endpointu Agents

Ta strona dotyczy endpointu agents.

Przykład

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

Ta konfiguracja włącza interfejs kreatora dla agentów.

recursionLimit

Key	Type	Description	Example
recursionLimit	Number	Ustawia domyślną liczbę kroków, które agent może wykonać w ramach jednego uruchomienia.	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.

Domyślnie: 25

Przykład:

recursionLimit: 50

Aby uzyskać więcej informacji na temat kroków agenta, zobacz Max Agent Steps.

maxRecursionLimit

Key	Type	Description	Example
maxRecursionLimit	Number	Określa bezwzględną maksymalną liczbę kroków, jakie agent może wykonać w ramach jednego uruchomienia.	Defines the upper limit for the recursionLimit that can be set from the UI. This prevents users from setting excessively high values.

Domyślnie: Jeśli zostanie pominięte, przyjmuje wartość recursionLimit lub 50, jeśli recursionLimit również zostanie pominięty.

Przykład:

maxRecursionLimit: 100

Aby uzyskać więcej informacji na temat kroków agenta, zobacz Max Agent Steps.

titleTiming

Key	Type	Description	Example
titleTiming	String	Określa, kiedy generowane są tytuły konwersacji dla endpointu agents. Prawidłowe wartości: "immediate" lub "final".	Defaults to "immediate".

Domyślnie: "immediate"

Dostępne wartości:

"immediate": Generuje tytuł natychmiast po rozpoczęciu żądania, równolegle z odpowiedzią modelu, używając pierwszej wiadomości użytkownika.
"final": Odracza generowanie tytułu do momentu zakończenia pełnej odpowiedzi. Zachowuje to starsze zachowanie (legacy behavior).

Przykład:

titleTiming: immediate

disableBuilder

Key	Type	Description	Example
disableBuilder	Boolean	Kontroluje widoczność i użycie interfejsu kreatora dla agentów.	When set to `true`, disables the builder interface for the agent, limiting direct manual interaction.

Domyślnie: false

Przykład:

disableBuilder: false

allowedProviders

Key	Type	Description	Example
allowedProviders	Array/List of Strings	Określa listę dostawców endpoint (np. "openAI", "anthropic", "google"), którzy są dozwoleni do użytku z funkcją Agents.	If defined, only agents configured with these providers can be initialized. If omitted or empty, all configured providers are allowed.

Domyślnie: [] (pusta lista, wszyscy dostawcy dozwoleni)

Uwaga: Musi to być jedna z poniższych wartości lub niestandardowa nazwa endpointu zdefiniowana w Twojej konfiguracji: - openAI, azureOpenAI, google, anthropic, assistants, azureAssistants, bedrock

Przykład:

allowedProviders:
  - openAI
  - google

capabilities

Key	Type	Description	Example
capabilities	Array/List of Strings	Określa możliwości agenta dostępne dla wszystkich użytkowników dla endpointu 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.

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

Programmatic Tool Calling jest opcjonalne. Dodaj programmatic_tools obok execute_code tylko wtedy, gdy Twoje wdrożenie Code Interpreter zawiera komponent Tool Call Server.

Przykład:

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'

Uwaga: To pole jest opcjonalne. Jeśli zostanie pominięte, domyślnym zachowaniem jest uwzględnienie wszystkich możliwości wymienionych w wartości domyślnej.

skills

Kontroluje ustawienia Umiejętności (Skills) na poziomie endpoint dla agentów.

Key	Type	Description	Example
skills.maxCatalogSkills	Number	Ogranicza liczbę aktywnych, dostępnych umiejętności (Skills) widocznych w katalogu modelu. Musi wynosić od 1 do 100.	maxCatalogSkills: 20

Domyślnie: Brak skonfigurowanego limitu poza limitem katalogu środowiska uruchomieniowego.

Przykład:

skills:
  maxCatalogSkills: 20

To nie wyłącza Skills. Użyj możliwości skills oraz zakresu umiejętności dla poszczególnych agentów/Model Specs, aby kontrolować, czy Skills są dostępne.

maxCitations

Key	Type	Description	Example
maxCitations	Number	Określa maksymalną łączną liczbę cytowań, które mogą zostać zawarte w pojedynczej odpowiedzi agenta.	When using file_search capability, limits the total number of source citations returned to prevent overwhelming responses while ensuring comprehensive coverage.

Domyślnie: 30

Zakres: 1-50

Przykład:

maxCitations: 30

maxCitationsPerFile

Key	Type	Description	Example
maxCitationsPerFile	Number	Ogranicza maksymalną liczbę cytatów, które mogą zostać wyodrębnione z pojedynczego pliku.	Ensures citation diversity by preventing any single file from dominating the citations, encouraging representation from multiple sources.

Domyślnie: 7

Zakres: 1-10

Przykład:

maxCitationsPerFile: 7

minRelevanceScore

Key	Type	Description	Example
minRelevanceScore	Number	Ustawia minimalny próg wyniku istotności dla źródeł, które mają zostać uwzględnione w odpowiedziach.	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.

Domyślnie: 0.45 (próg istotności 45%)

Zakres: 0.0-1.0

Przykład:

minRelevanceScore: 0.45

Przykłady konfiguracji cytowania plików

Domyślna konfiguracja (zrównoważona)

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

Zapewnia kompleksowe cytowania, jednocześnie zapobiegając zbyt obszernym odpowiedziom i odfiltrowując niskiej jakości dopasowania.

Ścisła konfiguracja (wysoka jakość)

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

Uwzględnia tylko wysoce istotne cytaty z rygorystycznymi limitami dla uzyskania skoncentrowanych odpowiedzi.

Kompleksowa konfiguracja (Badania)

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

Maksymalna ekstrakcja informacji dla wyczerpujących zadań badawczych, obejmująca wszystkie źródła niezależnie od ich istotności.

Możliwości agenta

Pole capabilities pozwala na włączanie lub wyłączanie określonych funkcjonalności dla agentów. Dostępne możliwości to:

deferred_tools: Pozwala agentom na wykrywanie odroczonych narzędzi MCP w czasie wykonywania (runtime), zamiast ładowania każdego narzędzia do kontekstu z wyprzedzeniem.
programmatic_tools: Włącza programowe wywoływanie narzędzi (Programmatic Tool Calling) dla narzędzi MCP oznaczonych jako Programmatic w kreatorze agentów (Agent Builder). Wymaga execute_code oraz wdrożenia interpretera kodu (Code Interpreter) z komponentem serwera wywołań narzędzi (Tool Call Server). Ta funkcja jest opcjonalna i nie jest domyślnie włączona.
execute_code: Pozwala agentowi na wykonywanie kodu.
file_search: Umożliwia agentowi przeszukiwanie plików i interakcję z nimi. Po włączeniu, zachowanie cytowań jest kontrolowane przez ustawienia maxCitations, maxCitationsPerFile oraz minRelevanceScore.
web_search: Włącza funkcjonalność wyszukiwania w sieci dla agentów, umożliwiając im przeszukiwanie i pobieranie informacji z internetu.
artifacts: Umożliwia agentowi generowanie interaktywnych artefaktów (komponenty React, HTML, diagramy Mermaid).
subagents: Umożliwia uruchamianie agentów podrzędnych w izolowanym kontekście. Zobacz Subagents.
actions: Pozwala agentowi na wykonywanie zdefiniowanych wcześniej akcji.
context: Włącza funkcjonalność „Prześlij jako tekst” (Upload as Text) na czacie oraz „Kontekst pliku” (File Context) dla agentów, umożliwiając użytkownikom przesyłanie plików, których zawartość jest wyodrębniana i dołączana bezpośrednio do konwersacji.
skills: Włącza Skills w panelu bocznym, ręczne wywołanie za pomocą $, umiejętności wywoływane przez model oraz listy dozwolonych umiejętności agenta. Zobacz Skills.
tools: Przyznaje agentowi dostęp do różnych narzędzi.
chain: Włącza funkcję beta dla łańcuchowania agentów (ang. agent chaining), znaną również jako przepływy pracy Mixture-of-Agents (MoA).
ocr: Opcjonalnie ulepsza funkcję „Prześlij jako tekst” (Upload as Text) na czacie oraz „Kontekst pliku” (File Context) dla agentów, umożliwiając przesyłanie i przetwarzanie plików za pomocą OCR. Wymaga skonfigurowania usługi OCR.

Określając możliwości (capabilities), możesz kontrolować funkcje dostępne dla użytkowników podczas interakcji z agentami.

Przykładowa konfiguracja

Oto przykład konfiguracji endpointu agents z niestandardowymi możliwościami (capabilities) oraz ustawieniami cytowania plików:

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'

W tym przykładzie:

Interfejs kreatora jest włączony
Cytowania plików są ograniczone do łącznie 20, z maksymalnie 5 na plik
Uwzględniane są tylko źródła o trafności 60%+
Agenci LibreChat mają dostęp do wykonywania kodu, wyszukiwania plików (z cytowaniami), umiejętności (Skills), podagentów (Subagents), akcji, artefaktów, kontekstu plików, usług OCR (jeśli są skonfigurowane) oraz możliwości wyszukiwania w sieci.
Programmatic Tool Calling pozostaje wyłączone, dopóki nie dodasz możliwości programmatic_tools obok execute_code

remoteApi

Konfiguracja uwierzytelniania zdalnego API agentów. Kontroluje sposób, w jaki usługi zewnętrzne uwierzytelniają się podczas wywoływania endpointów Agents API.

remoteApi.auth

Key	Type	Description	Example
auth	Object	Konfiguracja uwierzytelniania dla Remote Agent API.	Supports API key and/or OIDC Bearer token authentication. If omitted, only API key auth is active.

remoteApi.auth.apiKey

Key	Type	Description	Example
enabled	Boolean	Włącz uwierzytelnianie kluczem API dla Remote Agent API.	When true, requests with a valid LibreChat API key are accepted. Can be used alongside or instead of OIDC.

Domyślnie: true

remoteApi.auth.oidc

Key	Type	Description	Example
enabled	Boolean	Włącz uwierzytelnianie tokenem OIDC Bearer.	When true, the middleware validates Bearer tokens against the configured OIDC issuer via JWKS.
issuer	String	URL wystawcy 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.
jwksUri	String	Adres URL endpointu JWKS. Opcjonalne.	If omitted, resolved automatically via {issuer}/.well-known/openid-configuration. You can also set OPENID_JWKS_URL as an alternative.
audience	String	Oczekiwana grupa odbiorców tokena. Wymagane, gdy włączone jest uwierzytelnianie OIDC.	Tokens must contain this value in their aud claim.
scope	String	Wymagana wartość zakresu. Opcjonalne.	If set, the token must contain this value in its scp or scope claim. Use this to distinguish token intent across different APIs.

Domyślnie: enabled: false

Przykład - tylko OIDC:

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

Przykład - OIDC z rezerwowym kluczem 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

Priorytet rozpoznawania JWKS URI to jawne jwksUri, następnie OPENID_JWKS_URL, a potem automatyczne wykrywanie poprzez {issuer}/.well-known/openid-configuration.

Dopasowywanie użytkowników OIDC wykorzystuje oświadczenie sub jako główne kryterium wyszukiwania, z rezerwowym użyciem oświadczeń email, preferred_username lub upn. Dopasowany użytkownik musi już istnieć w LibreChat.

Subagenci

Pole subagents kontroluje, które izolowane agenty podrzędne może tworzyć agent nadrzędny, gdy dostępna jest funkcja subagents.

Key	Type	Description	Example
enabled	Boolean	Dodaje narzędzie tworzenia subagenta do tego agenta, gdy ustawione na true. Domyślnie: wyłączone.	enabled: true
allowSelf	Boolean	Pozwala agentowi na uruchomienie się w nowym, odizolowanym kontekście. Domyślnie: true.	allowSelf: true
agent_ids	Array/List of Strings	Konkretne agenty, które ten agent może tworzyć. Maksimum: 10.	agent_ids: ["agent_researcher"]

subagents:
  enabled: true
  allowSelf: true
  agent_ids:
    - 'agent_researcher'
    - 'agent_reviewer'

Aby uzyskać informacje na temat zachowania i limitów widocznych dla użytkownika, zobacz Subagents.

Uwagi

Nie zaleca się wyłączania interfejsu kreatora (builder interface), chyba że używasz modelSpecs do zdefiniowania listy agentów do wyboru.
Konfiguracja cytowań plików (maxCitations, maxCitationsPerFile, minRelevanceScore) ma zastosowanie tylko wtedy, gdy włączona jest funkcja file_search.
Wynik trafności jest obliczany przy użyciu podobieństwa wektorowego, gdzie 1.0 oznacza idealne dopasowanie, a 0.0 oznacza brak podobieństwa.
Limity cytowań pomagają zachować równowagę między kompleksowym wyszukiwaniem informacji a jakością i wydajnością odpowiedzi.
Funkcja context działa bez konfiguracji OCR przy użyciu metod parsowania tekstu. OCR poprawia jakość ekstrakcji, gdy jest skonfigurowany.
Funkcja ocr wymaga skonfigurowania usługi OCR (zobacz Konfiguracja OCR).

Struktura obiektu endpointu Agents

Na tej stronie