jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-16 05:46:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add speech to text entity (#1747)

Browse Source
This commit is contained in:
Martin Hjelmare 2023-04-15 03:07:30 +02:00 committed by GitHub
parent 8514cfbeec
commit 298f379b63
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 40 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
docs/core/entity/stt.md Normal file
View File

@ -0,0 +1,40 @@
---
title: Speech To Text Entity
sidebar_label: Speech To Text
---
A speech to text (STT) entity allows other integrations or applications to stream speech data to the STT API and get text back.
A speech to text entity is derived from the [`homeassistant.components.stt.SpeechToTextEntity`](https://github.com/home-assistant/core/blob/dev/homeassistant/components/stt/__init__.py).
## Properties
:::tip
Properties should always only return information from memory and not do I/O (like network requests).
:::
| Name | Type | Default | Description
| ---- | ---- | ------- | -----------
| supported_languages | list[str] | **Required** | The supported languages of the STT service.
| supported_formats | list[AudioFormats] | **Required** | The supported audio formats of the STT service, wav or ogg.
| supported_codecs | list[AudioCodecs] | **Required** | The supported audio codecs of the STT service, pcm or opus.
| supported_bit_rates | list[AudioBitRates] | **Required** | The supported audio bit rates of the STT service, 8, 16, 24 or 32.
| supported_sample_rates | list[AudioSampleRates] | **Required** | The supported audio sample rates of the STT service.
| supported_channels | list[AudioChannels] | **Required** | The supported audio channels of the STT service, 1 or 2.
## Methods
### Process audio stream
The process audio stream method is used send audio to an STT service and get text back.
```python
class MySpeechToTextEntity(SpeechToTextEntity):
"""Represent a Speech To Text entity."""
async def async_process_audio_stream(self) -> None:
"""Process an audio stream to STT service.
Only streaming content is allowed!
"""
```