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

Class CreateIntentOptions

java.lang.Object

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

com.ibm.watson.assistant.v1.model.CreateIntentOptions

All Implemented Interfaces:

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

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

The createIntent options.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
String	description()	Gets the description.
List<Example>	examples()	Gets the examples.
Boolean	includeAudit()	Gets the includeAudit.
String	intent()	Gets the intent.
CreateIntentOptions.Builder	newBuilder()	New builder.
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 CreateIntentOptions.Builder newBuilder()

New builder.

Returns:

a CreateIntentOptions builder

workspaceId

public String workspaceId()

Gets the workspaceId.

Unique identifier of the workspace.

Returns:

the workspaceId

intent

public String intent()

Gets the intent.

The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix `sys-`.

Returns:

the intent

description

public String description()

Gets the description.

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

Returns:

the description

examples

public List<Example> examples()

Gets the examples.

An array of user input examples for the intent.

Returns:

the examples

includeAudit

public Boolean includeAudit()

Gets the includeAudit.

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

Returns:

the includeAudit