From 32030dd6c9f405f4664c9f25ff37a16f0786d2f0 Mon Sep 17 00:00:00 2001
From: Danny Avila <danny@librechat.ai>
Date: Wed, 17 Jul 2024 10:47:25 -0400
Subject: [PATCH] =?UTF-8?q?=E2=9A=99=EF=B8=8F=20feat:=20config=20v1.1.5=20?=
 =?UTF-8?q?(#90)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* stream rate

* docs: update `speech` changelog

* docs: update speechTab example and edit notes about assistants streamRate

---------

Co-authored-by: Marco Beretta <81851188+berry-13@users.noreply.github.com>
---
 .../changelog/content/config_v1.1.5.mdx       | 13 +++++
 pages/changelog/config_v1.1.5.mdx             | 13 +++++
 .../shared_endpoint_settings.mdx              | 53 +++++++++++++++++++
 3 files changed, 79 insertions(+)
 create mode 100644 components/changelog/content/config_v1.1.5.mdx
 create mode 100644 pages/changelog/config_v1.1.5.mdx
 create mode 100644 pages/docs/configuration/librechat_yaml/object_structure/shared_endpoint_settings.mdx

diff --git a/components/changelog/content/config_v1.1.5.mdx b/components/changelog/content/config_v1.1.5.mdx
new file mode 100644
index 000000000..390ab0135
--- /dev/null
+++ b/components/changelog/content/config_v1.1.5.mdx
@@ -0,0 +1,13 @@
+- Added [`streamRate`](/docs/configuration/librechat_yaml/object_structure/shared_endpoint_settings#streamrate) to the shared endpoint settings.
+    - This setting allows you to control the rate at which data is streamed from the endpoint.
+    - You can set a global value for all endpoints or customize it for each individual endpoint.
+    - The `all` setting can override all individual endpoint values, making them unnecessary if used.
+
+- Added [`speech`](/docs/configuration/stt_tts#speech-introduction) object
+
+- Moved `TTS` and `STT` under the new `speech` object
+    - This change allows you to configure speech settings in a more organized way.
+
+- Added [`speechTab`](/docs/configuration/stt_tts#speech-tab-optional) under the new `speech` object
+    - This setting allows you to configure the default speech tab settings for LibreChat users
+    - Remeber that users can still override them
\ No newline at end of file
diff --git a/pages/changelog/config_v1.1.5.mdx b/pages/changelog/config_v1.1.5.mdx
new file mode 100644
index 000000000..85b6b9f44
--- /dev/null
+++ b/pages/changelog/config_v1.1.5.mdx
@@ -0,0 +1,13 @@
+---
+date: 2024/07/13
+title: ⚙️ Config v1.1.5
+---
+
+import { ChangelogHeader } from '@/components/changelog/ChangelogHeader'
+import Content from '@/components/changelog/content/config_v1.1.5.mdx'
+
+<ChangelogHeader />
+
+---
+
+<Content />
diff --git a/pages/docs/configuration/librechat_yaml/object_structure/shared_endpoint_settings.mdx b/pages/docs/configuration/librechat_yaml/object_structure/shared_endpoint_settings.mdx
new file mode 100644
index 000000000..7e2d7a9aa
--- /dev/null
+++ b/pages/docs/configuration/librechat_yaml/object_structure/shared_endpoint_settings.mdx
@@ -0,0 +1,53 @@
+# Shared Endpoint Settings
+
+This page describes the shared configuration settings for all endpoints. The settings highlighted here are available to all configurations under the ["Endpoints"](/docs/configuration/librechat_yaml/object_structure/config#endpoints) field unless noted otherwise.
+
+## Example Configuration
+
+```yaml filename="Shared Endpoint Settings"
+endpoints:
+  openAI:
+    streamRate: 25
+  anthropic:
+    streamRate: 25
+  google:
+    streamRate: 1
+  azureOpenAI:
+    streamRate: 20
+  assistants:
+    streamRate: 30
+  azureAssistants:
+    streamRate: 30
+  # the `all` setting would override all the above values, making them unnecessary to be set
+  all:
+    streamRate: 20
+```
+
+## streamRate
+
+**Key:**
+<OptionTable
+  options={[
+    ['streamRate', 'Number', 'The rate at which data is streamed from the endpoint. Useful for controlling the pace of streaming data.', 'streamRate: 25'],
+  ]}
+/>
+
+**Default:** 1
+
+> Allows for streaming data at the fastest rate possible while allowing the system to wait for the next tick
+
+**Notes:**
+- The `all` setting would override all individual endpoint values, making those specific settings unnecessary if used.
+- The value can be customized for each endpoint or set globally using the `all` key.
+- Recommended values are between 25-40 for a smooth streaming experience
+- Using a higher rate is a must when serving the app to many users at scale.
+
+---
+
+# Endpoint Settings
+- [Custom Endpoints](/docs/configuration/librechat_yaml/object_structure/custom_endpoint)
+- [OpenAI](/docs/configuration/pre_configured_ai/openai)
+- [Anthropic](/docs/configuration/pre_configured_ai/anthropic)
+- [Google](/docs/configuration/pre_configured_ai/google)
+- [Azure OpenAI](/docs/configuration/librechat_yaml/object_structure/azure_openai)
+- [Assistants](/docs/configuration/librechat_yaml/object_structure/assistants)
\ No newline at end of file