Özel Endpoint Nesne Yapısı

custom dizisindeki her bir endpoint aşağıdaki yapıya sahip olmalıdır:

Örnek

endpoints:
  custom:
    # Example using Mistral AI API
    - name: 'Mistral'
      apiKey: '${YOUR_ENV_VAR_KEY}'
      baseURL: 'https://api.mistral.ai/v1'
      models:
        default: ['mistral-tiny', 'mistral-small', 'mistral-medium', 'mistral-large-latest']
      titleConvo: true
      titleTiming: 'immediate'
      titleModel: 'mistral-tiny'
      modelDisplayLabel: 'Mistral'
      # customParams:
      #   reasoningFormat: reasoning_object
      #   reasoningKey: reasoning_content
      # tokenConfig:
      #   mistral-large-latest:
      #     prompt: 2
      #     completion: 6
      #     context: 128000
      # addParams:
      #   safe_prompt: true # Mistral specific value for moderating messages
      # NOTE: For Mistral, it is necessary to drop the following parameters or you will encounter a 422 Error:
      dropParams: ['stop', 'user', 'frequency_penalty', 'presence_penalty']

    # Example using the native Anthropic Messages API
    - name: 'Claude-Compatible'
      provider: 'anthropic'
      apiKey: '${ANTHROPIC_API_KEY}'
      baseURL: 'https://api.anthropic.com'
      headers:
        anthropic-version: '2023-06-01'
      models:
        default: ['claude-sonnet-4-5', 'claude-opus-4-5']
        fetch: false
      titleConvo: true
      titleModel: 'claude-sonnet-4-5'
      modelDisplayLabel: 'Claude (Compatible)'

name

Anahtar:

Gerekli

Örnek:

name: 'Mistral'

apiKey

Anahtar:

Gerekli

Örnek:

apiKey: '${MISTRAL_API_KEY}'

veya

apiKey: 'your_api_key'

veya

apiKey: 'user_provided'

baseURL

Anahtar:

Gerekli

Örnek:

baseURL: 'https://api.mistral.ai/v1'

veya

baseURL: '${MISTRAL_BASE_URL}'

veya

baseURL: 'user_provided'

Notlar:

• Eğer ayarladığınız baseURL tam completions endpoint'i ise, onu doğrudan kullanmak için directEndpoint alanını true olarak ayarlayabilirsiniz.
  • Bu gereklidir çünkü uygulama varsayılan olarak baseURL değerine "/chat/completions" veya "/completion" ekler.
• provider: anthropic kullanırken, baseURL değerini Anthropic SDK'nın çağırması gereken API kök dizinine, örneğin https://api.anthropic.com veya ağ geçidi kök dizininize ayarlayın. LibreChat, bu sağlayıcı için yerel Anthropic /v1/messages yolunu kullanır.

provider

Anahtar:

Varsayılan: belirtilmediğinde, OpenAI uyumlu özel endpoint yolunu kullanır.

Desteklenen Değerler:

• "anthropic" - Bu endpoint'in baseURL, apiKey, headers, addParams, dropParams ve customParams.paramDefinitions özelliklerini kullanarak yerel Anthropic /v1/messages istemcisini kullanır.

Örnek:

endpoints:
  custom:
    - name: 'Claude-Compatible'
      provider: 'anthropic'
      apiKey: '${ANTHROPIC_API_KEY}'
      baseURL: 'https://api.anthropic.com'
      headers:
        anthropic-version: '2023-06-01'
      models:
        default:
          - 'claude-sonnet-4-5'
          - 'claude-opus-4-5'
        fetch: false
      titleConvo: true
      titleModel: 'claude-sonnet-4-5'
      modelDisplayLabel: 'Claude (Compatible)'

Notlar:

• Anthropic'in kendisi veya yerel Messages API'sini kullanan Anthropic uyumlu ağ geçitleri için provider: anthropic kullanın.
• Modelleri models.default altında açıkça listeleyin; OpenAI tarzı models.fetch, yerel Anthropic özel endpoint'leri için kullanılmaz.
• Sağlayıcı, siz açıkça farklı bir customParams.defaultParamsEndpoint ayarlamadığınız sürece Anthropic UI parametrelerini ifade eder.
• provider içermeyen endpoint'ler, OpenAI ile uyumlu davranışı korur.

iconURL

Anahtar:

Varsayılan: ""

Örnek:

iconURL: https://github.com/danny-avila/LibreChat/raw/main/docs/assets/LibreChat.svg

veya yerleşik bir endpoint simgesini yeniden kullanın:

iconURL: openAI

Notlar:

• Özel bir endpoint name değerini, sadece bir simgeyi yeniden kullanmak amacıyla yerleşik bir endpoint adıyla ayarlamayın. Özel endpoint adları benzersiz olmalı ve aşağıdakiler gibi varsayılan endpoint değerlerini kullanmamalıdır:
  • "openAI" | "azureOpenAI" | "google" | "anthropic" | "assistants" | "azureAssistants" | "agents" | "bedrock"
• Projeye dahil edilmiş bir endpoint simgesi kullanmak için, özel endpoint name değerini benzersiz tutun ve bunun yerine iconURL değerini yerleşik endpoint anahtarlarından birine ayarlayın.
  • "openAI" | "azureOpenAI" | "google" | "anthropic" | "assistants" | "azureAssistants" | "agents" | "bedrock"
• Özel bir görsel kullanmak için iconURL değerini bir görsel URL'sine veya LibreChat tarafından sunulan bir yola, örneğin /assets/my-icon.svg şeklinde ayarlayın.
• Ayrıca, simgeleri sağlanan "bilinen endpoint'ler" (büyük/küçük harfe duyarlı değildir) de mevcuttur. Eğer endpoint name değeriniz aşağıdaki isimlerle eşleşiyorsa, bu alanı belirtmemelisiniz:
  • Anyscale
  • APIpie
  • Cohere
  • Deepseek
  • Havai Fişekler
  • groq
  • Helicone
  • Huggingface
  • Mistral
  • MLX
  • Moonshot
  • ollama
  • OpenRouter
  • Perplexity
  • Qwen
  • ShuttleAI
  • together.ai
  • Birleştir
  • xai

models

Anahtar:

Gerekli

Özellikler:

default

Anahtar:

Gerekli

Örnek:

default:
  - 'mistral-tiny'
  - 'mistral-small'
  - 'mistral-medium'

fetch

Anahtar:

Varsayılan: false

Örnek:

fetch: true

userIdQuery

Anahtar:

Varsayılan: false

Örnek:

userIdQuery: true

titleConvo

Anahtar:

Varsayılan: false

Örnek:

titleConvo: true

titleTiming

Anahtar:

Varsayılan: "immediate"

Kullanılabilir Değerler:

• "immediate" - İsteğin başladığı anda, model yanıtıyla paralel 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: 'final'

titleMethod

Anahtar:

Varsayılan: "completion"

Kullanılabilir Yöntemler:

• "completion" - Araçlar/fonksiyonlar olmadan standart completion API'sini kullanır. Çoğu LLM ile uyumludur.
• "structured" - Başlık oluşturma için yapılandırılmış çıktı kullanır. Sağlayıcı/model desteği gerektirir.
• "functions" - "structured" için eski bir takma ad. İşlevsel olarak aynıdır.

Örnek:

titleMethod: 'completion'

titleModel

Anahtar:

Varsayılan: "gpt-3.5-turbo"

Örnek:

titleModel: 'mistral-tiny'

titleModel: 'current_model'

titlePrompt

Anahtar:

Varsayılan:

Analyze this conversation and provide:
1. The detected language of the conversation
2. A concise title in the detected language (5 words or less, no punctuation or quotation)

{convo}

Notlar:

• Her zaman {convo} yer tutucusunu içermelidir
• {convo} yer tutucusu, biçimlendirilmiş konuşma ile değiştirilecektir

Örnek:

titlePrompt: "Create a brief, descriptive title for the following conversation:\n\n{convo}\n\nTitle:"

titlePromptTemplate

Anahtar:

Varsayılan: "User: {input}\nAI: {output}"

Notlar:

• Hem {input} hem de {output} yer tutucularını içermelidir
• titlePrompt içine eklendiğinde konuşmanın nasıl biçimlendirileceğini kontrol eder

Örnek:

titlePromptTemplate: "Human: {input}\n\nAssistant: {output}"

titleEndpoint

Anahtar:

Varsayılan: Mevcut özel endpoint'i kullanır

Kabul Edilen Değerler:

• openAI
• azureOpenAI
• google
• anthropic
• bedrock
• Başka bir özel endpoint adı

Örnek:

# Use a different custom endpoint for titles
endpoints:
  custom:
    - name: 'my-chat-endpoint'
      apiKey: '${CHAT_API_KEY}'
      baseURL: 'https://api.example.com/v1/chat'
      models:
        default: ['gpt-4']
      titleEndpoint: 'my-title-endpoint'

    - name: 'my-title-endpoint'
      apiKey: '${TITLE_API_KEY}'
      baseURL: 'https://api.example.com/v1/title'
      models:
        default: ['gpt-3.5-turbo']

modelDisplayLabel

Anahtar:

Varsayılan: "AI"

Örnek:

modelDisplayLabel: 'Mistral'

addParams

Anahtar:

Örnek:

addParams:
  safe_prompt: true
  max_tokens: 2048

Notlar:

• addParams alanı, varsayılan yükün (payload) bir parçası olmayan ek parametreleri dahil etmenize olanak tanır ("Varsayılan Parametreler" bölümüne bakın). Bu, özellikle API'ye özgü seçenekler için oldukça kullanışlıdır.

dropParams

Anahtar:

Örnek:

dropParams:
  - 'stop'
  - 'user'
  - 'frequency_penalty'
  - 'presence_penalty'

Not:

• dropParams alanı, her istekle birlikte gönderilen "Varsayılan Parametreleri" kaldırmanıza olanak tanır. Bu, belirli parametreleri kabul etmeyen veya tanımayan API'lerle çalışırken yararlıdır.

customParams

Anahtar:

Alt anahtarlar:

Akıl Yürütme Formatları:

• reasoning_effort - Eski reasoning_effort parametresini gönderir.
• reasoning_object - Daha yeni OpenAI uyumlu yapıyı takip eden sağlayıcılar için { effort, summary } gibi bir reasoning nesnesi gönderir.
• disabled - Bir kullanıcı veya Model Specs tarafından akıl yürütme (reasoning) seçildiğinde bile akıl yürütme parametrelerini bastırır.

Akıl yürütme tekrarı:

• Araç çağırma turları sırasında asistanın reasoning_content içeriğinin tekrar oynatılmasını gerektiren OpenAI uyumlu sağlayıcılar için includeReasoningContent: true kullanın.
• includeReasoningHistory: true ayarını yalnızca, bazı Xiaomi MiMo veya Kimi uyumlu ağ geçitleri gibi, sonraki turlarda kalıcı geçmişten yeniden oluşturulmuş reasoning_content gerektiren sağlayıcılar için kullanın.

Anthropic sağlayıcı notu:

Özel uç noktanın yerel Anthropic Messages API'sini kullanması gerektiğinde provider: anthropic kullanın. customParams.defaultParamsEndpoint: anthropic ifadesini, yalnızca OpenAI uyumlu özel uç nokta yoluna ihtiyaç duyduğunuz ancak Anthropic tarzı parametre meta verileri ve istek uyarlaması istediğiniz durumlarda, provider olmadan kullanın.

Örnek:

customParams:
  reasoningFormat: reasoning_object
  reasoningKey: reasoning_content
  includeReasoningContent: true

tokenConfig

Anahtar:

Her anahtar bir model adıdır. Her model girdisi şunları destekler:

Örnek:

tokenConfig:
  gpt-4o-mini:
    prompt: 0.15
    completion: 0.6
    context: 128000
    cacheRead: 0.075
    cacheWrite: 0.15

Notlar:

• Oranlar, görüntüleme için herhangi bir interface.currency dönüştürmesi uygulanmadan önce, milyon token başına USD cinsinden ifade edilir.
• Model adı, özel endpoint üzerinden gönderilen model değeriyle eşleşmelidir.
• Birden fazla endpoint kullanan Ajanlar için, kullanım ve maliyet kaydedilirken eşleşen endpoint/model token yapılandırması kullanılır.

headers

Anahtar:

Örnek:

headers:
  x-api-key: '${ENVIRONMENT_VARIABLE}'
  Content-Type: 'application/json'
  X-User-ID: '{{LIBRECHAT_USER_ID}}'
  X-User-Email: '{{LIBRECHAT_USER_EMAIL}}'

Not: "${VARIABLE_NAME}" formatını kullanan dinamik ortam değişkeni değerlerini destekler.

models.fetch: true kullanıldığında, bu başlıklar da çözümlenir ve yönetici kontrollü temel URL'ler (base URL) için model listesi isteğine iletilir. Yapılandırılmış bir Authorization başlığı, uç nokta apiKey yedeğine göre önceliklidir; bu, kullanıcı bazlı model listeleri döndüren kimlik doğrulama duyarlı proxy'ler için kullanışlıdır. Eğer baseURL: "user_provided" yapılandırılmışsa, LibreChat yapılandırılmış başlık şablonlarını kullanıcı tarafından sağlanan hedefe iletmez. provider: anthropic için başlıklar, OpenAI uyumlu istemci yerine yerel Anthropic istemcisi aracılığıyla iletilir.

Kullanılabilir Kullanıcı Alanı Yer Tutucuları:

Kullanılabilir İstek Gövdesi Yer Tutucuları:

İstek gövdesi yer tutucularını kullanan örnek:

headers:
  X-Conversation-ID: '{{LIBRECHAT_BODY_CONVERSATIONID}}'
  X-Parent-Message-ID: '{{LIBRECHAT_BODY_PARENTMESSAGEID}}'
  X-Message-ID: '{{LIBRECHAT_BODY_MESSAGEID}}'

directEndpoint

Anahtar:

Varsayılan: false

Örnek:

directEndpoint: true

titleMessageRole

• Seçenekler: "system" | "user" | "assistant"

Anahtar:

Varsayılan: "system"

Örnek:

titleMessageRole: 'user'