LibreChat is joining ClickHouse to power the open-source Agentic Data Stack 🎉 Learn more
LibreChat
設定LibreChat YAMLオブジェクト構造Agents エンドポイントオブジェクト構造

Agents エンドポイントオブジェクト構造

このページは agents endpoint に適用されます。

例

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

この設定により、エージェント用のビルダーインターフェースが有効になります。

recursionLimit

KeyTypeDescriptionExample
recursionLimitNumberエージェントが実行時に取ることができるステップのデフォルト数を設定します。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.

デフォルト: 25

例:

recursionLimit: 50

エージェントのステップに関する詳細については、Max Agent Steps を参照してください。

maxRecursionLimit

KeyTypeDescriptionExample
maxRecursionLimitNumberエージェントが1回の実行で取れるステップの絶対最大数を設定します。Defines the upper limit for the recursionLimit that can be set from the UI. This prevents users from setting excessively high values.

デフォルト: 省略された場合、recursionLimitの値、またはrecursionLimitも省略されている場合は50がデフォルト値となります。

例:

maxRecursionLimit: 100

エージェントのステップに関する詳細については、Max Agent Steps を参照してください。

titleTiming

KeyTypeDescriptionExample
titleTimingStringagents endpointの会話タイトルが生成されるタイミングを制御します。有効な値: "immediate" または "final"。Defaults to "immediate".

デフォルト: "immediate"

利用可能な値:

  • "immediate": リクエストが開始されると同時に、ユーザーの最初のメッセージを使用して、モデルの応答と並行してタイトルを生成します。
  • "final": タイトルの生成を完全な応答が完了するまで延期します。これは従来の動作を維持します。

例:

titleTiming: immediate

disableBuilder

KeyTypeDescriptionExample
disableBuilderBooleanエージェント用ビルダーインターフェースの表示と使用を制御します。When set to `true`, disables the builder interface for the agent, limiting direct manual interaction.

デフォルト: false

例:

disableBuilder: false

allowedProviders

KeyTypeDescriptionExample
allowedProvidersArray/List of StringsAgents機能で使用を許可するendpointプロバイダー（例: "openAI", "anthropic", "google"）のリストを指定します。If defined, only agents configured with these providers can be initialized. If omitted or empty, all configured providers are allowed.

デフォルト: [] (空のリスト、すべてのプロバイダーが許可されます)

注意: 以下のいずれか、または configuration で定義されたカスタム endpoint 名である必要があります: - openAI, azureOpenAI, google, anthropic, assistants, azureAssistants, bedrock

例:

allowedProviders:
  - openAI
  - google

capabilities

KeyTypeDescriptionExample
capabilitiesArray/List of Stringsagents endpointのすべてのユーザーが利用可能なエージェント機能を指定します。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.

デフォルト: ["deferred_tools", "execute_code", "file_search", "web_search", "artifacts", "subagents", "actions", "context", "skills", "tools", "chain", "ocr"]

Programmatic Tool Callingはオプトイン機能です。Code InterpreterのデプロイメントにTool Call Serverコンポーネントが含まれている場合にのみ、execute_codeと併せてprogrammatic_toolsを追加してください。

例:

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'

注: このフィールドは任意です。省略した場合、デフォルトの動作として、デフォルトでリストされているすべての機能が含まれます。

skills

エージェントのendpointレベルのSkills設定を制御します。

KeyTypeDescriptionExample
skills.maxCatalogSkillsNumberモデルから参照可能なカタログに公開される、アクティブでアクセス可能なSkillsの数に上限を設定します。1から100の間で指定する必要があります。maxCatalogSkills: 20

デフォルト: ランタイムカタログの制限を超える設定された上限はありません。

例:

skills:
  maxCatalogSkills: 20

これはSkillsを無効にするものではありません。Skillsが利用可能かどうかを制御するには、skills機能およびエージェントごと/Model Specsごとのスキルスコープ設定を使用してください。

maxCitations

KeyTypeDescriptionExample
maxCitationsNumber単一のエージェント応答に含めることができる引用の最大合計数を制御します。When using file_search capability, limits the total number of source citations returned to prevent overwhelming responses while ensuring comprehensive coverage.

デフォルト: 30

範囲: 1-50

例:

maxCitations: 30

maxCitationsPerFile

KeyTypeDescriptionExample
maxCitationsPerFileNumber1つのファイルから抽出できる引用の最大数を制限します。Ensures citation diversity by preventing any single file from dominating the citations, encouraging representation from multiple sources.

デフォルト: 7

範囲: 1-10

例:

maxCitationsPerFile: 7

minRelevanceScore

KeyTypeDescriptionExample
minRelevanceScoreNumber回答に含めるソースの最小関連度スコアのしきい値を設定します。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.

デフォルト: 0.45 (関連性しきい値 45%)

範囲: 0.0-1.0

例:

minRelevanceScore: 0.45

File Citation Configuration Examples

デフォルト設定 (バランス型)

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

包括的な引用を提供しつつ、過剰な応答を防ぎ、低品質な一致を除外します。

厳格な設定 (高品質)

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

焦点を絞った回答のために、厳格な制限を設けて関連性の高い引用のみを含めます。

包括的な設定（リサーチ）

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

網羅的なリサーチタスクのための最大限の情報抽出。関連性に関わらず、すべてのソースを含みます。

エージェントの機能

capabilities フィールドを使用すると、エージェントの特定の機能を有効または無効にできます。利用可能な機能は以下の通りです：

  • deferred_tools: エージェントが実行時に MCP ツールを遅延検出できるようにし、すべてのツールを事前にコンテキストへ読み込む必要をなくします。
  • programmatic_tools: Agent BuilderでProgrammaticとマークされたMCPツールに対して、Programmatic Tool Callingを有効にします。これには execute_code およびTool Call Serverコンポーネントを備えたCode Interpreterのデプロイメントが必要です。この機能はオプトインであり、デフォルトでは有効になっていません。
  • execute_code: エージェントがコードを実行できるようにします。
  • file_search: エージェントがファイルを検索し、操作できるようにします。有効にすると、引用の動作は maxCitations、maxCitationsPerFile、および minRelevanceScore の設定によって制御されます。
  • web_search: エージェントのウェブ検索機能を有効にし、インターネット上の情報を検索および取得できるようにします。
  • artifacts: エージェントがインタラクティブなアーティファクト（Reactコンポーネント、HTML、Mermaidダイアグラム）を生成できるようにします。
  • subagents: 隔離されたコンテキストでの子エージェントの実行を有効にします。詳細は Subagents を参照してください。
  • actions: エージェントが定義済みの操作を実行することを許可します。
  • context: チャットでの「テキストとしてアップロード」機能およびエージェントの「ファイルコンテキスト」を有効にします。これにより、ユーザーはファイルをアップロードし、その内容を抽出して会話に直接含めることができるようになります。
  • skills: サイドパネルでのSkillsの有効化、手動での $ 呼び出し、モデルによるSkillsの呼び出し、およびエージェントのSkill許可リストを有効にします。詳細は Skills を参照してください。
  • tools: エージェントに様々なツールへのアクセス権を付与します。
  • chain: エージェントチェーン（Mixture-of-Agents (MoA) ワークフローとも呼ばれます）のベータ機能を有効にします。
  • ocr: チャットでの「テキストとしてアップロード」およびエージェントの「ファイルコンテキスト」をオプションで強化し、ファイルをアップロードしてOCRで処理できるようにします。OCRサービスの設定が必要です。

capabilitiesを指定することで、エージェントと対話する際にユーザーが利用できる機能を制御できます。

設定例

以下は、カスタム機能とファイル引用設定を使用して agents endpoint を構成する例です：

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'

この例では：

  • ビルダーインターフェースが有効になっています
  • ファイル引用は合計20件まで、1ファイルにつき最大5件までとなります。
  • 関連度が60%以上のソースのみが含まれます
  • LibreChat Agentsは、コード実行、ファイル検索（引用付き）、Skills、Subagents、actions、artifacts、ファイルコンテキスト、設定済みの場合はOCRサービス、およびウェブ検索機能にアクセスできます。
  • execute_code と併せて programmatic_tools 機能を有効にしない限り、Programmatic Tool Calling は無効のままとなります。

remoteApi

Remote Agent API認証の設定。外部サービスがAgents APIエンドポイントを呼び出す際の認証方法を制御します。

remoteApi.auth

KeyTypeDescriptionExample
authObjectRemote Agent APIの認証設定。Supports API key and/or OIDC Bearer token authentication. If omitted, only API key auth is active.

remoteApi.auth.apiKey

KeyTypeDescriptionExample
enabledBooleanRemote Agent APIのAPIキー認証を有効にします。When true, requests with a valid LibreChat API key are accepted. Can be used alongside or instead of OIDC.

デフォルト: true

remoteApi.auth.oidc

KeyTypeDescriptionExample
enabledBooleanOIDC Bearerトークン認証を有効にする。When true, the middleware validates Bearer tokens against the configured OIDC issuer via JWKS.
issuerStringOIDC発行者URLThe 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。オプション。If omitted, resolved automatically via {issuer}/.well-known/openid-configuration. You can also set OPENID_JWKS_URL as an alternative.
audienceString期待されるトークンオーディエンス。OIDC認証が有効な場合に必須です。Tokens must contain this value in their aud claim.
scopeString必須のスコープ値。オプション。If set, the token must contain this value in its scp or scope claim. Use this to distinguish token intent across different APIs.

デフォルト: enabled: false

例 - OIDCのみ:

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

例 - APIキーフォールバック付き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の解決優先順位は、明示的な jwksUri、次に OPENID_JWKS_URL、最後に {issuer}/.well-known/openid-configuration を介した自動検出の順となります。

OIDCのユーザー照合では、sub クレームをプライマリの検索キーとして使用し、フォールバックとして email、preferred_username、または upn クレームを使用します。照合されるユーザーは、LibreChat内に既に存在している必要があります。

Subagents

subagents フィールドは、subagents 機能が利用可能な場合に、親エージェントが生成できる分離された子エージェントを制御します。

KeyTypeDescriptionExample
enabledBooleantrueに設定すると、このエージェントにサブエージェント生成ツールを追加します。デフォルト：無効。enabled: true
allowSelfBooleanエージェントが新しい隔離されたコンテキストで自身を生成できるようにします。デフォルト: true。allowSelf: true
agent_idsArray/List of Stringsこのエージェントが生成可能な特定のエージェント。最大数: 10。agent_ids: ["agent_researcher"]
subagents:
  enabled: true
  allowSelf: true
  agent_ids:
    - 'agent_researcher'
    - 'agent_reviewer'

ユーザー向けの動作や制限については、Subagents を参照してください。

注記

  • modelSpecs を使用して選択可能なエージェントのリストを定義している場合を除き、ビルダーインターフェースを無効にすることは推奨されません。
  • ファイル引用設定（maxCitations、maxCitationsPerFile、minRelevanceScore）は、file_search機能が有効な場合にのみ適用されます。
  • 関連性スコアはベクトル類似性を使用して計算され、1.0は完全一致、0.0は類似性がないことを表します。
  • 引用制限は、包括的な情報検索と応答の品質およびパフォーマンスのバランスを取るのに役立ちます。
  • context機能は、OCR設定なしでもテキスト解析メソッドを使用して動作します。OCRを設定すると、抽出品質が向上します。
  • ocr 機能を使用するには、OCR サービスの設定が必要です（OCR Configuration を参照してください）。

このガイドはいかがでしたか？

GitHub で編集

Assistantsエンドポイントのオブジェクト構造

前へ

Actionsオブジェクト構造

次へ

このページの内容

例recursionLimitmaxRecursionLimittitleTimingdisableBuilderallowedProviderscapabilitiesskillsmaxCitationsmaxCitationsPerFileminRelevanceScoreFile Citation Configuration Examplesエージェントの機能設定例remoteApiremoteApi.authremoteApi.auth.apiKeyremoteApi.auth.oidcSubagents注記