com.ibm.watson.speech_to_text.v1.model

Class LanguageModel

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.watson.speech_to_text.v1.model.LanguageModel

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class LanguageModel
extends com.ibm.cloud.sdk.core.service.model.GenericModel

Information about an existing custom language model.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LanguageModel.Status The current status of the custom language model: * `pending`: The model was created but is waiting either for valid training data to be added or for the service to finish analyzing added data.

Method Summary

Modifier and Type	Method and Description
String	getBaseModelName() Gets the baseModelName.
String	getCreated() Gets the created.
String	getCustomizationId() Gets the customizationId.
String	getDescription() Gets the description.
String	getDialect() Gets the dialect.
String	getError() Gets the error.
String	getLanguage() Gets the language.
String	getName() Gets the name.
String	getOwner() Gets the owner.
Long	getProgress() Gets the progress.
String	getStatus() Gets the status.
String	getUpdated() Gets the updated.
List<String>	getVersions() Gets the versions.
String	getWarnings() Gets the warnings.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getCustomizationId

public String getCustomizationId()

Gets the customizationId.

The customization ID (GUID) of the custom language model. The [Create a custom language model](#createlanguagemodel) method returns only this field of the object; it does not return the other fields.

Returns:

the customizationId

getCreated

public String getCreated()

Gets the created.

The date and time in Coordinated Universal Time (UTC) at which the custom language model was created. The value is provided in full ISO 8601 format (`YYYY-MM-DDThh:mm:ss.sTZD`).

Returns:

the created

getUpdated

public String getUpdated()

Gets the updated.

The date and time in Coordinated Universal Time (UTC) at which the custom language model was last modified. The `created` and `updated` fields are equal when a language model is first added but has yet to be updated. The value is provided in full ISO 8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

Returns:

the updated

getLanguage

public String getLanguage()

Gets the language.

The language identifier of the custom language model (for example, `en-US`). The value matches the five-character language identifier from the name of the base model for the custom model. This value might be different from the value of the `dialect` field.

Returns:

the language

getDialect

public String getDialect()

Gets the dialect.

The dialect of the language for the custom language model. _For custom models that are based on non-Spanish previous-generation models and on next-generation models,_ the field matches the language of the base model; for example, `en-US` for one of the US English models. _For custom models that are based on Spanish previous-generation models,_ the field indicates the dialect with which the model was created. The value can match the name of the base model or, if it was specified by the user, can be one of the following: * `es-ES` for Castilian Spanish (`es-ES` models) * `es-LA` for Latin American Spanish (`es-AR`, `es-CL`, `es-CO`, and `es-PE` models) * `es-US` for Mexican (North American) Spanish (`es-MX` models)

Dialect values are case-insensitive.

Returns:

the dialect

getVersions

public List<String> getVersions()

Gets the versions.

A list of the available versions of the custom language model. Each element of the array indicates a version of the base model with which the custom model can be used. Multiple versions exist only if the custom model has been upgraded to a new version of its base model. Otherwise, only a single version is shown.

Returns:

the versions

getOwner

public String getOwner()

Gets the owner.

The GUID of the credentials for the instance of the service that owns the custom language model.

Returns:

the owner

getName

public String getName()

Gets the name.

The name of the custom language model.

Returns:

the name

getDescription

public String getDescription()

Gets the description.

The description of the custom language model.

Returns:

the description

getBaseModelName

public String getBaseModelName()

Gets the baseModelName.

The name of the language model for which the custom language model was created.

Returns:

the baseModelName

getStatus

public String getStatus()

Gets the status.

The current status of the custom language model: * `pending`: The model was created but is waiting either for valid training data to be added or for the service to finish analyzing added data. * `ready`: The model contains valid data and is ready to be trained. If the model contains a mix of valid and invalid resources, you need to set the `strict` parameter to `false` for the training to proceed. * `training`: The model is currently being trained. * `available`: The model is trained and ready to use. * `upgrading`: The model is currently being upgraded. * `failed`: Training of the model failed.

Returns:

the status

getProgress

public Long getProgress()

Gets the progress.

A percentage that indicates the progress of the custom language model's current training. A value of `100` means that the model is fully trained. **Note:** The `progress` field does not currently reflect the progress of the training. The field changes from `0` to `100` when training is complete.

Returns:

the progress

getError

public String getError()

Gets the error.

If an error occurred while adding a grammar file to the custom language model, a message that describes an `Internal Server Error` and includes the string `Cannot compile grammar`. The status of the custom model is not affected by the error, but the grammar cannot be used with the model.

Returns:

the error

getWarnings

public String getWarnings()

Gets the warnings.

If the request included unknown parameters, the following message: `Unexpected query parameter(s) ['parameters'] detected`, where `parameters` is a list that includes a quoted string for each unknown parameter.

Returns:

the warnings