Skip to content

Commit f0ef8b6

Browse files
Update documentation and API spec for Universal-3-Pro and Universal-2 launch (#577)
* Update overview section with three main transcription callouts Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Fix: Update transcribe-an-audio-file2.mdx with three main transcription callouts Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update Overview section text and code example per user request Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Restore tabbed code examples with updated patterns (EU endpoint, speech_models, speaker_labels, diarization) Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update code examples: universal-2, language_detection, broadest language coverage comment Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Rewrite transcribe-an-audio-file page with new structure and all 4 language examples Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Add refinements: Info callouts for EU endpoint, base_url to SDK examples, pricing warning, and documentation links Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Remove line numbers from step-by-step code snippets using showLineNumbers={false} Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Revert "Remove line numbers from step-by-step code snippets using showLineNumbers={false}" This reverts commit 3fa746e. * Remove slam-1 page and add redirect to universal-3-pro Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update supported-languages page with Universal-2 and Universal-3-Pro terminology Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update select-the-speech-model page with Universal-2 and Universal-3-Pro terminology Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Remove ALD callout, remove C#/Ruby/PHP examples, add language_detection to code examples Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update keyterms-prompting page with Universal-3-Pro terminology and language_detection Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update improving-transcript-accuracy page with Universal-3-Pro and Universal-2 terminology Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Add Python SDK and JavaScript SDK code examples to improving-transcript-accuracy page Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update Supported models dropdown to use Universal-3-Pro and Universal-2 terminology Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update Supported models dropdown for speech-understanding pages Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update medical-scribe-best-practices page with Universal-3-Pro and Universal-2 terminology Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update FAQ pages with Universal-3-Pro and Universal-2 terminology Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update Universal-3-Pro supported languages to include 6 languages Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update Universal-3-Pro interactive box on models page with new description Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update Universal-3-Pro description to have each feature on a new line Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Reorder and update interactive boxes on models page: Universal-3-Pro, Universal-2, Universal-Streaming Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Remove bullets from interactive boxes and decrease font size Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update interactive box descriptions with new text and line breaks Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Add more spacing between lines in interactive box descriptions Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update Universal-3-Pro and Universal-2 descriptions with new text Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update 'Choosing the right model' section with Universal-3-Pro and Universal-2 descriptions Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Reorganize Pre-recorded Speech-to-text menu: add Quickstart, Natural language prompting, Audio tags, rename Filler words to Verbatim Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Move Verbatim and Audio tags as submenu under Natural language prompting Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Merge language detection pages into single Language detection page Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Remove Supported languages, Supported models, Supported regions cards from language detection page Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Move 'Set language manually' section to end of language detection page Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update intro copy on language detection page Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update Automatic language detection section copy and remove warning box Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Convert sections to subsections under Automatic language detection Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Move Language detection out of Transcript customization and below Language support Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Merge Supported languages content into Language detection page Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Move Supported languages to bottom with Universal-3-Pro and Universal-2 subsections Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Remove Breakdown of Universal-2 language support from right-side submenu Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Move Language detection above Custom spelling, move Word search below Custom spelling Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Remove Set the Start and End of the Transcript from navigation menu Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Remove Automatic punctuation and casing from navigation menu Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Merge Export SRT/VTT, Paragraphs/Sentences, and Word-level timestamps into Transcript export options page Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update Quickstart navigation to anchor link to #quickstart section Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Fix Quickstart navigation to use link syntax for anchor Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Link Automatic Language Detection to language detection page Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Add target _self to Quickstart link to remove external icon Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Use relative anchor href for Quickstart link Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update Pre-recorded Audio page: remove tip box, update quickstart code examples Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Remove Quickstart section from Pre-recorded Audio page and navigation menu Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Restore Quickstart section on Pre-recorded Audio page (keep nav submenu removed) Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Rename 'Model options' to 'Model selection' in menu and page title Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update Model selection page intro copy with new routing behavior description Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Rename 'Model routing behavior' to 'How model routing works' and add indentation to list Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Reorder table to put Universal-3-Pro first, update highlight to speech_models line Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update model routing behavior section with new copy Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Restructure Natural language prompting section and remove (default) from Universal-2 Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Move Select the region to Deployment section and rename to Available cloud regions Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Move Prompting best practices below Audio tags in navigation Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Rename 'How it works' to 'Overview' and add 'Quickstart' section on Natural language prompting page Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Highlight prompt parameter line in Quickstart code examples Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update Verbatim page: remove cards, add new intro, add verbatim transcription section Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update Verbatim page: stylize prompt parameter, rename sections, add Quickstart, highlight code Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update Audio tags page: new intro, add Overview and Quickstart sections from universal-3-pro Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Fix Verbatim page: highlight prompt line instead of speech_models Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update Audio tags page: new Overview copy and fix prompt line highlighting Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Fix Natural language prompting page: add AudioPlayer import Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Add Prompt generator section to Prompting best practices page Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update Keyterms Prompting page: new title and content from universal-3-pro Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Remove Supported languages, models, regions cards from Speaker diarization page Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update Keyterms Prompting page (improving-transcript-accuracy.mdx) with new title and content from universal-3-pro Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update Keyterms Prompting page: move copy above audio player, highlight keyterms_prompt lines Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Add Code switching and 99 languages coverage sections to Code Switching page Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update Code Switching page: rename to Built-in code switching, add Universal-3-Pro subtitle, move 99 languages coverage Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update Code Switching page: add Universal-3-Pro (Recommended) and Universal-2 sections with supported languages Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Refine Code Switching page: stylize language codes, move Use Automatic Language Detection to Universal-2, remove Code Switching and How It Works section, rename Supported Language Pairs to Other supported languages Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Remove Universal-3-Pro description copy from Code Switching page Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update Code Switching page: add Code Switching Confidence Threshold section, update Universal-2 copy, remove Example output section Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Move 99 languages coverage above Other supported languages and make it a subsection Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update 99 languages coverage section copy Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update Universal-3-Pro copy to 'Supports built-in code switching between:' Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update Universal-2 section copy with 99 languages and code switching setup Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Add code block to Code Switching Confidence Threshold section Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update Code Switching Confidence Threshold section text Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update Code Switching Confidence Threshold code blocks to only highlight code_switching_confidence_threshold line Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update Universal-3-Pro code block: change to universal-2, add code_switching option, update highlights Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update Code Switching page: reorganize params, update Universal-2 copy, add speech_models to all sections Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Add language_detection: True to Natural language prompting code blocks Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update speech_models to universal-2 in Natural language prompting code blocks Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update speech_models to universal-2 in Verbatim page code blocks Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update speech_models to universal-2 in Audio tags page code blocks Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Add speech_models and language_detection to Filler words (legacy) section code blocks Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update Keyterms prompting: change speech_models to universal-2 and highlight keyterms_prompt Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update Universal-2 (Beta) section: change speech_model to speech_models array and highlight keyterms_prompt Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Trigger preview rebuild Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Add speech_models and language_detection to Speaker diarization code blocks Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Add speech_models and language_detection to SDK code blocks in Speaker diarization Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Add speech_models and language_detection to C#, Ruby, and PHP code blocks in Speaker diarization Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Add speech_models and language_detection to multichannel transcription code blocks Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Add speech_models and language_detection to Identify speakers by name code blocks Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Add speech_models and language_detection to Manually Setting Language Codes section Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Remove language_detection from Manually Setting Language Codes section Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Add speech_models to Language detection page code blocks Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Add speech_models and language_detection to Custom spelling page code blocks Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Add speech_models and language_detection to Word search page code blocks Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Add speech_models and language_detection to Transcript status page code blocks Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update 'Transcript customization' to 'Transcription operations' Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Add speech_models and language_detection to Transcript export options page code blocks Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Add speech_models and language_detection to Delete Transcripts page code blocks Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Add link to model selection page for Universal-2 section Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Trigger preview rebuild Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Add slug to Model selection page for correct URL routing Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update API spec for Universal-2 and Universal-3-Pro terminology - Update SpeechModel enum to only include universal-2 and universal-3-pro - Update keyterms_prompt description for Universal-2/Universal-3-Pro word limits - Remove deprecated label from prompt parameter and update description - Update speech_model description to reference speech_models parameter - Update custom_topics and topics descriptions Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update openapi.yml for Universal-2 and Universal-3-Pro API Reference - Update SpeechModel enum to only include universal-2 and universal-3-pro - Update keyterms_prompt description for Universal-2/Universal-3-Pro word limits - Update prompt parameter: remove deprecated, add description with Universal-3-Pro callout - Update speech_model description to reference speech_models parameter - Update custom_topics and topics descriptions - Make speech_models parameter required - Add new temperature parameter (0.0-1.0, default 0.0, Universal-3-Pro only) Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Fix speech_models to be required in TranscriptOptionalParams Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Reorder Request and Response parameters alphabetically with deprecated at end Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Reorder Transcript and TranscriptOptionalParams properties alphabetically with deprecated at end in Fern definition Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Add temperature parameter to Transcript schema for GET endpoint Response Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update speed_boost description, pricing table, and WER cookbook Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Add supported languages and link to Universal-Streaming section Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Add speech_models and language_detection parameters to Available cloud regions page Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Remove C#, Ruby, and PHP code examples from Available cloud regions page Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update code highlighting and remove C#/Ruby/PHP from multiple pages Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Fix code highlighting to use single line numbers instead of ranges Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Fix code highlights on keyterms-prompting and universal-3-pro pages Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Fix code highlights to use 0-indexed line numbers for keyterms_prompt parameter Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Add speech_models and language_detection parameters to Webhooks page code examples Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Fix SDK code to use speech_models parameter and remove C#/Ruby/PHP from Webhooks page Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update prompting terminology on transcribe-an-audio-file and models pages Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update announcement banner for Universal-3-Pro launch Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update announcement banner URL to shorter blog link Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Retrigger CI checks Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Add speech_models and language_detection parameters to code examples across 13 pages Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> * Update Prompting page title and Code switching section content Co-Authored-By: Lee Vaughn <dlvprogramming@gmail.com> --------- Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: Lee Vaughn <dlvprogramming@gmail.com> Co-authored-by: Lee Vaughn <32204461+LeeVaughn@users.noreply.github.com>
1 parent 5fe143d commit f0ef8b6

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+4837
-5133
lines changed

fern/.definition/transcripts.yml

Lines changed: 57 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -590,19 +590,12 @@ types:
590590
SpeechModel:
591591
docs: The speech model to use for the transcription.
592592
enum:
593-
- docs: >-
594-
The model optimized for accuracy, low latency, ease of use, and
595-
mutli-language support.
596-
name: Best
597-
value: best
598-
- docs: A contextual model optimized for customization.
599-
name: Slam1
600-
value: slam-1
601-
- docs: >-
602-
The model optimized for accuracy, low latency, ease of use, and
603-
mutli-language support.
604-
name: Universal
605-
value: universal
593+
- docs: Our fastest model with the broadest language coverage.
594+
name: Universal2
595+
value: universal-2
596+
- docs: Our highest accuracy model with fine-tuning support and customization via prompting.
597+
name: Universal3Pro
598+
value: universal-3-pro
606599
source:
607600
openapi: ../openapi.yml
608601
SubstitutionPolicy:
@@ -703,10 +696,6 @@ types:
703696
Transcript:
704697
docs: A transcript object
705698
properties:
706-
acoustic_model:
707-
availability: deprecated
708-
docs: The acoustic model that was used for the transcript
709-
type: string
710699
audio_channels:
711700
docs: >-
712701
The number of audio channels in the audio file. This is only present
@@ -759,10 +748,6 @@ types:
759748
custom_spelling:
760749
docs: Customize how words are spelled and formatted using to and from values
761750
type: optional<list<TranscriptCustomSpelling>>
762-
custom_topics:
763-
availability: deprecated
764-
docs: Whether custom topics is enabled, either true or false
765-
type: optional<boolean>
766751
disfluencies:
767752
docs: >-
768753
Transcribe Filler Words, like "umm", in your media file; can be true
@@ -808,8 +793,8 @@ types:
808793
format: uuid
809794
keyterms_prompt:
810795
docs: >
811-
Improve accuracy with up to 200 (for Universal) or 1000 (for Slam-1)
812-
domain-specific words or phrases (maximum 6 words per phrase).
796+
Improve accuracy with up to 200 (for Universal-2) or 1000 (for Universal-3-Pro)
797+
domain-specific words or phrases (maximum 6 words per phrase).
813798
type: optional<list<string>>
814799
language_code:
815800
docs: >
@@ -851,21 +836,17 @@ types:
851836
language_detection_options:
852837
docs: Specify options for Automatic Language Detection.
853838
type: optional<TranscriptLanguageDetectionOptions>
854-
language_model:
855-
availability: deprecated
856-
docs: The language model that was used for the transcript
857-
type: string
858839
multichannel:
859840
docs: >-
860841
Whether [Multichannel
861842
transcription](https://www.assemblyai.com/docs/models/speech-recognition#multichannel-transcription)
862843
was enabled in the transcription request, either true or false
863844
type: optional<boolean>
864845
prompt:
865-
availability: deprecated
866-
docs: >-
867-
This parameter does not currently have any functionality attached to
868-
it.
846+
docs: >
847+
Provide natural language prompting of up to 1,500 words of contextual information to the model.
848+
849+
Note: This parameter is only supported for the Universal-3-Pro model.
869850
type: optional<string>
870851
punctuate:
871852
docs: Whether Automatic Punctuation is enabled, either true or false
@@ -929,9 +910,6 @@ types:
929910
diarization](https://www.assemblyai.com/docs/models/speaker-diarization)
930911
for more details.
931912
type: optional<integer>
932-
speech_model:
933-
availability: deprecated
934-
type: optional<SpeechModel>
935913
speech_model_used:
936914
docs: The speech model that was actually used for the transcription.
937915
type: optional<SpeechModel>
@@ -952,10 +930,6 @@ types:
952930
Enable speech understanding tasks like translation, speaker
953931
identification, and custom formatting
954932
type: optional<TranscriptSpeechUnderstanding>
955-
speed_boost:
956-
availability: deprecated
957-
docs: Whether speed boost is enabled
958-
type: optional<boolean>
959933
status:
960934
docs: >-
961935
The status of your transcript. Possible values are queued, processing,
@@ -995,10 +969,6 @@ types:
995969
True while a request is throttled and false when a request is no
996970
longer throttled
997971
type: optional<boolean>
998-
topics:
999-
availability: deprecated
1000-
docs: The list of custom topics provided if custom topics is enabled
1001-
type: optional<list<string>>
1002972
translated_texts:
1003973
docs: Translated text keyed by language code
1004974
type: optional<TranscriptTranslatedTexts>
@@ -1045,6 +1015,31 @@ types:
10451015
recognition](https://www.assemblyai.com/docs/models/speech-recognition)
10461016
for more information.
10471017
type: optional<list<TranscriptWord>>
1018+
acoustic_model:
1019+
availability: deprecated
1020+
docs: The acoustic model that was used for the transcript
1021+
type: string
1022+
custom_topics:
1023+
availability: deprecated
1024+
docs: This parameter does not currently have any functionality attached to it.
1025+
type: optional<boolean>
1026+
language_model:
1027+
availability: deprecated
1028+
docs: The language model that was used for the transcript
1029+
type: string
1030+
speech_model:
1031+
availability: deprecated
1032+
docs: >
1033+
This parameter has been replaced with the `speech_models` parameter, learn more about the `speech_models` parameter [here](https://www.assemblyai.com/docs/pre-recorded-audio/select-the-speech-model).
1034+
type: optional<SpeechModel>
1035+
speed_boost:
1036+
availability: deprecated
1037+
docs: Whether speed boost is enabled
1038+
type: optional<boolean>
1039+
topics:
1040+
availability: deprecated
1041+
docs: This parameter does not currently have any functionality attached to it.
1042+
type: optional<list<string>>
10481043
source:
10491044
openapi: ../openapi.yml
10501045
TranscriptBoostParam:
@@ -1297,11 +1292,6 @@ types:
12971292
custom_spelling:
12981293
docs: Customize how words are spelled and formatted using to and from values
12991294
type: optional<list<TranscriptCustomSpelling>>
1300-
custom_topics:
1301-
availability: deprecated
1302-
default: false
1303-
docs: Enable custom topics, either true or false
1304-
type: optional<boolean>
13051295
disfluencies:
13061296
default: false
13071297
docs: >-
@@ -1332,8 +1322,8 @@ types:
13321322
type: optional<boolean>
13331323
keyterms_prompt:
13341324
docs: >
1335-
Improve accuracy with up to 200 (for Universal) or 1000 (for Slam-1)
1336-
domain-specific words or phrases (maximum 6 words per phrase).
1325+
Improve accuracy with up to 200 (for Universal-2) or 1000 (for Universal-3-Pro)
1326+
domain-specific words or phrases (maximum 6 words per phrase).
13371327
type: optional<list<string>>
13381328
language_code: optional<TranscriptLanguageCode>
13391329
language_codes:
@@ -1370,10 +1360,10 @@ types:
13701360
transcription, can be true or false.
13711361
type: optional<boolean>
13721362
prompt:
1373-
availability: deprecated
1374-
docs: >-
1375-
This parameter does not currently have any functionality attached to
1376-
it.
1363+
docs: >
1364+
Provide natural language prompting of up to 1,500 words of contextual information to the model.
1365+
1366+
Note: This parameter is only supported for the Universal-3-Pro model.
13771367
type: optional<string>
13781368
punctuate:
13791369
default: true
@@ -1434,9 +1424,6 @@ types:
14341424
diarization](https://www.assemblyai.com/docs/models/speaker-diarization)
14351425
for more details.
14361426
type: optional<integer>
1437-
speech_model:
1438-
availability: deprecated
1439-
type: optional<SpeechModel>
14401427
speech_models:
14411428
docs: >
14421429
List multiple speech models in priority order, allowing our system to
@@ -1465,10 +1452,6 @@ types:
14651452
summary_type:
14661453
docs: The type of summary
14671454
type: optional<SummaryType>
1468-
topics:
1469-
availability: deprecated
1470-
docs: The list of custom topics
1471-
type: optional<list<string>>
14721455
webhook_auth_header_name:
14731456
docs: >-
14741457
The header name to be sent with the transcript completed or failed
@@ -1488,6 +1471,20 @@ types:
14881471
One request when a transcript is completed or failed, and one request
14891472
when the redacted audio is ready if redact_pii_audio is enabled.
14901473
type: optional<string>
1474+
custom_topics:
1475+
availability: deprecated
1476+
default: false
1477+
docs: This parameter does not currently have any functionality attached to it.
1478+
type: optional<boolean>
1479+
speech_model:
1480+
availability: deprecated
1481+
docs: >
1482+
This parameter has been replaced with the `speech_models` parameter, learn more about the `speech_models` parameter [here](https://www.assemblyai.com/docs/pre-recorded-audio/select-the-speech-model).
1483+
type: optional<SpeechModel>
1484+
topics:
1485+
availability: deprecated
1486+
docs: This parameter does not currently have any functionality attached to it.
1487+
type: optional<list<string>>
14911488
source:
14921489
openapi: ../openapi.yml
14931490
TranscriptOptionalParamsLanguageDetectionOptions:

fern/docs.yml

Lines changed: 27 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ settings:
2525
metadata:
2626
canonical-host: "assemblyai.com"
2727
announcement:
28-
message: "Gemini 3 Pro now available in LLM Gateway! <a href='/docs/llm-gateway/overview' class='underline font-semibold'>Learn more</a>"
28+
message: "Universal-3-Pro, our most powerful Voice AI model yet, is now live! <a href='http://assemblyai.com/blog/introducing-universal-3-pro' class='underline font-semibold'>Learn more</a>"
2929
title: AssemblyAI | Documentation
3030
tabs:
3131
docs:
@@ -65,10 +65,6 @@ navigation:
6565
- page: Transcribe streaming audio
6666
slug: /getting-started/transcribe-streaming-audio
6767
path: pages/01-getting-started/transcribe-streaming-audio.mdx
68-
- page: Introducing Slam-1
69-
path: pages/01-getting-started/slam-1.mdx
70-
slug: /getting-started/slam-1
71-
hidden: true
7268
- page: Introducing Universal 3 Pro
7369
path: pages/01-getting-started/universal-3-pro.mdx
7470
slug: /getting-started/universal-3-pro
@@ -84,64 +80,38 @@ navigation:
8480
path: pages/02-speech-to-text/pre-recorded-audio/index.mdx
8581
slug: /pre-recorded-audio
8682
contents:
87-
# TODO: add a section for "how to use our API/retrieve transcriptions/webhooks etc."
88-
- page: Transcript status
89-
path: pages/02-speech-to-text/pre-recorded-audio/transcript-status.mdx
90-
- page: Select the speech model
83+
- page: Model selection
9184
path: pages/02-speech-to-text/pre-recorded-audio/select-the-speech-model-with-best-and-nano.mdx
92-
- page: Customizing transcription results using Prompt Engineering
85+
slug: select-the-speech-model
86+
- page: Prompting
9387
path: pages/02-speech-to-text/pre-recorded-audio/prompt-engineering.mdx
94-
slug: prompt-engineering
95-
hidden: true
96-
- page: Improving transcript results with Keyterms Prompting
88+
slug: prompting
89+
- page: Keyterms prompting
9790
path: pages/02-speech-to-text/pre-recorded-audio/improving-transcript-accuracy.mdx
98-
- page: Select the region
99-
path: pages/02-speech-to-text/pre-recorded-audio/select-the-region.mdx
100-
- section: Language settings
101-
skip-slug: true
102-
contents:
103-
- page: Supported languages
104-
path: pages/01-getting-started/supported-languages.mdx
105-
- page: Automatic language detection
106-
path: pages/02-speech-to-text/pre-recorded-audio/automatic-language-detection.mdx
107-
- page: Set language manually
108-
path: pages/02-speech-to-text/pre-recorded-audio/set-language-manually.mdx
91+
- page: Speaker diarization
92+
path: pages/02-speech-to-text/pre-recorded-audio/speaker-diarization.mdx
93+
- page: Multichannel
94+
path: pages/02-speech-to-text/pre-recorded-audio/multichannel-transcription.mdx
10995
- page: Code switching
11096
path: pages/02-speech-to-text/pre-recorded-audio/code-switching-docs.mdx
111-
- section: Speaker separation
97+
- page: Language detection
98+
path: pages/02-speech-to-text/pre-recorded-audio/language-detection.mdx
99+
- page: Custom spelling
100+
path: pages/02-speech-to-text/pre-recorded-audio/custom-spelling.mdx
101+
- page: Word search
102+
path: pages/02-speech-to-text/pre-recorded-audio/word-search.mdx
103+
- section: Transcription operations
112104
skip-slug: true
113105
contents:
114-
- page: Speaker Diarization
115-
path: pages/02-speech-to-text/pre-recorded-audio/speaker-diarization.mdx
116-
- page: Multichannel transcription
117-
path: pages/02-speech-to-text/pre-recorded-audio/multichannel-transcription.mdx
118-
- section: Transcript export options
119-
skip-slug: true
120-
contents:
121-
- page: Export SRT or VTT caption files
122-
path: pages/02-speech-to-text/pre-recorded-audio/export-srt-or-vtt-caption-files.mdx
123-
- page: Export paragraphs and sentences
124-
path: pages/02-speech-to-text/pre-recorded-audio/export-paragraphs-and-sentences.mdx
125-
- page: Word-level timestamps
126-
path: pages/02-speech-to-text/pre-recorded-audio/word-level-timestamps.mdx
127-
- page: Word search
128-
path: pages/02-speech-to-text/pre-recorded-audio/word-search.mdx
129-
- section: Transcript customization features
130-
skip-slug: true
131-
contents:
132-
- page: Automatic punctuation and casing
133-
path: pages/02-speech-to-text/pre-recorded-audio/automatic-punctuation-and-casing.mdx
134-
- page: Custom spelling
135-
path: pages/02-speech-to-text/pre-recorded-audio/custom-spelling.mdx
106+
- page: Transcript status
107+
path: pages/02-speech-to-text/pre-recorded-audio/transcript-status.mdx
136108
- page: Custom vocabulary
137109
path: pages/02-speech-to-text/pre-recorded-audio/custom-vocabulary.mdx
138110
hidden: true
139-
- page: Filler words
140-
path: pages/02-speech-to-text/pre-recorded-audio/filler-words.mdx
141-
- page: Set the start and end of the transcript
142-
path: pages/02-speech-to-text/pre-recorded-audio/set-the-start-and-end-of-the-transcript.mdx
143-
- page: Delete transcripts
144-
path: pages/02-speech-to-text/pre-recorded-audio/delete-transcripts.mdx
111+
- page: Transcript export options
112+
path: pages/02-speech-to-text/pre-recorded-audio/transcript-export-options.mdx
113+
- page: Delete transcripts
114+
path: pages/02-speech-to-text/pre-recorded-audio/delete-transcripts.mdx
145115
- section: Streaming Speech-to-text
146116
icon: microphone-lines
147117
path: pages/02-speech-to-text/universal-streaming/universal-streaming.mdx
@@ -301,8 +271,8 @@ navigation:
301271
path: pages/05-guides/deployment.mdx
302272
icon: rocket
303273
contents:
304-
- link: Available cloud regions
305-
href: /docs/speech-to-text/pre-recorded-audio/select-the-region
274+
- page: Available cloud regions
275+
path: pages/02-speech-to-text/pre-recorded-audio/select-the-region.mdx
306276
- page: Self-hosted streaming
307277
path: pages/05-guides/self-hosted-streaming.mdx
308278
hidden: true
@@ -1579,3 +1549,5 @@ redirects:
15791549
destination: /docs/getting-started/transcribe-streaming-audio
15801550
- source: /docs/getting-started/transcribe-streaming-audio-from-a-microphone/typescript/
15811551
destination: /docs/getting-started/transcribe-streaming-audio
1552+
- source: /docs/getting-started/slam-1
1553+
destination: /docs/getting-started/universal-3-pro

0 commit comments

Comments
 (0)