public class RuntimeEntity
extends com.ibm.cloud.sdk.core.service.model.GenericModel
Modifier and Type | Class and Description |
---|---|
static class |
RuntimeEntity.Builder
Builder.
|
Modifier and Type | Method and Description |
---|---|
List<RuntimeEntityAlternative> |
alternatives()
Gets the alternatives.
|
Double |
confidence()
Gets the confidence.
|
String |
entity()
Gets the entity.
|
List<CaptureGroup> |
groups()
Gets the groups.
|
RuntimeEntityInterpretation |
interpretation()
Gets the interpretation.
|
List<Long> |
location()
Gets the location.
|
RuntimeEntity.Builder |
newBuilder()
New builder.
|
RuntimeEntityRole |
role()
Gets the role.
|
String |
skill()
Gets the skill.
|
String |
value()
Gets the value.
|
public RuntimeEntity.Builder newBuilder()
public String entity()
An entity detected in the input.
public List<Long> location()
An array of zero-based character offsets that indicate where the detected entity values begin and end in the input text.
public String value()
The term in the input text that was recognized as an entity value.
public Double confidence()
A decimal percentage that represents Watson's confidence in the recognized entity.
public List<CaptureGroup> groups()
The recognized capture groups for the entity, as defined by the entity pattern.
public RuntimeEntityInterpretation interpretation()
An object containing detailed information about the entity recognized in the user input. This property is included only if the new system entities are enabled for the skill.
For more information about how the new system entities are interpreted, see the [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-beta-system-entities).
public List<RuntimeEntityAlternative> alternatives()
An array of possible alternative values that the user might have intended instead of the value returned in the **value** property. This property is returned only for `@sys-time` and `@sys-date` entities when the user's input is ambiguous.
This property is included only if the new system entities are enabled for the skill.
public RuntimeEntityRole role()
An object describing the role played by a system entity that is specifies the beginning or end of a range recognized in the user input. This property is included only if the new system entities are enabled for the skill.
public String skill()
The skill that recognized the entity value. Currently, the only possible values are `main skill` for the dialog skill (if enabled) and `actions skill` for the action skill.
This property is present only if the assistant has both a dialog skill and an action skill.
Copyright © 2023 IBM Cloud. All rights reserved.