Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UpdateWorkspaceParams

Parameters for the updateWorkspace operation.

Hierarchy

  • UpdateWorkspaceParams

Index

Properties

Optional append

append: boolean

Whether the new data is to be appended to the existing data in the object. If append=false, elements included in the new data completely replace the corresponding existing elements, including all subelements. For example, if the new data for a workspace includes entities and append=false, all existing entities in the workspace are discarded and replaced with the new entities.

If append=true, existing elements are preserved, and the new elements are added. If any elements in the new data collide with existing elements, the update request fails.

Optional counterexamples

counterexamples: Counterexample[]

An array of objects defining input examples that have been marked as irrelevant input.

Optional description

description: string

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

Optional dialogNodes

dialogNodes: DialogNode[]

An array of objects describing the dialog nodes in the workspace.

Optional entities

entities: CreateEntity[]

An array of objects describing the entities for the workspace.

Optional headers

headers: OutgoingHttpHeaders

Optional includeAudit

includeAudit: boolean

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

Optional intents

intents: CreateIntent[]

An array of objects defining the intents for the workspace.

Optional language

language: string

The language of the workspace.

Optional learningOptOut

learningOptOut: boolean

Whether training data from the workspace (including artifacts such as intents and entities) can be used by IBM for general service improvements. true indicates that workspace training data is not to be used.

Optional metadata

metadata: JsonObject

Any metadata related to the workspace.

Optional name

name: string

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

Optional systemSettings

systemSettings: WorkspaceSystemSettings

Global settings for the workspace.

Optional webhooks

webhooks: Webhook[]

workspaceId

workspaceId: string

Unique identifier of the workspace.

Generated using TypeDoc