feat:Deprecate custom_topics and remove assemblyai/mistral-7b model

[HavenDV]

Summary by CodeRabbit

• Chores
  • Deprecated an existing transcript option; users are advised to update their integrations.
  • Removed a previously available model from the selection, affecting any workflows that relied on it.

[coderabbitai]

Walkthrough

The pull request updates the openapi.yaml file in the AssemblyAI library. It marks the custom_topics parameter in the TranscriptOptionalParams schema as deprecated, and removes the assemblyai/mistral-7b model from the LemurModel enum. These changes indicate that the deprecated parameter is no longer recommended and that the removed model is no longer available for user selection.

Changes

File	Change Summary
src/libs/AssemblyAI/openapi.yaml	Deprecated custom_topics in TranscriptOptionalParams schema; Removed assemblyai/mistral-7b from LemurModel enum

Possibly related PRs

• feat:Update AssemblyAI OpenAPI spec with terminology and model deprecation changes #49: Addresses model deprecation and schema updates similar to the current changes.
• feat:Update openapi.yaml with new endpoints and improved query parameters #29: Updates the TranscriptOptionalParams schema with deprecation details and property removals.
• feat:Update openapi.yaml with model deprecations and improved documentation #14: Focuses on model deprecation and enhanced documentation within the openapi.yaml file.

Suggested reviewers

• github-actions

Poem

I’m a rabbit with a cheerful hop,
Munching carrots while changes never stop.
Deprecated hints and models cleared away,
In our API fields, ready for a new day.
Hop along, code—let’s waltz into a brighter way!
🥕🐇

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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. (Beta)
• @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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

src/libs/AssemblyAI/openapi.yaml (1)

1450-1456: Marking Custom Topics as Deprecated
The custom_topics parameter in the TranscriptOptionalParams schema is now explicitly marked as deprecated (via the added deprecated: true line). This is a clear indication to users that the parameter is no longer recommended for use.

If there is additional documentation or migration guidance for API consumers, please ensure it is updated accordingly.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1871c6d and 613e830.

⛔ Files ignored due to path filters (2)

• src/libs/AssemblyAI/Generated/AssemblyAI.Models.LemurModel.g.cs is excluded by !**/generated/**
• src/libs/AssemblyAI/Generated/AssemblyAI.Models.TranscriptOptionalParams.g.cs is excluded by !**/generated/**

📒 Files selected for processing (1)

• src/libs/AssemblyAI/openapi.yaml (1 hunks)

🔇 Additional comments (1)

src/libs/AssemblyAI/openapi.yaml (1)

5741-5749: ⚠️ Potential issue

Inconsistent Removal of the Mistral Model
According to the PR objectives and AI-generated summary, the assemblyai/mistral-7b model should be removed from the LemurModel enum. However, the block for assemblyai/mistral-7b is still present in this file. Please verify whether this model should indeed be removed. If removal is intended, you can apply a diff similar to the one below:

-        assemblyai/mistral-7b:
-          description: >
-            LeMUR Mistral 7B is an LLM self-hosted by AssemblyAI.
-            It's the fastest and cheapest of the LLM options. We recommend it for use cases like basic summaries and factual Q&A.
-          casing:
-            camel: assemblyaiMistral7b
-            snake: assemblyai_mistral7b
-            pascal: AssemblyaiMistral7b
-            screamingSnake: ASSEMBLYAI_MISTRAL7B

This will align the implementation with the intended API changes.

Likely an incorrect or invalid review comment.