Skip to content

Conversation

@HavenDV
Copy link
Contributor

@HavenDV HavenDV commented Jul 31, 2025

Summary by CodeRabbit

  • New Features

    • Expanded task parameter options to support specifying transcript IDs or input text as inputs.
    • Made the model selection (final_model) a required field for tasks.
    • Added new options for controlling output size and temperature settings.
  • Documentation

    • Updated example usage to reflect the latest input options and requirements.

@coderabbitai
Copy link

coderabbitai bot commented Jul 31, 2025

Walkthrough

The schema for LemurTaskParams in the OpenAPI specification was refactored to directly include properties previously inherited from LemurBaseParams. New properties were added, required fields were updated, and the example was modified to reflect these changes. Inheritance via $ref was removed.

Changes

Cohort / File(s) Change Summary
LemurTaskParams Schema Refactor
src/libs/AssemblyAI/openapi.yaml
Removed $ref inheritance from LemurBaseParams; explicitly defined properties (transcript_ids, input_text, final_model, max_output_size, temperature); updated required fields (prompt, final_model); revised example (removed context).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Poem

A schema hops, it sheds its shell,
Inheritance gone, new fields now dwell.
Lemur’s tasks are clear and bright,
With models, text, and IDs in sight.
The prompt and model now required—
By tidy YAML, rabbits are inspired! 🐇✨

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch bot/update-openapi_202507311522

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.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@HavenDV HavenDV enabled auto-merge (squash) July 31, 2025 15:23
@coderabbitai coderabbitai bot changed the title feat:@coderabbitai feat:Refactor LemurTaskParams schema to inline properties and update fields Jul 31, 2025
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🔭 Outside diff range comments (1)
src/libs/AssemblyAI/openapi.yaml (1)

5643-5663: context field was dropped – this is a breaking API change

LemurTaskParams previously inherited context from LemurBaseParams; after the in-place expansion the field is missing.
Any client code that relies on passing conversation context will now fail schema validation.

If the omission is intentional, bump the major version and document the migration path.
Otherwise, re-introduce the property (or keep delegating to LemurBaseParams) to preserve backward compatibility.

🧹 Nitpick comments (1)
src/libs/AssemblyAI/openapi.yaml (1)

5647-5685: Code duplication – consider reverting to $ref inheritance

By inlining all properties from LemurBaseParams you now maintain the same definitions twice (transcript_ids, input_text, max_output_size, temperature, etc.).
This increases drift risk – a future edit to the base schema will not propagate here.

Re-use $ref (composition) and extend only where the task schema truly diverges (e.g., prompt, extra required list).

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between eaafad3 and 988b9c0.

⛔ Files ignored due to path filters (3)
  • src/libs/AssemblyAI/Generated/AssemblyAI.JsonConverters.LemurTaskParams.g.cs is excluded by !**/generated/**
  • src/libs/AssemblyAI/Generated/AssemblyAI.Models.LemurTaskParams.g.cs is excluded by !**/generated/**
  • src/libs/AssemblyAI/Generated/AssemblyAI.Models.LemurTaskParamsVariant1.g.cs is 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)

5684-5686: Required final_model clashes with its own default and existing behaviour

final_model is now listed in required, meaning callers must always supply it.
However:

  1. A default of "default" is still provided – redundant once the field is required.
  2. The C# helpers (FromPrompt, etc.) relied on the absence of the field to inject "default" automatically, so generation code will now emit payloads that violate the new schema.

Either:

  • Drop final_model from required (maintains current UX), or
  • Remove the default and update SDK generators / helpers accordingly.

Comment on lines +5664 to +5670
x-label: Final model
description: |
The model that is used for the final prompt after compression is performed.
default: "default"
oneOf:
- $ref: "#/components/schemas/LemurModel"
max_output_size:
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

final_model typing narrowed and loses free-form fallback

LemurBaseParams uses

anyOf:
  - $ref: "#/components/schemas/LemurModel"
  - type: string        # allow future / custom model IDs

Here the replacement switches to a oneOf with only the enum reference, forbidding arbitrary strings.
This silently breaks clients that send unreleased / private model names and removes forward-compatibility.

Consider restoring the anyOf union or leaving the property in the shared base schema.

🤖 Prompt for AI Agents
In src/libs/AssemblyAI/openapi.yaml around lines 5664 to 5670, the final_model
property was changed from an anyOf union allowing both LemurModel references and
arbitrary strings to a oneOf with only the LemurModel reference, which removes
support for custom or future model IDs. To fix this, revert the change to use
anyOf with both the LemurModel schema reference and a string type to preserve
forward compatibility and allow free-form model identifiers.

@HavenDV HavenDV closed this Aug 1, 2025
auto-merge was automatically disabled August 1, 2025 10:52

Pull request was closed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants