Skip to content

Commit

Permalink
Update docs with more samples
Browse files Browse the repository at this point in the history
  • Loading branch information
Swimburger committed Mar 1, 2024
1 parent efff44e commit d87cceb
Showing 1 changed file with 19 additions and 16 deletions.
35 changes: 19 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,16 +48,13 @@ You can now use the `client` object to interact with the AssemblyAI API.
# Usage

## Speech-To-Text
<details>
<summary>Transcribe a local audio file</summary>
<details open>
<summary>Transcribe an audio file with a public URL</summary>

```ruby
data = File.open('/path/to/your/file').read
encoded = Base64.encode64(data)
uploaded_file = client.files.upload(request: encoded)

transcript = client.transcripts.transcribe(audio_url: uploaded_file.upload_url)
puts transcript.text
transcript = client.transcripts.transcribe(
audio_url: 'https://storage.googleapis.com/aai-web-samples/espn-bears.m4a',
)
```

`transcribe` queues a transcription job and polls it until the `status` is `completed` or `error`.
Expand All @@ -71,27 +68,28 @@ transcript = client.transcripts.submit(
```

</details>

<details>
<summary>Transcribe an audio file with a public URL</summary>
<summary>Transcribe a local audio file</summary>

```ruby
transcript = client.transcripts.transcribe(
audio_url: 'https://storage.googleapis.com/aai-web-samples/espn-bears.m4a',
)
data = File.open('/path/to/your/file').read
encoded = Base64.encode64(data)
uploaded_file = client.files.upload(request: encoded)

transcript = client.transcripts.transcribe(audio_url: uploaded_file.upload_url)
puts transcript.text
```

`transcribe` queues a transcription job and polls it until the `status` is `completed` or `error`.

If you don't want to wait until the transcript is ready, you can use `submit`:

```ruby
transcript = client.transcripts.submit(
audio_url: 'https://storage.googleapis.com/aai-web-samples/espn-bears.m4a'
)
transcript = client.transcripts.submit(audio_url: uploaded_file.upload_url)
```

</details>

<details>
<summary>Enable additional AI models</summary>

Expand Down Expand Up @@ -199,13 +197,18 @@ response = client.transcripts.delete(transcript_id: transcript.id)

Call [LeMUR endpoints](https://www.assemblyai.com/docs/api-reference/lemur) to apply LLMs to your transcript.

<details open>
<summary>Prompt your audio with LeMUR</summary>

```ruby
response = client.lemur.task(
transcript_ids: ['0d295578-8c75-421a-885a-2c487f188927'],
prompt: 'Write a haiku about this conversation.'
)
```

</details>

<details>
<summary>Summarize with LeMUR</summary>

Expand Down

0 comments on commit d87cceb

Please sign in to comment.