Skip to content

feat:Standardize model naming in OpenAPI documentation #163

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
Mar 16, 2026
Merged

feat:Standardize model naming in OpenAPI documentation #163

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
16 changes: 8 additions & 8 deletions src/libs/AssemblyAI/Generated/AssemblyAI.Models.Transcript.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ public sealed partial class Transcript
public required global::System.Guid Id { get; set; }

/// <summary>
/// Improve accuracy with up to 200 (for Universal-2) or 1000 (for Universal-3-Pro) domain-specific words or phrases (maximum 6 words per phrase). See [Keyterms Prompting](https://www.assemblyai.com/docs/pre-recorded-audio/keyterms-prompting) for more details.
/// Improve accuracy with up to 200 (for Universal-2) or 1000 (for Universal-3 Pro) domain-specific words or phrases (maximum 6 words per phrase). See [Keyterms Prompting](https://www.assemblyai.com/docs/pre-recorded-audio/keyterms-prompting) for more details.
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("keyterms_prompt")]
public global::System.Collections.Generic.IList<string>? KeytermsPrompt { get; set; }
Expand Down Expand Up @@ -210,7 +210,7 @@ public sealed partial class Transcript

/// <summary>
/// Provide natural language prompting of up to 1,500 words of contextual information to the model. See the [Prompting Guide](https://www.assemblyai.com/docs/pre-recorded-audio/prompting) for best practices.<br/>
/// Note: This parameter is only supported for the Universal-3-Pro model.
/// Note: This parameter is only supported for the Universal-3 Pro model.
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("prompt")]
public string? Prompt { get; set; }
Expand Down Expand Up @@ -346,15 +346,15 @@ public sealed partial class Transcript

/// <summary>
/// Whether [audio event tags](https://www.assemblyai.com/docs/pre-recorded-audio/universal-3-pro#audio-event-tags) were removed from the transcript text.<br/>
/// Note: This parameter is only supported for the Universal-3-Pro model.
/// Note: This parameter is only supported for the Universal-3 Pro model.
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("remove_audio_tags")]
[global::System.Text.Json.Serialization.JsonConverter(typeof(global::AssemblyAI.JsonConverters.OneOfJsonConverter<global::AssemblyAI.TranscriptRemoveAudioTags?, object>))]
public global::AssemblyAI.OneOf<global::AssemblyAI.TranscriptRemoveAudioTags?, object>? RemoveAudioTags { get; set; }

/// <summary>
/// The temperature that was used for the model's response. See the [Prompting Guide](https://www.assemblyai.com/docs/pre-recorded-audio/prompting) for more details.<br/>
/// Note: This parameter can only be used with the Universal-3-Pro model.
/// Note: This parameter can only be used with the Universal-3 Pro model.
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("temperature")]
public double? Temperature { get; set; }
Expand Down Expand Up @@ -535,7 +535,7 @@ public sealed partial class Transcript
/// The unique identifier of your transcript
/// </param>
/// <param name="keytermsPrompt">
/// Improve accuracy with up to 200 (for Universal-2) or 1000 (for Universal-3-Pro) domain-specific words or phrases (maximum 6 words per phrase). See [Keyterms Prompting](https://www.assemblyai.com/docs/pre-recorded-audio/keyterms-prompting) for more details.
/// Improve accuracy with up to 200 (for Universal-2) or 1000 (for Universal-3 Pro) domain-specific words or phrases (maximum 6 words per phrase). See [Keyterms Prompting](https://www.assemblyai.com/docs/pre-recorded-audio/keyterms-prompting) for more details.
/// </param>
/// <param name="languageCode">
/// The language of your audio file.<br/>
Expand Down Expand Up @@ -565,7 +565,7 @@ public sealed partial class Transcript
/// </param>
/// <param name="prompt">
/// Provide natural language prompting of up to 1,500 words of contextual information to the model. See the [Prompting Guide](https://www.assemblyai.com/docs/pre-recorded-audio/prompting) for best practices.<br/>
/// Note: This parameter is only supported for the Universal-3-Pro model.
/// Note: This parameter is only supported for the Universal-3 Pro model.
/// </param>
/// <param name="punctuate">
/// Whether [Automatic Punctuation](https://www.assemblyai.com/docs/pre-recorded-audio) is enabled, either true or false
Expand Down Expand Up @@ -622,11 +622,11 @@ public sealed partial class Transcript
/// </param>
/// <param name="removeAudioTags">
/// Whether [audio event tags](https://www.assemblyai.com/docs/pre-recorded-audio/universal-3-pro#audio-event-tags) were removed from the transcript text.<br/>
/// Note: This parameter is only supported for the Universal-3-Pro model.
/// Note: This parameter is only supported for the Universal-3 Pro model.
/// </param>
/// <param name="temperature">
/// The temperature that was used for the model's response. See the [Prompting Guide](https://www.assemblyai.com/docs/pre-recorded-audio/prompting) for more details.<br/>
/// Note: This parameter can only be used with the Universal-3-Pro model.
/// Note: This parameter can only be used with the Universal-3 Pro model.
/// </param>
/// <param name="text">
/// The textual transcript of your media file
Expand Down
16 changes: 8 additions & 8 deletions src/libs/AssemblyAI/Generated/AssemblyAI.Models.TranscriptOptionalParams.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ public sealed partial class TranscriptOptionalParams
public bool? IabCategories { get; set; }

/// <summary>
/// Improve accuracy with up to 200 (for Universal-2) or 1000 (for Universal-3-Pro) domain-specific words or phrases (maximum 6 words per phrase). See [Keyterms Prompting](https://www.assemblyai.com/docs/pre-recorded-audio/keyterms-prompting) for more details.
/// Improve accuracy with up to 200 (for Universal-2) or 1000 (for Universal-3 Pro) domain-specific words or phrases (maximum 6 words per phrase). See [Keyterms Prompting](https://www.assemblyai.com/docs/pre-recorded-audio/keyterms-prompting) for more details.
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("keyterms_prompt")]
public global::System.Collections.Generic.IList<string>? KeytermsPrompt { get; set; }
Expand Down Expand Up @@ -146,7 +146,7 @@ public sealed partial class TranscriptOptionalParams

/// <summary>
/// Provide natural language prompting of up to 1,500 words of contextual information to the model. See the [Prompting Guide](https://www.assemblyai.com/docs/pre-recorded-audio/prompting) for best practices.<br/>
/// Note: This parameter is only supported for the Universal-3-Pro model.
/// Note: This parameter is only supported for the Universal-3 Pro model.
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("prompt")]
public string? Prompt { get; set; }
Expand Down Expand Up @@ -276,7 +276,7 @@ public sealed partial class TranscriptOptionalParams

/// <summary>
/// Remove [audio event tags](https://www.assemblyai.com/docs/pre-recorded-audio/universal-3-pro#audio-event-tags) from the transcript text. Set to `"all"` to remove all audio tags.<br/>
/// Note: This parameter is only supported for the Universal-3-Pro model.<br/>
/// Note: This parameter is only supported for the Universal-3 Pro model.<br/>
/// Default Value: openapi-json-null-sentinel-value-2BF93600-0FE4-4250-987A-E5DDB203E464
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("remove_audio_tags")]
Expand All @@ -285,7 +285,7 @@ public sealed partial class TranscriptOptionalParams

/// <summary>
/// Control the amount of randomness injected into the model's response. See the [Prompting Guide](https://www.assemblyai.com/docs/pre-recorded-audio/prompting) for more details.<br/>
/// Note: This parameter can only be used with the Universal-3-Pro model.<br/>
/// Note: This parameter can only be used with the Universal-3 Pro model.<br/>
/// Default Value: 0.0
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("temperature")]
Expand Down Expand Up @@ -384,7 +384,7 @@ public sealed partial class TranscriptOptionalParams
/// Default Value: false
/// </param>
/// <param name="keytermsPrompt">
/// Improve accuracy with up to 200 (for Universal-2) or 1000 (for Universal-3-Pro) domain-specific words or phrases (maximum 6 words per phrase). See [Keyterms Prompting](https://www.assemblyai.com/docs/pre-recorded-audio/keyterms-prompting) for more details.
/// Improve accuracy with up to 200 (for Universal-2) or 1000 (for Universal-3 Pro) domain-specific words or phrases (maximum 6 words per phrase). See [Keyterms Prompting](https://www.assemblyai.com/docs/pre-recorded-audio/keyterms-prompting) for more details.
/// </param>
/// <param name="languageCode">
/// The language of your audio file. Possible values are found in [Supported Languages](https://www.assemblyai.com/docs/pre-recorded-audio/supported-languages).<br/>
Expand Down Expand Up @@ -414,7 +414,7 @@ public sealed partial class TranscriptOptionalParams
/// </param>
/// <param name="prompt">
/// Provide natural language prompting of up to 1,500 words of contextual information to the model. See the [Prompting Guide](https://www.assemblyai.com/docs/pre-recorded-audio/prompting) for best practices.<br/>
/// Note: This parameter is only supported for the Universal-3-Pro model.
/// Note: This parameter is only supported for the Universal-3 Pro model.
/// </param>
/// <param name="punctuate">
/// Enable [Automatic Punctuation](https://www.assemblyai.com/docs/pre-recorded-audio), can be true or false<br/>
Expand Down Expand Up @@ -471,12 +471,12 @@ public sealed partial class TranscriptOptionalParams
/// </param>
/// <param name="removeAudioTags">
/// Remove [audio event tags](https://www.assemblyai.com/docs/pre-recorded-audio/universal-3-pro#audio-event-tags) from the transcript text. Set to `"all"` to remove all audio tags.<br/>
/// Note: This parameter is only supported for the Universal-3-Pro model.<br/>
/// Note: This parameter is only supported for the Universal-3 Pro model.<br/>
/// Default Value: openapi-json-null-sentinel-value-2BF93600-0FE4-4250-987A-E5DDB203E464
/// </param>
/// <param name="temperature">
/// Control the amount of randomness injected into the model's response. See the [Prompting Guide](https://www.assemblyai.com/docs/pre-recorded-audio/prompting) for more details.<br/>
/// Note: This parameter can only be used with the Universal-3-Pro model.<br/>
/// Note: This parameter can only be used with the Universal-3 Pro model.<br/>
/// Default Value: 0.0
/// </param>
/// <param name="webhookAuthHeaderName">
Expand Down
16 changes: 8 additions & 8 deletions src/libs/AssemblyAI/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1335,7 +1335,7 @@ components:
keyterms_prompt:
x-label: Keyterms prompt
description: |
Improve accuracy with up to 200 (for Universal-2) or 1000 (for Universal-3-Pro) domain-specific words or phrases (maximum 6 words per phrase). See [Keyterms Prompting](https://www.assemblyai.com/docs/pre-recorded-audio/keyterms-prompting) for more details.
Improve accuracy with up to 200 (for Universal-2) or 1000 (for Universal-3 Pro) domain-specific words or phrases (maximum 6 words per phrase). See [Keyterms Prompting](https://www.assemblyai.com/docs/pre-recorded-audio/keyterms-prompting) for more details.
type: array
items:
x-label: Keyterm
Expand Down Expand Up @@ -1427,7 +1427,7 @@ components:
description: |
Provide natural language prompting of up to 1,500 words of contextual information to the model. See the [Prompting Guide](https://www.assemblyai.com/docs/pre-recorded-audio/prompting) for best practices.

Note: This parameter is only supported for the Universal-3-Pro model.
Note: This parameter is only supported for the Universal-3 Pro model.
type: string

punctuate:
Expand Down Expand Up @@ -1578,7 +1578,7 @@ components:
description: |
Remove [audio event tags](https://www.assemblyai.com/docs/pre-recorded-audio/universal-3-pro#audio-event-tags) from the transcript text. Set to `"all"` to remove all audio tags.

Note: This parameter is only supported for the Universal-3-Pro model.
Note: This parameter is only supported for the Universal-3 Pro model.
oneOf:
- type: string
enum:
Expand All @@ -1591,7 +1591,7 @@ components:
description: |
Control the amount of randomness injected into the model's response. See the [Prompting Guide](https://www.assemblyai.com/docs/pre-recorded-audio/prompting) for more details.

Note: This parameter can only be used with the Universal-3-Pro model.
Note: This parameter can only be used with the Universal-3 Pro model.
type: number
minimum: 0.0
maximum: 1.0
Expand Down Expand Up @@ -2836,7 +2836,7 @@ components:
keyterms_prompt:
x-label: Keyterms prompt
description: |
Improve accuracy with up to 200 (for Universal-2) or 1000 (for Universal-3-Pro) domain-specific words or phrases (maximum 6 words per phrase). See [Keyterms Prompting](https://www.assemblyai.com/docs/pre-recorded-audio/keyterms-prompting) for more details.
Improve accuracy with up to 200 (for Universal-2) or 1000 (for Universal-3 Pro) domain-specific words or phrases (maximum 6 words per phrase). See [Keyterms Prompting](https://www.assemblyai.com/docs/pre-recorded-audio/keyterms-prompting) for more details.
type: array
items:
x-label: Keyterm
Expand Down Expand Up @@ -2931,7 +2931,7 @@ components:
description: |
Provide natural language prompting of up to 1,500 words of contextual information to the model. See the [Prompting Guide](https://www.assemblyai.com/docs/pre-recorded-audio/prompting) for best practices.

Note: This parameter is only supported for the Universal-3-Pro model.
Note: This parameter is only supported for the Universal-3 Pro model.
type: string

punctuate:
Expand Down Expand Up @@ -3078,7 +3078,7 @@ components:
description: |
Whether [audio event tags](https://www.assemblyai.com/docs/pre-recorded-audio/universal-3-pro#audio-event-tags) were removed from the transcript text.

Note: This parameter is only supported for the Universal-3-Pro model.
Note: This parameter is only supported for the Universal-3 Pro model.
oneOf:
- type: string
enum:
Expand All @@ -3090,7 +3090,7 @@ components:
description: |
The temperature that was used for the model's response. See the [Prompting Guide](https://www.assemblyai.com/docs/pre-recorded-audio/prompting) for more details.

Note: This parameter can only be used with the Universal-3-Pro model.
Note: This parameter can only be used with the Universal-3 Pro model.
type: [number, "null"]
minimum: 0.0
maximum: 1.0
Expand Down
Loading