Octopus Speech-to-Index
Web Quick Start

Platforms

• Chrome & Chromium-based browsers
• Edge
• Firefox
• Safari

Requirements

• Picovoice Account and AccessKey
• Node.js 16+
• npm

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 Node.js.

2. Install the Octopus Speech-to-Index Web package:

npm install @picovoice/octopus-web

Usage

Download the model from GitHub.

Put the model file in the project's public directory or generate a base64 model using the build in script:

npx pvbase64 -i ${OCTOPUS_PARAMS_PATH} -o ${OUTPUT_FILE_PATH}

Create an Octopus Speech-to-Index instance using a base64 model or a model hosted in a public directory:

import { OctopusWorker } from "@picovoice/octopus-web";
import octopusParams from "${PATH_TO_BASE64_OCTOPUS_PARAMS}";

const octopus = await OctopusWorker.create(
  "${ACCESS_KEY}",
  {
    base64: octopusParams,
    // or
    publicPath: "${MODEL_RELATIVE_PATH}"
  },
);

Index raw audio data (sample rate of 16 kHz, 16-bit linearly encoded and 1 channel):

function getAudioData(): Int16Array {
  // get audio
  return new Int16Array();
}

const octopusMetadata = await octopus.index(getAudioData());

Search for instances of a phrase:

const result = await octopus.search(octopusMetadata, "${SEARCH_PHRASE}");

Release resources explicitly when done with Octopus Speech-to-Index:

await octopus.release();

Demo

For the Octopus Speech-to-Index Web SDK, there is a Web demo project available on the Octopus Speech-to-Index GitHub repository.

Setup

Clone the Octopus Speech-to-Index repository from GitHub:

git clone --recurse-submodules https://github.com/Picovoice/octopus.git

Usage

1. Install dependencies and run:

cd octopus/demo/web
npm install
npm run start

2. Open http://localhost:5000 to view it in the browser.

Resources