Metadata-Version: 1.1
Name: yandex_speech
Version: 0.4
Summary: A library for Yandex speech kit
Home-page: https://github.com/art1415926535/Yandex_speech
Author: Artem Fedotov
Author-email: art1415926535@ya.ru
License: MIT
Description: ============================
        yandex_speech
        ============================
        
        .. image:: https://img.shields.io/pypi/v/yandex_speech.svg
            :target: https://pypi.python.org/pypi/yandex_speech
        
        .. image:: https://img.shields.io/travis/art1415926535/yandex_speech.svg
            :target: https://travis-ci.org/art1415926535/yandex_speech
        
        .. image:: https://landscape.io/github/art1415926535/Yandex_speech/master/landscape.svg?style=flat
            :target: https://landscape.io/github/art1415926535/Yandex_speech/master
        
        Installation
        ------------
        Use ``Pip``, Luke
        
        .. code-block:: bash
        
            $ pip install yandex_speech
        
        Usage
        -----
        `Text to speech <https://github.com/art1415926535/yandex_speech#text-to-speech>`_
        
        Speech to text (not ready)
        
        `Natural language understanding <https://github.com/art1415926535/yandex_speech#natural-language-understanding>`_
        
        ****
        
        Text to speech
        --------------
        Generation of speech using `Yandex SpeechKit <https://tech.yandex.ru/speechkit/>`_.
        SpeechKit Cloud allows you to voice any text in Russian, English, Turkish, or Ukrainian.
        You can choose the voice (male or female), tempo and intonation (e.g., joy).
        
        .. code-block:: python
        
            >>> from yandex_speech import TTS
            >>> tts = TTS("jane", "mp3", "60589d42-0e42-b742-8942-thekeyisalie")
            >>> tts.generate("РџСЂРёРІРµС‚ РјРёСЂ")
            >>> tss.save()
            speech.mp3
        
        TTS(speaker, audio_format, key, lang="ruвЂ‘RU", emotion="neutral", speed=1)
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        - ``speaker`` - Speaker. Female: "jane", "oksana", "alyss", "omazh". Male: "zahar", "ermil";
        - ``audio_format`` - Audio file format: "mp3", "wav", "opus";
        - ``key`` - `APIвЂ‘key for Yandex speech kit <https://developer.tech.yandex.ru>`_.
        - ``lang`` (optional) - Language: "ruвЂ‘RU" (by default), "en-US", "tr-TR", "uk-UK";
        - ``emotion`` (optional) - The color of the voice: "neutral" (by default), "evil", "good";
        - ``speed`` (optional) - Speech tempo: a value between 0.1 (slowest) to 3.0 (fastest).
        
        
        tts.generate(text)
        ~~~~~~~~~~~~~~~~~~
        - ``text`` - Text to speech: "Р·+Р°РјРѕРє" (before the stressed vowel can be put "+"; the restriction on line length: 2000 bytes);
        
        tts.save(path="speech")
        ~~~~~~~~~~~~~~~~~~~~~~~
        - ``path`` (optional) - A path to save file: "test", "dirname/test.mp3", ...;
        Returns the path.
        
        References
        ----------
        `Overview tts technology
        <https://tech.yandex.ru/speechkit/cloud/doc/dg/concepts/speechkit-dg-overview-technology-tts-docpage/>`_
        
        `The format of request and response
        <https://tech.yandex.ru/speechkit/cloud/doc/dg/concepts/speechkit-dg-tts-docpage/>`_
        
        ****
        
        Natural language understanding
        ------------------------------
        Natural language understanding is a technology that allows you to find certain objects in arbitrary text and mark them.
        
        .. code-block:: python
        
            >>> from yandex_speech import NLU
            >>> nlu = NLU("60589d42-0e42-b742-8942-thekeyisalie")
            >>> nlu.parse("31 Р°РїСЂРµР»СЏ СЂРѕРґРёР»СЃСЏ РҐР»СѓСЃРѕРІ Р“РµРЅРЅР°РґРёР№ Р’РёРєС‚РѕСЂРѕРІРёС‡", ("Date", "Fio"))
            {'Date': [{'Tokens': {'Begin': 0, 'End': 2}, 'Month': 4, 'Day': 31}], 'Fio': [{'Patronymic': 'РІРёРєС‚РѕСЂРѕРІРёС‡', 'Type': 'fioname', 'Tokens': {'Begin': 3, 'End': 6}, 'FirstName': 'РіРµРЅР°РґРёР№', 'LastName': 'С…Р»СѓСЃРѕРІ'}]}
        
        NLU(key)
        ~~~~~~~~
        - ``key`` - `APIвЂ‘key for Yandex speech kit <https://developer.tech.yandex.ru>`_.
        
        NLU.parse(text, layers=None)
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        - ``text`` - Text to parse.
        - ``layers`` (optional) - Special fields. Only one string or iterable object (e.g "Data", ("Data", "Fio")). Only these fields will be returned.
        
        Returns the parsed text into a json object.
        
        References
        ----------
        
        `Overview nlu technology
        <https://tech.yandex.ru/speechkit/cloud/doc/dg/concepts/speechkit-dg-overview-technology-nlu-docpage/>`_
        
        The format of `request <https://tech.yandex.ru/speechkit/cloud/doc/dg/concepts/speechkit-dg-nlu-params-docpage/>`_ and `response <https://tech.yandex.ru/speechkit/cloud/doc/dg/concepts/speechkit-dg-nlu-response-docpage/>`_
        
Keywords: yandex speech kit text-to-speech tts
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: Russian
Classifier: Natural Language :: English
Classifier: Natural Language :: Turkish
Classifier: Natural Language :: Ukranian
Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
