Skip to content

Commit

Permalink
Merge branch 'main' into update-few-guides-with-lb
Browse files Browse the repository at this point in the history
  • Loading branch information
shawnrushefsky authored Nov 18, 2024
2 parents 15d473b + 2be7668 commit 731cf4d
Show file tree
Hide file tree
Showing 8 changed files with 358 additions and 44 deletions.
2 changes: 2 additions & 0 deletions dictionaries/salad-cloud.txt
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ infotexts
inpainting
INSTALLDIR
interruptible
ipinfo
italian
iterrows
jemison
Expand All @@ -72,6 +73,7 @@ makedirs
metavoiceio
mintlify
neofetch
nflx
noheader
nomos8khatLOtf_v20.safetensors
noproxy
Expand Down
4 changes: 2 additions & 2 deletions guides/transcription/salad-transcription-api/captions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ description:

## Introduction

SaladCloud's Managed Transcription API provides powerful features for generating captions in the SRT (SubRip Subtitle)
format, which is widely used for video subtitles and closed captions. Our service enables you to:
Salad Transcription API provides powerful features for generating captions in the SRT (SubRip Subtitle) format, which is
widely used for video subtitles and closed captions. Our service enables you to:

- **Generate SRT captions with industry-standard formatting**: We adhere to the standard of a maximum of **84 characters
per caption** to ensure readability and compliance with broadcasting guidelines.
Expand Down
261 changes: 261 additions & 0 deletions guides/transcription/salad-transcription-api/llm-features.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,261 @@
---
title: 'LLM Integration Guide'
description: >
Learn how to enhance your transcriptions using Salad Transcription API with Large Language Model (LLM) features. This
guide covers advanced parameters like `summarize`, `llm_translation`, `custom_prompt`, `classification_labels`,
`overall_classification`, and `overall_sentiment_analysis` to extract deeper insights from your audio content.
---

## Introduction

Salad Transcription API now offers integration with Large Language Models (LLMs) to provide advanced features such as
summarization, translation, custom prompts, and sentiment analysis. By leveraging LLMs, you can gain richer insights and
perform complex language processing tasks on your transcriptions.

This guide covers the key LLM-related parameters you can use to enhance your transcription outputs:

- **Summarization**:
- `summarize`
- **LLM-Based Translation**:
- `llm_translation`
- `srt_translation`
- **Custom Prompts**:
- `custom_prompt`
- **Overall Classification and Sentiment Analysis**:
- `overall_classification`
- `overall_sentiment_analysis`

By properly utilizing these parameters, you can unlock the full potential of LLMs in your transcription workflows.

## LLM Integration Parameters

### 1. `summarize`

#### Description

The `summarize` parameter enables you to generate a concise summary of your transcription using an LLM. You can specify
the maximum word count for the summary.

- **Default**: `0` (No summarization)
- **Type**: `integer`

#### Usage

Set `"summarize": word_limit` in your request to receive a summary with the specified word limit.

**Example:**

```json
"input": {
"url": "https://example.com/path/to/file.mp3",
"summarize": 100
}
```

**Output**

The summary will be included in the `summary` field of the output.

```json
"summary": "This meeting discussed project timelines, budget allocations, and assigned tasks to team members for the next quarter."
```

### 2. `llm_translation`

#### Description

Use the `"llm_translation"` parameter to translate your transcription into one or more specified languages using an LLM.

- **Type**: `string` (Comma-separated list of languages)

**Usage**

Set `"llm_translation": "Language1, Language2"` to translate the transcription into the specified languages.

**Example:**

```json
"input": {
"url": "https://example.com/path/to/file.mp3",
"llm_translation": "german, italian, french"
}
```

**Output**

Translations will be included in the `llm_translation` object.

```json
"llm_translation": {
"French": "Votre transcription en français.",
"German": "Ihre Transkription auf Deutsch."
}
```

Check [translation page](/guides/transcription/salad-transcription-api/translation) for more details.

### 3. `srt_translation`

#### Description

Translate the generated SRT subtitles into specified languages using an LLM.

- **Type**: `string` (Comma-separated list of languages)

**Usage**

Set `"srt_translation": "Language1, Language2"` to translate the transcription into the specified languages.

**Example:**

```json
"input": {
"url": "https://example.com/path/to/file.mp3",
"srt_translation": "spanish"
}
```

**Output**

Translations will be included in the `srt_translation` object.

```json
"llm_translation": {
"Spanish": "1\n00:00:01,000 --> 00:00:04,000\nSu transcripción en español.\n\n..."
}
```

Check [translation page](/guides/transcription/salad-transcription-api/translation) for more details.

### 4. `custom_prompt`

#### Description

Provide a `custom prompt` to guide the LLM in performing specific tasks, such as generating a tailored summary,
extracting key information, improve result, or answering questions based on the transcription.

- **Type**: `string`

**Usage**

Set `"custom_prompt": "Your custom instruction here"` to direct the LLM. As a result the LLM model will receive a prompt
in the following format: `custom instruction:transcription`

**Example:**

```json
"input": {
"url": "https://example.com/path/to/file.mp3",
"custom_prompt": "List all action items discussed in the meeting."
}
```

**Output**

The LLM will generate a response based on the custom prompt. The result will be included in the `llm_result` field.

json Copy code

```json
"llm_result": "- Prepare the project proposal by Friday.\n- Schedule a follow-up meeting next Monday.\n- Allocate resources for the development team."
```

### 5. `classification_labels ` and `overall_classification`

#### Description

Use the `classification_labels` parameter in conjunction with `overall_classification` to classify the entire
transcription into specified categories using an LLM.

- **`classification_labels`**:
- **Type**: `string` (Comma-separated list of labels)
- **`overall_classification`**:
- **Default**: `false`
- **Type**: `boolean`

#### Usage

Set `"overall_classification": true` and provide your labels in `"classification_labels": "Label1, Label2"` to classify
the entire transcription.

**Example:**

```json
"input": {
"url": "https://example.com/path/to/file.mp3",
"overall_classification": true,
"classification_labels": "Interview, Meeting, Presentation"
}
```

**Output**

The classification result will be included in the `overall_classification` field.

```json
"overall_classification": "Meeting"
```

**Notes**

- **`Custom Labels:`**: You can define any categories relevant to your use case.
- **`Multiple Labels:`**: The LLM will select the most appropriate label from the list provided

### 6. `overall_sentiment_analysis`

#### Description

Analyze the overall sentiment of the transcription using an LLM.

- **Default**: `false`
- **Type**: `boolean`

#### Usage

Set `"overall_sentiment_analysis"`: true to perform sentiment analysis.

**Example:**

```json
"input": {
"url": "https://example.com/path/to/file.mp3",
"overall_sentiment_analysis": true
}
```

**Output**

The result will be included in the `overall_sentiment` field.

json Copy code

```json
"overall_sentiment": "Positive"
```

### 7. `custom_vocabulary`

#### Description

Improve transcription accuracy by providing a custom vocabulary of terms that are specific to your domain, such as
industry jargon, acronyms, or proper nouns.

- **Type**: `string` (Comma-separated list of terms)

#### Usage

Set `"custom_vocabulary": "Term1, Term2"` to include custom terms in the transcription process.

**Example:**

```json
"input": {
"url": "https://example.com/path/to/file.mp3",
"custom_vocabulary": "SaladCloud, AI Transcription, LLM Integration"
}
```

**Notes**

- The custom vocabulary helps the LLM update domain-specific terms.
- Result will have both the original transcrioption and updated under `llm_custom_vocabulary`.
11 changes: 5 additions & 6 deletions guides/transcription/salad-transcription-api/speech-to-text.mdx
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@
---
title: 'Speech-to-Text Guide'
description:
"Discover the core transcription features of SaladCloud's Managed Transcription API. Learn how to utilize parameters
like `return_as_file`, `sentence_level_timestamps`, `word_level_timestamps`, `diarization`, `sentence_diarization`,
and how to specify `language_code` for optimal performance."
'Discover the core transcription features of Salad Transcription API. Learn how to utilize parameters like
`return_as_file`, `sentence_level_timestamps`, `word_level_timestamps`, `diarization`, `sentence_diarization`, and how
to specify `language_code` for optimal performance.'
---

# Transcription API Features Guide

## Introduction

SaladCloud's Managed Transcription API offers a suite of powerful features to help you get the most out of your audio
and video content. This guide covers the key transcription parameters you can use to customize your transcription
outputs:
Salad Transcription API offers a suite of powerful features to help you get the most out of your audio and video
content. This guide covers the key transcription parameters you can use to customize your transcription outputs:

- **Transcription Output Options**:
- `return_as_file`
Expand Down
6 changes: 4 additions & 2 deletions mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,8 @@
"products/transcription/transcription-overview",
"products/transcription/speech-to-text",
"products/transcription/translation",
"products/transcription/captions"
"products/transcription/captions",
"products/transcription/insights-intelligence"
]
},
{
Expand Down Expand Up @@ -373,7 +374,8 @@
"pages": [
"guides/transcription/salad-transcription-api/speech-to-text",
"guides/transcription/salad-transcription-api/translation",
"guides/transcription/salad-transcription-api/captions"
"guides/transcription/salad-transcription-api/captions",
"guides/transcription/salad-transcription-api/llm-features"
]
},
{
Expand Down
Loading

0 comments on commit 731cf4d

Please sign in to comment.