Back to Content

SpeechRecognition: phrases property

files/en-us/web/api/speechrecognition/phrases/index.md

latest2.0 KB
Original Source

{{APIRef("Web Speech API")}}{{SeeCompatTable}}

The phrases property of the {{domxref("SpeechRecognition")}} interface sets an array of {{domxref("SpeechRecognitionPhrase")}} objects to be used for contextual biasing.

Value

An ObservableArray of {{domxref("SpeechRecognitionPhrase")}} objects.

Examples

Basic usage

The following code first creates an array containing the phrases to boost and their {{domxref("SpeechRecognitionPhrase.boost", "boost")}} values. We convert this data to an ObservableArray of SpeechRecognitionPhrase objects by mapping the original array to {{domxref("SpeechRecognitionPhrase.SpeechRecognitionPhrase", "SpeechRecognitionPhrase()")}} constructor calls:

js
const phraseData = [
  { phrase: "azure", boost: 5.0 },
  { phrase: "khaki", boost: 3.0 },
  { phrase: "tan", boost: 2.0 },
];

const phraseObjects = phraseData.map(
  (p) => new SpeechRecognitionPhrase(p.phrase, p.boost),
);

After creating a {{domxref("SpeechRecognition")}} instance, we then plug our contextual biasing phrases into it by setting the phraseObjects array as the value of the SpeechRecognition.phrases property:

js
const recognition = new SpeechRecognition();
recognition.continuous = false;
recognition.lang = "en-US";
recognition.interimResults = false;
recognition.processLocally = true;
recognition.phrases = phraseObjects;

// …

This code is excerpted from our on-device speech color changer (run the demo live). See Using the Web Speech API for a full explanation.

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also