Struktur Objek endpoint Agents

Halaman ini berlaku untuk endpoint agents.

Contoh

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

Konfigurasi ini mengaktifkan antarmuka pembuat untuk agen.

recursionLimit

Key	Type	Description	Example
recursionLimit	Number	Mengatur jumlah langkah default yang dapat diambil agen dalam satu proses eksekusi.	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.

Default: 25

Contoh:

recursionLimit: 50

Untuk informasi lebih lanjut mengenai langkah-langkah agen, lihat Max Agent Steps.

maxRecursionLimit

Key	Type	Description	Example
maxRecursionLimit	Number	Menetapkan jumlah langkah maksimum absolut yang dapat diambil agen dalam satu kali eksekusi.	Defines the upper limit for the recursionLimit that can be set from the UI. This prevents users from setting excessively high values.

Default: Jika dihilangkan, secara default akan menggunakan nilai recursionLimit atau 50 jika recursionLimit juga dihilangkan.

Contoh:

maxRecursionLimit: 100

Untuk informasi lebih lanjut mengenai langkah-langkah agen, lihat Max Agent Steps.

titleTiming

Key	Type	Description	Example
titleTiming	String	Mengontrol kapan judul percakapan dibuat untuk endpoint agents. Nilai yang valid: "immediate" atau "final".	Defaults to "immediate".

Default: "immediate"

Nilai yang Tersedia:

"immediate": Menghasilkan judul segera setelah permintaan dimulai, secara paralel dengan respons model, menggunakan pesan pertama pengguna.
"final": Menunda pembuatan judul hingga respons penuh selesai. Ini mempertahankan perilaku lama.

Contoh:

titleTiming: immediate

disableBuilder

Key	Type	Description	Example
disableBuilder	Boolean	Mengontrol visibilitas dan penggunaan antarmuka pembuat untuk agen.	When set to `true`, disables the builder interface for the agent, limiting direct manual interaction.

Default: false

Contoh:

disableBuilder: false

allowedProviders

Key	Type	Description	Example
allowedProviders	Array/List of Strings	Menentukan daftar penyedia endpoint (misalnya, "openAI", "anthropic", "google") yang diizinkan untuk digunakan dengan fitur Agents.	If defined, only agents configured with these providers can be initialized. If omitted or empty, all configured providers are allowed.

Default: [] (daftar kosong, semua penyedia diizinkan)

Catatan: Harus berupa salah satu dari berikut ini, atau nama endpoint kustom sebagaimana didefinisikan dalam konfigurasi Anda: - openAI, azureOpenAI, google, anthropic, assistants, azureAssistants, bedrock

Contoh:

allowedProviders:
  - openAI
  - google

capabilities

Key	Type	Description	Example
capabilities	Array/List of Strings	Menentukan kapabilitas agen yang tersedia bagi semua pengguna untuk 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.

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

Programmatic Tool Calling bersifat opsional (opt-in). Tambahkan programmatic_tools bersama dengan execute_code hanya jika penyebaran Code Interpreter Anda menyertakan komponen Tool Call Server.

Contoh:

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'

Catatan: Bidang ini bersifat opsional. Jika diabaikan, perilaku defaultnya adalah menyertakan semua kapabilitas yang tercantum dalam default.

skills

Mengontrol pengaturan Skills tingkat endpoint untuk agen.

Key	Type	Description	Example
skills.maxCatalogSkills	Number	Membatasi jumlah Skill aktif yang dapat diakses dan ditampilkan dalam katalog yang terlihat oleh model. Harus bernilai antara 1 dan 100.	maxCatalogSkills: 20

Default: Tidak ada batas yang dikonfigurasi selain batas katalog runtime.

Contoh:

skills:
  maxCatalogSkills: 20

Ini tidak menonaktifkan Skills. Gunakan kapabilitas skills dan cakupan skill per-agent/model-spec untuk mengontrol apakah Skills tersedia atau tidak.

maxCitations

Key	Type	Description	Example
maxCitations	Number	Mengontrol jumlah total maksimum sitasi yang dapat disertakan dalam satu respons agen.	When using file_search capability, limits the total number of source citations returned to prevent overwhelming responses while ensuring comprehensive coverage.

Default: 30

Rentang: 1-50

Contoh:

maxCitations: 30

maxCitationsPerFile

Key	Type	Description	Example
maxCitationsPerFile	Number	Membatasi jumlah maksimum sitasi yang dapat diekstrak dari satu file.	Ensures citation diversity by preventing any single file from dominating the citations, encouraging representation from multiple sources.

Default: 7

Rentang: 1-10

Contoh:

maxCitationsPerFile: 7

minRelevanceScore

Key	Type	Description	Example
minRelevanceScore	Number	Menetapkan ambang batas skor relevansi minimum agar sumber disertakan dalam respons.	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.

Default: 0.45 (ambang batas relevansi 45%)

Rentang: 0.0-1.0

Contoh:

minRelevanceScore: 0.45

Contoh Konfigurasi Sitasi File

Konfigurasi Default (Seimbang)

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

Menyediakan sitasi yang komprehensif sekaligus mencegah respons yang berlebihan dan memfilter kecocokan berkualitas rendah.

Konfigurasi Ketat (Kualitas Tinggi)

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

Hanya menyertakan kutipan yang sangat relevan dengan batasan ketat untuk respons yang terfokus.

Konfigurasi Komprehensif (Penelitian)

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

Ekstraksi informasi maksimal untuk tugas penelitian yang mendalam, mencakup semua sumber tanpa memandang relevansinya.

Kemampuan Agen

Kolom capabilities memungkinkan Anda untuk mengaktifkan atau menonaktifkan fungsionalitas tertentu untuk agen. Kapabilitas yang tersedia adalah:

deferred_tools: Memungkinkan agen untuk menemukan MCP tools yang ditangguhkan (deferred) saat runtime alih-alih memuat setiap tool ke dalam konteks di awal.
programmatic_tools: Mengaktifkan Pemanggilan Alat Programatis (Programmatic Tool Calling) untuk alat MCP yang ditandai sebagai Programmatic di Agent Builder. Memerlukan execute_code dan deployment Code Interpreter dengan komponen Tool Call Server. Kemampuan ini bersifat opt-in dan tidak diaktifkan secara default.
execute_code: Mengizinkan agen untuk mengeksekusi kode.
file_search: Memungkinkan agen untuk mencari dan berinteraksi dengan file. Saat diaktifkan, perilaku sitasi dikendalikan oleh pengaturan maxCitations, maxCitationsPerFile, dan minRelevanceScore.
web_search: Mengaktifkan fungsionalitas pencarian web untuk agen, memungkinkan mereka untuk mencari dan mengambil informasi dari internet.
artifacts: Memungkinkan agen untuk menghasilkan artefak interaktif (komponen React, HTML, diagram Mermaid).
subagents: Mengaktifkan eksekusi agen anak dengan konteks terisolasi. Lihat Subagents.
actions: Mengizinkan agen untuk melakukan tindakan yang telah ditentukan sebelumnya.
context: Mengaktifkan fungsionalitas "Upload as Text" dalam obrolan, dan "File Context" untuk agen, yang memungkinkan pengguna untuk mengunggah file dan kontennya diekstraksi serta disertakan secara langsung ke dalam percakapan.
skills: Mengaktifkan Skills di panel samping, pemanggilan manual $, skills yang dipanggil model, dan daftar izin (allowlist) skill agen. Lihat Skills.
tools: Memberikan agen akses ke berbagai tools.
chain: Mengaktifkan fitur Beta untuk perantaian agen (agent chaining), yang juga dikenal sebagai alur kerja Mixture-of-Agents (MoA).
ocr: Secara opsional meningkatkan fitur "Upload as Text" dalam obrolan, dan "File Context" untuk agen, yang memungkinkan file diunggah dan diproses dengan OCR. Memerlukan layanan OCR untuk dikonfigurasi.

Dengan menentukan kapabilitas, Anda dapat mengontrol fitur yang tersedia bagi pengguna saat berinteraksi dengan agen.

Contoh Konfigurasi

Berikut adalah contoh konfigurasi endpoint agents dengan kemampuan kustom dan pengaturan sitasi 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'

Dalam contoh ini:

Antarmuka builder telah diaktifkan
Kutipan file dibatasi hingga total 20, dengan maksimal 5 per file
Hanya sumber dengan relevansi 60%+ yang disertakan
Agen LibreChat memiliki akses ke eksekusi kode, pencarian file (dengan sitasi), Skills, Subagents, actions, artifacts, konteks file, layanan ocr jika dikonfigurasi, dan kemampuan pencarian web.
Programmatic Tool Calling tetap dinonaktifkan kecuali Anda menambahkan kapabilitas programmatic_tools bersama dengan execute_code

remoteApi

Konfigurasi untuk autentikasi API Remote Agent. Mengontrol bagaimana layanan eksternal melakukan autentikasi saat memanggil endpoint Agents API.

remoteApi.auth

Key	Type	Description	Example
auth	Object	Konfigurasi autentikasi untuk API Remote Agent.	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	Aktifkan autentikasi kunci API untuk Remote Agent API.	When true, requests with a valid LibreChat API key are accepted. Can be used alongside or instead of OIDC.

Default: true

remoteApi.auth.oidc

Key	Type	Description	Example
enabled	Boolean	Aktifkan autentikasi token Bearer OIDC.	When true, the middleware validates Bearer tokens against the configured OIDC issuer via JWKS.
issuer	String	URL penerbit 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	URL endpoint JWKS. Opsional.	If omitted, resolved automatically via {issuer}/.well-known/openid-configuration. You can also set OPENID_JWKS_URL as an alternative.
audience	String	Audiens token yang diharapkan. Diperlukan saat autentikasi OIDC diaktifkan.	Tokens must contain this value in their aud claim.
scope	String	Nilai scope yang diperlukan. Opsional.	If set, the token must contain this value in its scp or scope claim. Use this to distinguish token intent across different APIs.

Default: enabled: false

Contoh - Hanya OIDC:

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

Contoh - OIDC dengan fallback API key:

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

Prioritas resolusi JWKS URI adalah jwksUri eksplisit, kemudian OPENID_JWKS_URL, lalu penemuan otomatis melalui {issuer}/.well-known/openid-configuration.

Pencocokan pengguna OIDC menggunakan klaim sub sebagai pencarian utama, dengan cadangan ke klaim email, preferred_username, atau upn. Pengguna yang dicocokkan harus sudah ada di LibreChat.

Subagents

Kolom subagents mengontrol agen anak terisolasi mana yang dapat dibuat oleh agen induk saat kapabilitas subagents tersedia.

Key	Type	Description	Example
enabled	Boolean	Menambahkan alat spawn subagent ke agen ini jika bernilai true. Default: dinonaktifkan.	enabled: true
allowSelf	Boolean	Mengizinkan agen untuk memunculkan dirinya sendiri dalam konteks terisolasi yang baru. Default: true.	allowSelf: true
agent_ids	Array/List of Strings	Agen spesifik yang dapat dibuat oleh agen ini. Maksimum: 10.	agent_ids: ["agent_researcher"]

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

Untuk perilaku dan batasan yang dihadapi pengguna, lihat Subagents.

Catatan

Tidak disarankan untuk menonaktifkan antarmuka builder kecuali Anda menggunakan modelSpecs untuk menentukan daftar agen yang dapat dipilih.
Konfigurasi sitasi file (maxCitations, maxCitationsPerFile, minRelevanceScore) hanya berlaku ketika kapabilitas file_search diaktifkan.
Skor relevansi dihitung menggunakan kesamaan vektor, di mana 1.0 merepresentasikan kecocokan sempurna dan 0.0 merepresentasikan tidak ada kesamaan.
Batas sitasi membantu menyeimbangkan pengambilan informasi yang komprehensif dengan kualitas dan performa respons.
Kemampuan context berfungsi tanpa konfigurasi OCR menggunakan metode penguraian teks. OCR meningkatkan kualitas ekstraksi saat dikonfigurasi.
Kemampuan ocr memerlukan layanan OCR untuk dikonfigurasi (lihat Konfigurasi OCR).

Struktur Objek endpoint Agents

Di halaman ini