Skip to content

feat:Update LemurBaseParams schema documentation for transcript_ids and input_text #94

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
HavenDV merged 1 commit into from
Jul 8, 2025
Merged

feat:Update LemurBaseParams schema documentation for transcript_ids and input_text #94

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/libs/AssemblyAI/Generated/AssemblyAI.Models.LemurBaseParams.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ public sealed partial class LemurBaseParams
public required global::AssemblyAI.AnyOf<global::AssemblyAI.LemurModel?, string> FinalModel { get; set; } = "default";

/// <summary>
/// Custom formatted transcript data. Maximum size is the context limit of the selected model, which defaults to 100000.<br/>
/// Custom formatted transcript data. Maximum size is the context limit of the selected model.<br/>
/// Use either transcript_ids or input_text as input into LeMUR.
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("input_text")]
Expand All @@ -51,7 +51,7 @@ public sealed partial class LemurBaseParams
public float? Temperature { get; set; }

/// <summary>
/// A list of completed transcripts with text. Up to a maximum of 100 files or 100 hours, whichever is lower.<br/>
/// A list of completed transcripts with text. Up to a maximum of 100 hours.<br/>
/// Use either transcript_ids or input_text as input into LeMUR.
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("transcript_ids")]
Expand All @@ -74,7 +74,7 @@ public sealed partial class LemurBaseParams
/// Default Value: default
/// </param>
/// <param name="inputText">
/// Custom formatted transcript data. Maximum size is the context limit of the selected model, which defaults to 100000.<br/>
/// Custom formatted transcript data. Maximum size is the context limit of the selected model.<br/>
/// Use either transcript_ids or input_text as input into LeMUR.
/// </param>
/// <param name="maxOutputSize">
Expand All @@ -88,7 +88,7 @@ public sealed partial class LemurBaseParams
/// Default Value: 0F
/// </param>
/// <param name="transcriptIds">
/// A list of completed transcripts with text. Up to a maximum of 100 files or 100 hours, whichever is lower.<br/>
/// A list of completed transcripts with text. Up to a maximum of 100 hours.<br/>
/// Use either transcript_ids or input_text as input into LeMUR.
/// </param>
#if NET7_0_OR_GREATER
Expand Down
4 changes: 2 additions & 2 deletions src/libs/AssemblyAI/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5577,7 +5577,7 @@ components:
transcript_ids:
x-label: Transcript IDs
description: |
A list of completed transcripts with text. Up to a maximum of 100 files or 100 hours, whichever is lower.
A list of completed transcripts with text. Up to a maximum of 100 hours.
Use either transcript_ids or input_text as input into LeMUR.
type: array
Comment on lines 5577 to 5582
Copy link

@coderabbitai coderabbitai bot Jul 8, 2025

Choose a reason for hiding this comment

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

💡 Verification agent

🧩 Analysis chain

Description change leaves the array unconstrained – consider adding a formal maxItems or clarifying docs

The previous wording (“100 files or 100 hours”) communicated two independent limits.
After the edit the hours-based limit remains, but the array length is now unspecified.
Because OpenAPI cannot express a duration constraint, clients will infer the only enforced limit is hours and might push thousands of transcript_ids in one call.

If the backend still restricts the list size (e.g. 100 transcripts), add an explicit schema constraint:

         items:
           x-label: Transcript ID
           type: string
           format: uuid
+        maxItems: 100        # hard cap retained from the original spec

At minimum, extend the sentence to state whether the number of transcripts is unlimited.
Without this, SDKs and generated docs lose an important contract.

🏁 Script executed:

#!/bin/bash
# Locate the transcript_ids definition
grep -R "transcript_ids:" -n src/libs/AssemblyAI/openapi.yaml

# Show the surrounding context of that block
sed -n '5560,5600p' src/libs/AssemblyAI/openapi.yaml

# Check for any existing maxItems constraints in the file
grep -R "maxItems" -n src/libs/AssemblyAI/openapi.yaml

Length of output: 1958

Add explicit maxItems to the transcript_ids array

We confirmed that the transcript_ids schema in src/libs/AssemblyAI/openapi.yaml (around lines 5577–5582) lacks a maxItems constraint, even though the description still mentions “100 hours” and the original spec enforced a 100-item cap. Without this, generated clients may assume unlimited IDs.

Please update the schema as follows:

   properties:
     transcript_ids:
       x-label: Transcript IDs
       description: |
         A list of completed transcripts with text. Up to a maximum of 100 hours.
         Use either transcript_ids or input_text as input into LeMUR.
       type: array
-      items:
+      items:
         x-label: Transcript ID
         type: string
         format: uuid
+      maxItems: 100        # enforce the original 100-transcript limit

If the service truly allows unlimited transcript IDs regardless of count, please clarify in the description instead.

Committable suggestion skipped: line range outside the PR's diff.

🤖 Prompt for AI Agents 
In src/libs/AssemblyAI/openapi.yaml around lines 5577 to 5582, the
transcript_ids array schema is missing a maxItems constraint, which should limit
the number of items to 100 as per the original specification. Add a maxItems:
100 property to the transcript_ids array definition to explicitly enforce this
limit and align with the description. If the service actually supports unlimited
transcript IDs, update the description to clarify this instead.

items:
Expand All @@ -5587,7 +5587,7 @@ components:
input_text:
x-label: Input text
description: |
Custom formatted transcript data. Maximum size is the context limit of the selected model, which defaults to 100000.
Custom formatted transcript data. Maximum size is the context limit of the selected model.
Use either transcript_ids or input_text as input into LeMUR.
type: string
context:
Expand Down