Dynamically configuring the Speech to Text service or Speech to Text Adapter

Speech to Text service

This example shows configuration that you can add to the node response in your Watson Assistant dialog tree. The settings are transparently passed as JSON properties to the Speech to Text service.

{
  "output": {
    "vgwAction": {
      "command": "vgwActSetSTTConfig",
      "parameters": {
  			"credentials": {
  		  	"url": "https://api.us-south.speech-to-text.watson.cloud.ibm.com/instances/{instance_id}",
  		  	"apikey": "{apikey}",
  		  	"tokenServiceProviderUrl": "https://iam.cloud.ibm.com/identity/token"
  			},
  			"config": {
  				"x-watson-learning-opt-out": true,
  				"model": "en-US_NarrowbandModel",
  				"profanity_filter": true,
  				"smart_formatting": true,
  				"customization_id": "81d3630-ba58-11e7-aa4b-41bcd3f6f24d",
  				"acoustic_customization_id": "e4766090-ba51-11e7-be33-99bd3ac8fa93"
  			},
  			"confidenceScoreThreshold": 0.7,
  			"echoSuppression": true,
  			"bargeInResume": true,
  			"connectionTimeout": 30,
  			"requestTimeout": 15
  		}
    }
  }
}

The parameters that you can set under the config and broadbandConfig JSON properties reflect the parameters that are made available by the Speech to Text WebSocket interface. The WebSocket API sends two types of parameters: query parameters, which are sent when Voice Gateway connects to the service, and message parameters, which are sent as JSON after the connection is established. For example, model and customization_id are query parameters, and smart_formatting is a WebSocket message parameter. For a full list of parameters, see the WebSockets API reference for Watson Speech to Text Service.

You can define the following query parameters for the Media Relay's connection to the Speech To Text service. Any other parameter that you define under config or broadbandConfig is passed through on the WebSocket message request.

• model
• customization_id
• acoustic_customization_id
• version - Version 1.0.0.4c and later
• x-watson-learning-opt-out

Note: The following parameters from the Speech to Text service can't be modified because they have fixed values that are used by the Media Relay.

• action
• content-type
• interim_results
• continuous
• inactivity_timeout

{
  "output": {
    "vgwAction": {
      "command": "vgwActSetSTTConfig",
      "parameters": {
  			"config": {
  				"model": "es-ES_NarrowbandModel",
  				"smart_formatting": true
  			}
  		}
    }
  }
}

Using updateMethod

You can use the updateMethod property in dynamic configuration to define how changes to the configuration are , by either replacing the configuration or merging new configuration properties, and specifying whether these changes occur for the duration of the call or one conversation turn.

{

  "output": {
    "text": "I can speak Spanish now",
    "vgwAction": {
      "command": "vgwActSetSTTConfig",
      "parameters": {
        "updateMethod": "mergeOnce",
        "config": {
          "recognizeBody": {
            "contentType": "application/sgrs",
            "body": "#ABNF 1.0 ISO-8859-1;\nlanguage en-US;\nmode voice;\nroot $pattern;\n$pattern = $alphanum <1-> ;\n$alphanum = $digit | $letter\n$digit = zero | one | two | three | four | five | six | seven | eight | nine;\n$letter = \\"A.\\" | \\"B.\\" | \\"C.\\" | \\"D.\\" | \\"E.\\" | \\"F.\\" | \\"G.\\" | \\"H.\\" | \\"I.\\" | \\"J.\\" | \\"K.\\" | \\"L.\\" | \\"M.\\" | \\"N.\\" | \\"O.\\" | \\"P.\\" | \\"Q.\\" | \\"R.\\"| \\"S.\\" | \\"T.\\" | \\"U.\\" |\\"V.\\" | \\"W.\\" | \\"X.\\" | \\"Y.\\" | \\"Z.\\" ;\n"
          }
        }
      }
    }
  }
}

Voice Gateway Speech to Text Adapter

The following example for Cloud Speech API shows configuration that you can add to the node response in your Watson Assistant dialog tree. The settings are transparently passed as JSON properties to the Cloud Speech API.

{
  "output": {
    "vgwAction": {
      "command": "vgwActSetSTTConfig",
      "parameters": {
        "config": {
          "languageCode": "es-ES",
          "profanityFilter": true,
          "maxAlternatives": 2,
          "speechContexts": [{
              "phrases": [ "Si", "Por supuesto", "Claro", "Si por favor"]
          }]
        },
        "thirdPartyCredentials": {
            "type": "service_account",
            "project_id": "my_google_project",
            "private_key_id": "d2f36f96cb0c58309a5eba101cef4af0663d9465",
            "private_key": "-----BEGIN PRIVATE ... \n-----END PRIVATE KEY-----\n",
            "client_email": "developer1@my_google_project.iam.gserviceaccount.com",
            "client_id": "100033083330209022330835",
            "auth_uri": "https://accounts.google.com/o/oauth2/auth",
            "token_uri": "https://accounts.google.com/o/oauth2/token",
            "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
            "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/developer1@my_google_project.iam.gserviceaccount.com"
        }
      }
    }
  }
}

The JSON properties define the values that will change. If a property isn't defined, the existing value is used.

Note: The following fields for RecognitionConfig in the Cloud Speech API can't be modified because they have fixed values that are used by the Speech To Text Adapter.

• encoding
• sample_rate_hertz

Deprecated: Configuring the Speech to Text service by defining state variables

In Version 1.0.0.2, configuring Watson speech service by defining state variables was deprecated in favor of the action tags described in the previous sections.

Important: Although the state variables continue to function, you can't define these deprecated state variables and the action tags within a node. Your Watson Assistant dialog can contain a mixture of action tags and deprecated state variables, but the JSON definition for each node can contain only one or the other.

{
	"context": {
		"vgwSTTConfigSettings": {
			"credentials": {
		  	"url": "https://api.us-south.speech-to-text.watson.cloud.ibm.com/instances/{instance_id}",
		  	"apikey": "{apikey}",
		  	"tokenServiceProviderUrl": "https://iam.cloud.ibm.com/identity/token"
			},
			"config": {
				"x-watson-learning-opt-out": true,
				"model": "en-US_NarrowbandModel",
				"profanity_filter": true,
				"smart_formatting": true
			},
			"confidenceScoreThreshold": 0.7
		}
	}
}