Skip to content

Commit 25244d3

Browse files
authored
doc update
1 parent 63ec4ee commit 25244d3

File tree

87 files changed

+290
-426
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

87 files changed

+290
-426
lines changed

README.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ spoken command:
5252
- Android and iOS
5353
- Chrome, Safari, Firefox, and Edge
5454
- Linux (x86_64), macOS (x86_64, arm64), and Windows (x86_64)
55-
- **Self-Service:** Design, train, and test voice interfaces instantly in your browser, using [Picovoice Console](https://picovoice.ai/console/).
55+
- **Self-Service:** Design, train, and test voice interfaces instantly in your browser, using [Picovoice Console](https://console.picovoice.ai/).
5656
- **Reliable:** Runs locally without needing continuous connectivity.
5757
- **Zero Latency:** Edge-first architecture eliminates unpredictable network delay.
5858

@@ -62,7 +62,7 @@ spoken command:
6262
pre-trained speech models. The SDK is licensed under Apache 2.0 and available on GitHub to encourage independent
6363
benchmarking and integration testing. You are empowered to make a data-driven decision.
6464

65-
2. **Design:** [Picovoice Console](https://picovoice.ai/console/) is a cloud-based platform for designing voice
65+
2. **Design:** [Picovoice Console](https://console.picovoice.ai/) is a cloud-based platform for designing voice
6666
interfaces and training speech models, all within your web browser. No machine learning skills are required. Simply
6767
describe what you need with text and export trained models.
6868

@@ -165,7 +165,7 @@ alternatives with wide margins.
165165

166166
## Picovoice Console
167167

168-
[Picovoice Console](https://picovoice.ai/console/) is a web-based platform for designing, testing, and training voice
168+
[Picovoice Console](https://console.picovoice.ai/) is a web-based platform for designing, testing, and training voice
169169
user interfaces. Using Picovoice Console you can train custom wake word, and domain-specific NLU (Speech-to-Intent)
170170
models.
171171

@@ -673,7 +673,7 @@ Create a new instance of Picovoice:
673673
```python
674674
from picovoice import Picovoice
675675

676-
access_key = "${ACCESS_KEY}" # AccessKey obtained from Picovoice Console (https://picovoice.ai/console/)
676+
access_key = "${ACCESS_KEY}" # AccessKey obtained from Picovoice Console (https://console.picovoice.ai/)
677677

678678
keyword_path = ...
679679

@@ -853,7 +853,7 @@ import ai.picovoice.picovoice.*;
853853

854854
String keywordPath = "/absolute/path/to/keyword.ppn"
855855

856-
final String accessKey = "${ACCESS_KEY}"; // AccessKey obtained from [Picovoice Console](https://picovoice.ai/console/)
856+
final String accessKey = "${ACCESS_KEY}"; // AccessKey obtained from [Picovoice Console](https://console.picovoice.ai/)
857857

858858
PicovoiceWakeWordCallback wakeWordCallback = () -> {..};
859859

@@ -1090,7 +1090,7 @@ The static constructor `PicovoiceManager.create` will create an instance of a Pi
10901090
import 'package:picovoice/picovoice_manager.dart';
10911091
import 'package:picovoice/picovoice_error.dart';
10921092

1093-
String accessKey = "{ACCESS_KEY}"; // AccessKey obtained from Picovoice Console (https://picovoice.ai/console/)
1093+
String accessKey = "{ACCESS_KEY}"; // AccessKey obtained from Picovoice Console (https://console.picovoice.ai/)
10941094
10951095
void createPicovoiceManager() {
10961096
_picovoiceManager = PicovoiceManager.create(
@@ -1131,7 +1131,7 @@ who want to incorporate it into an already existing audio processing pipeline.
11311131
import 'package:picovoice/picovoice_manager.dart';
11321132
import 'package:picovoice/picovoice_error.dart';
11331133

1134-
String accessKey = "{ACCESS_KEY}"; // AccessKey obtained from Picovoice Console (https://picovoice.ai/console/)
1134+
String accessKey = "{ACCESS_KEY}"; // AccessKey obtained from Picovoice Console (https://console.picovoice.ai/)
11351135
11361136
void createPicovoice() async {
11371137
double porcupineSensitivity = 0.7;
@@ -1188,7 +1188,7 @@ audio recording. This class is the quickest way to get started.
11881188

11891189
The static constructor `PicovoiceManager.create` will create an instance of a PicovoiceManager using a Porcupine keyword file and Rhino context file that you pass to it.
11901190
```javascript
1191-
const accessKey = "${ACCESS_KEY}" // obtained from Picovoice Console (https://picovoice.ai/console/)
1191+
const accessKey = "${ACCESS_KEY}" // obtained from Picovoice Console (https://console.picovoice.ai/)
11921192
11931193
this._picovoiceManager = PicovoiceManager.create(
11941194
accessKey,
@@ -1221,7 +1221,7 @@ who want to incorporate it into an already existing audio processing pipeline.
12211221
`Picovoice` is created by passing a Porcupine keyword file and Rhino context file to the `create` static constructor. Sensitivity and model files are optional.
12221222

12231223
```javascript
1224-
const accessKey = "${ACCESS_KEY}" // obtained from Picovoice Console (https://picovoice.ai/console/)
1224+
const accessKey = "${ACCESS_KEY}" // obtained from Picovoice Console (https://console.picovoice.ai/)
12251225
12261226
async createPicovoice(){
12271227
let porcupineSensitivity = 0.7
@@ -1389,7 +1389,7 @@ intent inference. The class can be initialized as below:
13891389
```swift
13901390
import Picovoice
13911391

1392-
let accessKey = "${ACCESS_KEY}" // obtained from Picovoice Console (https://picovoice.ai/console/)
1392+
let accessKey = "${ACCESS_KEY}" // obtained from Picovoice Console (https://console.picovoice.ai/)
13931393
13941394
let manager = PicovoiceManager(
13951395
accessKey: accessKey,
@@ -1415,7 +1415,7 @@ o construct an instance, you'll need to provide a Porcupine keyword file (.ppn),
14151415
```swift
14161416
import Picovoice
14171417

1418-
let accessKey = "${ACCESS_KEY}" // obtained from Picovoice Console (https://picovoice.ai/console/)
1418+
let accessKey = "${ACCESS_KEY}" // obtained from Picovoice Console (https://console.picovoice.ai/)
14191419
14201420
do {
14211421
let picovoice = try Picovoice(
@@ -1632,7 +1632,7 @@ import { PicovoiceService } from "@picovoice/picovoice-web-angular"
16321632
try {
16331633
await this.picovoiceService.init(pvFactoryEn,
16341634
{
1635-
// AccessKey obtained from Picovoice Console (https://picovoice.ai/console/)
1635+
// AccessKey obtained from Picovoice Console (https://console.picovoice.ai/)
16361636
accessKey: "${ACCESS_KEY}",
16371637
// Built-in wake word
16381638
porcupineKeyword: {builtin: "Hey Google", sensitivity: 0.6},
@@ -1699,7 +1699,7 @@ export default function VoiceWidget() {
16991699
} = usePicovoice(
17001700
PicovoiceWorkerFactory,
17011701
{
1702-
accessKey: "${ACCESS_KEY}", // AccessKey obtained from Picovoice Console (https://picovoice.ai/console/)
1702+
accessKey: "${ACCESS_KEY}", // AccessKey obtained from Picovoice Console (https://console.picovoice.ai/)
17031703
// "Picovoice" is one of the builtin wake words, so we merely need to ask for it by name.
17041704
// To use a custom wake word, you supply the `.ppn` files in base64 and provide a label for it.
17051705
porcupineKeyword: "Picovoice",
@@ -1756,7 +1756,7 @@ export default {
17561756
isTalking: false,
17571757
factory: PicovoiceWorkerFactoryEn,
17581758
factoryArgs: {
1759-
accessKey: '${ACCESS_KEY}', // AccessKey obtained from Picovoice Console (https://picovoice.ai/console/)
1759+
accessKey: '${ACCESS_KEY}', // AccessKey obtained from Picovoice Console (https://console.picovoice.ai/)
17601760
porcupineKeyword: { builtin: 'Picovoice', sensitivity: 0.6 },
17611761
rhinoContext: {
17621762
base64: 'RHINO_TRAINED_CONTEXT_BASE_64_STRING'
@@ -1863,7 +1863,7 @@ loop {
18631863
Picovoice is implemented in ANSI C and therefore can be directly linked to C applications. Its public header file ([sdk/include/pv_picovoice.h](sdk/include/pv_picovoice.h)) contains relevant information. An instance of the Picovoice object can be constructed as follows.
18641864

18651865
```c
1866-
const char* ACCESS_KEY = "${ACCESS_KEY}"; // AccessKey string obtained from [Picovoice Console](https://picovoice.ai/console/)
1866+
const char* ACCESS_KEY = "${ACCESS_KEY}"; // AccessKey string obtained from [Picovoice Console](https://console.picovoice.ai/)
18671867
18681868
const char *pocupine_model_path = ... // Available at resources/porcupine/lib/common/porcupine_params.pv
18691869
const char *keyword_path = ...

demo/android/Activity/picovoice-activity-demo-app/src/main/java/ai/picovoice/picovoicedemo/MainActivity.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
import ai.picovoice.rhino.RhinoInference;
3939

4040
public class MainActivity extends AppCompatActivity {
41-
private final String ACCESS_KEY = "${YOUR_ACCESS_KEY_HERE}"; // AccessKey obtained from Picovoice Console (https://picovoice.ai/console/)
41+
private final String ACCESS_KEY = "${YOUR_ACCESS_KEY_HERE}"; // AccessKey obtained from Picovoice Console (https://console.picovoice.ai/)
4242

4343
private PicovoiceManager picovoiceManager;
4444
private TextView intentTextView;

demo/android/README.md

+3-6
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,9 @@
22

33
## AccessKey
44

5-
All demos require a valid Picovoice `AccessKey` at initialization. `AccessKey`s act as your credentials when using Picovoice SDKs.
6-
You can create your `AccessKey` for free. Make sure to keep your `AccessKey` secret.
7-
8-
To obtain your `AccessKey`:
9-
1. Login or Signup for a free account on the [Picovoice Console](https://picovoice.ai/console/).
10-
2. Once logged in, go to the [`AccessKey` tab](https://console.picovoice.ai/access_key) to create one or use an existing `AccessKey`.
5+
Picovoice requires a valid Picovoice `AccessKey` at initialization. `AccessKey` acts as your credentials when using Picovoice SDKs.
6+
You can get your `AccessKey` for free. Make sure to keep your `AccessKey` secret.
7+
Signup or Login to [Picovoice Console](https://console.picovoice.ai/) to get your `AccessKey`.
118

129
## Activity
1310

demo/android/Service/picovoice-service-demo-app/src/main/java/ai/picovoice/picovoicedemoservice/PicovoiceService.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
import ai.picovoice.picovoice.*;
3232

3333
public class PicovoiceService extends Service {
34-
private final String ACCESS_KEY = "${YOUR_ACCESS_KEY_HERE}"; // AccessKey obtained from Picovoice Console (https://picovoice.ai/console/)
34+
private final String ACCESS_KEY = "${YOUR_ACCESS_KEY_HERE}"; // AccessKey obtained from Picovoice Console (https://console.picovoice.ai/)
3535

3636
private static final String CHANNEL_ID = "PicovoiceServiceChannel";
3737

demo/angular/README.md

+4-7
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,9 @@ This project was generated with [Angular CLI](https://github.com/angular/angular
1212

1313
## AccessKey
1414

15-
The Picovoice SDK requires a valid `AccessKey` at initialization. `AccessKey`s act as your credentials when using Picovoice SDKs.
16-
You can create your `AccessKey` for free. Make sure to keep your `AccessKey` secret.
17-
18-
To obtain your `AccessKey`:
19-
1. Login or Signup for a free account on the [Picovoice Console](https://picovoice.ai/console/).
20-
2. Once logged in, go to the [`AccessKey` tab](https://console.picovoice.ai/access_key) to create one or use an existing `AccessKey`.
15+
Picovoice requires a valid Picovoice `AccessKey` at initialization. `AccessKey` acts as your credentials when using Picovoice SDKs.
16+
You can get your `AccessKey` for free. Make sure to keep your `AccessKey` secret.
17+
Signup or Login to [Picovoice Console](https://console.picovoice.ai/) to get your `AccessKey`.
2118

2219
## Install and run
2320

@@ -71,7 +68,7 @@ Try a phrase that is out-of-context:
7168

7269
This command falls outside the domain of "Alarm Clock" and is therefore not understood.
7370

74-
The Alarm Clock was trained to understand a particular set of expressions. These are built using a simple grammar and grouped together into a YAML file. This file is trained by [Picovoice Console](https://picovoice.ai/console/) to create a `.rhn` file for the WebAssembly (WASM) platform.
71+
The Alarm Clock was trained to understand a particular set of expressions. These are built using a simple grammar and grouped together into a YAML file. This file is trained by [Picovoice Console](https://console.picovoice.ai/) to create a `.rhn` file for the WebAssembly (WASM) platform.
7572

7673
```yaml
7774
context:

demo/c/README.md

+3-8
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,9 @@ You need a C99-compatible compiler to build these demos.
1010

1111
## AccessKey
1212

13-
Picovoice requires a valid `AccessKey` at initialization. `AccessKey`s act as your credentials when using Picovoice SDKs.
14-
You can create your `AccessKey` for free. Make sure to keep your `AccessKey` secret.
15-
16-
To obtain your `AccessKey`:
17-
1. Login or Signup for a free account on the [Picovoice Console](https://picovoice.ai/console/).
18-
2. Once logged in, go to the [`AccessKey` tab](https://console.picovoice.ai/access_key) to create one or use an existing `AccessKey`.
19-
20-
# Microphone Demo
13+
Picovoice requires a valid Picovoice `AccessKey` at initialization. `AccessKey` acts as your credentials when using Picovoice SDKs.
14+
You can get your `AccessKey` for free. Make sure to keep your `AccessKey` secret.
15+
Signup or Login to [Picovoice Console](https://console.picovoice.ai/) to get your `AccessKey`.
2116

2217
## Build
2318

demo/dotnet/README.md

+3-6
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,9 @@ dotnet build -c FileDemo.Release
4444

4545
## AccessKey
4646

47-
Picovoice requires a valid `AccessKey` at initialization. `AccessKey`s act as your credentials when using Picovoice SDKs.
48-
You can create your `AccessKey` for free. Make sure to keep your `AccessKey` secret.
49-
50-
To obtain your `AccessKey`:
51-
1. Login or Signup for a free account on the [Picovoice Console](https://picovoice.ai/console/).
52-
2. Once logged in, go to the [`AccessKey` tab](https://console.picovoice.ai/access_key) to create one or use an existing `AccessKey`.
47+
Picovoice requires a valid Picovoice `AccessKey` at initialization. `AccessKey` acts as your credentials when using Picovoice SDKs.
48+
You can get your `AccessKey` for free. Make sure to keep your `AccessKey` secret.
49+
Signup or Login to [Picovoice Console](https://console.picovoice.ai/) to get your `AccessKey`.
5350

5451
## Usage
5552

demo/electron/src/components/VoiceTimer.vue

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<h3>
1515
<label>
1616
AccessKey obtained from
17-
<a href="https://picovoice.ai/console/">Picovoice Console</a>:
17+
<a href="https://console.picovoice.ai/">Picovoice Console</a>:
1818
<input
1919
type="text"
2020
name="accessKey"

demo/flutter-clock/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ All demos require a valid Picovoice `AccessKey` at initialization. `AccessKey`s
1010
You can create your `AccessKey` for free. Make sure to keep your `AccessKey` secret.
1111

1212
To obtain your `AccessKey`:
13-
1. Login or Signup for a free account on the [Picovoice Console](https://picovoice.ai/console/).
13+
1. Login or Signup for a free account on the [Picovoice Console](https://console.picovoice.ai/).
1414
2. Once logged in, go to the [`AccessKey` tab](https://console.picovoice.ai/access_key) to create one or use an existing `AccessKey`.
1515

1616
Once you obtain your `AccessKey`, replace it in [lib/main.dart](lib/main.dart) file:
1717

1818
```dart
19-
final String accessKey = "{YOUR_ACCESS_KEY_HERE}"; // AccessKey obtained from Picovoice Console (https://picovoice.ai/console/)
19+
final String accessKey = "{YOUR_ACCESS_KEY_HERE}"; // AccessKey obtained from Picovoice Console (https://console.picovoice.ai/)
2020
```

demo/flutter-clock/lib/main.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ class MyHomePage extends StatefulWidget {
5454

5555
class _MyHomePageState extends State<MyHomePage> {
5656
final String accessKey =
57-
"{YOUR_ACCESS_KEY_HERE}"; // AccessKey obtained from Picovoice Console (https://picovoice.ai/console/)
57+
"{YOUR_ACCESS_KEY_HERE}"; // AccessKey obtained from Picovoice Console (https://console.picovoice.ai/)
5858

5959
bool _isError = false;
6060
String _errorMessage = "";

demo/flutter/README.md

+6-9
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,18 @@ To run the Picovoice demo on Android or iOS with Flutter, you must have the [Flu
44

55
## AccessKey
66

7-
All demos require a valid Picovoice `AccessKey` at initialization. `AccessKey`s act as your credentials when using Picovoice SDKs.
8-
You can create your `AccessKey` for free. Make sure to keep your `AccessKey` secret.
7+
Picovoice requires a valid Picovoice `AccessKey` at initialization. `AccessKey` acts as your credentials when using Picovoice SDKs.
8+
You can get your `AccessKey` for free. Make sure to keep your `AccessKey` secret.
9+
Signup or Login to [Picovoice Console](https://console.picovoice.ai/) to get your `AccessKey`.
910

10-
To obtain your `AccessKey`:
11-
1. Login or Signup for a free account on the [Picovoice Console](https://picovoice.ai/console/).
12-
2. Once logged in, go to the [`AccessKey` tab](https://console.picovoice.ai/access_key) to create one or use an existing `AccessKey`.
11+
## Usage
1312

14-
Once you obtain your `AccessKey`, replace it in [lib/main.dart](lib/main.dart) file:
13+
Replace your `AccessKey` in [lib/main.dart](lib/main.dart) file:
1514

1615
```dart
17-
final String accessKey = "{YOUR_ACCESS_KEY_HERE}"; // AccessKey obtained from Picovoice Console (https://picovoice.ai/console/)
16+
final String accessKey = "{YOUR_ACCESS_KEY_HERE}"; // AccessKey obtained from Picovoice Console (https://console.picovoice.ai/)
1817
```
1918

20-
## Usage
21-
2219
Before launching the app, use the copy_assets.sh script to copy the Picovoice demo assets into the demo project. (**NOTE**: on Windows, Git Bash or another bash shell is required, or you will have to manually copy the context into the project.).
2320

2421
Run the following command from [demo/flutter](/demo/flutter) to build and deploy the demo to your device:

demo/flutter/lib/main.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ class MyApp extends StatefulWidget {
2828

2929
class _MyAppState extends State<MyApp> {
3030
final String accessKey =
31-
'{YOUR_ACCESS_KEY_HERE}'; // AccessKey obtained from Picovoice Console (https://picovoice.ai/console/)
31+
'{YOUR_ACCESS_KEY_HERE}'; // AccessKey obtained from Picovoice Console (https://console.picovoice.ai/)
3232

3333
final GlobalKey<ScaffoldState> _scaffoldKey = GlobalKey<ScaffoldState>();
3434

demo/go/README.md

+3-6
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,9 @@ This Go module contains demos for processing real-time audio (i.e. microphone) a
2222

2323
## AccessKey
2424

25-
Picovoice requires a valid `AccessKey` at initialization. `AccessKey`s act as your credentials when using Picovoice SDKs.
26-
You can create your `AccessKey` for free. Make sure to keep your `AccessKey` secret.
27-
28-
To obtain your `AccessKey`:
29-
1. Login or Signup for a free account on the [Picovoice Console](https://picovoice.ai/console/).
30-
2. Once logged in, go to the [`AccessKey` tab](https://console.picovoice.ai/access_key) to create one or use an existing `AccessKey`.
25+
Picovoice requires a valid Picovoice `AccessKey` at initialization. `AccessKey` acts as your credentials when using Picovoice SDKs.
26+
You can get your `AccessKey` for free. Make sure to keep your `AccessKey` secret.
27+
Signup or Login to [Picovoice Console](https://console.picovoice.ai/) to get your `AccessKey`.
3128

3229
## Usage
3330

demo/ios/README.md

+3-7
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,9 @@ The minimum iOS version required to run the demo is iOS 14.0 or higher.
44

55
## AccessKey
66

7-
Picovoice requires a valid `AccessKey` at initialization. `AccessKey`s act as your credentials when using Picovoice SDKs.
8-
You can create your `AccessKey` for free. Make sure to keep your `AccessKey` secret.
9-
10-
To obtain your `AccessKey`:
11-
1. Login or Signup for a free account on the [Picovoice Console](https://picovoice.ai/console/).
12-
2. Once logged in, go to the [`AccessKey` tab](https://console.picovoice.ai/access_key) to create one or use an existing `AccessKey`.
13-
7+
Picovoice requires a valid Picovoice `AccessKey` at initialization. `AccessKey` acts as your credentials when using Picovoice SDKs.
8+
You can get your `AccessKey` for free. Make sure to keep your `AccessKey` secret.
9+
Signup or Login to [Picovoice Console](https://console.picovoice.ai/) to get your `AccessKey`.
1410

1511
## BackgroundService Demo
1612

demo/java-swing/README.md

+3-6
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,9 @@ Before running the demo, run the `copy.sh` script to copy wake word and context
66

77
## AccessKey
88

9-
The Picovoice SDK requires a valid `AccessKey` at initialization. `AccessKey`s act as your credentials when using Picovoice SDKs.
10-
You can create your `AccessKey` for free. Make sure to keep your `AccessKey` secret.
11-
12-
To obtain your `AccessKey`:
13-
1. Login or Signup for a free account on the [Picovoice Console](https://picovoice.ai/console/).
14-
2. Once logged in, go to the [`AccessKey` tab](https://console.picovoice.ai/access_key) to create one or use an existing `AccessKey`.
9+
Picovoice requires a valid Picovoice `AccessKey` at initialization. `AccessKey` acts as your credentials when using Picovoice SDKs.
10+
You can get your `AccessKey` for free. Make sure to keep your `AccessKey` secret.
11+
Signup or Login to [Picovoice Console](https://console.picovoice.ai/) to get your `AccessKey`.
1512

1613
## Usage
1714

demo/java-swing/src/Main.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ private static Options BuildCommandLineOptions() {
228228
options.addOption(Option.builder("a")
229229
.longOpt("access_key")
230230
.hasArg(true)
231-
.desc("AccessKey obtained from Picovoice Console (https://picovoice.ai/console/).")
231+
.desc("AccessKey obtained from Picovoice Console (https://console.picovoice.ai/).")
232232
.build());
233233

234234
options.addOption(new Option("h", "help", false, ""));

0 commit comments

Comments
 (0)