Skip to content

Commit 98c945c

Browse files
authored
docs(spec): remove 'phrases' from custom_spelling docs (#227)
* docs(spec): remove 'phrases' from custom_spelling docs' * chore: format mdx files
1 parent ac7b872 commit 98c945c

File tree

8 files changed

+43
-25
lines changed

8 files changed

+43
-25
lines changed

Diff for: fern/.definition/transcripts.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1030,7 +1030,7 @@ types:
10301030
docs: Words or phrases to replace
10311031
type: list<string>
10321032
to:
1033-
docs: Word or phrase to replace with
1033+
docs: Word to replace with
10341034
type: string
10351035
source:
10361036
openapi: ../openapi.yml

Diff for: fern/pages/01-getting-started/transcribe-an-audio-file.mdx

+5-1
Original file line numberDiff line numberDiff line change
@@ -560,8 +560,12 @@ var transcript = await client.Transcripts.TranscribeAsync(
560560
```ruby
561561
audio_url = 'https://assembly.ai/sports_injuries.mp3'
562562
```
563+
563564
<Note title="Creating self hosted audio URLs">
564-
You can use a service like Amazon S3, Google Cloud Storage, or any platform that supports direct file access to generate a shareable audio file URL. Check out this cookbook on how to [transcribe from an S3 bucket.](/docs/guides/transcribe_from_s3)
565+
You can use a service like Amazon S3, Google Cloud Storage, or any platform
566+
that supports direct file access to generate a shareable audio file URL. Check
567+
out this cookbook on how to [transcribe from an S3
568+
bucket.](/docs/guides/transcribe_from_s3)
565569
</Note>
566570

567571
<Note title="Local audio files">

Diff for: fern/pages/01-getting-started/transcribe-an-audio-file/csharp.mdx

+1
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,7 @@ Specify a URL to the audio you want to transcribe. The URL needs to be accessibl
185185
```C#
186186
var audioUrl = "https://assembly.ai/sports_injuries.mp3";
187187
```
188+
188189
<Note title="Creating self hosted audio URLs">
189190
You can use a service like Amazon S3, Google Cloud Storage, or any platform that supports direct file access to generate a shareable audio file URL. Check out this cookbook on how to [transcribe from an S3 bucket.](/docs/guides/transcribe_from_s3)
190191
</Note>

Diff for: fern/pages/01-getting-started/transcribe-an-audio-file/python.mdx

+30-19
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Here's the full sample code for what you'll build in this tutorial:
4545
print(f" \nFull Transcript: \n\n{transcript.text}")
4646

4747
print("\nSpeaker Segmentation:\n")
48-
48+
4949
for utterance in transcript.utterances:
5050
print(f"Speaker {utterance.speaker}: {utterance.text}")
5151
```
@@ -70,7 +70,7 @@ Here's the full sample code for what you'll build in this tutorial:
7070
print(f"Error: {response.status_code}, Response: {response.text}")
7171
response.raise_for_status()
7272
73-
upload_json = response.json()
73+
upload_json = response.json()
7474
upload_url = upload_json["upload_url"]
7575
'''
7676

@@ -103,6 +103,7 @@ Here's the full sample code for what you'll build in this tutorial:
103103
else:
104104
time.sleep(3)
105105
````
106+
106107
</Tab>
107108
</Tabs>
108109

@@ -111,31 +112,36 @@ Here's the full sample code for what you'll build in this tutorial:
111112
To complete this tutorial, you need:
112113

113114
- [Python](https://www.python.org/) installed.
114-
- <a href="https://www.assemblyai.com/dashboard/signup" target="_blank">A free AssemblyAI account</a>.
115+
- <a href="https://www.assemblyai.com/dashboard/signup" target="_blank">
116+
A free AssemblyAI account
117+
</a>
118+
.
115119

116120
<Tabs groupId="language">
117121
<Tab language="python-sdk" title="Python SDK" default>
118122
## Step 1: Install the SDK
119123
Install our Python SDK via pip:
120124

121-
```bash
122-
pip install assemblyai
123-
```
125+
```bash
126+
pip install assemblyai
127+
```
128+
124129
</Tab>
125130
<Tab language="python" title="Python">
126131
## Step 1: Install and import the necessary libraries
127132
Install the requests library used for making an HTTP request.
128133

129-
```bash
130-
pip install requests
131-
```
134+
```bash
135+
pip install requests
136+
```
137+
138+
Create a new file and import the requests and time library.
132139

133-
Create a new file and import the requests and time library.
140+
```python
141+
import requests
142+
import time
143+
```
134144

135-
```python
136-
import requests
137-
import time
138-
```
139145
</Tab>
140146
</Tabs>
141147

@@ -162,6 +168,7 @@ To complete this tutorial, you need:
162168
```
163169
</Step>
164170
</Steps>
171+
165172
</Tab>
166173
<Tab language="python" title="Python">
167174
## Step 2: Set up the API endpoint and headers
@@ -181,6 +188,7 @@ To complete this tutorial, you need:
181188
```
182189
</Step>
183190
</Steps>
191+
184192
</Tab>
185193
</Tabs>
186194

@@ -250,6 +258,7 @@ In this step, you'll submit the audio file for transcription and wait until it's
250258
<Step>
251259
Run the application and wait for it to finish.
252260
</Step>
261+
253262
</Steps>
254263
</Tab>
255264
<Tab language="python" title="Python">
@@ -334,11 +343,11 @@ In this step, you'll submit the audio file for transcription and wait until it's
334343
<Step>
335344
Run the application and wait for it to finish.
336345
</Step>
346+
337347
</Steps>
338348
</Tab>
339349
</Tabs>
340350

341-
342351
You've successfully transcribed your first audio file. You can see all submitted transcription jobs in the <a href="https://www.assemblyai.com/app/processing-queue" target="_blank">Processing queue</a>.
343352

344353
## Step 4: Enable additional AI models
@@ -365,6 +374,7 @@ You can extract even more insights from the audio by enabling any of our [AI mod
365374
print(f"Speaker {utterance.speaker}: {utterance.text}")
366375
```
367376
</Step>
377+
368378
</Steps>
369379
</Tab>
370380
<Tab language="python" title="Python">
@@ -395,14 +405,13 @@ You can extract even more insights from the audio by enabling any of our [AI mod
395405
time.sleep(3)
396406
```
397407
</Step>
408+
398409
</Steps>
399410
</Tab>
400411
</Tabs>
401412

402-
403413
Many of the properties in the transcript object only become available after you enable the corresponding model. For more information, see the models under [Speech-to-Text](/speech-to-text) and [Audio Intelligence](/audio-intelligence).
404414

405-
406415
## Next steps
407416

408417
In this tutorial, you've learned how to generate a transcript for an audio file and how to extract speaker information by enabling the [Speaker diarization](/docs/speech-to-text/speaker-diarization) model.
@@ -413,8 +422,10 @@ Want to learn more?
413422
- If you want to transcribe audio in real-time, see [Transcribe streaming audio from a microphone](/getting-started/transcribe-streaming-audio-from-a-microphone).
414423
- To search, summarize, and ask questions on your transcripts with LLMs, see [LeMUR](/lemur).
415424

416-
417425
## Need some help?
418426

419427
If you get stuck, or have any other questions, we'd love to help you out. Contact our support team at [email protected] or create a [support ticket](https://www.assemblyai.com/contact/support).
420-
````
428+
429+
```
430+
431+
```

Diff for: fern/pages/03-audio-intelligence/pii-redaction.mdx

+3-1
Original file line numberDiff line numberDiff line change
@@ -561,7 +561,9 @@ getting hit in the US. Is because there's a couple of weather systems that ...
561561
```
562562

563563
<Tip title="PII Redaction Using LeMUR">
564-
If you would like the option to use LeMUR for custom PII redaction, check out this guide [Redact PII from Text Using LeMUR](/docs/lemur/lemur-pii-redaction).
564+
If you would like the option to use LeMUR for custom PII redaction, check out
565+
this guide [Redact PII from Text Using
566+
LeMUR](/docs/lemur/lemur-pii-redaction).
565567
</Tip>
566568

567569
## Create redacted audio files

Diff for: fern/pages/05-guides/cookbooks/lemur/lemur-pii-redaction.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -172,4 +172,4 @@ Print the redacted transcript.
172172
```python
173173
print('Full redacted transcript:')
174174
print(redacted_transcript)
175-
```
175+
```

Diff for: openapi.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1975,7 +1975,7 @@
19751975
},
19761976
"to": {
19771977
"x-label": "To",
1978-
"description": "Word or phrase to replace with",
1978+
"description": "Word to replace with",
19791979
"type": "string"
19801980
}
19811981
},

Diff for: openapi.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1668,7 +1668,7 @@ components:
16681668
type: string
16691669
to:
16701670
x-label: To
1671-
description: Word or phrase to replace with
1671+
description: Word to replace with
16721672
type: string
16731673
required: [from, to]
16741674
example: { from: ["dicarlo"], to: "Decarlo" }

0 commit comments

Comments
 (0)