Package com.ibm.watson.assistant.v1.model

Class CreateExampleOptions

java.lang.Object

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

com.ibm.watson.assistant.v1.model.CreateExampleOptions

All Implemented Interfaces:

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

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

The createExample options.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CreateExampleOptions.Builder	Builder.

Method Summary

Modifier and Type	Method	Description
Boolean	includeAudit()	Gets the includeAudit.
String	intent()	Gets the intent.
List<Mention>	mentions()	Gets the mentions.
CreateExampleOptions.Builder	newBuilder()	New builder.
String	text()	Gets the text.
String	workspaceId()	Gets the workspaceId.

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 Details

newBuilder

public CreateExampleOptions.Builder newBuilder()

New builder.

Returns:

a CreateExampleOptions builder

workspaceId

public String workspaceId()

Gets the workspaceId.

Unique identifier of the workspace.

Returns:

the workspaceId

intent

public String intent()

Gets the intent.

The intent name.

Returns:

the intent

text

public String text()

Gets the text.

The text of a user input example. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters.

Returns:

the text

mentions

public List<Mention> mentions()

Gets the mentions.

An array of contextual entity mentions.

Returns:

the mentions

includeAudit

public Boolean includeAudit()

Gets the includeAudit.

Whether to include the audit properties (`created` and `updated` timestamps) in the response.

Returns:

the includeAudit