{
    "info": {
        "author": "Voysis",
        "author_email": "support@voysis.com",
        "bugtrack_url": null,
        "classifiers": [],
        "description": "[![Build Status](https://travis-ci.org/voysis/voysis-python.svg?branch=master)](https://travis-ci.org/voysis/voysis-python)\n\n# Voysis Python Library\n\nThe Voysis Python Library provides a set of classes that allow Python\napplications to interact with Voysis Query API endpoints.\n\nA command-line invocation tool is also supplied to provide both an\neasy way to interact with the Voysis Query API and a working example\nof how to consume the library classes.\n\n## Installation\n\nTo install from the PyPI repository, simply run\n\n```\npip3 install --upgrade voysis-python\n```\n\nor to install from this source tree, execute\n\n```\npython3 setup.py install\n```\n\n### Requirements\n\nThe Voysis Python library and command line tool require Python 3, with\nPython 3.6 being the recommended environment.\n\n`portaudio` is required to operate in a Mac OSX environment. This can\nbe installed using [Homebrew](https://brew.sh)\n\n```\nbrew install portaudio \n```\n\n## API Documentation\n\nThe full documentation for the Voysis API can be found here:\n[Voysis Developer Documentation](https://developers.voysis.com/docs)\n\n## VTC: The Voysis Test Client\n\nThis project supplies a command-line testing tool called `voysis-vtc`, which\nprovides a simple way to test and interact with a Voysis Voice AI.\n\n\n### Getting Help\n\nAfter installation, run `voysis-vtc --help` for a summary of the command line\narguments and sub-commands available. Re-running the tool with a sub-command\nname and `--help` will give further help for that sub-command:\n\n```\nvoysis-vtc query --help\n```\n\n### Specifying Your Voice AI Endpoint\n\nTo execute queries against your Voice AI endpoint, you will need to tell\nVTC the URL of your Voice AI. This URL will be supplied to you by Voysis.\n\nTo provide it to VTC, use the global `--url` option:\n\n```\nvoysis-vtc --url wss://test.voysis.io/websocketapi query\n```\n\nYou can also specify the endpoint URL in your environment so that you\ndo not have to provide on the command line for each invocation:\n\n```\nexport VTC_URL=wss://test.voysis.io/websocketapi\n```\n\n### Authentication\n\nYour Voice AI endpoint will require an authentication token to be\nspecified for queries to be successful. The VTC command supports\nspecifying a valid refresh token using the global `--auth-token` option:\n\n```\nvoysis-vtc \\\n    --auth-token=8U7CsQyiK8bqLwGnZUmnmgArbmiR9si50DIrjIHp5soAJ4i7NHB2Gg3IhlIgXYN1 \\\n    --url=wss://test.voysis.io/websocketapi \\\n    query\n```\n\nYou can also provide the refresh token in your environment so that you do not\nneed to provide it on the command line for each invocation:\n\n```\nexport VTC_AUTH_TOKEN=8U7CsQyiK8bqLwGnZUmnmgArbmiR9si50DIrjIHp5soAJ4i7NHB2Gg3IhlIgXYN1\n```\n\n### Interacting with Your Voice AI\n\nThe most direct way of interacting with your Voice AI is by sending a single\nquery recorded from the microphone.\n\nTo record a voice query and send it to the Voice AI, execute\n\n```\nvoysis-vtc query\n```\n\nand follow the on-screen prompts.\n\n### Sending an Audio File\n\nThe VTC client can send a file containing audio data rather than recording\nfrom the microphone. Currently only files containing raw samples or a wav\nfile are supported. If sending raw samples, the audio data _must_ conform\nto the following parameters:\n\n * 16000Hz 16-bit signed integer single-channel PCM data.\n\n```\nvoysis-vtc query --send audio_data.wav\n```\n\n### Sending Many Audio Files\n\nThe VTC client supports sending a batch of audio files sequentially to\na Voice AI endpoint. The path to a directory containing many wav files\nshould be supplied on the command line:\n\n```\nvoysis-vtc query --batch /path/to/wav/folder\n``` \n\n### Providing Query Feedback\n\nThe Voysis Query API supports providing feedback on the quality of the\nresults of an audio query. To provide this feedback, use the `feedback`\nsub-command:\n\n```\nvoysis-vtc feedback \\\n           --query-id dda80ba2-f0fa-421d-8462-2f849bbb30b3 \\\n           --rating 5 \\\n           --description=\"Perfect results\"\n```\n\nThe rating is a simple integer in the range 1 - 5 with 1 representing the\npoorest quality and 5 representing the best. Description is a free-form\nstring that can be used to provide additional information about why the\nquery results were poor. This information will be stored alongside the\nquery and can be used by Voysis to improve Voice AIs.",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/voysis/voysis-python",
        "keywords": "",
        "license": "MIT",
        "maintainer": "",
        "maintainer_email": "",
        "name": "voysis-python",
        "package_url": "https://pypi.org/project/voysis-python/",
        "platform": "",
        "project_url": "https://pypi.org/project/voysis-python/",
        "project_urls": {
            "Homepage": "https://github.com/voysis/voysis-python"
        },
        "release_url": "https://pypi.org/project/voysis-python/2.0.0/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "Voysis Query API Python Library",
        "version": "2.0.0"
    },
    "last_serial": 5184068,
    "releases": {
        "1.0.10": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "f101c341e2a423e1f29b709737b1579b",
                    "sha256": "930c2904fea1bf46cf8678989c0ef736b2f8869684d4aa57e6d8ba79dffd4314"
                },
                "downloads": -1,
                "filename": "voysis-python-1.0.10.tar.gz",
                "has_sig": false,
                "md5_digest": "f101c341e2a423e1f29b709737b1579b",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 30644,
                "upload_time": "2018-10-10T15:01:28",
                "url": "https://files.pythonhosted.org/packages/05/31/7ddb1fde6a8c4f7c5daffce8d7794d0422bf8ecf91dd65d96a552a5c6df8/voysis-python-1.0.10.tar.gz"
            }
        ],
        "1.0.11": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "062cc5d3887b62c4050a84af6d982c7f",
                    "sha256": "647060a83bfae20be18f7240af228e7dd2ff61cc32179be66c33ad6534a3d257"
                },
                "downloads": -1,
                "filename": "voysis-python-1.0.11.tar.gz",
                "has_sig": false,
                "md5_digest": "062cc5d3887b62c4050a84af6d982c7f",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 30620,
                "upload_time": "2018-10-11T09:40:28",
                "url": "https://files.pythonhosted.org/packages/c8/2b/44cd31148fb1f092f6bf1cd2faf09094f8ac180880d9ec8be507e6bc9aeb/voysis-python-1.0.11.tar.gz"
            }
        ],
        "1.0.12": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "7fbbc8514dab29eefac6b0c8739a399b",
                    "sha256": "38f2864f18774c3c882844e8780153aea904d24984be9b7533fc86e952d4db8c"
                },
                "downloads": -1,
                "filename": "voysis-python-1.0.12.tar.gz",
                "has_sig": false,
                "md5_digest": "7fbbc8514dab29eefac6b0c8739a399b",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 30897,
                "upload_time": "2018-10-12T13:15:19",
                "url": "https://files.pythonhosted.org/packages/90/d5/5575f70171df618bbff069ba3800fb7df604131fc95895b01473f972edc3/voysis-python-1.0.12.tar.gz"
            }
        ],
        "1.0.13": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "4589240664f5ed8d01a451079c9f5e26",
                    "sha256": "5e7aaa93d648523c85dfce2d75fc0f6765ebca78fbe7474cc0e3c380c07e74af"
                },
                "downloads": -1,
                "filename": "voysis-python-1.0.13.tar.gz",
                "has_sig": false,
                "md5_digest": "4589240664f5ed8d01a451079c9f5e26",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 32749,
                "upload_time": "2019-04-24T19:16:50",
                "url": "https://files.pythonhosted.org/packages/1f/a8/7e6758d180fa2c7194bf660136fe77feea2c6b007460b63287243c7c4f60/voysis-python-1.0.13.tar.gz"
            }
        ],
        "1.0.8": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "12d6b8b25b3e481cffd282091ef1835e",
                    "sha256": "bbe6f200e20830e1f09b56b2a9002cd82ba4afb17639d16143d32d035900604e"
                },
                "downloads": -1,
                "filename": "voysis-python-1.0.8.tar.gz",
                "has_sig": false,
                "md5_digest": "12d6b8b25b3e481cffd282091ef1835e",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 30157,
                "upload_time": "2018-09-18T14:17:57",
                "url": "https://files.pythonhosted.org/packages/4e/24/e64caa2aab41712286c2f2ff18484241e7aa6661d769249fefc15247c1ed/voysis-python-1.0.8.tar.gz"
            }
        ],
        "1.0.9": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "ddcc97f972d8edb34e1bbe417207e908",
                    "sha256": "6c319d45beace920548f1dacdf9cf418099ce6cde11400d06d6dda4d942064c1"
                },
                "downloads": -1,
                "filename": "voysis-python-1.0.9.tar.gz",
                "has_sig": false,
                "md5_digest": "ddcc97f972d8edb34e1bbe417207e908",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 30221,
                "upload_time": "2018-09-18T15:58:48",
                "url": "https://files.pythonhosted.org/packages/88/a8/d92118d24741de630e5679f625b26e661a3f5e84575b26a2e6fb0c62d158/voysis-python-1.0.9.tar.gz"
            }
        ],
        "1.0.9a1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "3af51410bf4999592b6a2b718906d171",
                    "sha256": "ad6e8d9252c4de0ce5131e86ab283368036745a25d534f8f635737803257d681"
                },
                "downloads": -1,
                "filename": "voysis-python-1.0.9a1.tar.gz",
                "has_sig": false,
                "md5_digest": "3af51410bf4999592b6a2b718906d171",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 30222,
                "upload_time": "2018-09-18T15:51:13",
                "url": "https://files.pythonhosted.org/packages/25/94/7a0e33ab354fced0883e39c7fdb57a7101d9908209680033dceb428d635e/voysis-python-1.0.9a1.tar.gz"
            }
        ],
        "2.0.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "9d27f64562dcc4215a4290c5f28f426b",
                    "sha256": "08aae056d411150911ca516a872a2c5f6bf29ce2871dbb352d1acadaebf7c016"
                },
                "downloads": -1,
                "filename": "voysis-python-2.0.0.tar.gz",
                "has_sig": false,
                "md5_digest": "9d27f64562dcc4215a4290c5f28f426b",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 32682,
                "upload_time": "2019-04-24T19:26:46",
                "url": "https://files.pythonhosted.org/packages/7b/0f/7fb121b1815a8be3ad0581e8a6ad5b9f67ae5537ec7a86466ae800b3e144/voysis-python-2.0.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "9d27f64562dcc4215a4290c5f28f426b",
                "sha256": "08aae056d411150911ca516a872a2c5f6bf29ce2871dbb352d1acadaebf7c016"
            },
            "downloads": -1,
            "filename": "voysis-python-2.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "9d27f64562dcc4215a4290c5f28f426b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 32682,
            "upload_time": "2019-04-24T19:26:46",
            "url": "https://files.pythonhosted.org/packages/7b/0f/7fb121b1815a8be3ad0581e8a6ad5b9f67ae5537ec7a86466ae800b3e144/voysis-python-2.0.0.tar.gz"
        }
    ]
}