CreateEntityParams | ibm-watson

Parameters for the createEntity operation.

Index

description: string

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

entity: string

The name of the entity. This string must conform to the following restrictions:

It can contain only Unicode alphanumeric, underscore, and hyphen characters.
If you specify an entity name beginning with the reserved prefix sys-, it must be the name of a system entity that you want to enable. (Any entity content specified with the request is ignored.).

fuzzyMatch: boolean

Whether to use fuzzy matching for the entity.

headers: OutgoingHttpHeaders

includeAudit: boolean

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

Any metadata related to the entity.

An array of objects describing the entity values.

workspaceId: string

Unique identifier of the workspace.