Skip to content

Conversation

@HavenDV
Copy link
Contributor

@HavenDV HavenDV commented Sep 15, 2025

Summary by CodeRabbit

  • Documentation
    • Added EU server guidance for the Get redacted audio endpoint, specifying api.eu.assemblyai.com for EU requests.
    • Revised Keyterms prompt description to reflect model-specific limits: 200 words for Universal and 1000 words for Slam-1, replacing the previous single 1000-word limit.
    • Clarified endpoint usage notes to help ensure correct configuration for EU-based usage.

@coderabbitai
Copy link

coderabbitai bot commented Sep 15, 2025

Walkthrough

Updated OpenAPI spec descriptions: added EU server usage note to the Get redacted audio endpoint and revised Keyterms prompt limits to be model-specific.

Changes

Cohort / File(s) Summary of Change
OpenAPI spec text updates
src/libs/AssemblyAI/openapi.yaml
- Added EU server guidance for the Get redacted audio endpoint (use api.eu.assemblyai.com for EU).
- Updated Keyterms prompt description to model-specific limits: 200 words for Universal, 1000 for Slam-1.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Poem

A rabbit taps keys with a gentle hop,
Adds EU notes in a tidy swap.
Keyterms trimmed, models know their share—
200 here, 1000 there.
Specs now tidy, carrots in a row,
Onward we code—let’s ship and go! 🥕🚀

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Title Check ⚠️ Warning The changes touch src/libs/AssemblyAI/openapi.yaml—adding an EU server guidance note for the Get redacted audio endpoint and updating Keyterms prompt limits—yet the title "feat:@coderabbitai" does not describe these edits and reads like a bot/author tag rather than a concise summary of the main change. Because the title does not communicate the primary change or intent, it fails the requirement for a clear, descriptive PR title. This makes the PR history harder to scan and is potentially misleading to reviewers. Please rename the PR to a short, specific sentence that summarizes the primary change; for example: "docs(openapi): add EU server guidance for redacted-audio endpoint and update Keyterms prompt limits". Use a conventional prefix like docs/chore/feat as appropriate and avoid including bot handles or emojis in the title. After renaming, the title should be concise and clearly reflect the changes in openapi.yaml so reviewers can quickly understand the PR purpose.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ 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_202509151826

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@HavenDV HavenDV merged commit 66825c1 into main Sep 15, 2025
2 of 4 checks passed
@HavenDV HavenDV deleted the bot/update-openapi_202509151826 branch September 15, 2025 18:27
@coderabbitai coderabbitai bot changed the title feat:@coderabbitai feat:EU server note for redacted audio; Keyterms prompt limits by model Sep 15, 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: 0

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

556-559: Replace “above” with “this request” and match EU-note tone

Verified — single occurrence in src/libs/AssemblyAI/openapi.yaml (lines 556–559).

-        <Note>To retrieve the redacted audio on the EU server, replace `api.assemblyai.com` with `api.eu.assemblyai.com` in the `GET` request above.</Note>
+        <Note>To retrieve redacted audio on our EU server, replace `api.assemblyai.com` with `api.eu.assemblyai.com` in this request.</Note>

Optional: add https://api.eu.assemblyai.com to top-level servers.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 627b501 and 3e86a0c.

⛔ Files ignored due to path filters (3)
  • src/libs/AssemblyAI/Generated/AssemblyAI.ITranscriptClient.GetRedactedAudio.g.cs is excluded by !**/generated/**
  • src/libs/AssemblyAI/Generated/AssemblyAI.Models.Transcript.g.cs is excluded by !**/generated/**
  • src/libs/AssemblyAI/Generated/AssemblyAI.TranscriptClient.GetRedactedAudio.g.cs is excluded by !**/generated/**
📒 Files selected for processing (1)
  • src/libs/AssemblyAI/openapi.yaml (2 hunks)
🔇 Additional comments (1)
src/libs/AssemblyAI/openapi.yaml (1)

2883-2891: Clarify model‑specific Keyterms limits and keep both descriptions in sync.

Make the limits explicit and ensure both keyterms_prompt descriptions in src/libs/AssemblyAI/openapi.yaml (occurrences near lines 1475 and 2883) are identical.

-          description: |
-            Improve accuracy with up to 200 (for Universal) or 1000 (for Slam-1) domain-specific words or phrases (maximum 6 words per phrase).
+          description: |
+            Improve accuracy with up to 200 domain‑specific words or phrases when using the Universal model, or up to 1000 when using Slam‑1. Each phrase may include up to 6 words.

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