com.ibm.watson.developer_cloud.speech_to_text.v1.model

Class CreateSessionOptions

java.lang.Object

com.ibm.watson.developer_cloud.service.model.GenericModel

com.ibm.watson.developer_cloud.speech_to_text.v1.model.CreateSessionOptions

All Implemented Interfaces:

ObjectModel

public class CreateSessionOptions
extends GenericModel

The createSession options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateSessionOptions.Builder Builder.
static interface	CreateSessionOptions.Model The identifier of the model to be used by the new session.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	acousticCustomizationId() Gets the acousticCustomizationId.
java.lang.String	customizationId() Gets the customizationId.
java.lang.Double	customizationWeight() Gets the customizationWeight.
java.lang.String	model() Gets the model.
CreateSessionOptions.Builder	newBuilder() New builder.
java.lang.String	version() Gets the version.

Methods inherited from class com.ibm.watson.developer_cloud.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

newBuilder

public CreateSessionOptions.Builder newBuilder()

New builder.

Returns:

a CreateSessionOptions builder

model

public java.lang.String model()

Gets the model. The identifier of the model to be used by the new session. (Use `GET /v1/models` or `GET /v1/models/{model_id}` for information about available models.).

Returns:

the model

customizationId

public java.lang.String customizationId()

Gets the customizationId. The GUID of a custom language model that is to be used with the new session. The base model of the specified custom language model must match the model specified with the `model` parameter. You must make the request with service credentials created for the instance of the service that owns the custom model. By default, no custom language model is used.

Returns:

the customizationId

acousticCustomizationId

public java.lang.String acousticCustomizationId()

Gets the acousticCustomizationId. The GUID of a custom acoustic model that is to be used with the new session. The base model of the specified custom acoustic model must match the model specified with the `model` parameter. You must make the request with service credentials created for the instance of the service that owns the custom model. By default, no custom acoustic model is used.

Returns:

the acousticCustomizationId

customizationWeight

public java.lang.Double customizationWeight()

Gets the customizationWeight. If you specify a `customization_id` when you create the session, you can use the `customization_weight` parameter to tell the service how much weight to give to words from the custom language model compared to those from the base model for recognition requests made with the session. Specify a value between 0.0 and 1.0. Unless a different customization weight was specified for the custom model when it was trained, the default value is 0.3. A customization weight that you specify overrides a weight that was specified when the custom model was trained. The default value yields the best performance in general. Assign a higher value if your audio makes frequent use of OOV words from the custom model. Use caution when setting the weight: a higher value can improve the accuracy of phrases from the custom model's domain, but it can negatively affect performance on non-domain phrases.

Returns:

the customizationWeight

version

public java.lang.String version()

Gets the version. The version of the specified base `model` that is to be used with the new session. Multiple versions of a base model can exist when a model is updated for internal improvements. The parameter is intended primarily for use with custom models that have been upgraded for a new base model. The default value depends on whether the parameter is used with or without a custom model. For more information, see [Base model version](https://console.bluemix.net/docs/services/speech-to-text/input.html#version).

Returns:

the version