Merge pull request #32 from LibreChat-AI/update-51924

🅰️ docs: Azure Assistants

components/mobileSwitch.tsx

@@ -26,6 +26,8 @@ export default function MobileSwitch(props: {
   }, [])
 
   return (
-    <div ref={objectRef}>{isMobile === null ? null : isMobile ? props.mobile : props.desktop}</div>
+    <div ref={objectRef}>
+      {isMobile === null ? null : isMobile ? <>{props.mobile}</> : <>{props.desktop}</>}
+    </div>
   )
 }

pages/changelog/config_v1.1.1.mdx

@@ -0,0 +1,14 @@
+---
+date: 2024/05/19
+title: ⚙️ Config v1.1.1
+---
+
+import { ChangelogHeader } from '@/components/changelog/ChangelogHeader'
+
+<ChangelogHeader />
+
+---
+
+- Added new `azureAssistants` endpoint to [librechat_yaml config](/docs/configuration/librechat_yaml/object_structure/assistants_endpoint)
+    - Uses the same structure as the `assistants` endpoint, but is separated to accomodate latest OpenAI Assistant v2 changes to the API.
+    - More info: [Azure OpenAI Configuration](/docs/configuration/librechat_yaml/ai_endpoints/azure#using-assistants-with-azure)

pages/docs/configuration/librechat_yaml/ai_endpoints/azure.mdx

@@ -321,7 +321,7 @@ The above configuration would enable `gpt-4-vision-preview`, `gpt-3.5-turbo` and
 
 To enable use of Assistants with Azure OpenAI, there are 2 main steps.
 
-1) Set the `assistants` field at the [Endpoint-level](#endpoint-level-configuration) to `true`, like so:
+1) Set the `assistants` field, **under** the `azureOpenAI` endpoint, i.e, at the [Endpoint-level](#endpoint-level-configuration) to `true`, like so:
 
 ```yaml filename="librechat.yaml"
 endpoints:
@@ -330,7 +330,7 @@ endpoints:
     assistants: true
 ```
 
-2) Add the `assistants` field to all groups compatible with Azure's Assistants API integration.
+2) Add the `assistants` field to groups compatible with Azure's Assistants API integration.
 
 - At least one of your group configurations must be compatible.
 - You can check the [compatible regions and models in the Azure docs here](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#assistants-preview).
@@ -354,23 +354,26 @@ endpoints:
 
 **Notes:**
 
+- For credentials, rely on custom envrionment variables specified at each assistants-compatible group configuration.
 - If you mark multiple regions as assistants-compatible, assistants you create will be aggregated across regions to the main assistant selection list.
 - Files you upload to Azure OpenAI, whether at the message or assistant level, will only be available in the region the current assistant's model is part of.
     - For this reason, it's recommended you use only one region or resource group for Azure OpenAI Assistants, or you will experience an error.
     - Uploading to "OpenAI" is the default behavior for official `code_interpeter` and `retrieval` capabilities.
 - Downloading files that assistants generate will soon be supported.
-- If the `ASSISTANTS_API_KEY` is still set to `user_provided` in your environment file `.env`, comment it out.
-- As of March 14th 2024, retrieval and streaming are not supported through Azure OpenAI.
-    - To avoid any errors with retrieval while it's not supported, it's recommended to disable the capability altogether through the `assistants` endpoint config:
+- As of May 19th 2024, retrieval and streaming are not yet supported through Azure OpenAI.
+    - To avoid any errors with retrieval while it's not supported, it's recommended to disable the capability altogether through the `azureAssistants` endpoint config:
 
     ```yaml filename="librechat.yaml"
     endpoints:
-      assistants:
+      azureOpenAI:
+        # ...rest
+
+      azureAssistants:
       # "retrieval" omitted.
         capabilities: ["code_interpreter", "actions", "tools"]
     ```
 
-    - By default, all capabilities are enabled.
+    - By default, all capabilities, except retrieval, are enabled.
 
 ### Using Plugins with Azure
 

pages/docs/configuration/librechat_yaml/object_structure/assistants_endpoint.mdx

@@ -1,13 +1,19 @@
 # Assistants Endpoint Object Structure
 
+This page applies to both the `assistants` and `azureAssistants` endpoints.
+
+**Note:** To enable `azureAssistants`, see the [Azure OpenAI Configuration](/docs/configuration/librechat_yaml/ai_endpoints/azure#using-assistants-with-azure) for more information.
+
 ## Example
 
 ```yaml filename="Assistants Endpoint"
 endpoints:
+  # azureAssistants: # <-- Azure-specific configuration has the same structure as `assistants`
+    #  pollIntervalMs: 500
+    #  timeoutMs: 10000
+
   assistants:
     disableBuilder: false
-    pollIntervalMs: 500
-    timeoutMs: 10000
     # Use either `supportedIds` or `excludedIds` but not both
     supportedIds: ["asst_supportedAssistantId1", "asst_supportedAssistantId2"]
     # excludedIds: ["asst_excludedAssistantId"]
@@ -43,12 +49,13 @@ disableBuilder: false
   ]}
 />
 
-**Default:** `750`
+**Default:** `2000`
 
 **Example:**
 ```yaml filename="endpoints / assistants / pollIntervalMs"
-pollIntervalMs: 500
+pollIntervalMs: 2500
 ```
+**Note:** Currently, this is only used by Azure Assistants. Higher values are recommended for Azure Assistants to avoid rate limiting errors.
 
 ## timeoutMs
 

pages/docs/configuration/librechat_yaml/object_structure/config.mdx

@@ -231,6 +231,7 @@ see: [Model Specs Object Structure](/docs/configuration/librechat_yaml/object_st
     ['custom', 'Array of Objects', 'Each object in the array represents a unique endpoint configuration.', ''],
     ['azureOpenAI', 'Object', 'Azure OpenAI endpoint-specific configuration', ''],
     ['assistants', 'Object', 'Assistants endpoint-specific configuration.', ''],
+    ['azureAssistants', 'Object', 'Azure Assistants endpoint-specific configuration.', ''],
   ]}
 />