com.ibm.watson.assistant.v2.model

Class Skill

java.lang.Object

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

com.ibm.watson.assistant.v2.model.Skill

All Implemented Interfaces:

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

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

Skill.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Skill.Status The current status of the skill: - **Available**: The skill is available and ready to process messages.
static interface	Skill.Type The type of skill.

Method Summary

Modifier and Type	Method and Description
String	getAssistantId() Gets the assistantId.
String	getDescription() Gets the description.
Map<String,Object>	getDialogSettings() Gets the dialogSettings.
String	getEnvironmentId() Gets the environmentId.
String	getLanguage() Gets the language.
String	getName() Gets the name.
String	getNextSnapshotVersion() Gets the nextSnapshotVersion.
SearchSettings	getSearchSettings() Gets the searchSettings.
String	getSkillId() Gets the skillId.
String	getStatus() Gets the status.
String	getStatusDescription() Gets the statusDescription.
List<StatusError>	getStatusErrors() Gets the statusErrors.
String	getType() Gets the type.
List<SearchSkillWarning>	getWarnings() Gets the warnings.
Map<String,Object>	getWorkspace() Gets the workspace.
String	getWorkspaceId() Gets the workspaceId.
Boolean	isValid() Gets the valid.

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

getName

public String getName()

Gets the name.

The name of the skill. This string cannot contain carriage return, newline, or tab characters.

Returns:

the name

getDescription

public String getDescription()

Gets the description.

The description of the skill. This string cannot contain carriage return, newline, or tab characters.

Returns:

the description

getWorkspace

public Map<String,Object> getWorkspace()

Gets the workspace.

An object containing the conversational content of an action or dialog skill.

Returns:

the workspace

getSkillId

public String getSkillId()

Gets the skillId.

The skill ID of the skill.

Returns:

the skillId

getStatus

public String getStatus()

Gets the status.

The current status of the skill: - **Available**: The skill is available and ready to process messages. - **Failed**: An asynchronous operation has failed. See the **status_errors** property for more information about the cause of the failure. - **Non Existent**: The skill does not exist. - **Processing**: An asynchronous operation has not yet completed. - **Training**: The skill is training based on new data.

Returns:

the status

getStatusErrors

public List<StatusError> getStatusErrors()

Gets the statusErrors.

An array of messages about errors that caused an asynchronous operation to fail. Included only if **status**=`Failed`.

Returns:

the statusErrors

getStatusDescription

public String getStatusDescription()

Gets the statusDescription.

The description of the failed asynchronous operation. Included only if **status**=`Failed`.

Returns:

the statusDescription

getDialogSettings

public Map<String,Object> getDialogSettings()

Gets the dialogSettings.

For internal use only.

Returns:

the dialogSettings

getAssistantId

public String getAssistantId()

Gets the assistantId.

The unique identifier of the assistant the skill is associated with.

Returns:

the assistantId

getWorkspaceId

public String getWorkspaceId()

Gets the workspaceId.

The unique identifier of the workspace that contains the skill content. Included only for action and dialog skills.

Returns:

the workspaceId

getEnvironmentId

public String getEnvironmentId()

Gets the environmentId.

The unique identifier of the environment where the skill is defined. For action and dialog skills, this is always the draft environment.

Returns:

the environmentId

isValid

public Boolean isValid()

Gets the valid.

Whether the skill is structurally valid.

Returns:

the valid

getNextSnapshotVersion

public String getNextSnapshotVersion()

Gets the nextSnapshotVersion.

The name that will be given to the next snapshot that is created for the skill. A snapshot of each versionable skill is saved for each new release of an assistant.

Returns:

the nextSnapshotVersion

getSearchSettings

public SearchSettings getSearchSettings()

Gets the searchSettings.

An object describing the search skill configuration.

**Note:** Search settings are not supported in **Import skills** requests, and are not included in **Export skills** responses.

Returns:

the searchSettings

getWarnings

public List<SearchSkillWarning> getWarnings()

Gets the warnings.

An array of warnings describing errors with the search skill configuration. Included only for search skills.

Returns:

the warnings

getLanguage

public String getLanguage()

Gets the language.

The language of the skill.

Returns:

the language

getType

public String getType()

Gets the type.

The type of skill.

Returns:

the type