Skip to content

Commit 12f8c89

Browse files
docs: add groups to modelspecs (#429)
Co-authored-by: Dustin Healy <[email protected]>
1 parent 79b5d16 commit 12f8c89

File tree

1 file changed

+35
-17
lines changed

1 file changed

+35
-17
lines changed

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

Lines changed: 35 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ URL or a predefined endpoint name for the model's icon.
199199
]}
200200
/>
201201

202-
**Description:**
202+
**Description:**
203203
A brief description of the model and its intended use or role, shown in the header dropdown menu.
204204

205205
---
@@ -208,41 +208,59 @@ A brief description of the model and its intended use or role, shown in the head
208208

209209
<OptionTable
210210
options={[
211-
['group', 'String', 'Optional field to organize model specs in the UI selector with flexible grouping.', 'No default. Optional.'],
211+
['group', 'String', 'Optional group name for organizing model specs in the UI selector. Controls where the spec appears in the menu hierarchy.', 'No default. Optional.'],
212212
]}
213213
/>
214214

215-
**Description:**
216-
Optional group name for organizing specs in the UI selector. The behavior depends on the `group` value:
215+
**Description:**
216+
Optional group name for organizing model specs in the UI selector. The `group` field provides flexible control over how model specs are organized:
217217

218-
- **Endpoint name** (e.g., "openAI", "groq"): If `group` matches an existing endpoint name, the spec appears nested under that endpoint in the UI
219-
- **Custom name**: If `group` is a custom string that doesn't match any endpoint, it creates a separate collapsible section with that name
220-
- **Omitted**: If `group` is not specified, the spec appears as a standalone item at the top level
218+
- **If `group` matches an endpoint name** (e.g., `"openAI"`, `"groq"`): The model spec appears nested under that endpoint in the selector menu
219+
- **If `group` is a custom name** (doesn't match any endpoint): Creates a separate collapsible section with that name
220+
- **If `group` is omitted**: The model spec appears as a standalone item at the top level
221+
222+
This feature is particularly useful when you want to add descriptions to models without losing the organizational structure of the selector menu.
221223

222224
**Example:**
223-
```yaml filename="modelSpecs / group"
225+
226+
```yaml filename="modelSpecs with group field examples"
224227
modelSpecs:
225228
list:
226-
# Nested under openAI endpoint
227-
- name: "gpt-4o-custom"
229+
# Example 1: Nested under an endpoint
230+
# When group matches an endpoint name, the spec appears under that endpoint
231+
- name: "gpt-4o-optimized"
228232
label: "GPT-4 Optimized"
229-
group: "openAI" # Matches endpoint name
233+
description: "Most capable GPT-4 model with multimodal support"
234+
group: "openAI" # Appears nested under the OpenAI endpoint
230235
preset:
231236
endpoint: "openAI"
232237
model: "gpt-4o"
233-
234-
# Custom group section
238+
239+
# Example 2: Custom group section
240+
# When group is a custom name, it creates a separate collapsible section
235241
- name: "coding-assistant"
236242
label: "Coding Assistant"
237-
group: "my-assistants" # Custom group
243+
description: "Specialized for coding tasks"
244+
group: "my-assistants" # Creates a custom "my-assistants" section
238245
preset:
239246
endpoint: "openAI"
240247
model: "gpt-4o"
241-
242-
# Standalone at top level
248+
249+
# Multiple specs with the same group name are grouped together
250+
- name: "writing-assistant"
251+
label: "Writing Assistant"
252+
description: "Specialized for creative writing"
253+
group: "my-assistants" # Grouped together with coding-assistant
254+
preset:
255+
endpoint: "anthropic"
256+
model: "claude-sonnet-4"
257+
258+
# Example 3: Standalone (no group)
259+
# When group is omitted, the spec appears at the top level
243260
- name: "general-assistant"
244261
label: "General Assistant"
245-
# No group field - appears at top level
262+
description: "General purpose assistant"
263+
# No group field - appears as standalone item at top level
246264
preset:
247265
endpoint: "openAI"
248266
model: "gpt-4o-mini"

0 commit comments

Comments
 (0)