public class CreateValueOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel
Modifier and Type | Class and Description |
---|---|
static class |
CreateValueOptions.Builder
Builder.
|
static interface |
CreateValueOptions.Type
Specifies the type of entity value.
|
Modifier and Type | Method and Description |
---|---|
String |
entity()
Gets the entity.
|
Boolean |
includeAudit()
Gets the includeAudit.
|
Map<String,Object> |
metadata()
Gets the metadata.
|
CreateValueOptions.Builder |
newBuilder()
New builder.
|
List<String> |
patterns()
Gets the patterns.
|
List<String> |
synonyms()
Gets the synonyms.
|
String |
type()
Gets the type.
|
String |
value()
Gets the value.
|
String |
workspaceId()
Gets the workspaceId.
|
public CreateValueOptions.Builder newBuilder()
public String workspaceId()
Unique identifier of the workspace.
public String entity()
The name of the entity.
public String value()
The text of the entity value. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters.
public Map<String,Object> metadata()
Any metadata related to the entity value.
public String type()
Specifies the type of entity value.
public List<String> synonyms()
An array of synonyms for the entity value. A value can specify either synonyms or patterns (depending on the value type), but not both. A synonym must conform to the following resrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters.
public List<String> patterns()
An array of patterns for the entity value. A value can specify either synonyms or patterns (depending on the value type), but not both. A pattern is a regular expression; for more information about how to specify a pattern, see the [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-entities#entities-create-dictionary-based).
public Boolean includeAudit()
Whether to include the audit properties (`created` and `updated` timestamps) in the response.
Copyright © 2023 IBM Cloud. All rights reserved.