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

Agents Endpoint Nesne Yapısı

Bu sayfa agents endpoint'i için geçerlidir.

Örnek

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

Bu yapılandırma, ajanlar için oluşturucu arayüzünü etkinleştirir.

recursionLimit

KeyTypeDescriptionExample
recursionLimitNumberBir ajanın bir çalışmada atabileceği varsayılan adım sayısını belirler.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.

Varsayılan: 25

Örnek:

recursionLimit: 50

Ajan adımları hakkında daha fazla bilgi için Max Agent Steps bölümüne bakın.

maxRecursionLimit

KeyTypeDescriptionExample
maxRecursionLimitNumberBir aracın bir çalıştırma sırasında atabileceği mutlak maksimum adım sayısını belirler.Defines the upper limit for the recursionLimit that can be set from the UI. This prevents users from setting excessively high values.

Varsayılan: Belirtilmediği takdirde, recursionLimit değerini veya recursionLimit de belirtilmemişse 50 değerini varsayar.

Örnek:

maxRecursionLimit: 100

Ajan adımları hakkında daha fazla bilgi için Max Agent Steps bölümüne bakın.

titleTiming

KeyTypeDescriptionExample
titleTimingStringAgents endpoint için konuşma başlıklarının ne zaman oluşturulacağını kontrol eder. Geçerli değerler: "immediate" veya "final".Defaults to "immediate".

Varsayılan: "immediate"

Kullanılabilir Değerler:

  • "immediate": İstek başladığı anda, model yanıtıyla eş zamanlı olarak, kullanıcının ilk mesajını kullanarak başlığı oluşturur.
  • "final": Başlık oluşturma işlemini tam yanıt tamamlanana kadar erteler. Bu, eski davranışı korur.

Örnek:

titleTiming: immediate

disableBuilder

KeyTypeDescriptionExample
disableBuilderBooleanAjanlar için oluşturucu arayüzünün görünürlüğünü ve kullanımını kontrol eder.When set to `true`, disables the builder interface for the agent, limiting direct manual interaction.

Varsayılan: false

Örnek:

disableBuilder: false

allowedProviders

KeyTypeDescriptionExample
allowedProvidersArray/List of StringsAgents özelliği ile kullanılmasına izin verilen endpoint sağlayıcılarının (örneğin, "openAI", "anthropic", "google") bir listesini belirtir.If defined, only agents configured with these providers can be initialized. If omitted or empty, all configured providers are allowed.

Varsayılan: [] (boş liste, tüm sağlayıcılara izin verilir)

Not: Aşağıdakilerden biri veya yapılandırmanızda tanımlandığı şekliyle özel bir endpoint adı olmalıdır: - openAI, azureOpenAI, google, anthropic, assistants, azureAssistants, bedrock

Örnek:

allowedProviders:
  - openAI
  - google

capabilities

KeyTypeDescriptionExample
capabilitiesArray/List of StringsAgents endpoint'i için tüm kullanıcılara sunulan agent yeteneklerini belirtir.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.

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

Programmatic Tool Calling isteğe bağlıdır. programmatic_tools ifadesini, yalnızca Code Interpreter dağıtımınız Tool Call Server bileşenini içerdiğinde execute_code ile birlikte ekleyin.

Örnek:

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'

Not: Bu alan isteğe bağlıdır. Atlanırsa, varsayılan davranış, varsayılan değerde listelenen tüm yetenekleri dahil etmektir.

skills

Ajanlar için uç nokta düzeyindeki Skills ayarlarını kontrol eder.

KeyTypeDescriptionExample
skills.maxCatalogSkillsNumberModel tarafından görülebilen katalogda sunulan aktif ve erişilebilir Skill sayısını sınırlar. 1 ile 100 arasında olmalıdır.maxCatalogSkills: 20

Varsayılan: Çalışma zamanı katalog sınırı dışında yapılandırılmış bir üst sınır yoktur.

Örnek:

skills:
  maxCatalogSkills: 20

Bu, Skills özelliğini devre dışı bırakmaz. Skills özelliğinin kullanılabilir olup olmadığını kontrol etmek için skills yeteneğini ve aracı/model-spec bazlı yetenek kapsamlandırmasını (scoping) kullanın.

maxCitations

KeyTypeDescriptionExample
maxCitationsNumberTek bir aracı yanıtına dahil edilebilecek maksimum toplam alıntı sayısını kontrol eder.When using file_search capability, limits the total number of source citations returned to prevent overwhelming responses while ensuring comprehensive coverage.

Varsayılan: 30

Aralık: 1-50

Örnek:

maxCitations: 30

maxCitationsPerFile

KeyTypeDescriptionExample
maxCitationsPerFileNumberHerhangi bir dosyadan çıkarılabilecek maksimum alıntı sayısını sınırlar.Ensures citation diversity by preventing any single file from dominating the citations, encouraging representation from multiple sources.

Varsayılan: 7

Aralık: 1-10

Örnek:

maxCitationsPerFile: 7

minRelevanceScore

KeyTypeDescriptionExample
minRelevanceScoreNumberYanıtlara dahil edilecek kaynaklar için minimum alaka düzeyi puanı eşiğini belirler.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.

Varsayılan: 0.45 (%45 alaka düzeyi eşiği)

Aralık: 0.0-1.0

Örnek:

minRelevanceScore: 0.45

Dosya Alıntı Yapılandırma Örnekleri

Varsayılan Yapılandırma (Dengeli)

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

Aşırı uzun yanıtları önlerken ve düşük kaliteli eşleşmeleri filtrelerken kapsamlı alıntılar sağlar.

Sıkı Yapılandırma (Yüksek Kalite)

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

Odaklanmış yanıtlar için katı sınırlamalarla yalnızca yüksek derecede alakalı alıntıları içerir.

Kapsamlı Yapılandırma (Araştırma)

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

Alaka düzeyine bakılmaksızın tüm kaynaklar dahil olmak üzere, kapsamlı araştırma görevleri için maksimum bilgi çıkarımı.

Ajan Yetenekleri

capabilities alanı, aracılar için belirli işlevleri etkinleştirmenize veya devre dışı bırakmanıza olanak tanır. Mevcut yetenekler şunlardır:

  • deferred_tools: Temsilcilerin, her aracı önceden bağlama yüklemek yerine çalışma zamanında ertelenmiş MCP araçlarını keşfetmesine olanak tanır.
  • programmatic_tools: Agent Builder'da Programmatic olarak işaretlenmiş MCP araçları için Programmatic Tool Calling özelliğini etkinleştirir. execute_code ve Tool Call Server bileşenine sahip bir Code Interpreter dağıtımı gerektirir. Bu yetenek isteğe bağlıdır (opt-in) ve varsayılan olarak etkin değildir.
  • execute_code: Ajanın kod çalıştırmasına izin verir.
  • file_search: Ajanın dosyaları aramasını ve dosyalarla etkileşime girmesini sağlar. Etkinleştirildiğinde, alıntı davranışı maxCitations, maxCitationsPerFile ve minRelevanceScore ayarlarıyla kontrol edilir.
  • web_search: Temsilciler için web arama işlevini etkinleştirir, internetten bilgi aramalarına ve almalarına olanak tanır.
  • artifacts: Ajanın etkileşimli artifact'ler (React bileşenleri, HTML, Mermaid diyagramları) oluşturmasını sağlar.
  • subagents: İzole edilmiş bağlamlı alt ajan çalıştırmalarını etkinleştirir. Bkz. Subagents.
  • actions: Ajanın önceden tanımlanmış eylemleri gerçekleştirmesine izin verir.
  • context: Sohbet içinde "Metin Olarak Yükle" işlevini ve aracılar için "Dosya Bağlamı" özelliğini etkinleştirir; bu, kullanıcıların dosya yüklemesine ve içeriklerinin ayıklanarak doğrudan konuşmaya dahil edilmesine olanak tanır.
  • skills: Yan panelde Skills özelliğini, manuel $ çağrısını, model tarafından çağrılan skills özelliklerini ve aracı skill izin listelerini etkinleştirir. Bkz. Skills.
  • tools: Ajanın çeşitli araçlara erişimini sağlar.
  • chain: Ajan zincirleme (Mixture-of-Agents (MoA) iş akışları olarak da bilinir) için Beta özelliğini etkinleştirir.
  • ocr: Sohbet içinde "Metin Olarak Yükle" özelliğini ve aracılar için "Dosya Bağlamı"nı isteğe bağlı olarak geliştirir; dosyaların yüklenmesine ve OCR ile işlenmesine olanak tanır. Bir OCR hizmetinin yapılandırılmasını gerektirir.

Yetenekleri belirterek, kullanıcıların temsilcilerle etkileşim kurarken erişebilecekleri özellikleri kontrol edebilirsiniz.

Örnek Yapılandırma

Aşağıda, agents endpoint'ini özel yetenekler ve dosya alıntı ayarlarıyla yapılandırmaya dair bir örnek bulunmaktadır:

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'

Bu örnekte:

  • Oluşturucu arayüzü etkinleştirildi
  • Dosya alıntıları toplamda 20 ile sınırlıdır ve dosya başına en fazla 5 alıntı yapılabilir.
  • Yalnızca %60 ve üzeri uygunluğa sahip kaynaklar dahil edilir
  • LibreChat Ajanları; kod yürütme, dosya arama (alıntılarla birlikte), Yetenekler (Skills), Alt ajanlar (Subagents), eylemler (actions), yapıtlar (artifacts), dosya bağlamı, yapılandırılmışsa OCR hizmetleri ve web arama yeteneklerine erişebilir.
  • execute_code ile birlikte programmatic_tools yeteneğini eklemediğiniz sürece Programmatic Tool Calling devre dışı kalmaya devam eder.

remoteApi

Remote Agent API kimlik doğrulaması için yapılandırma. Harici servislerin Agents API uç noktalarını çağırırken nasıl kimlik doğrulaması yapacağını kontrol eder.

remoteApi.auth

KeyTypeDescriptionExample
authObjectRemote Agent API için kimlik doğrulama yapılandırması.Supports API key and/or OIDC Bearer token authentication. If omitted, only API key auth is active.

remoteApi.auth.apiKey

KeyTypeDescriptionExample
enabledBooleanRemote Agent API için API anahtarı kimlik doğrulamasını etkinleştirin.When true, requests with a valid LibreChat API key are accepted. Can be used alongside or instead of OIDC.

Varsayılan: true

remoteApi.auth.oidc

KeyTypeDescriptionExample
enabledBooleanOIDC Bearer token kimlik doğrulamasını etkinleştirin.When true, the middleware validates Bearer tokens against the configured OIDC issuer via JWKS.
issuerStringOIDC sağlayıcı URL'si.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. İsteğe bağlı.If omitted, resolved automatically via {issuer}/.well-known/openid-configuration. You can also set OPENID_JWKS_URL as an alternative.
audienceStringBeklenen belirteç hedef kitlesi. OIDC kimlik doğrulaması etkinleştirildiğinde gereklidir.Tokens must contain this value in their aud claim.
scopeStringGerekli kapsam değeri. İsteğe bağlı.If set, the token must contain this value in its scp or scope claim. Use this to distinguish token intent across different APIs.

Varsayılan: enabled: false

Örnek - Sadece OIDC:

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

Örnek - API anahtarı yedeği ile OIDC:

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

JWKS URI çözümleme önceliği sırasıyla açıkça belirtilen jwksUri, ardından OPENID_JWKS_URL ve son olarak {issuer}/.well-known/openid-configuration üzerinden otomatik keşiftir.

OIDC kullanıcı eşleştirme, birincil arama için sub claim'ini kullanır; email, preferred_username veya upn claim'leri ise yedek olarak kullanılır. Eşleşen kullanıcının LibreChat içinde zaten mevcut olması gerekir.

Alt Ajanlar

subagents alanı, subagents yeteneği mevcut olduğunda bir üst ajanın hangi izole alt ajanları oluşturabileceğini kontrol eder.

KeyTypeDescriptionExample
enabledBooleantrue olduğunda bu aracıya alt aracı (subagent) oluşturma aracını ekler. Varsayılan: devre dışı.enabled: true
allowSelfBooleanAjanın kendisini yeni ve yalıtılmış bir bağlamda oluşturmasına olanak tanır. Varsayılan: true.allowSelf: true
agent_idsArray/List of StringsBu aracın oluşturabileceği belirli aracılar. Maksimum: 10.agent_ids: ["agent_researcher"]
subagents:
  enabled: true
  allowSelf: true
  agent_ids:
    - 'agent_researcher'
    - 'agent_reviewer'

Kullanıcıya yönelik davranışlar ve sınırlar için Subagents bölümüne bakın.

Notlar

  • modelSpecs kullanarak seçim yapılabilecek bir temsilci listesi tanımlamadığınız sürece builder arayüzünü devre dışı bırakmanız önerilmez.
  • Dosya alıntı yapılandırması (maxCitations, maxCitationsPerFile, minRelevanceScore) yalnızca file_search özelliği etkinleştirildiğinde geçerlidir.
  • Alaka düzeyi puanı, 1.0'ın mükemmel bir eşleşmeyi, 0.0'ın ise hiç benzerlik olmadığını temsil ettiği vektör benzerliği kullanılarak hesaplanır.
  • Alıntı sınırları, kapsamlı bilgi erişimi ile yanıt kalitesi ve performans arasında denge kurmaya yardımcı olur.
  • context yeteneği, metin ayrıştırma yöntemlerini kullanarak OCR yapılandırması olmadan çalışır. OCR yapılandırıldığında, çıkarma kalitesini artırır.
  • ocr yeteneği, bir OCR hizmetinin yapılandırılmasını gerektirir (bkz. OCR Yapılandırması).

Bu rehber nasıl?