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.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	baseModelName
protected java.lang.String	created
protected java.lang.String	customizationId
protected java.lang.String	description
protected java.lang.String	dialect
protected java.lang.String	error
protected java.lang.String	language
protected java.lang.String	name
protected java.lang.String	owner
protected java.lang.Long	progress
protected java.lang.String	status
protected java.lang.String	updated
protected java.util.List<java.lang.String>	versions
protected java.lang.String	warnings

Constructor Summary

Constructors

Constructor and Description
LanguageModel()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getBaseModelName() Gets the baseModelName.
java.lang.String	getCreated() Gets the created.
java.lang.String	getCustomizationId() Gets the customizationId.
java.lang.String	getDescription() Gets the description.
java.lang.String	getDialect() Gets the dialect.
java.lang.String	getError() Gets the error.
java.lang.String	getLanguage() Gets the language.
java.lang.String	getName() Gets the name.
java.lang.String	getOwner() Gets the owner.
java.lang.Long	getProgress() Gets the progress.
java.lang.String	getStatus() Gets the status.
java.lang.String	getUpdated() Gets the updated.
java.util.List<java.lang.String>	getVersions() Gets the versions.
java.lang.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

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

Field Detail

customizationId

@SerializedName(value="customization_id")
protected java.lang.String customizationId

created

protected java.lang.String created

updated

protected java.lang.String updated

language

protected java.lang.String language

dialect

protected java.lang.String dialect

versions

protected java.util.List<java.lang.String> versions

owner

protected java.lang.String owner

name

protected java.lang.String name

description

protected java.lang.String description

baseModelName

@SerializedName(value="base_model_name")
protected java.lang.String baseModelName

status

protected java.lang.String status

progress

protected java.lang.Long progress

error

protected java.lang.String error

warnings

protected java.lang.String warnings

Constructor Detail

LanguageModel

public LanguageModel()

Method Detail

getCustomizationId

public java.lang.String getCustomizationId()

Gets the customizationId.

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

Returns:

the customizationId

getCreated

public java.lang.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 java.lang.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 java.lang.String getLanguage()

Gets the language.

The language identifier of the custom language model (for example, `en-US`).

Returns:

the language

getDialect

public java.lang.String getDialect()

Gets the dialect.

The dialect of the language for the custom language model. For non-Spanish models, the field matches the language of the base model; for example, `en-US` for either of the US English language models. For Spanish models, the field indicates the dialect for which the model was created: * `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 java.util.List<java.lang.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; otherwise, only a single version is shown.

Returns:

the versions

getOwner

public java.lang.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 java.lang.String getName()

Gets the name.

The name of the custom language model.

Returns:

the name

getDescription

public java.lang.String getDescription()

Gets the description.

The description of the custom language model.

Returns:

the description

getBaseModelName

public java.lang.String getBaseModelName()

Gets the baseModelName.

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

Returns:

the baseModelName

getStatus

public java.lang.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 java.lang.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 java.lang.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 java.lang.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