> ## Documentation Index
> Fetch the complete documentation index at: https://daily-docs-source-analytics-user-turn-strategies.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Simplismart

> Speech-to-text service implementation using the Simplismart HTTP API

export const CommunityMaintained = ({maintainer, maintainerUrl, repo}) => <Note>
    <strong>Community-maintained integration.</strong> This service is built and
    maintained by{" "}
    <a href={maintainerUrl} target="_blank" rel="noreferrer">
      {maintainer}
    </a>
    . Pipecat does not test or officially support it. Please report issues and
    request changes on the{" "}
    <a href={repo} target="_blank" rel="noreferrer">
      source repository
    </a>
    . Learn more about{" "}
    <a href="/api-reference/server/services/community-integrations">
      community integrations
    </a>
    .
  </Note>;

<CommunityMaintained maintainer="simpli-smart" maintainerUrl="https://github.com/simpli-smart" repo="https://github.com/simpli-smart/pipecat-simplismart" />

## Overview

`SimplismartSTTService` is a segmented speech-to-text service that POSTs WAV
audio segments to the [Simplismart](https://simplismart.ai) HTTP `/predict`
endpoint and emits `TranscriptionFrame`s. It requires upstream VAD (a
`VADProcessor` or transport/user-aggregator VAD) so speech segments are
delimited before transcription.

<CardGroup cols={2}>
  <Card title="Source Repository" icon="github" href="https://github.com/simpli-smart/pipecat-simplismart">
    Source code, examples, and issues for the Simplismart integration
  </Card>

  <Card title="Simplismart" icon="book" href="https://simplismart.ai">
    Learn more about Simplismart's AI platform
  </Card>
</CardGroup>

## Installation

This is a community-maintained package distributed separately from `pipecat-ai`.
It is not published to PyPI, so install it from source:

```bash theme={null}
uv pip install git+https://github.com/simpli-smart/pipecat-simplismart.git
```

## Prerequisites

### Simplismart Account Setup

Before using the Simplismart STT service, you need a Simplismart account and an
API key. See [Simplismart](https://simplismart.ai) to get started.

### Required Environment Variables

* `SIMPLISMART_API_KEY`: Bearer token used to authenticate requests. May be
  passed directly via the `api_key` constructor argument instead.
* `SIMPLISMART_STT_URL` *(optional)*: Full URL for the STT endpoint. Defaults to
  `https://api.simplismart.live/predict`.

## Configuration

<ParamField path="api_key" type="str" default="None">
  Bearer token. Falls back to the `SIMPLISMART_API_KEY` environment variable if
  not provided.
</ParamField>

<ParamField path="base_url" type="str" default="None">
  Full URL to the predict endpoint. Falls back to the `SIMPLISMART_STT_URL`
  environment variable, then to `https://api.simplismart.live/predict`.
</ParamField>

<ParamField path="aiohttp_session" type="aiohttp.ClientSession" default="None">
  Optional shared aiohttp session. If not provided, the service creates and owns
  its own session.
</ParamField>

<ParamField path="sample_rate" type="int" default="None">
  Input audio sample rate. Usually supplied by the pipeline `StartFrame`.
</ParamField>

<ParamField path="settings" type="SimplismartSTTService.Settings" default="None">
  Runtime-configurable STT settings. See [Settings](#settings) below.
</ParamField>

### Settings

Runtime-configurable settings passed via the `settings` constructor argument
using `SimplismartSTTService.Settings(...)`. The settings dataclass extends
Pipecat's common `STTSettings` (which includes `model` and `language`).

| Parameter                        | Type    | Default | Description                                                       |
| -------------------------------- | ------- | ------- | ----------------------------------------------------------------- |
| `vad_filter`                     | `bool`  | `True`  | Enable server-side VAD filtering when supported.                  |
| `vad_onset`                      | `float` | `0.5`   | VAD onset threshold.                                              |
| `beam_size`                      | `int`   | `4`     | Beam search size for decoding.                                    |
| `temperature`                    | `float` | `0.0`   | Decoding temperature.                                             |
| `strict_hallucination_reduction` | `bool`  | `True`  | Ask the server to apply extra anti-hallucination logic (Whisper). |

The default model is `openai/whisper-large-v3-turbo` and the default language is
`Language.EN`.

<Note>
  See the [source
  repository](https://github.com/simpli-smart/pipecat-simplismart) for the
  authoritative, up-to-date list of settings and defaults.
</Note>

## Usage

Place a `VADProcessor` **before** `SimplismartSTTService` so VAD events reach the
segmented STT layer.

```python theme={null}
from pipecat.audio.vad.silero import SileroVADAnalyzer
from pipecat.processors.audio.vad_processor import VADProcessor
from pipecat_simplismart import SimplismartSTTService

vad_processor = VADProcessor(vad_analyzer=SileroVADAnalyzer())
stt = SimplismartSTTService(
    api_key="YOUR_KEY",
    base_url="https://api.simplismart.live/predict",
)

# pipeline: ... transport.input(), vad_processor, stt, ...
```

The service outputs `TranscriptionFrame`s.

## Compatibility

Tested with Pipecat v1.1.0 (`pipecat-ai>=0.0.86`). Check the [source
repository](https://github.com/simpli-smart/pipecat-simplismart) for the latest
tested version and changelog.