Class Context (4.61.0) 

public final class Context extends GeneratedMessageV3 implements ContextOrBuilder

Dialogflow contexts are similar to natural language context. If a person says to you "they are orange", you need context in order to understand what "they" is referring to. Similarly, for Dialogflow to handle an end-user expression like that, it needs to be provided with context in order to correctly match an intent.

Using contexts, you can control the flow of a conversation. You can configure contexts for an intent by setting input and output contexts, which are identified by string names. When an intent is matched, any configured output contexts for that intent become active. While any contexts are active, Dialogflow is more likely to match intents that are configured with input contexts that correspond to the currently active contexts.

For more information about context, see the Contexts guide.

Protobuf type google.cloud.dialogflow.v2beta1.Context

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Context

Implements

ContextOrBuilder

Static Fields

LIFESPAN_COUNT_FIELD_NUMBER

public static final int LIFESPAN_COUNT_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PARAMETERS_FIELD_NUMBER

public static final int PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Context getDefaultInstance()
Returns
Type Description
Context

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Context.Builder newBuilder()
Returns
Type Description
Context.Builder

newBuilder(Context prototype)

public static Context.Builder newBuilder(Context prototype)
Parameter
Name Description
prototype Context
Returns
Type Description
Context.Builder

parseDelimitedFrom(InputStream input)

public static Context parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Context
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Context parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Context
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Context parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Context
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Context parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Context
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Context parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Context
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Context parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Context
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Context parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Context
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Context parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Context
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Context parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Context
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Context parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Context
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Context parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Context
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Context parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Context
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Context> parser()
Returns
Type Description
Parser<Context>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Context getDefaultInstanceForType()
Returns
Type Description
Context

getLifespanCount()

public int getLifespanCount()

Optional. The number of conversational query requests after which the context expires. The default is 0. If set to 0, the context expires immediately. Contexts expire automatically after 20 minutes if there are no matching queries.

int32 lifespan_count = 2;

Returns
Type Description
int

The lifespanCount.

getName()

public String getName()

Required. The unique identifier of the context. Supported formats:

  • projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>,
  • projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session ID>/contexts/<Context ID>,
  • projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>,

  • projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>,

    The Context ID is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long.

    If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

    The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names:

  • system_counters

  • *_id_dialog_context
  • *_dialog_params_size

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The unique identifier of the context. Supported formats:

  • projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>,
  • projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session ID>/contexts/<Context ID>,
  • projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>,

  • projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>,

    The Context ID is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long.

    If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

    The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names:

  • system_counters

  • *_id_dialog_context
  • *_dialog_params_size

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParameters()

public Struct getParameters()

Optional. The collection of parameters associated with this context.

Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs:

  • MapKey type: string
  • MapKey value: parameter name
  • MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map.
  • MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.

.google.protobuf.Struct parameters = 3;

Returns
Type Description
Struct

The parameters.

getParametersOrBuilder()

public StructOrBuilder getParametersOrBuilder()

Optional. The collection of parameters associated with this context.

Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs:

  • MapKey type: string
  • MapKey value: parameter name
  • MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map.
  • MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.

.google.protobuf.Struct parameters = 3;

Returns
Type Description
StructOrBuilder

getParserForType()

public Parser<Context> getParserForType()
Returns
Type Description
Parser<Context>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasParameters()

public boolean hasParameters()

Optional. The collection of parameters associated with this context.

Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs:

  • MapKey type: string
  • MapKey value: parameter name
  • MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map.
  • MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.

.google.protobuf.Struct parameters = 3;

Returns
Type Description
boolean

Whether the parameters field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Context.Builder newBuilderForType()
Returns
Type Description
Context.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Context.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Context.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Context.Builder toBuilder()
Returns
Type Description
Context.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException