update cookbook names

AssemblyAI · Feb 21, 2025 · 6bfa73c · 6bfa73c
1 parent 7d8ceaf
commit 6bfa73c
Show file tree

Hide file tree

Showing 17 changed files with 31 additions and 71 deletions.
diff --git a/fern/cookbooks/audio-intelligence/key_phrases.mdx b/fern/cookbooks/audio-intelligence/key_phrases.mdx
@@ -1,5 +1,5 @@
 ---
-title: "Identifying Highlights in Audio and Video Files"
+title: "How to Identify Highlights in Audio and Video Files"
 ---
 
 <a href="https://www.assemblyai.com/">

diff --git a/fern/docs.yml b/fern/docs.yml
@@ -86,7 +86,7 @@ navigation:
               - page: Identifying Hate Speech in Audio or Video Files
                 path: pages/05-guides/identifying-hate-speech-in-audio-or-video-files.mdx
                 hidden: true
-              - page: Identifying Highlights in Audio or Video Files
+              - page: How to Identify Highlights in Audio or Video Files
                 path: pages/05-guides/identifying-highlights-in-audio-or-video-files.mdx
                 hidden: true
               - page: Identifying Speakers in Audio Recordings
@@ -115,7 +115,7 @@ navigation:
                 path: pages/05-guides/cookbooks/audio-intelligence/content_moderation.mdx
                 slug: content_moderation
                 hidden: true
-              - page: Identifying Highlights in Audio and Video Files
+              - page: How to Identify Highlights in Audio and Video Files
                 path: pages/05-guides/cookbooks/audio-intelligence/key_phrases.mdx
                 slug: key_phrases
                 hidden: true

diff --git a/fern/pages/05-guides/cookbooks/audio-intelligence/key_phrases.mdx b/fern/pages/05-guides/cookbooks/audio-intelligence/key_phrases.mdx
@@ -1,12 +1,8 @@
 ---
-title: 'Identifying Highlights in Audio and Video Files'
+title: 'How to Identify Highlights in Audio and Video Files'
 ---
 
 
-
-
-# Identifying Highlights in Audio and Video Files
-
 The [Key Phrases](https://www.assemblyai.com/docs/models/key-phrases) model identifies significant words and phrases in your transcript and lets you extract the most important concepts or highlights from your audio or video file.
 
 For example, if you're a call center, you can analyze highlights from recorded phone calls.

diff --git a/fern/pages/05-guides/cookbooks/audio-intelligence/summarization.mdx b/fern/pages/05-guides/cookbooks/audio-intelligence/summarization.mdx
@@ -1,12 +1,7 @@
 ---
-title: 'Summarizing Virtual Meetings'
+title: 'How to Summarize Virtual Meetings'
 ---
 
-
-
-
-# Summarizing Virtual Meetings
-
 In this Colab, we'll show you how to use the [Summarization model](https://www.assemblyai.com/docs/models/summarization) to automatically generate summaries of your virtual meetings, so you can quickly review important information and take action based on the insights gathered from the conversations.
 
 ### Get Started

diff --git a/fern/pages/05-guides/cookbooks/core-transcription/SDK-Node-batch.mdx b/fern/pages/05-guides/cookbooks/core-transcription/SDK-Node-batch.mdx
@@ -1,9 +1,7 @@
 ---
-title: 'Transcribe Multiple Files Simultaneously Using the Node SDK'
+title: 'How to Transcribe Multiple Files Simultaneously Using the Node SDK'
 ---
 
-# Transcribe Multiple Files Simultaneously Using the Node SDK
-
 In this guide, we'll show you how to transcribe multiple files simultaneously using the Node SDK.
 
 ## Getting Started

diff --git a/.../cookbooks/core-transcription/automatic-language-detection-route-nano-model.mdx b/.../cookbooks/core-transcription/automatic-language-detection-route-nano-model.mdx
@@ -1,12 +1,7 @@
 ---
-title: 'Automatic Language Detection: Route to Nano Speech Model if Language Confidence is Low'
+title: 'How to Route to Nano Speech Model if Detected Language Confidence is Low'
 ---
 
-
-
-
-# Automatic Language Detection: Route to Nano Speech Model if Language Confidence is Low
-
 This guide will show you how to use AssemblyAI's API to resubmit a request to the Nano Speech Model if the Best Speech Model Automatic Language Detection's `language_confidence_threshold` isn't met. As the Nano Speech Model supports 99 languages compared to 17 by the Best Speech Model, this workflow will route transcripts to the identified language code if it does not fit within our Best supported languages. The following code uses the Python SDK.
 
 ## Get Started

diff --git a/...5-guides/cookbooks/core-transcription/automatic-language-detection-separate.mdx b/...5-guides/cookbooks/core-transcription/automatic-language-detection-separate.mdx
@@ -1,9 +1,7 @@
 ---
-title: 'Automatic Language Detection as separate step from Transcription'
+title: 'How to Use Automatic Language Detection as a Separate Step From Transcription'
 ---
 
-# Automatic Language Detection as separate step from Transcription
-
 In this guide, we'll show you how to perform automatic language detection separately from the transcription process. For the transcription, the file then gets then routed to either our [*Best* or *Nano*](https://www.assemblyai.com/docs/speech-to-text/speech-recognition#select-the-speech-model-with-best-and-nano) model class, depending on the supported language.
 
 This workflow is designed to be cost-effective, slicing the first 60 seconds of audio and running it through Nano ALD, which detects 99 languages, at a cost of $0.002 per transcript for this language detection workflow (not including the total transcription cost).

diff --git a/fern/pages/05-guides/cookbooks/core-transcription/common_errors_and_solutions.mdx b/fern/pages/05-guides/cookbooks/core-transcription/common_errors_and_solutions.mdx
@@ -1,9 +1,7 @@
 ---
-title: 'Guide to troubleshoot Common Errors'
+title: 'How to Troubleshoot Common Errors'
 ---
 
-# Guide to troubleshoot Common Errors
-
 AssemblyAI's API always returns a response even when there is an error. This guide is designed to help you navigate and resolve common issues when implementing AssemblyAI.
 
 ## Understanding Errors with AssemblyAI

diff --git a/...pages/05-guides/cookbooks/core-transcription/detecting-low-confidence-words.mdx b/...pages/05-guides/cookbooks/core-transcription/detecting-low-confidence-words.mdx
@@ -1,9 +1,7 @@
 ---
-title: 'Detecting Low Confidence Words in a Transcript'
+title: 'How to Detect Low Confidence Words in a Transcript'
 ---
 
-# Detecting Low Confidence Words in a Transcript
-
 In this guide, we'll show you how to detect sentences that contain words with low confidence scores. Confidence scores represent how confident the model was in predicting the transcribed word. Detecting words with low confidence scores can be important for manually editing transcripts. 
 Each transcribed word will contain a corresponding confidence score between 0.0 (low confidence) and 1.0 (high confidence). 
 You can decide what your confidence threshold will be when implementing this logic in your application. For this guide, we will use a threshold of 0.4.

diff --git a/fern/pages/05-guides/cookbooks/core-transcription/gradio-frontend.mdx b/fern/pages/05-guides/cookbooks/core-transcription/gradio-frontend.mdx
@@ -1,12 +1,7 @@
 ---
-title: 'Build a UI for Transcription with Gradio and Python'
+title: 'How to Build a UI for Transcription with Gradio and Python'
 ---
 
-
-
-
-# Build a UI for Transcription with Gradio and Python
-
 In this guide, we'll show you how to use the [Gradio](https://www.gradio.app/) library in Python to build a simple front-end that allows you to drag-and-drop files for transcription. If you've ever gotten tired of running your Python program from the command-line, now you can have a self-hosted UI for processing your transcripts!
 
 ## Get Started

diff --git a/fern/pages/05-guides/cookbooks/core-transcription/identify_duplicate_channels.mdx b/fern/pages/05-guides/cookbooks/core-transcription/identify_duplicate_channels.mdx
@@ -1,12 +1,8 @@
 ---
-title: 'Identifying Duplicate Dual Channel Files'
+title: 'How to Identify Duplicate Dual Channel Files'
 ---
 
 
-
-
-# Identifying Duplicate Dual Channel Files
-
 In this guide, you'll learn how to identify Dual Channel (Stereo) files that contain the same content on each channel. With AssemblyAI's API, we support Dual Channel files by transcribing each channel individually, then intelligently combining the results into one transcript. If a file contains the same content on both channels, then you may end up with duplicate content in your transcript.
 
 To programmatically identify duplicate channels, you can hash the audio content found on each channel and compare the hashes to quickly determine whether you should remove a channel and then submit the file for more accurate results.

diff --git a/fern/pages/05-guides/cookbooks/core-transcription/make.com-speaker-labels.mdx b/fern/pages/05-guides/cookbooks/core-transcription/make.com-speaker-labels.mdx
@@ -1,9 +1,7 @@
 ---
-title: 'Iterate over Speaker Labels with Make.com'
+title: 'How to Iterate over Speaker Labels with Make.com'
 ---
 
-# Iterate over Speaker Labels with Make.com
-
 ## Introduction
 
 This is a quick guide on how to iterate over speaker labels in Make.com. This guide will return speaker labels as a readable format to a Google Doc. The end result will look like the two images below.

diff --git a/fern/pages/05-guides/cookbooks/core-transcription/subtitles.mdx b/fern/pages/05-guides/cookbooks/core-transcription/subtitles.mdx
@@ -1,12 +1,8 @@
 ---
-title: 'Generating Subtitles for Videos'
+title: 'How to Generate Subtitles for Video'
 ---
 
 
-
-
-# Generating Subtitles for Videos
-
 You can export your completed transcripts in SRT or VTT format, which can be used for subtitles and closed captions in videos. Once your transcript status shows as completed, you can make a request to the appropriate endpoint to export your transcript in SRT or VTT format.
 
 In this Colab, we'll walk through the process of generating subtitles for videos using the AssemblyAI API.

diff --git a/fern/pages/05-guides/cookbooks/core-transcription/transcribing-github-files.mdx b/fern/pages/05-guides/cookbooks/core-transcription/transcribing-github-files.mdx
@@ -1,9 +1,7 @@
 ---
-title: 'Transcribe GitHub Files'
+title: 'How to Transcribe GitHub Files'
 ---
 
-## **Transcribing Files Hosted on GitHub with AssemblyAI**
-
 ### Step 1: Upload Your Audio Files to a Public GitHub Repository
 
 - **File Requirements**: GitHub has a file size limit of 100MB so ensure your audio files are 100MB in size or less. The files must be in a public repository otherwise you will receive an error saying the file is not publicly accessible. For a more secure way to host files check out our [Transcribing from an S3 Bucket Cookbook](transcribe_from_s3.ipynb).

diff --git a/fern/pages/05-guides/cookbooks/core-transcription/translate_transcripts.mdx b/fern/pages/05-guides/cookbooks/core-transcription/translate_transcripts.mdx
@@ -1,5 +1,5 @@
 ---
-title: 'Commercial Models'
+title: 'How to Translate AssemblyAI Transcripts Into Other Languages Using Commercial Models'
 ---
 
 

diff --git a/fern/pages/05-guides/index.mdx b/fern/pages/05-guides/index.mdx
@@ -58,44 +58,43 @@ _LeMUR_
 | --- |
 |[Creating Summarized Chapters from Podcasts](guides/auto_chapters)|
 |[Identifying Hate Speech in Audio or Video Files](guides/content_moderation)|
-|[Identifying Highlights in Audio and Video Files](guides/key_phrases)|
-|[Label Content with Topic Tags Using Topic Detection](guides/topic_detection)|
-|[Summarizing Virtual Meetings](guides/summarization)|
+|[How to Identify Highlights in Audio and Video Files](guides/key_phrases)|
+|[How to Label Content with Topic Tags Using Topic Detection](guides/topic_detection)|
+|[How to Summarize Virtual Meetings](guides/summarization)|
 |[Untitled](guides/entity_redaction)|
 |[Automatic Language Detection](guides/automatic-language-detection)|
-|[Automatic Language Detection as separate step from Transcription](guides/automatic-language-detection-separate)|
+|[How to Use Automatic Language Detection as a Separate Step From Transcription](guides/automatic-language-detection-separate)|
 |[Automatic Language Detection: Route to Default Language if Language Confidence is Low](guides/automatic-language-detection-route-default-language-js)|
 |[Automatic Language Detection: Route to Default Language if Language Confidence is Low](guides/automatic-language-detection-route-default-language-python)|
-|[Automatic Language Detection: Route to Nano Speech Model if Language Confidence is Low](guides/automatic-language-detection-route-nano-model)|
-|[Build a UI for Transcription with Gradio and Python](guides/gradio-frontend)|
+|[How to Route to Nano Speech Model if Detected Language Confidence is Low](guides/automatic-language-detection-route-nano-model)|
+|[How to Build a UI for Transcription with Gradio and Python](guides/gradio-frontend)|
 |[Calculate Talk / Listen Ratio](guides/talk-listen-ratio)|
-|[Commercial Models](guides/translate_transcripts)|
+|[How to Translate AssemblyAI Transcripts Into Other Languages Using Commercial Models](guides/translate_transcripts)|
 |[How To Correct Audio Duration Discrepancies with Multi-Tool Validation and Transcoding](guides/audio-duration-fix)|
 |[How To Plot A Speaker Timeline](guides/speaker_timeline)|
 |[Create custom length subtitles with AssemblyAI](guides/subtitle_creation_by_word_count)|
 |[Creating Subtitles with Speaker Labels](guides/speaker_labelled_subtitles)|
-|[Deleting an AssemblyAI Transcript](guides/delete_transcript)|
-|[Detecting Low Confidence Words in a Transcript](guides/detecting-low-confidence-words)|
+|[How to Detect Low Confidence Words in a Transcript](guides/detecting-low-confidence-words)|
 |[Do More With The JavaScript SDK](guides/do-more-with-sdk-js)|
 |[Do More With The Python SDK](guides/do-more-with-sdk-python)|
-|[Generating Subtitles for Videos](guides/subtitles)|
-|[Guide to troubleshoot Common Errors](guides/common_errors_and_solutions)|
+|[How to Generate Subtitles for Videos](guides/subtitles)|
+|[How to Troubleshoot Common Errors](guides/common_errors_and_solutions)|
 |[How To Use The EU Endpoint](guides/how_to_use_the_eu_endpoint)|
 |[How to Get YouTube Video Transcripts with yt-dlp](guides/transcribe_youtube_videos)|
 |[How to Implement Retry Server Error Logic](guides/retry-server-error)|
 |[How to Implement Retry Upload Error Logic](guides/retry-upload-error)|
-|[Identifying Duplicate Dual Channel Files](guides/identify_duplicate_channels)|
+|[How to Identify Duplicate Dual Channel Files](guides/identify_duplicate_channels)|
 |[Identifying Speakers in Audio Recordings](guides/speaker_labels)|
-|[Iterate over Speaker Labels with Make.com](guides/make.com-speaker-labels)|
+|[How to Iterate over Speaker Labels with Make.com](guides/make.com-speaker-labels)|
 |[Schedule a DELETE request with AssemblyAI and EasyCron](guides/schedule_delete)|
 |[Speaker Diarization with Async Chunking](guides/speaker-diarization-with-async-chunking)|
 |[How To Setup A Speaker Identification System using Pinecone & Nvidia TitaNet](guides/titanet-speaker-identification)|
 |[Specifying a language](guides/specify-language)|
-|[Transcribe Multiple Files Simultaneously Using the Node SDK](guides/sdk-node-batch)|
+|[How to Transcribe Multiple Files Simultaneously Using the Node SDK](guides/sdk-node-batch)|
 |[Transcribing an Audio File](guides/transcribe)|
 |[Transcribing from an S3 Bucket](guides/transcribe_from_s3)|
 |[Translating an AssemblyAI Subtitle Transcript](guides/translate_subtitles)|
-|[Untitled](guides/transcribing-github-files)|
+|[How to Transcribe GitHub Files](guides/transcribing-github-files)|
 |[Untitled](guides/transcribing-google-drive-file)|
 |[How to generate custom Speaker Labels with Pyannote](guides/Use_AssemblyAI_with_Pyannote_to_generate_custom_Speaker_Labels)|
 |[Transcribing multiple files simultaneously ](guides/SDK_transcribe_batch_of_files/batch_transcription)|

diff --git a/fern/pages/05-guides/registry.yaml b/fern/pages/05-guides/registry.yaml
@@ -18,7 +18,7 @@
   tags:
     - audio-intelligence
 
-- title: Identifying highlights in audio and video files
+- title: How to Identify highlights in audio and video files
   path: audio-intelligence/key_phrases.ipynb
   tags:
     - audio-intelligence