Skip to main content

Python SDK for Yandex Speechkit API.

Project description


🎙 Yandex SpeechKit Python SDK

PyPI GitHub build and test Updates codecov Documentation Status FOSSA Status Downloads

Python SDK for Yandex SpeechKit API. This SDK allows you to use the cloud API for speech recognition and synthesis from Yandex.

For more information please visit Yandex Speechkit API Docs. This lib supports short and long audio recognition with speechkit

🛠 Getting Started

Assuming that you have Python and virtualenv installed, set up your environment and install the required dependencies like this, or you can install the library using pip:

$ git clone https://github.com/TikhonP/yandex-speechkit-lib-python.git
$ cd yandex-speechkit-lib-python
$ virtualenv venv
...
$ . venv/bin/activate
$ python -m pip install -r requirements.txt
$ python -m pip install .
python -m pip install speechkit

📑 Speechkit documentation

Check out speechkit docs for more info. PDF docs

🔮 Using speechkit

There are support of recognizing long and short audio and synthesis. For more information please read docs below.

First you need create session for authorisation:

from speechkit import Session

oauth_token = str('<oauth_token>')
folder_id = str('<folder_id>')
api_key = str('<api-key>')
jwt_token = str('<jwt_token>')

oauth_session = Session.from_yandex_passport_oauth_token(oauth_token, folder_id)
api_key_session = Session.from_api_key(api_key, x_client_request_id_header=True, x_data_logging_enabled=True) 
# You can use `x_client_request_id_header` and `x_data_logging_enabled` params to troubleshoot yandex recognition
# Use `Session.get_x_client_request_id()` method to get x_client_request_id value.
jwt_session = Session.from_jwt(jwt_token)

Use created session to make other requests.

There are also functions for getting credentials (read Documentation for more info): Speechkit.auth.generate_jwt, speechkit.auth.get_iam_token, speechkit.auth.get_api_key

For audio recognition

Short audio:

from speechkit import ShortAudioRecognition

recognizeShortAudio = ShortAudioRecognition(session)
with open(str('/Users/tikhon/Desktop/out.wav'), str('rb')) as f:
    data = f.read()

print(recognizeShortAudio.recognize(data, format='lpcm', sampleRateHertz='48000'))

# Will be printed: 'text that need to be recognized'

Look at example with long audio long_audio_recognition.py .

Look at example with streaming audio streaming_recognize.py

For synthesis

from speechkit import SpeechSynthesis

synthesizeAudio = SpeechSynthesis(session)
synthesizeAudio.synthesize(
    str('/Users/tikhon/Desktop/out.wav'), text='Text that will be synthesised',
    voice='oksana', format='lpcm', sampleRateHertz='16000'
)

🔗 Links

💼 License

MIT

In other words, you can use the code for private and commercial purposes with an author attribution (by including the original license file).

❤️

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

speechkit-2.2.3.tar.gz (31.3 kB view details)

Uploaded Source

Built Distribution

speechkit-2.2.3-py3-none-any.whl (42.5 kB view details)

Uploaded Python 3

File details

Details for the file speechkit-2.2.3.tar.gz.

File metadata

  • Download URL: speechkit-2.2.3.tar.gz
  • Upload date:
  • Size: 31.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for speechkit-2.2.3.tar.gz
Algorithm Hash digest
SHA256 0028e5db972e0708cb555827ef47cd2fe0119bb1f1db09e4cd7620dca8a7a24c
MD5 3198745d963440f62ff9072c82857446
BLAKE2b-256 b2897b2756f64b21c61816491b92aeb5393c615d3c8927ce13ee1451d518031b

See more details on using hashes here.

File details

Details for the file speechkit-2.2.3-py3-none-any.whl.

File metadata

  • Download URL: speechkit-2.2.3-py3-none-any.whl
  • Upload date:
  • Size: 42.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for speechkit-2.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 4b7f6507b5cdef6730bb0edd0c9d57e3e8b6b41fa071bccefc5a5b8efbe07bd2
MD5 50c1954bba79e49e1e5c99792c2252fb
BLAKE2b-256 491dc4b5bb37051add92790ed2dc27213aff3247382c6dce155498088d69974d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page