# Octopus Speech-to-Index engine
Made in Vancouver, Canada by [Picovoice](https://picovoice.ai)
This package contains commandline program for indexing and searching inside audio files using Octopus Speech-to-Index engine.
## Octopus
Octopus is Picovoice's Speech-to-Index engine. It directly indexes speech without relying on a text representation.
## Compatibility
- Python 3
- Runs on Linux (x86_64), macOS (x86_64, arm64), Windows (x86_64).
## AccessKey
Octopus requires a valid Picovoice `AccessKey` at initialization. `AccessKey` acts as your credentials when using Octopus SDKs.
You can get your `AccessKey` for free. Make sure to keep your `AccessKey` secret.
Signup or Login to [Picovoice Console](https://console.picovoice.ai/) to get your `AccessKey`.
## Installation
```console
sudo pip3 install pvoctopusdemo
```
## Usage
This demo allows testing Octopus interactively through commandline. It accepts MP3, WAV, FLAC, and OPUS audio files with sample rates higher than 16kHz. The following command processes all files in the space-separated `{AUDIO_PATHS}` list:
```console
octopus_demo --access_key {AccessKey} --audio_paths ${AUDIO_PATHS}
```
where `{AccessKey}` is an AccessKey which should be obtained from [Picovoice Console](https://console.picovoice.ai/).
After processing audio files, you are asked for a search phrase:
```console
Enter search phrase (Ctrl+c to exit):
```
The search phrase can have several words separated by space, but each word should only consist of alphabetic characters. As shown in the prompt above, press `Ctrl` and `C` keys at the same time to exit the program.
Raw data
{
"_id": null,
"home_page": "https://github.com/Picovoice/octopus",
"name": "pvoctopusdemo",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.5",
"maintainer_email": "",
"keywords": "Speech-to-Index,Voice Search,Keyword Spotting,Speech Recognition,Voice Recognition",
"author": "Picovoice",
"author_email": "hello@picovoice.ai",
"download_url": "https://files.pythonhosted.org/packages/ef/5b/3a6d85123b83bfcd21e9cc9c96f25436552bfa2fefaf9b6c51043cdacd0a/pvoctopusdemo-2.0.0.tar.gz",
"platform": null,
"description": "# Octopus Speech-to-Index engine\n\nMade in Vancouver, Canada by [Picovoice](https://picovoice.ai)\n\nThis package contains commandline program for indexing and searching inside audio files using Octopus Speech-to-Index engine.\n\n## Octopus\n\nOctopus is Picovoice's Speech-to-Index engine. It directly indexes speech without relying on a text representation.\n\n## Compatibility\n\n- Python 3\n- Runs on Linux (x86_64), macOS (x86_64, arm64), Windows (x86_64).\n\n## AccessKey\n\nOctopus requires a valid Picovoice `AccessKey` at initialization. `AccessKey` acts as your credentials when using Octopus SDKs.\nYou can get your `AccessKey` for free. Make sure to keep your `AccessKey` secret.\nSignup or Login to [Picovoice Console](https://console.picovoice.ai/) to get your `AccessKey`.\n\n## Installation\n\n```console\nsudo pip3 install pvoctopusdemo\n```\n\n## Usage\n\nThis demo allows testing Octopus interactively through commandline. It accepts MP3, WAV, FLAC, and OPUS audio files with sample rates higher than 16kHz. The following command processes all files in the space-separated `{AUDIO_PATHS}` list:\n\n```console\noctopus_demo --access_key {AccessKey} --audio_paths ${AUDIO_PATHS}\n```\nwhere `{AccessKey}` is an AccessKey which should be obtained from [Picovoice Console](https://console.picovoice.ai/).\n\nAfter processing audio files, you are asked for a search phrase:\n\n```console\nEnter search phrase (Ctrl+c to exit):\n```\n\nThe search phrase can have several words separated by space, but each word should only consist of alphabetic characters. As shown in the prompt above, press `Ctrl` and `C` keys at the same time to exit the program.\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Octopus Speech-to-Index engine demo.",
"version": "2.0.0",
"project_urls": {
"Homepage": "https://github.com/Picovoice/octopus"
},
"split_keywords": [
"speech-to-index",
"voice search",
"keyword spotting",
"speech recognition",
"voice recognition"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3296ba4307eba38541884b79bab353c829a0cae1b21ee111389b82593586c552",
"md5": "2de9bbea455a0372909fa232ec2d43c8",
"sha256": "14ffc5cae4af62c59c0ee340d8d1eb6e46dca6cf5191d301795c4cbb4c9c5288"
},
"downloads": -1,
"filename": "pvoctopusdemo-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2de9bbea455a0372909fa232ec2d43c8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.5",
"size": 8131,
"upload_time": "2023-11-30T19:14:56",
"upload_time_iso_8601": "2023-11-30T19:14:56.245025Z",
"url": "https://files.pythonhosted.org/packages/32/96/ba4307eba38541884b79bab353c829a0cae1b21ee111389b82593586c552/pvoctopusdemo-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ef5b3a6d85123b83bfcd21e9cc9c96f25436552bfa2fefaf9b6c51043cdacd0a",
"md5": "95fed1337e2cecfc7663f0f4e13b246c",
"sha256": "fd5e868151eb2c46bf6833ae1e627c8a0b55a627a314c701754bf033c70cad82"
},
"downloads": -1,
"filename": "pvoctopusdemo-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "95fed1337e2cecfc7663f0f4e13b246c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5",
"size": 7809,
"upload_time": "2023-11-30T19:14:58",
"upload_time_iso_8601": "2023-11-30T19:14:58.115006Z",
"url": "https://files.pythonhosted.org/packages/ef/5b/3a6d85123b83bfcd21e9cc9c96f25436552bfa2fefaf9b6c51043cdacd0a/pvoctopusdemo-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-30 19:14:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Picovoice",
"github_project": "octopus",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pvoctopusdemo"
}
JSON
