git.basschouten.com Git - openhab-addons.git/blob

   1 /**
   2  * Copyright (c) 2010-2023 Contributors to the openHAB project
   3  *
   4  * See the NOTICE file(s) distributed with this work for additional
   5  * information.
   6  *
   7  * This program and the accompanying materials are made available under the
   8  * terms of the Eclipse Public License 2.0 which is available at
   9  * http://www.eclipse.org/legal/epl-2.0
  10  *
  11  * SPDX-License-Identifier: EPL-2.0
  12  */
  13 package org.openhab.voice.watsonstt.internal;
  14
  15 import org.eclipse.jdt.annotation.NonNullByDefault;
  16
  17 /**
  18  * The {@link WatsonSTTConfiguration} class contains fields mapping thing configuration parameters.
  19  *
  20  * @author Miguel Álvarez - Initial contribution
  21  */
  22 @NonNullByDefault
  23 public class WatsonSTTConfiguration {
  24
  25     /**
  26      * Api key for Speech-to-Text instance created on IBM Cloud.
  27      */
  28     public String apiKey = "";
  29     /**
  30      * Url for Speech-to-Text instance created on IBM Cloud.
  31      */
  32     public String instanceUrl = "";
  33     /**
  34      * Prefer multimedia to telephony models. Multimedia models are intended for audio that has a minimum sampling rate
  35      * of 16 kHz, while telephony models are intended for audio that has a minimum sampling rate of 8 kHz.
  36      */
  37     public boolean preferMultimediaModel = true;
  38     /**
  39      * Use the parameter to suppress side conversations or background noise.
  40      */
  41     public float backgroundAudioSuppression = 0f;
  42     /**
  43      * Use the parameter to suppress word insertions from music, coughing, and other non-speech events.
  44      */
  45     public float speechDetectorSensitivity = 0.5f;
  46     /**
  47      * If true, the service converts dates, times, series of digits and numbers, phone numbers, currency values, and
  48      * internet addresses into more readable.
  49      */
  50     public boolean smartFormatting = false;
  51     /**
  52      * If true, the service redacts, or masks, numeric data from final transcripts.
  53      */
  54     public boolean redaction = false;
  55     /**
  56      * Single phrase mode.
  57      */
  58     public boolean singleUtteranceMode = true;
  59     /**
  60      * max seconds without getting new transcriptions to stop listening.
  61      */
  62     public int maxSilenceSeconds = 3;
  63     /**
  64      * Message to be told when no results
  65      */
  66     public String noResultsMessage = "No results";
  67     /**
  68      * By default, all IBM Watson™ services log requests and their results. Logging is done only to improve the services
  69      * for future users. The logged data is not shared or made public.
  70      */
  71     public boolean optOutLogging = true;
  72 }