feat:Remove word_boost and boost_param from transcript OpenAPI schemas #125
Conversation
WalkthroughRemoved word_boost and boost_param properties from transcript-related OpenAPI schemas and examples in src/libs/AssemblyAI/openapi.yaml. TranscriptBoostParam type remains but is no longer referenced. Minor documentation whitespace tweak. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 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. CodeRabbit Commands (Invoked using PR/Issue comments)Type 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: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (4)
src/libs/AssemblyAI/openapi.yaml (4)
1263-1269: Schema bug: use items, not objects, for arrays.
expected_languagesusesobjects:which is invalid JSON Schema/OpenAPI. This will break generators/validators.Apply:
expected_languages: x-label: Minimum speakers expected description: List of languages expected in the audio file. Defaults to `["all"]` when unspecified. type: array - objects: + items: x-label: language type: string
2634-2641: Same array bug in Transcript shape.Duplicate of the above issue in the read-only
language_detection_options.expected_languages.expected_languages: x-label: Minimum speakers expected description: List of languages expected in the audio file. Defaults to `["all"]` when unspecified. type: array - objects: + items: x-label: language type: string
1396-1403: Normalize substitution policy wording to match enum values.Docs say
entity_typein some places andentity_nameelsewhere, while enum =entity_name | hash. Align descriptions toentity_name.- description: The replacement logic for detected PII, can be `entity_type` or `hash`. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details. + description: The replacement logic for detected PII, can be `entity_name` or `hash`. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.And in
SubstitutionPolicy:- description: The replacement logic for detected PII, can be `entity_name` or `hash`. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details. + description: The replacement logic for detected PII, can be `entity_name` or `hash`. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.Also applies to: 1893-1906
2210-2222: Fix typo and stray enum label in SpeechModel.
- Typo: “mutli-language” → “multi-language”.
x-aai-enumcontainsnanowhich is not inenumlist. Remove or add toenum(likely remove).description: The model optimized for accuracy, low latency, ease of use, and mu - tli-language support. + lti-language support. ... - x-aai-enum: - best: - label: Best - nano: - label: Nano + x-aai-enum: + best: + label: Best(If
nanoshould exist, add it to theenumand document accordingly instead.)
🧹 Nitpick comments (3)
src/libs/AssemblyAI/openapi.yaml (3)
1691-1706: Orphan type: deprecate or remove TranscriptBoostParam.
TranscriptBoostParamis no longer referenced; keep it only if you need legacy SDKs, but mark it deprecated and ignore for Fern to avoid surfacing unused types.- TranscriptBoostParam: + TranscriptBoostParam: type: string x-label: Word boost level - description: How much to boost specified words + description: (Deprecated) Previously used to control word boosting. No longer supported. x-fern-sdk-group-name: transcripts + deprecated: true + x-fern-ignore: true
5106-5113: Fix prev_url description (points to previous page, not next).Minor doc accuracy issue.
- description: The URL to the next page of transcripts. The previous URL always points to a page with older transcripts. + description: The URL to the previous page of transcripts. The previous URL always points to a page with older transcripts.
1330-1333: Grammar: “We sends” → “We send”.User-facing docs.
- We sends two different types of webhook requests. + We send two different types of webhook requests.Also applies to: 2746-2749
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
⛔ Files ignored due to path filters (4)
src/libs/AssemblyAI/Generated/AssemblyAI.ITranscriptClient.ListTranscripts.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.Transcript.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.TranscriptOptionalParams.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.TranscriptClient.ListTranscripts.g.csis excluded by!**/generated/**
📒 Files selected for processing (1)
src/libs/AssemblyAI/openapi.yaml(1 hunks)
🔇 Additional comments (1)
src/libs/AssemblyAI/openapi.yaml (1)
175-175: LGTM on copy tweak.Whitespace/wording adjustment reads fine.
Summary by CodeRabbit
Breaking Changes
Documentation