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

Configuration de la parole

Vue d'ensemble

L'objet speech vous permet de configurer directement les fournisseurs de synthÚse vocale (TTS) et de reconnaissance vocale (STT) dans votre fichier de configuration librechat.yaml. Cela permet d'activer des services vocaux cÎté serveur sans que les utilisateurs aient besoin de configurer leurs propres clés API.

Champs sous speech :

  • tts - Configurations du fournisseur de synthĂšse vocale (Text-to-Speech)
  • stt - Configurations du fournisseur Speech-to-Text
  • speechTab - ParamĂštres d'interface par dĂ©faut pour les fonctionnalitĂ©s vocales

Notes :

  • Plusieurs fournisseurs peuvent ĂȘtre configurĂ©s simultanĂ©ment
  • Les utilisateurs peuvent sĂ©lectionner leur fournisseur prĂ©fĂ©rĂ© parmi les options disponibles.
  • Les clĂ©s API dans le fichier de configuration doivent utiliser des rĂ©fĂ©rences de variables d'environnement pour des raisons de sĂ©curitĂ©

Exemple

speech:
  tts:
    openai:
      apiKey: "${TTS_API_KEY}"
      model: "tts-1"
      voices: ["alloy", "echo", "fable", "onyx", "nova", "shimmer"]
    elevenlabs:
      apiKey: "${ELEVENLABS_API_KEY}"
      model: "eleven_multilingual_v2"
      voices: ["voice-id-1", "voice-id-2"]
  stt:
    openai:
      apiKey: "${STT_API_KEY}"
      model: "whisper-1"
  speechTab:
    conversationMode: true
    advancedMode: false
    speechToText: true
    textToSpeech: true

tts

L'objet tts configure les fournisseurs de synthĂšse vocale (Text-to-Speech). Plusieurs fournisseurs peuvent ĂȘtre configurĂ©s, et les utilisateurs peuvent choisir celui qu'ils souhaitent utiliser.

openai

Configuration de OpenAI TTS utilisant des modĂšles comme tts-1 ou tts-1-hd.

KeyTypeDescriptionExample
urlStringURL d'API personnalisĂ©e (optionnel). À utiliser pour les endpoints compatibles avec OpenAI.
apiKeyStringClé API OpenAI. Utilisez la référence de variable d'environnement.Required
modelStringModĂšle TTS Ă  utiliser (par ex. "tts-1", "tts-1-hd").Required
voicesArray of StringsOptions vocales disponibles à la sélection pour les utilisateurs.Required

Exemple :

tts:
  openai:
    apiKey: "${TTS_API_KEY}"
    model: "tts-1"
    voices: ["alloy", "echo", "fable", "onyx", "nova", "shimmer"]

azureOpenAI

Configuration de Azure OpenAI TTS.

KeyTypeDescriptionExample
instanceNameStringNom de l'instance Azure OpenAI.Required
apiKeyStringClé API Azure OpenAI.Required
deploymentNameStringLe nom de déploiement pour le modÚle TTS.Required
apiVersionStringVersion de l'API Azure OpenAI.Required
modelStringIdentifiant du modĂšle TTS.Required
voicesArray of StringsOptions vocales disponibles.Required

Exemple :

tts:
  azureOpenAI:
    instanceName: "my-azure-instance"
    apiKey: "${AZURE_TTS_API_KEY}"
    deploymentName: "tts-deployment"
    apiVersion: "2024-02-15-preview"
    model: "tts-1"
    voices: ["alloy", "echo", "nova"]

elevenlabs

Configuration de ElevenLabs TTS pour une synthÚse vocale de haute qualité.

KeyTypeDescriptionExample
urlStringURL d'API personnalisée (optionnel).
websocketUrlStringURL WebSocket pour le streaming (optionnel).
apiKeyStringClé API ElevenLabs.Required
modelStringModĂšle ElevenLabs (par ex. "eleven_multilingual_v2").Required
voicesArray of StringsIDs de voix disponibles pour la sélection.Required
voice_settingsObjectParamĂštres de personnalisation vocale (optionnel).
pronunciation_dictionary_locatorsArray of StringsIDs de dictionnaire de prononciation (optionnel).

Sous-clés de voice_settings :

KeyTypeDescriptionExample
similarity_boostNumberAmélioration de la similarité vocale (0-1).
stabilityNumberStabilité de la voix (0-1).
styleNumberExagération du style (0-1).
use_speaker_boostBooleanActiver l'amplification du haut-parleur.

Exemple :

tts:
  elevenlabs:
    apiKey: "${ELEVENLABS_API_KEY}"
    model: "eleven_multilingual_v2"
    voices: ["21m00Tcm4TlvDq8ikWAM", "AZnzlk1XvdvUeBnXmlld"]
    voice_settings:
      stability: 0.5
      similarity_boost: 0.75
      use_speaker_boost: true

localai

Configuration de LocalAI TTS pour la synthÚse vocale auto-hébergée.

KeyTypeDescriptionExample
urlStringURL du serveur LocalAI.Required
apiKeyStringClé API si l'authentification est activée (optionnel).
voicesArray of StringsModĂšles vocaux disponibles.Required
backendStringBackend TTS Ă  utiliser (par ex. "piper").Required

Exemple :

tts:
  localai:
    url: "http://localhost:8080"
    voices: ["en-us-amy-low", "en-us-danny-low"]
    backend: "piper"

stt

L'objet stt configure les fournisseurs de Speech-to-Text.

openai

Configuration de OpenAI Whisper STT.

KeyTypeDescriptionExample
urlStringURL d'API personnalisĂ©e (optionnel). À utiliser pour les endpoints compatibles avec OpenAI.
apiKeyStringClé API OpenAI. Utilisez la référence de variable d'environnement.Required
modelStringModĂšle STT Ă  utiliser (par ex. "whisper-1").Required

Exemple :

stt:
  openai:
    apiKey: "${STT_API_KEY}"
    model: "whisper-1"

azureOpenAI

Configuration de Azure OpenAI Whisper STT.

KeyTypeDescriptionExample
instanceNameStringNom de l'instance Azure OpenAI.Required
apiKeyStringClé API Azure OpenAI.Required
deploymentNameStringLe nom de déploiement pour le modÚle Whisper.Required
apiVersionStringVersion de l'API Azure OpenAI.Required

Exemple :

stt:
  azureOpenAI:
    instanceName: "my-azure-instance"
    apiKey: "${AZURE_STT_API_KEY}"
    deploymentName: "whisper-deployment"
    apiVersion: "2024-02-15-preview"

speechTab

L'objet speechTab configure les paramÚtres d'interface utilisateur par défaut pour les fonctionnalités vocales. Ces paramÚtres contrÎlent ce que les utilisateurs voient par défaut dans le panneau des paramÚtres vocaux.

KeyTypeDescriptionExample
conversationModeBooleanActiver le mode conversation par défaut.false
advancedModeBooleanAfficher les paramÚtres vocaux avancés par défaut.false
speechToTextBoolean or ObjectActiver STT par défaut, ou configurer les paramÚtres détaillés de STT.false
textToSpeechBoolean or ObjectActivez TTS par défaut, ou configurez des paramÚtres TTS détaillés.false

speechToText (Format d'objet)

Lors de l'utilisation d'un objet au lieu d'un booléen :

KeyTypeDescriptionExample
engineSTTStringMoteur STT par défaut. Options : `"openai"`, `"azureOpenAI"`.
languageSTTStringLangue par défaut pour STT.
autoTranscribeAudioBooleanTranscrire automatiquement les messages audio.
decibelValueNumberSeuil de décibels pour la détection vocale.
autoSendTextNumberDélai en ms avant l'envoi automatique du texte transcrit (0 pour désactiver).

textToSpeech (Format d'objet)

Lors de l'utilisation d'un objet au lieu d'un booléen :

KeyTypeDescriptionExample
engineTTSStringMoteur TTS par défaut. Options : `"openai"`, `"azureOpenAI"`, `"elevenlabs"`, `"localai"`.
voiceStringSélection de la voix par défaut.
languageTTSStringLangue par défaut pour le TTS.
automaticPlaybackBooleanLire automatiquement les réponses TTS.
playbackRateNumberVitesse de lecture par dĂ©faut (1.0 = normale). Plage : 0.25–4.0.
cacheTTSBooleanMettre en cache l'audio TTS pour une lecture répétée.

Exemple :

speechTab:
  conversationMode: false
  advancedMode: false
  speechToText:
    engineSTT: "openai"
    autoTranscribeAudio: true
    decibelValue: -45
  textToSpeech:
    engineTTS: "openai"
    voice: "nova"
    automaticPlayback: false
    playbackRate: 1.0
    cacheTTS: true

Exemple complet

version: 1.3.18
cache: true

speech:
  tts:
    openai:
      apiKey: "${TTS_API_KEY}"
      model: "tts-1-hd"
      voices: ["alloy", "echo", "fable", "onyx", "nova", "shimmer"]
    elevenlabs:
      apiKey: "${ELEVENLABS_API_KEY}"
      model: "eleven_multilingual_v2"
      voices: ["21m00Tcm4TlvDq8ikWAM", "AZnzlk1XvdvUeBnXmlld"]
      voice_settings:
        stability: 0.5
        similarity_boost: 0.75
  stt:
    openai:
      apiKey: "${STT_API_KEY}"
      model: "whisper-1"
  speechTab:
    conversationMode: false
    advancedMode: false
    speechToText: true
    textToSpeech:
      engineTTS: "openai"
      voice: "nova"
      automaticPlayback: false

Notes

  • Utilisez toujours des rĂ©fĂ©rences de variables d'environnement (par ex. ${API_KEY}) pour les clĂ©s API dans les fichiers de configuration
  • Plusieurs fournisseurs de TTS peuvent ĂȘtre configurĂ©s ; les utilisateurs sĂ©lectionnent leur option prĂ©fĂ©rĂ©e dans l'interface utilisateur.
  • Les paramĂštres speechTab dĂ©finissent les valeurs par dĂ©faut que les utilisateurs peuvent remplacer dans leurs paramĂštres personnels.
  • Pour une documentation dĂ©taillĂ©e des fonctionnalitĂ©s, consultez Speech to Text & Text to Speech

Que pensez-vous de ce guide ?