Zebra Translate
Web Quick Start

Platforms

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

Requirements

• Picovoice Account and AccessKey
• Node.js 18+
• 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 Zebra Translate Web package:

npm install @picovoice/zebra-web

Usage

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

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

Create a ZebraWorker instance using a base64 model or a model hosted in a public directory:

import { ZebraWorker } from "@picovoice/zebra-web"
import zebraParams from "${ZEBRA_PARAMS_BASE64_PATH}";

const zebra = await ZebraWorker.create(
  "${ACCESS_KEY}",
  {
    base64: zebraParams,
    // or
    publicPath: "${MODEL_RELATIVE_PATH}"
  }
);

Read more about how to select a model in the Translation Models section.

Translate Text:

const translation = await zebra.process("${TEXT_TO_TRANSLATE}");

Release resources explicitly when done with Zebra Translate:

await zebra.release()

Translation Models

Supported Zebra translation models are located in our GitHub repository. The selected model decides the source and target translation languages.

The format of the model follows:

zebra_params_${SOURCE}_${TARGET}.pv

Where ${SOURCE} is the language code of the source language and ${TARGET} is the language code of the target language for the translation.

Demo

For the Zebra Translate Web SDK, there is a Web demo project available on the Zebra Translate GitHub repository.

Setup

Clone the Zebra Translate repository from GitHub:

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

Usage

1. Install dependencies and run:

cd zebra/demo/web
npm install

2. Run the demo with the start script with two language codes to start a local web server hosting the demo of your choice (e.g. en -> English, fr -> French). To see a list of available language pairs, run start without a language code.

npm run start ${SOURCE} ${TARGET}

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

Resources