feat:Update LemurTaskParams schema to include LemurBaseParams properties and fields #110
Conversation
WalkthroughThe schema for Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Poem
✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
coderabbitai
bot
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🔭 Outside diff range comments (1)
src/libs/AssemblyAI/openapi.yaml (1)
5643-5657: Duplication oftranscript_idsviolates DRY and risks schema drift
transcript_idswas already defined inLemurBaseParams. By in-lining the same definition here you now maintain two authoritative copies. Any future bug-fix or evolution (e.g. max size, item format) must be applied twice or the two schemas will silently diverge.Prefer keeping a single source of truth via:
- allOf: - - type: object - additionalProperties: false - properties: - prompt: ... - transcript_ids: ... + allOf: + - type: object + additionalProperties: false + properties: + prompt: + ... + - $ref: "#/components/schemas/LemurBaseParams"This preserves the public surface while eliminating duplication.
🧹 Nitpick comments (1)
src/libs/AssemblyAI/openapi.yaml (1)
5676-5685:temperatureduplicated – constraint mismatch & maintenance hazardSame issue as above: constraints match today but will silently diverge on future edits. Keep this property in one place.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (3)
src/libs/AssemblyAI/Generated/AssemblyAI.JsonConverters.LemurTaskParams.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.LemurTaskParams.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.LemurTaskParamsVariant1.g.csis excluded by!**/generated/**
📒 Files selected for processing (1)
src/libs/AssemblyAI/openapi.yaml(1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
src/libs/AssemblyAI/openapi.yaml (2)
src/libs/AssemblyAI/Conversions/LemurTaskParams.cs (2)
struct(5-36)FromPrompt(25-35)src/libs/AssemblyAI/Conversions/LemurTaskParamsVariant1.cs (2)
FromPrompt(24-30)LemurTaskParamsVariant1(5-31)
🔇 Additional comments (1)
src/libs/AssemblyAI/openapi.yaml (1)
5664-5670: RestoreanyOfonfinal_modelto support custom model IDsThe current change replaces the previous union type (
enum ∪ string) with a strictoneOfreference toLemurModel, preventing clients from passing new or experimental model IDs without a spec bump. To maintain backward‐ and forward‐compatibility, restore the original definition:final_model: x-label: Final model description: | The model that is used for the final prompt after compression is performed. default: "default" anyOf: - $ref: "#/components/schemas/LemurModel" - type: stringLocations to update:
- src/libs/AssemblyAI/openapi.yaml (around lines 5664–5670)
| input_text: | ||
| x-label: Input text | ||
| description: | | ||
| Custom formatted transcript data. Maximum size is the context limit of the selected model. | ||
| Use either transcript_ids or input_text as input into LeMUR. | ||
| type: string | ||
| final_model: |
There was a problem hiding this comment.
input_text duplicated & still optional – but now mutually exclusive rule vanished
input_text duplicates the base definition and, more importantly, the prose rule “Use either transcript_ids or input_text” is no longer enforceable once inheritance is removed.
Consider re-using LemurBaseParams or adding an oneOf composition to keep mutual-exclusivity machine-readable.
🤖 Prompt for AI Agents
In src/libs/AssemblyAI/openapi.yaml around lines 5657 to 5663, the input_text
property is duplicated and the mutual exclusivity rule between transcript_ids
and input_text is lost. To fix this, refactor the schema to reuse
LemurBaseParams where input_text is defined or add a oneOf composition that
enforces either transcript_ids or input_text is provided, ensuring the mutual
exclusivity is machine-readable and not just in the description.
| x-label: Maximum output size | ||
| description: Max output size in tokens, up to 4000 | ||
| type: integer | ||
| default: 2000 | ||
| temperature: |
There was a problem hiding this comment.
max_output_size duplicated with no bounds check
The duplicated field omits minimum / maximum guards that still exist in LemurBaseParams. This widens the accepted range for the task endpoint only, creating inconsistent server validation.
🤖 Prompt for AI Agents
In src/libs/AssemblyAI/openapi.yaml around lines 5671 to 5675, the
max_output_size field is duplicated without minimum and maximum bounds, unlike
in LemurBaseParams. To fix this, add the same minimum and maximum constraints
(e.g., minimum: 1, maximum: 4000) to this max_output_size definition to ensure
consistent validation across endpoints.
| default: 0 | ||
| minimum: 0 | ||
| maximum: 1 | ||
| required: [prompt, final_model] |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Breaking change: context field silently removed
Existing clients may rely on context when calling /lemur/v3/generate/task. Removing it without a new version or deprecation period is a breaking API change.
If intentional, increment the API major version and document migration steps; otherwise restore the field via inheritance.
🏁 Script executed:
#!/bin/bash
# Locate the /lemur/v3/generate/task endpoint and inspect its requestBody schema (showing 20 lines of context)
rg -n "/lemur/v3/generate/task" -C20 src/libs/AssemblyAI/openapi.yamlLength of output: 1665
🏁 Script executed:
#!/bin/bash
# Inspect the LemurTaskParams schema to verify if 'context' was removed
rg -n "LemurTaskParams:" -C50 src/libs/AssemblyAI/openapi.yamlLength of output: 4448
Breaking change: context property removed from LeMUR task schema
The components/schemas/LemurTaskParams definition no longer includes a context field and only lists prompt, transcript_ids, input_text, final_model, max_output_size, and temperature as allowed properties (with additionalProperties: false), and the required array only contains [prompt, final_model]. Any clients sending context will now fail schema validation.
• File: src/libs/AssemblyAI/openapi.yaml
Location: components/schemas/LemurTaskParams (around line 5635)
Actions:
- If removal was intentional, bump the API’s major version and document migration steps for clients.
- Otherwise, restore the
contextproperty (e.g., via schema inheritance) to maintain backward compatibility.
🤖 Prompt for AI Agents
In src/libs/AssemblyAI/openapi.yaml around line 5635, the LemurTaskParams schema
has removed the 'context' property, causing breaking changes for clients using
it. To fix this, either restore the 'context' property in the schema to maintain
backward compatibility or, if the removal is intentional, increment the API's
major version and add clear migration instructions for clients to handle the
change.
Pull request was closed
Summary by CodeRabbit
New Features
Bug Fixes
Documentation