Picovoice WordmarkPicovoice Console
Introduction
Introduction
AndroidC.NETFlutterlink to GoiOSJavaNvidia JetsonLinuxmacOSNodejsPythonRaspberry PiReact NativeRustWebWindows
AndroidC.NETFlutterlink to GoiOSJavaNodejsPythonReact NativeRustWeb
SummaryPicovoice LeopardAmazon TranscribeAzure Speech-to-TextGoogle ASRGoogle ASR (Enhanced)IBM Watson Speech-to-Text
FAQ
Introduction
AndroidC.NETFlutterlink to GoiOSJavaNodejsPythonReact NativeRustWeb
AndroidC.NETFlutterlink to GoiOSJavaNodejsPythonReact NativeRustWeb
FAQ
Introduction
AndroidCiOSLinuxmacOSPythonWebWindows
AndroidCiOSPythonWeb
SummaryOctopus Speech-to-IndexGoogle Speech-to-TextMozilla DeepSpeech
FAQ
Introduction
AndroidAngularArduinoBeagleBoneCChrome.NETEdgeFirefoxFlutterlink to GoiOSJavaNvidia JetsonLinuxmacOSMicrocontrollerNodejsPythonRaspberry PiReactReact NativeRustSafariUnityVueWebWindows
AndroidAngularC.NETFlutterlink to GoiOSJavaMicrocontrollerNodejsPythonReactReact NativeRustUnityVueWeb
SummaryPorcupineSnowboyPocketSphinx
Wake Word TipsFAQ
Introduction
AndroidAngularBeagleBoneCChrome.NETEdgeFirefoxFlutterlink to GoiOSJavaNvidia JetsonlinuxmacOSNodejsPythonRaspberry PiReactReact NativeRustSafariUnityVueWebWindows
AndroidAngularC.NETFlutterlink to GoiOSJavaNodejsPythonReactReact NativeRustUnityVueWeb
SummaryPicovoice RhinoGoogle DialogflowAmazon LexIBM WatsonMicrosoft LUIS
Expression SyntaxFAQ
Introduction
AndroidBeagleboneCiOSNvidia JetsonLinuxmacOSPythonRaspberry PiRustWebWindows
AndroidCiOSPythonRustWeb
SummaryPicovoice CobraWebRTC VAD
FAQ
Introduction
AndroidAngularArduinoBeagleBoneC.NETFlutterlink to GoiOSJavaNvidia JetsonMicrocontrollerNodejsPythonRaspberry PiReactReact NativeRustUnityVueWeb
AndroidAngularCMicrocontroller.NETFlutterlink to GoiOSJavaNodejsPythonReactReact NativeRustUnityVueWeb
Picovoice SDK - FAQ
IntroductionSTM32F407G-DISC1 (Arm Cortex-M4)STM32F411E-DISCO (Arm Cortex-M4)STM32F769I-DISCO (Arm Cortex-M7)IMXRT1050-EVKB (Arm Cortex-M7)
FAQGlossary

Octopus Speech-to-Index
Python Quick Start


Platforms

  • Linux (x86_64)
  • macOS (x86_64, arm64)
  • Windows (x86_64)

Requirements

  • Picovoice Account & AccessKey
  • Python 3
  • PIP

Picovoice Account & AccessKey

Signup or Login to Picovoice Console to get your AccessKey. Make sure to keep your AccessKey secret.

Quick Start

Setup

  1. Install Python 3.

  2. Install the pvoctopus Python package using PIP:

pip3 install pvoctopus

Usage

Create an instance of the engine and index an audio file by passing in the absolute path to the file:

import pvoctopus
octopus = pvoctopus.create(access_key='${ACCESS_KEY}')
metadata = octopus.index_audio_file("${AUDIO_FILE_PATH}")

Search audio using the generated metadata object:

matches = octopus.search(["gorilla", "terminator"])

Free resources used by Octopus:

octopus.delete();

Non-English Languages

Use the corresponding model file (.pv), to index and search non-English data. The model files for all supported languages are available on the Octopus GitHub repository.

Pass in the model file using the model_path input argument to change the detection language:

octopus = pvoctopus.create(
access_key='${ACCESS_KEY}',
model_path='${MODEL_PATH}'
)

Demo

For the Octopus Python SDK, we offer demo applications that demonstrate how to use the Speech-to-Index engine on audio files.

Setup

Install the pvoctopusdemo Python package using PIP:

pip3 install pvoctopusdemo

This package installs command-line utilities for the Octopus Python demos.

Usage

Use the --help flag to see the usage options for the demo:

octopus_demo_file --help

Run the following command to transcribe an audio file:

octopus_demo_file --access_key ${ACCESS_KEY} \
--audio_paths ${AUDIO_PATH1} ${AUDIO_PATH2} ...

For more information on our Octopus demos for Python, head over to our GitHub repository.

Resources

Packages

  • pvoctopus on PyPI
  • pvoctopusdemo on PyPI

API

  • pvoctopus Python API Docs

GitHub

  • Octopus Python SDK on GitHub
  • Octopus Python demo on GitHub

Benchmark

  • Speech-to-Index Benchmark

Further Reading

  • Octopus: Picovoice's Voice Search Engine
  • OctoTube: Voice Search for YouTube

Was this doc helpful?

Issue with this doc?

Report a GitHub Issue
Octopus Speech-to-Index Python Quick Start
  • Platforms
  • Requirements
  • Picovoice Account & AccessKey
  • Quick Start
  • Setup
  • Usage
  • Non-English Languages
  • Demo
  • Setup
  • Usage
  • Resources
Platform
  • Leopard Speech-to-Text
  • Cheetah Streaming Speech-to-Text
  • Octopus Speech-to-Index
  • Porcupine Wake Word
  • Rhino Speech-to-Intent
  • Cobra Voice Activity Detection
Resources
  • Docs
  • Console
  • Blog
  • Demos
Sales
  • Pricing
  • Starter Tier
  • Enterprise
Company
  • Careers
Follow Picovoice
  • LinkedIn
  • GitHub
  • Twitter
  • Medium
  • YouTube
  • AngelList
Subscribe to our newsletter
Terms of Use
Privacy Policy
© 2019-2022 Picovoice Inc.