RuntimeEntityInterpretation (IBM Watson Java SDK 9.3.1 API)

java.lang.Object
- com.ibm.cloud.sdk.core.service.model.GenericModel
- - com.ibm.watson.assistant.v2.model.RuntimeEntityInterpretation

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel
```
public class RuntimeEntityInterpretation
extends com.ibm.cloud.sdk.core.service.model.GenericModel
```
RuntimeEntityInterpretation.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`RuntimeEntityInterpretation.Builder` Builder.
`static interface`	`RuntimeEntityInterpretation.Granularity` The precision or duration of a time range specified by a recognized `@sys-time` or `@sys-date` entity.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`calendarType()` Gets the calendarType.
`String`	`datetimeLink()` Gets the datetimeLink.
`String`	`festival()` Gets the festival.
`String`	`granularity()` Gets the granularity.
`RuntimeEntityInterpretation.Builder`	`newBuilder()` New builder.
`Double`	`numericValue()` Gets the numericValue.
`String`	`partOfDay()` Gets the partOfDay.
`String`	`rangeLink()` Gets the rangeLink.
`String`	`rangeModifier()` Gets the rangeModifier.
`Double`	`relativeDay()` Gets the relativeDay.
`Double`	`relativeHour()` Gets the relativeHour.
`Double`	`relativeMinute()` Gets the relativeMinute.
`Double`	`relativeMonth()` Gets the relativeMonth.
`Double`	`relativeSecond()` Gets the relativeSecond.
`Double`	`relativeWeek()` Gets the relativeWeek.
`Double`	`relativeWeekend()` Gets the relativeWeekend.
`Double`	`relativeYear()` Gets the relativeYear.
`Double`	`specificDay()` Gets the specificDay.
`String`	`specificDayOfWeek()` Gets the specificDayOfWeek.
`Double`	`specificHour()` Gets the specificHour.
`Double`	`specificMinute()` Gets the specificMinute.
`Double`	`specificMonth()` Gets the specificMonth.
`Double`	`specificQuarter()` Gets the specificQuarter.
`Double`	`specificSecond()` Gets the specificSecond.
`Double`	`specificYear()` Gets the specificYear.
`String`	`subtype()` Gets the subtype.
`String`	`timezone()` Gets the timezone.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel
equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - newBuilder
```
public RuntimeEntityInterpretation.Builder newBuilder()
```
    New builder.
    
    Returns:
    
    a RuntimeEntityInterpretation builder
  - calendarType
```
public String calendarType()
```
    Gets the calendarType.
    The calendar used to represent a recognized date (for example, `Gregorian`).
    
    Returns:
    
    the calendarType
  - datetimeLink
```
public String datetimeLink()
```
    Gets the datetimeLink.
    A unique identifier used to associate a recognized time and date. If the user input contains a date and time that are mentioned together (for example, `Today at 5`, the same **datetime_link** value is returned for both the `@sys-date` and `@sys-time` entities).
    
    Returns:
    
    the datetimeLink
  - festival
```
public String festival()
```
    Gets the festival.
    A locale-specific holiday name (such as `thanksgiving` or `christmas`). This property is included when a `@sys-date` entity is recognized based on a holiday name in the user input.
    
    Returns:
    
    the festival
  - granularity
```
public String granularity()
```
    Gets the granularity.
    The precision or duration of a time range specified by a recognized `@sys-time` or `@sys-date` entity.
    
    Returns:
    
    the granularity
  - rangeLink
```
public String rangeLink()
```
    Gets the rangeLink.
    A unique identifier used to associate multiple recognized `@sys-date`, `@sys-time`, or `@sys-number` entities that are recognized as a range of values in the user's input (for example, `from July 4 until July 14` or `from 20 to 25`).
    
    Returns:
    
    the rangeLink
  - rangeModifier
```
public String rangeModifier()
```
    Gets the rangeModifier.
    The word in the user input that indicates that a `sys-date` or `sys-time` entity is part of an implied range where only one date or time is specified (for example, `since` or `until`).
    
    Returns:
    
    the rangeModifier
  - relativeDay
```
public Double relativeDay()
```
    Gets the relativeDay.
    A recognized mention of a relative day, represented numerically as an offset from the current date (for example, `-1` for `yesterday` or `10` for `in ten days`).
    
    Returns:
    
    the relativeDay
  - relativeMonth
```
public Double relativeMonth()
```
    Gets the relativeMonth.
    A recognized mention of a relative month, represented numerically as an offset from the current month (for example, `1` for `next month` or `-3` for `three months ago`).
    
    Returns:
    
    the relativeMonth
  - relativeWeek
```
public Double relativeWeek()
```
    Gets the relativeWeek.
    A recognized mention of a relative week, represented numerically as an offset from the current week (for example, `2` for `in two weeks` or `-1` for `last week).
    
    Returns:
    
    the relativeWeek
  - relativeWeekend
```
public Double relativeWeekend()
```
    Gets the relativeWeekend.
    A recognized mention of a relative date range for a weekend, represented numerically as an offset from the current weekend (for example, `0` for `this weekend` or `-1` for `last weekend`).
    
    Returns:
    
    the relativeWeekend
  - relativeYear
```
public Double relativeYear()
```
    Gets the relativeYear.
    A recognized mention of a relative year, represented numerically as an offset from the current year (for example, `1` for `next year` or `-5` for `five years ago`).
    
    Returns:
    
    the relativeYear
  - specificDay
```
public Double specificDay()
```
    Gets the specificDay.
    A recognized mention of a specific date, represented numerically as the date within the month (for example, `30` for `June 30`.).
    
    Returns:
    
    the specificDay
  - specificDayOfWeek
```
public String specificDayOfWeek()
```
    Gets the specificDayOfWeek.
    A recognized mention of a specific day of the week as a lowercase string (for example, `monday`).
    
    Returns:
    
    the specificDayOfWeek
  - specificMonth
```
public Double specificMonth()
```
    Gets the specificMonth.
    A recognized mention of a specific month, represented numerically (for example, `7` for `July`).
    
    Returns:
    
    the specificMonth
  - specificQuarter
```
public Double specificQuarter()
```
    Gets the specificQuarter.
    A recognized mention of a specific quarter, represented numerically (for example, `3` for `the third quarter`).
    
    Returns:
    
    the specificQuarter
  - specificYear
```
public Double specificYear()
```
    Gets the specificYear.
    A recognized mention of a specific year (for example, `2016`).
    
    Returns:
    
    the specificYear
  - numericValue
```
public Double numericValue()
```
    Gets the numericValue.
    A recognized numeric value, represented as an integer or double.
    
    Returns:
    
    the numericValue
  - subtype
```
public String subtype()
```
    Gets the subtype.
    The type of numeric value recognized in the user input (`integer` or `rational`).
    
    Returns:
    
    the subtype
  - partOfDay
```
public String partOfDay()
```
    Gets the partOfDay.
    A recognized term for a time that was mentioned as a part of the day in the user's input (for example, `morning` or `afternoon`).
    
    Returns:
    
    the partOfDay
  - relativeHour
```
public Double relativeHour()
```
    Gets the relativeHour.
    A recognized mention of a relative hour, represented numerically as an offset from the current hour (for example, `3` for `in three hours` or `-1` for `an hour ago`).
    
    Returns:
    
    the relativeHour
  - relativeMinute
```
public Double relativeMinute()
```
    Gets the relativeMinute.
    A recognized mention of a relative time, represented numerically as an offset in minutes from the current time (for example, `5` for `in five minutes` or `-15` for `fifteen minutes ago`).
    
    Returns:
    
    the relativeMinute
  - relativeSecond
```
public Double relativeSecond()
```
    Gets the relativeSecond.
    A recognized mention of a relative time, represented numerically as an offset in seconds from the current time (for example, `10` for `in ten seconds` or `-30` for `thirty seconds ago`).
    
    Returns:
    
    the relativeSecond
  - specificHour
```
public Double specificHour()
```
    Gets the specificHour.
    A recognized specific hour mentioned as part of a time value (for example, `10` for `10:15 AM`.).
    
    Returns:
    
    the specificHour
  - specificMinute
```
public Double specificMinute()
```
    Gets the specificMinute.
    A recognized specific minute mentioned as part of a time value (for example, `15` for `10:15 AM`.).
    
    Returns:
    
    the specificMinute
  - specificSecond
```
public Double specificSecond()
```
    Gets the specificSecond.
    A recognized specific second mentioned as part of a time value (for example, `30` for `10:15:30 AM`.).
    
    Returns:
    
    the specificSecond
  - timezone
```
public String timezone()
```
    Gets the timezone.
    A recognized time zone mentioned as part of a time value (for example, `EST`).
    
    Returns:
    
    the timezone

Class RuntimeEntityInterpretation

Nested Class Summary

Method Summary

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

Methods inherited from class java.lang.Object

Method Detail

newBuilder

calendarType

datetimeLink

festival

granularity

rangeLink

rangeModifier

relativeDay

relativeMonth

relativeWeek

relativeWeekend

relativeYear

specificDay

specificDayOfWeek

specificMonth

specificQuarter

specificYear

numericValue

subtype

partOfDay

relativeHour

relativeMinute

relativeSecond

specificHour

specificMinute

specificSecond

timezone