Class CreateSynonymOptions

java.lang.Object
com.ibm.cloud.sdk.core.service.model.GenericModel
com.ibm.watson.assistant.v1.model.CreateSynonymOptions
All Implemented Interfaces:
com.ibm.cloud.sdk.core.service.model.ObjectModel

public class CreateSynonymOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel
The createSynonym options.
  • Method Details

    • newBuilder

      public CreateSynonymOptions.Builder newBuilder()
      New builder.
      Returns:
      a CreateSynonymOptions builder
    • workspaceId

      public String workspaceId()
      Gets the workspaceId.

      Unique identifier of the workspace.

      Returns:
      the workspaceId
    • entity

      public String entity()
      Gets the entity.

      The name of the entity.

      Returns:
      the entity
    • value

      public String value()
      Gets the value.

      The text of the entity value.

      Returns:
      the value
    • synonym

      public String synonym()
      Gets the synonym.

      The text of the synonym. 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 synonym
    • includeAudit

      public Boolean includeAudit()
      Gets the includeAudit.

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

      Returns:
      the includeAudit