com.ibm.watson.assistant.v2.model

Class MessageContextGlobalSystem

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.watson.assistant.v2.model.MessageContextGlobalSystem

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class MessageContextGlobalSystem
extends com.ibm.cloud.sdk.core.service.model.GenericModel

Built-in system properties that apply to all skills used by the assistant.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MessageContextGlobalSystem.Builder Builder.
static interface	MessageContextGlobalSystem.Locale The language code for localization in the user input.

Method Summary

Modifier and Type	Method and Description
String	locale() Gets the locale.
MessageContextGlobalSystem.Builder	newBuilder() New builder.
String	referenceTime() Gets the referenceTime.
String	timezone() Gets the timezone.
Long	turnCount() Gets the turnCount.
String	userId() Gets the userId.

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 MessageContextGlobalSystem.Builder newBuilder()

New builder.

Returns:

a MessageContextGlobalSystem builder

timezone

public String timezone()

Gets the timezone.

The user time zone. The assistant uses the time zone to correctly resolve relative time references.

Returns:

the timezone

userId

public String userId()

Gets the userId.

A string value that identifies the user who is interacting with the assistant. The client must provide a unique identifier for each individual end user who accesses the application. For user-based plans, this user ID is used to identify unique users for billing purposes. This string cannot contain carriage return, newline, or tab characters. If no value is specified in the input, **user_id** is automatically set to the value of **context.global.session_id**.

**Note:** This property is the same as the **user_id** property at the root of the message body. If **user_id** is specified in both locations in a message request, the value specified at the root is used.

Returns:

the userId

turnCount

public Long turnCount()

Gets the turnCount.

A counter that is automatically incremented with each turn of the conversation. A value of 1 indicates that this is the the first turn of a new conversation, which can affect the behavior of some skills (for example, triggering the start node of a dialog).

Returns:

the turnCount

locale

public String locale()

Gets the locale.

The language code for localization in the user input. The specified locale overrides the default for the assistant, and is used for interpreting entity values in user input such as date values. For example, `04/03/2018` might be interpreted either as April 3 or March 4, depending on the locale.

This property is included only if the new system entities are enabled for the skill.

Returns:

the locale

referenceTime

public String referenceTime()

Gets the referenceTime.

The base time for interpreting any relative time mentions in the user input. The specified time overrides the current server time, and is used to calculate times mentioned in relative terms such as `now` or `tomorrow`. This can be useful for simulating past or future times for testing purposes, or when analyzing documents such as news articles.

This value must be a UTC time value formatted according to ISO 8601 (for example, `2019-06-26T12:00:00Z` for noon on 26 June 2019.

This property is included only if the new system entities are enabled for the skill.

Returns:

the referenceTime