Made in Vancouver, Canada by Picovoice
Octopus is Picovoice's Speech-to-Index engine. It directly indexes speech without relying on a text representation. This acoustic-only approach boosts accuracy by removing out-of-vocabulary limitation and eliminating the problem of competing hypothesis (e.g. homophones).
- English, French, German, Italian, Japanese, Korean, Portuguese, and Spanish.
- Support for additional languages is available for commercial customers on a case-by-case basis.
Install the demo package:
sudo pip3 install pvoctopusdemoRun the following in the terminal:
octopus_demo --access_key {AccessKey} --audio_paths ${AUDIO_PATHS}Replace ${AccessKey} with your AccessKey obtained from Picovoice Console and ${AUDIO_PATHS} with a space-separated list of audio files.
Octopus starts processing the audio files and asks you for search phrases and shows results interactively.
For more information about the Python demos go to demo/python.
Build the demo:
cmake -S demo/c/ -B demo/c/build && cmake --build demo/c/buildIndex a given audio file:
./demo/c/build/octopus_index_demo ${LIBRARY_PATH} ${ACCESS_KEY} ${AUDIO_PATH} ${INDEX_PATH}Then search the index for a given phrase:
./demo/c/build/octopus_search_demo ${LIBRARY_PATH} ${MODEL_PATH} ${ACCESS_KEY} ${INDEX_PATH} ${SEARCH_PHRASE}Replace ${LIBRARY_PATH} with path to appropriate library available under lib, ${ACCESS_KEY} with
AccessKey obtained from Picovoice Console, ${AUDIO_PATH} with the path to a given
audio file and format, ${INDEX_PATH} with the path to cached index file and ${SEARCH_PHRASE} to a search phrase.
For more information about C demos go to demo/c.
Using Android Studio, open demo/android/OctopusDemo as an Android project.
Replace "${YOUR_ACCESS_KEY_HERE}" inside MainActivity.java
with your AccessKey obtained from Picovoice Console. Then run the demo.
For more information about Android demos go to demo/android.
From the demo/ios/OctopusDemo, run the following to install the Octopus CocoaPod:
pod installReplace "{YOUR_ACCESS_KEY_HERE}" inside ViewModel.swift with your
AccessKey obtained from Picovoice Console. Then, using Xcode,
open the generated OctopusDemo.xcworkspace and run the application.
For more information about iOS demos go to demo/ios.
From demo/web run the following in the terminal:
yarn
yarn start(or)
npm install
npm run startOpen http://localhost:5000 in your browser to try the demo.
Create an instance of the engine:
import pvoctopus
# AccessKey obtained from Picovoice Console (https://console.picovoice.ai/)
access_key = "${ACCESS_KEY}"
handle = pvoctopus.create(access_key=access_key)Index your raw audio data or file:
import pvoctopus
# AccessKey obtained from Picovoice Console (https://console.picovoice.ai/)
access_key = "${ACCESS_KEY}"
handle = pvoctopus.create(access_key=access_key)
audio_data = [...]
metadata = handle.index_audio_data(audio_data)
# or
audio_file_path = "/path/to/my/audiofile.wav"
metadata = handle.index_audio_file(audio_file_path)
# Then search the metadata for phrases
matches = handle.search(metadata, phrases=['avocado'])
avocado_matches = matches['avocado']
for match in avocado_matches:
print(f"Match for `avocado`: {match.start_sec} -> {match.end_sec} ({match.probability})")When done the handle resources have to be released explicitly handle.delete().
pv_octopus.h header file contains relevant information. Build an instance of the object:
const char *model_path = "..."; // absolute path to the model file available at `lib/common/octopus_params.pv`
const char *access_key = "..." // AccessKey provided by Picovoice Console (https://console.picovoice.ai/)
pv_octopus_t *handle = NULL;
pv_status_t status = pv_octopus_init(access_key, model_path, &handle);
if (status != PV_STATUS_SUCCESS) {
// error handling logic
}Index audio data using constructed object:
const char *audio_path = "..."; // absolute path to the audio file to be indexed
void *indices = NULL;
int32_t num_indices_bytes = 0;
pv_status_t status = pv_octopus_index_file(handle, audio_path, &indices, &num_indices_bytes);
if (status != PV_STATUS_SUCCESS) {
// error handling logic
}Search the indexed data:
const char *phrase = "...";
pv_octopus_match_t *matches = NULL;
int32_t num_matches = 0;
pv_status_t status = pv_octopus_search(handle, indices, num_indices_bytes, phrase, &matches, &num_matches);
if (status != PV_STATUS_SUCCESS) {
// error handling logic
}When done be sure to release the acquired resources:
pv_octopus_delete(handle);Create an instance of the engine:
import ai.picovoice.octopus.*;
final String accessKey = "..."; // AccessKey provided by Picovoice Console (https://console.picovoice.ai/)
try {
Octopus handle = new Octopus.Builder().setAccessKey(accessKey).build(appContext);
} catch (OctopusException ex) { }Index audio data using constructed object:
final String audioFilePath = "/path/to/my/audiofile.wav"
try {
OctopusMetadata metadata = handle.indexAudioFile(audioFilePath);
} catch (OctopusException ex) { }Search the indexed data:
HashMap <String, OctopusMatch[]> matches = handle.search(metadata, phrases);
for (Map.Entry<String, OctopusMatch[]> entry : map.entrySet()) {
final String phrase = entry.getKey();
for (OctopusMatch phraseMatch : entry.getValue()){
final float startSec = phraseMatch.getStartSec();
final float endSec = phraseMatch.getEndSec();
final float probability = phraseMatch.getProbability();
}
}When done be sure to release the acquired resources:
metadata.delete();
handle.delete();Create an instance of the engine:
import Octopus
let accessKey : String = // .. AccessKey provided by Picovoice Console (https://console.picovoice.ai/)
do {
let handle = try Octopus(accessKey: accessKey)
} catch { }Index audio data using constructed object:
let audioFilePath = "/path/to/my/audiofile.wav"
do {
let metadata = try handle.indexAudioFile(path: audioFilePath)
} catch { }Search the indexed data:
let matches: Dictionary<String, [OctopusMatch]> = try octopus.search(metadata: metadata, phrases: phrases)
for (phrase, phraseMatches) in matches {
for phraseMatch in phraseMatches {
var startSec = phraseMatch.startSec;
var endSec = phraseMatch.endSec;
var probability = phraseMatch.probability;
}
}When done be sure to release the acquired resources:
handle.delete();Install the web SDK using yarn:
yarn add @picovoice/octopus-webor using npm:
npm install --save @picovoice/octopus-webCreate an instance of the engine using OctopusWorker and transcribe an audio file:
import { Octopus } from "@picovoice/octopus-web";
import octopusParams from "${PATH_TO_BASE64_OCTOPUS_PARAMS}";
function getAudioData(): Int16Array {
... // function to get audio data
return new Int16Array();
}
const octopus = await OctopusWorker.create(
"${ACCESS_KEY}",
{ base64: octopusParams }
);
const octopusMetadata = await octopus.index(getAudioData());
const searchResult = await octopus.search(octopusMetadata, "${SEARCH_PHRASE}");
console.log(searchResult);Replace ${ACCESS_KEY} with yours obtained from Picovoice Console. Finally, when done release the resources using octopus.release().
- Improvements to error reporting
- Upgrades to authorization and authentication system
- Various bug fixes and improvements
- Web min support bumped to Node 16
- iOS support bumped to iOS 13
- Added language support for French, German, Spanish, Japanese, Korean, Italian, and Portuguese.
- Improved testing infrastructure
- Various bug fixes and improvements
- Initial release