feat:Expand AssemblyAI schema with advanced transcript features#149
Merged
feat:Expand AssemblyAI schema with advanced transcript features#149
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
WalkthroughThis PR significantly expands the AssemblyAI OpenAPI schema to introduce advanced transcript processing features including multilingual language detection, PII redaction with audio options, content safety/moderation, speech understanding capabilities (translation, speaker identification, custom formatting), and structured transcript elements like chapters and entities. LeMUR endpoints are disabled, and new error handling for 403 responses is added. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~30 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
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: 5
🧹 Nitpick comments (1)
src/libs/AssemblyAI/openapi.yaml (1)
6120-6129: Enforceknown_valueswhenspeaker_type=rolein-schema.Line 6128 states
known_valuesis required forspeaker_type: role, but the schema currently doesn’t enforce it. Add conditional validation (if/thenoroneOf) to prevent invalid requests passing schema validation.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/libs/AssemblyAI/openapi.yaml` around lines 6120 - 6129, The schema currently declares speaker_type and known_values but doesn't enforce that known_values is present when speaker_type is "role"; update the OpenAPI schema for the object containing speaker_type/known_values to add a conditional validation (use an if/then block) — use an if that checks properties.speaker_type.const = "role" and a then that adds required: ["known_values"] and (optionally) enforces items.maxLength: 35 for known_values; reference the existing speaker_type and known_values definitions when adding the if/then so the schema rejects requests missing known_values when speaker_type is "role".
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@src/libs/AssemblyAI/openapi.yaml`:
- Around line 1582-1583: Fix the grammar in the webhook description strings:
locate the occurrences of the sentence fragment "We sends two different types of
webhook requests." (appearing in openapi.yaml around the webhook description
entries) and change "We sends" to "We send" in both places (the entry containing
the transcript/redacted-audio description and the similar entry near lines
3084-3085) so the descriptions read "We send two different types of webhook
requests."
- Around line 1241-1243: The examples for the TranscriptOptionalParams schema
are invalid because speech_models is now required; update each example block
referenced (the two examples around lines ~1613–1661 and ~1681–1730) to include
a valid speech_models property that matches the schema (e.g., provide an array
or object as defined by speech_models); locate the examples near the
TranscriptOptionalParams schema and add the required speech_models field with an
appropriate example value to each example so they validate against the schema.
- Around line 3144-3153: The translated_texts schema currently defines a fixed
property "language_code" which contradicts "keyed by language code"; update the
"translated_texts" schema to allow dynamic language keys by removing the fixed
"language_code" property and adding additionalProperties with type: string (same
pattern used by the Utterance schema) so entries like {"es": "...", "de": "..."}
are accepted; target the translated_texts schema in the OpenAPI file when making
this change.
- Line 45: Add a 403 response for the POST /v2/transcript operation in
src/libs/AssemblyAI/openapi.yaml to mirror the existing 403 declared for
/v2/upload: create a response named CannotAccessUploadedFile (or reuse that
response object) with the same description/message ("Cannot access uploaded
file" / 403) and schema as used by the /v2/upload 403 response so the contract
reflects the documented warning about using mismatched project API keys when
transcribing uploaded files.
- Around line 3141-3143: Remove the invalid required constraint placed under the
Transcript schema's topics array: locate the Transcript schema's "topics"
property and delete the misplaced "required: - request" block (the constraint
referencing "request" belongs to the speech_understanding object schema, not a
string array). Ensure no other array-type properties include a "required" field
and keep the correct "required: [request]" only within the speech_understanding
object schema where "request" is an actual property.
---
Nitpick comments:
In `@src/libs/AssemblyAI/openapi.yaml`:
- Around line 6120-6129: The schema currently declares speaker_type and
known_values but doesn't enforce that known_values is present when speaker_type
is "role"; update the OpenAPI schema for the object containing
speaker_type/known_values to add a conditional validation (use an if/then block)
— use an if that checks properties.speaker_type.const = "role" and a then that
adds required: ["known_values"] and (optionally) enforces items.maxLength: 35
for known_values; reference the existing speaker_type and known_values
definitions when adding the if/then so the schema rejects requests missing
known_values when speaker_type is "role".
ℹ️ Review info
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (130)
src/libs/AssemblyAI/Generated/AnyOf.2.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI..JsonSerializerContext.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.AssemblyAIClient.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.IAssemblyAIClient.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.ILeMURClient.GetLemurResponse.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.ILeMURClient.LemurQuestionAnswer.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.ILeMURClient.LemurSummary.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.ILeMURClient.LemurTask.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.ILeMURClient.PurgeLemurRequestData.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.ILeMURClient.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.ITranscriptClient.DeleteTranscript.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.ITranscriptClient.GetRedactedAudio.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.ITranscriptClient.ListTranscripts.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.ITranscriptClient.UploadFile.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.JsonConverters.ErrorStatusNullable.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.JsonConverters.OneOf3.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.JsonConverters.SpeakerIdentificationRequestBodySpeakerIdentificationSpeakerType.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.JsonConverters.SpeakerIdentificationRequestBodySpeakerIdentificationSpeakerTypeNullable.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.JsonConverters.SpeechModel.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.JsonSerializerContextTypes.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.LeMURClient.GetLemurResponse.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.LeMURClient.LemurQuestionAnswer.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.LeMURClient.LemurSummary.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.LeMURClient.LemurTask.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.LeMURClient.PurgeLemurRequestData.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.LeMURClient.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.AutoHighlightResult.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.AutoHighlightsResult.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.AutoHighlightsResult2.Json.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.AutoHighlightsResult2.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.Chapter.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.ContentSafetyLabel.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.ContentSafetyLabelResult.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.ContentSafetyLabelsResult.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.CreateRealtimeTemporaryTokenParams.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.CustomFormattingRequestBody.Json.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.CustomFormattingRequestBody.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.CustomFormattingRequestBodyCustomFormatting.Json.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.CustomFormattingRequestBodyCustomFormatting.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.CustomFormattingResponse.Json.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.CustomFormattingResponse.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.CustomFormattingResponseCustomFormatting.Json.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.CustomFormattingResponseCustomFormatting.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.CustomFormattingResponseCustomFormattingMapping.Json.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.CustomFormattingResponseCustomFormattingMapping.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.Entity.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.Error.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.ErrorStatus.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.LemurActionItemsParams.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.LemurActionItemsResponse.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.LemurBaseParams.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.LemurBaseResponse.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.LemurQuestion.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.LemurQuestionAnswer.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.LemurQuestionAnswerParams.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.LemurQuestionAnswerResponse.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.LemurResponse.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.LemurStringResponse.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.LemurSummaryParams.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.LemurSummaryResponse.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/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.LemurTaskResponse.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.ListTranscriptParams.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.PageDetails.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.ParagraphsResponse.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.PurgeLemurRequestDataResponse.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.RealtimeTemporaryTokenResponse.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.RedactedAudioNotification.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.RedactedAudioResponse.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.SentencesResponse.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.SentimentAnalysisResult.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.SeverityScoreSummary.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.SpeakerIdentificationRequestBody.Json.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.SpeakerIdentificationRequestBody.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.SpeakerIdentificationRequestBodySpeakerIdentification.Json.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.SpeakerIdentificationRequestBodySpeakerIdentification.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.SpeakerIdentificationRequestBodySpeakerIdentificationSpeakerType.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.SpeakerIdentificationResponse.Json.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.SpeakerIdentificationResponse.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.SpeakerIdentificationResponseSpeakerIdentification.Json.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.SpeakerIdentificationResponseSpeakerIdentification.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.SpeechModel.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.Timestamp.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.TopicDetectionModelResult.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.TopicDetectionResult.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.TopicDetectionResultLabel.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.Transcript.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.TranscriptCustomSpelling.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.TranscriptLanguageDetectionOptions.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.TranscriptList.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.TranscriptListItem.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.TranscriptOptionalParams.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.TranscriptOptionalParamsLanguageDetectionOptions.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.TranscriptOptionalParamsSpeakerOptions.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.TranscriptOptionalParamsSpeechUnderstanding.Json.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.TranscriptOptionalParamsSpeechUnderstanding.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.TranscriptParagraph.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.TranscriptParams.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.TranscriptReadyNotification.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.TranscriptSentence.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.TranscriptSpeechUnderstanding.Json.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.TranscriptSpeechUnderstanding.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.TranscriptTranslatedTexts.Json.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.TranscriptTranslatedTexts.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.TranscriptUtterance.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.TranscriptUtteranceTranslatedTexts.Json.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.TranscriptUtteranceTranslatedTexts.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.TranscriptWebhookNotification.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.TranscriptWord.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.TranslationRequestBody.Json.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.TranslationRequestBody.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.TranslationRequestBodyTranslation.Json.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.TranslationRequestBodyTranslation.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.TranslationResponse.Json.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.TranslationResponse.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.TranslationResponseTranslation.Json.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.TranslationResponseTranslation.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.UploadedFile.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.WordSearchMatch.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.Models.WordSearchResponse.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.TranscriptClient.DeleteTranscript.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.TranscriptClient.GetRedactedAudio.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.TranscriptClient.GetSubtitles.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.TranscriptClient.ListTranscripts.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.TranscriptClient.UploadFile.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/AssemblyAI.TranscriptClient.WordSearch.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/OneOf.2.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/OneOf.3.Json.g.csis excluded by!**/generated/**src/libs/AssemblyAI/Generated/OneOf.3.g.csis excluded by!**/generated/**
📒 Files selected for processing (1)
src/libs/AssemblyAI/openapi.yaml
| Upload a media file to AssemblyAI's servers. | ||
|
|
||
| <Note>To upload a media file to our EU server, replace `api.assemblyai.com` with `api.eu.assemblyai.com`.</Note> | ||
| <Warning>Requests to transcribe uploaded files must use an API key from the same project as the key that was used to upload the file. If you use an API key from a different project you will get a `403` error and "Cannot access uploaded file" message.</Warning> |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
# First, let's check the file size and read the relevant sections
wc -l src/libs/AssemblyAI/openapi.yamlRepository: tryAGI/AssemblyAI
Length of output: 98
🏁 Script executed:
# Read lines around line 45 to see the warning and endpoint definition
sed -n '35,55p' src/libs/AssemblyAI/openapi.yamlRepository: tryAGI/AssemblyAI
Length of output: 891
🏁 Script executed:
# Read lines around 67-68 to see the /v2/upload 403 response
sed -n '60,75p' src/libs/AssemblyAI/openapi.yamlRepository: tryAGI/AssemblyAI
Length of output: 615
🏁 Script executed:
# Find the POST /v2/transcript endpoint and check its responses section
sed -n '1,150p' src/libs/AssemblyAI/openapi.yaml | grep -n -A 20 "^ /v2/transcript:"Repository: tryAGI/AssemblyAI
Length of output: 842
🏁 Script executed:
# Let's get a broader view of the POST /v2/transcript responses section
# Search for the entire /v2/transcript endpoint and its responses
rg -n "^ /v2/transcript:" -A 50 src/libs/AssemblyAI/openapi.yaml | head -70Repository: tryAGI/AssemblyAI
Length of output: 2232
🏁 Script executed:
# Get the complete responses section for POST /v2/transcript
sed -n '99,140p' src/libs/AssemblyAI/openapi.yamlRepository: tryAGI/AssemblyAI
Length of output: 1705
Add 403 CannotAccessUploadedFile response to POST /v2/transcript.
The warning at line 45 describes a 403 error that occurs when transcribing uploaded files with a different project's API key. However, the 403 response is declared only on /v2/upload, not on POST /v2/transcript where the error would actually occur. Add the 403 response to the /v2/transcript endpoint to match the documented behavior.
Suggested contract fix
/v2/transcript:
post:
responses:
"200":
x-label: Transcript created
description: Transcript created and queued for processing
+ "403":
+ $ref: "#/components/responses/CannotAccessUploadedFile"
"400":
$ref: "#/components/responses/BadRequest"🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@src/libs/AssemblyAI/openapi.yaml` at line 45, Add a 403 response for the POST
/v2/transcript operation in src/libs/AssemblyAI/openapi.yaml to mirror the
existing 403 declared for /v2/upload: create a response named
CannotAccessUploadedFile (or reuse that response object) with the same
description/message ("Cannot access uploaded file" / 403) and schema as used by
the /v2/upload 403 response so the contract reflects the documented warning
about using mismatched project API keys when transcribing uploaded files.
Comment on lines
+1241
to
1243
| required: | ||
| - speech_models | ||
| properties: |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
# First, let's check the file exists and get its total line count
wc -l src/libs/AssemblyAI/openapi.yamlRepository: tryAGI/AssemblyAI
Length of output: 98
🏁 Script executed:
# Read lines 1241-1243 to see the schema requirement definition
sed -n '1235,1250p' src/libs/AssemblyAI/openapi.yamlRepository: tryAGI/AssemblyAI
Length of output: 588
🏁 Script executed:
# Read the first example at lines 1613-1661
sed -n '1610,1665p' src/libs/AssemblyAI/openapi.yamlRepository: tryAGI/AssemblyAI
Length of output: 1837
🏁 Script executed:
# Read the second example at lines 1681-1730
sed -n '1675,1735p' src/libs/AssemblyAI/openapi.yamlRepository: tryAGI/AssemblyAI
Length of output: 2099
Examples are invalid after making speech_models required.
The speech_models field is marked as required in the TranscriptOptionalParams schema (line 1242), but both examples omit it:
- Lines 1613–1661: Missing
speech_models - Lines 1681–1730: Missing
speech_models
Both examples should include speech_models to comply with the schema requirement.
Suggested example fix
example:
{
+ speech_models: ["your_preferred_model"],
speech_model: null,
language_code: "en_us",
...
}
example:
{
+ speech_models: ["your_preferred_model"],
speech_model: null,
language_code: "en_us",
...
}🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@src/libs/AssemblyAI/openapi.yaml` around lines 1241 - 1243, The examples for
the TranscriptOptionalParams schema are invalid because speech_models is now
required; update each example block referenced (the two examples around lines
~1613–1661 and ~1681–1730) to include a valid speech_models property that
matches the schema (e.g., provide an array or object as defined by
speech_models); locate the examples near the TranscriptOptionalParams schema and
add the required speech_models field with an appropriate example value to each
example so they validate against the schema.
Comment on lines
+1582
to
+1583
| We sends two different types of webhook requests. | ||
| One request when a transcript is completed or failed, and one request when the redacted audio is ready if redact_pii_audio is enabled. |
There was a problem hiding this comment.
Fix grammar in webhook description.
Line 1582 and Line 3084 use “We sends…”. Change to “We send…”.
Also applies to: 3084-3085
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@src/libs/AssemblyAI/openapi.yaml` around lines 1582 - 1583, Fix the grammar
in the webhook description strings: locate the occurrences of the sentence
fragment "We sends two different types of webhook requests." (appearing in
openapi.yaml around the webhook description entries) and change "We sends" to
"We send" in both places (the entry containing the transcript/redacted-audio
description and the similar entry near lines 3084-3085) so the descriptions read
"We send two different types of webhook requests."
Comment on lines
+3141
to
+3143
| required: | ||
| - request | ||
|
|
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
# First, let's examine the context around lines 3141-3143
sed -n '3130,3160p' src/libs/AssemblyAI/openapi.yaml | cat -nRepository: tryAGI/AssemblyAI
Length of output: 1072
🏁 Script executed:
# Look at the broader context to see what schema/section this is part of
sed -n '3100,3160p' src/libs/AssemblyAI/openapi.yaml | cat -nRepository: tryAGI/AssemblyAI
Length of output: 2490
🏁 Script executed:
# Look further up to find the schema name and understand the parent structure
sed -n '3050,3110p' src/libs/AssemblyAI/openapi.yaml | cat -nRepository: tryAGI/AssemblyAI
Length of output: 3141
🏁 Script executed:
# Look further up to find the schema name
sed -n '3000,3060p' src/libs/AssemblyAI/openapi.yaml | cat -nRepository: tryAGI/AssemblyAI
Length of output: 3165
🏁 Script executed:
# Look further up to find the schema definition name
sed -n '2900,2950p' src/libs/AssemblyAI/openapi.yaml | cat -nRepository: tryAGI/AssemblyAI
Length of output: 2713
🏁 Script executed:
# Find the schema name by looking for the properties declaration
sed -n '2850,2910p' src/libs/AssemblyAI/openapi.yaml | cat -nRepository: tryAGI/AssemblyAI
Length of output: 3331
🏁 Script executed:
# Find the schema definition name
sed -n '2800,2860p' src/libs/AssemblyAI/openapi.yaml | cat -nRepository: tryAGI/AssemblyAI
Length of output: 2942
🏁 Script executed:
# Find the schema definition name
sed -n '2700,2810p' src/libs/AssemblyAI/openapi.yaml | cat -nRepository: tryAGI/AssemblyAI
Length of output: 5193
🏁 Script executed:
# Find the schema name
sed -n '2600,2710p' src/libs/AssemblyAI/openapi.yaml | cat -nRepository: tryAGI/AssemblyAI
Length of output: 4445
🏁 Script executed:
# Search for speech_understanding schema definition
rg -n "speech_understanding" src/libs/AssemblyAI/openapi.yaml | head -20Repository: tryAGI/AssemblyAI
Length of output: 204
🏁 Script executed:
# Look at the speech_understanding definitions to understand their structure
sed -n '1520,1570p' src/libs/AssemblyAI/openapi.yaml | cat -nRepository: tryAGI/AssemblyAI
Length of output: 2238
🏁 Script executed:
# Verify the exact indentation and context around lines 3141-3143
sed -n '3138,3148p' src/libs/AssemblyAI/openapi.yaml | cat -ARepository: tryAGI/AssemblyAI
Length of output: 337
Remove misplaced required constraint under topics property.
The required: [request] constraint on lines 3141–3143 is incorrectly placed under the topics array property in the Transcript schema. Array types in OpenAPI do not support a required field, and "request" is not a valid constraint for a string array. This appears to be leftover code from the speech_understanding schema, where required: [request] is properly used to mark the request property as mandatory within an object type.
Suggested cleanup
topics:
x-label: Topics
description: This parameter does not currently have any functionality attached to it.
type: array
items:
x-label: Topic
type: string
deprecated: true
-
- required:
- - request🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@src/libs/AssemblyAI/openapi.yaml` around lines 3141 - 3143, Remove the
invalid required constraint placed under the Transcript schema's topics array:
locate the Transcript schema's "topics" property and delete the misplaced
"required: - request" block (the constraint referencing "request" belongs to the
speech_understanding object schema, not a string array). Ensure no other
array-type properties include a "required" field and keep the correct "required:
[request]" only within the speech_understanding object schema where "request" is
an actual property.
Comment on lines
+3144
to
+3153
| translated_texts: | ||
| # x-label: Translated text | ||
| type: object | ||
| description: Translated text keyed by language code | ||
| properties: | ||
| language_code: | ||
| x-label: Language code | ||
| type: string | ||
| description: Translated text for this language code | ||
|
|
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
# First, check if the file exists and read the specific lines
file_path="src/libs/AssemblyAI/openapi.yaml"
if [ -f "$file_path" ]; then
wc -l "$file_path"
echo "--- Lines 3144-3153 ---"
sed -n '3144,3153p' "$file_path"
echo ""
echo "--- Context around these lines (3140-3160) ---"
sed -n '3140,3160p' "$file_path"
else
echo "File not found: $file_path"
fiRepository: tryAGI/AssemblyAI
Length of output: 1009
🏁 Script executed:
# Search for other instances of similar patterns in the schema
# to understand if translated_texts should be a map or fixed property
rg "translated_texts|additionalProperties" src/libs/AssemblyAI/openapi.yaml -A 5 -B 2Repository: tryAGI/AssemblyAI
Length of output: 15214
Use additionalProperties to support dynamic language code keys.
The description states "keyed by language code", but the current schema defines a fixed language_code property instead. This mismatch prevents the field from accepting multiple language translations (e.g., {"es": "...", "de": "..."}). The Utterance schema in this same file correctly implements this pattern using additionalProperties: type: string, which should be applied here as well.
Suggested schema fix
translated_texts:
- # x-label: Translated text
+ x-label: Translated texts
type: object
description: Translated text keyed by language code
- properties:
- language_code:
- x-label: Language code
- type: string
- description: Translated text for this language code
+ additionalProperties:
+ type: string🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@src/libs/AssemblyAI/openapi.yaml` around lines 3144 - 3153, The
translated_texts schema currently defines a fixed property "language_code" which
contradicts "keyed by language code"; update the "translated_texts" schema to
allow dynamic language keys by removing the fixed "language_code" property and
adding additionalProperties with type: string (same pattern used by the
Utterance schema) so entries like {"es": "...", "de": "..."} are accepted;
target the translated_texts schema in the OpenAPI file when making this change.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit
Release Notes