-
-
Notifications
You must be signed in to change notification settings - Fork 1
feat:Add keyterms_prompt parameter, deprecate prompt and word_boost, update SpeechModel enum #72
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.
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
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -1344,6 +1344,7 @@ components: | |
| items: | ||
| x-label: Word to boost | ||
| type: string | ||
| deprecated: true | ||
|
|
||
| boost_param: | ||
| x-label: Word boost level | ||
|
|
@@ -1431,6 +1432,22 @@ components: | |
| x-label: Custom spelling | ||
| $ref: "#/components/schemas/TranscriptCustomSpelling" | ||
|
|
||
| keyterms_prompt: | ||
| x-label: Keyterms prompt | ||
| description: | | ||
| <Warning>`keyterms_prompt` is only supported when the `speech_model` is specified as `slam-1`</Warning> | ||
| Improve accuracy with up to 1000 domain-specific words or phrases (maximum 6 words per phrase). | ||
| type: array | ||
| items: | ||
| x-label: Keyterm | ||
| type: string | ||
|
|
||
| prompt: | ||
| x-label: Prompt | ||
| description: This parameter does not currently have any functionality attached to it. | ||
| type: string | ||
| deprecated: true | ||
|
|
||
| sentiment_analysis: | ||
| x-label: Sentiment Analysis | ||
| description: Enable [Sentiment Analysis](https://www.assemblyai.com/docs/models/sentiment-analysis), can be true or false | ||
|
|
@@ -2150,10 +2167,18 @@ components: | |
| enum: | ||
| - best | ||
| - nano | ||
| - slam-1 | ||
| - universal | ||
| x-fern-enum: | ||
| universal: | ||
| name: Universal | ||
| description: The model optimized for accuracy, low latency, ease of use, and mutli-language support. | ||
| slam-1: | ||
| name: Slam-1 | ||
| description: A contextual model optimized for customization. | ||
| best: | ||
| name: Best | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fix typo in model description - description: The model optimized for accuracy, low latency, ease of use, and mutli-language support.
+ description: The model optimized for accuracy, low latency, ease of use, and multi-language support.
|
||
| description: The best model optimized for accuracy. | ||
| description: The model optimized for accuracy, low latency, ease of use, and mutli-language support. | ||
| nano: | ||
| name: Nano | ||
| description: A lightweight, lower cost model for a wide range of languages. | ||
|
|
@@ -2724,6 +2749,7 @@ components: | |
| items: | ||
| x-label: Boosted word | ||
| type: string | ||
| deprecated: true | ||
|
|
||
| boost_param: | ||
| x-label: Boost | ||
|
|
@@ -2817,6 +2843,21 @@ components: | |
| x-label: Custom spelling | ||
| $ref: "#/components/schemas/TranscriptCustomSpelling" | ||
|
|
||
| keyterms_prompt: | ||
| x-label: Keyterms prompt | ||
| description: | | ||
| Improve accuracy with up to 1000 domain-specific words or phrases (maximum 6 words per phrase). | ||
| type: array | ||
| items: | ||
| x-label: Keyterm | ||
| type: string | ||
|
|
||
| prompt: | ||
| x-label: Prompt | ||
| description: This parameter does not currently have any functionality attached to it. | ||
| type: string | ||
| deprecated: true | ||
|
|
||
| auto_chapters: | ||
| x-label: Auto Chapters enabled | ||
| description: Whether [Auto Chapters](https://www.assemblyai.com/docs/models/auto-chapters) is enabled, can be true or false | ||
|
|
||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
Add validation constraints for
keyterms_promptThe description calls out “up to 1000 domain-specific words or phrases (maximum 6 words per phrase)” but the schema lacks any
maxItemsor per-item length constraints.Consider adding:
to enforce the documented limits.