RuntimeEntityInterpretation

public struct RuntimeEntityInterpretation : Codable, Equatable

RuntimeEntityInterpretation.

  • The precision or duration of a time range specified by a recognized @sys-time or @sys-date entity.

    See more

    Declaration

    Swift

    public enum Granularity : String
  • The calendar used to represent a recognized date (for example, Gregorian).

    Declaration

    Swift

    public var calendarType: String?
  • 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).

    Declaration

    Swift

    public var datetimeLink: String?
  • 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.

    Declaration

    Swift

    public var festival: String?
  • The precision or duration of a time range specified by a recognized @sys-time or @sys-date entity.

    Declaration

    Swift

    public var granularity: String?
  • 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).

    Declaration

    Swift

    public var rangeLink: String?
  • 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).

    Declaration

    Swift

    public var rangeModifier: String?
  • 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).

    Declaration

    Swift

    public var relativeDay: Double?
  • 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).

    Declaration

    Swift

    public var relativeMonth: Double?
  • 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).

    Declaration

    Swift

    public var relativeWeek: Double?
  • 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).

    Declaration

    Swift

    public var relativeWeekend: Double?
  • 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).

    Declaration

    Swift

    public var relativeYear: Double?
  • A recognized mention of a specific date, represented numerically as the date within the month (for example, 30 for June 30.).

    Declaration

    Swift

    public var specificDay: Double?
  • A recognized mention of a specific day of the week as a lowercase string (for example, monday).

    Declaration

    Swift

    public var specificDayOfWeek: String?
  • A recognized mention of a specific month, represented numerically (for example, 7 for July).

    Declaration

    Swift

    public var specificMonth: Double?
  • A recognized mention of a specific quarter, represented numerically (for example, 3 for the third quarter).

    Declaration

    Swift

    public var specificQuarter: Double?
  • A recognized mention of a specific year (for example, 2016).

    Declaration

    Swift

    public var specificYear: Double?
  • A recognized numeric value, represented as an integer or double.

    Declaration

    Swift

    public var numericValue: Double?
  • The type of numeric value recognized in the user input (integer or rational).

    Declaration

    Swift

    public var subtype: String?
  • 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).

    Declaration

    Swift

    public var partOfDay: String?
  • 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).

    Declaration

    Swift

    public var relativeHour: Double?
  • 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).

    Declaration

    Swift

    public var relativeMinute: Double?
  • 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).

    Declaration

    Swift

    public var relativeSecond: Double?
  • A recognized specific hour mentioned as part of a time value (for example, 10 for 10:15 AM.).

    Declaration

    Swift

    public var specificHour: Double?
  • A recognized specific minute mentioned as part of a time value (for example, 15 for 10:15 AM.).

    Declaration

    Swift

    public var specificMinute: Double?
  • A recognized specific second mentioned as part of a time value (for example, 30 for 10:15:30 AM.).

    Declaration

    Swift

    public var specificSecond: Double?
  • A recognized time zone mentioned as part of a time value (for example, EST).

    Declaration

    Swift

    public var timezone: String?
  • Initialize a RuntimeEntityInterpretation with member variables.

    Declaration

    Swift

    public init(
        calendarType: String? = nil,
        datetimeLink: String? = nil,
        festival: String? = nil,
        granularity: String? = nil,
        rangeLink: String? = nil,
        rangeModifier: String? = nil,
        relativeDay: Double? = nil,
        relativeMonth: Double? = nil,
        relativeWeek: Double? = nil,
        relativeWeekend: Double? = nil,
        relativeYear: Double? = nil,
        specificDay: Double? = nil,
        specificDayOfWeek: String? = nil,
        specificMonth: Double? = nil,
        specificQuarter: Double? = nil,
        specificYear: Double? = nil,
        numericValue: Double? = nil,
        subtype: String? = nil,
        partOfDay: String? = nil,
        relativeHour: Double? = nil,
        relativeMinute: Double? = nil,
        relativeSecond: Double? = nil,
        specificHour: Double? = nil,
        specificMinute: Double? = nil,
        specificSecond: Double? = nil,
        timezone: String? = nil
    )

    Parameters

    calendarType

    The calendar used to represent a recognized date (for example, Gregorian).

    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).

    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.

    granularity

    The precision or duration of a time range specified by a recognized @sys-time or @sys-date entity.

    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).

    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).

    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).

    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).

    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).

    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).

    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).

    specificDay

    A recognized mention of a specific date, represented numerically as the date within the month (for example, 30 for June 30.).

    specificDayOfWeek

    A recognized mention of a specific day of the week as a lowercase string (for example, monday).

    specificMonth

    A recognized mention of a specific month, represented numerically (for example, 7 for July).

    specificQuarter

    A recognized mention of a specific quarter, represented numerically (for example, 3 for the third quarter).

    specificYear

    A recognized mention of a specific year (for example, 2016).

    numericValue

    A recognized numeric value, represented as an integer or double.

    subtype

    The type of numeric value recognized in the user input (integer or rational).

    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).

    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).

    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).

    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).

    specificHour

    A recognized specific hour mentioned as part of a time value (for example, 10 for 10:15 AM.).

    specificMinute

    A recognized specific minute mentioned as part of a time value (for example, 15 for 10:15 AM.).

    specificSecond

    A recognized specific second mentioned as part of a time value (for example, 30 for 10:15:30 AM.).

    timezone

    A recognized time zone mentioned as part of a time value (for example, EST).

    Return Value

    An initialized RuntimeEntityInterpretation.