public static final class Context.Builder extends GeneratedMessageV3.Builder<Context.Builder> 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
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Context.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
Returns
buildPartial()
public Context buildPartial()
Returns
clear()
public Context.Builder clear()
Returns
Overrides
clearField(Descriptors.FieldDescriptor field)
public Context.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
clearLifespanCount()
public Context.Builder clearLifespanCount()
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;
clearName()
public Context.Builder clearName()
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;
clearOneof(Descriptors.OneofDescriptor oneof)
public Context.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
clearParameters()
public Context.Builder clearParameters()
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: map
- Else: depending on parameter value type, could be one of string,
number, boolean, null, list or map
- MapValue value:
- If parameter's entity type is a composite entity:
map from composite entity property names to property values
- Else: parameter value
.google.protobuf.Struct parameters = 3;
clone()
public Context.Builder clone()
Returns
Overrides
getDefaultInstanceForType()
public Context getDefaultInstanceForType()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
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;
| Type | Description |
| int | The lifespanCount.
|
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;
| 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;
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: map
- Else: depending on parameter value type, could be one of string,
number, boolean, null, list or map
- MapValue value:
- If parameter's entity type is a composite entity:
map from composite entity property names to property values
- Else: parameter value
.google.protobuf.Struct parameters = 3;
| Type | Description |
| Struct | The parameters.
|
getParametersBuilder()
public Struct.Builder getParametersBuilder()
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: map
- Else: depending on parameter value type, could be one of string,
number, boolean, null, list or map
- MapValue value:
- If parameter's entity type is a composite entity:
map from composite entity property names to property values
- Else: parameter value
.google.protobuf.Struct parameters = 3;
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: map
- Else: depending on parameter value type, could be one of string,
number, boolean, null, list or map
- MapValue value:
- If parameter's entity type is a composite entity:
map from composite entity property names to property values
- Else: parameter value
.google.protobuf.Struct parameters = 3;
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: map
- Else: depending on parameter value type, could be one of string,
number, boolean, null, list or map
- MapValue value:
- If parameter's entity type is a composite entity:
map from composite entity property names to property values
- Else: parameter value
.google.protobuf.Struct parameters = 3;
| Type | Description |
| boolean | Whether the parameters field is set.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeFrom(Context other)
public Context.Builder mergeFrom(Context other)
Parameter
Returns
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Context.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public Context.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
mergeParameters(Struct value)
public Context.Builder mergeParameters(Struct value)
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: map
- Else: depending on parameter value type, could be one of string,
number, boolean, null, list or map
- MapValue value:
- If parameter's entity type is a composite entity:
map from composite entity property names to property values
- Else: parameter value
.google.protobuf.Struct parameters = 3;
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Context.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public Context.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
setLifespanCount(int value)
public Context.Builder setLifespanCount(int value)
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;
| Name | Description |
| value | int
The lifespanCount to set.
|
Returns
setName(String value)
public Context.Builder setName(String value)
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;
| Name | Description |
| value | String
The name to set.
|
Returns
setNameBytes(ByteString value)
public Context.Builder setNameBytes(ByteString value)
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;
| Name | Description |
| value | ByteString
The bytes for name to set.
|
Returns
setParameters(Struct value)
public Context.Builder setParameters(Struct value)
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: map
- Else: depending on parameter value type, could be one of string,
number, boolean, null, list or map
- MapValue value:
- If parameter's entity type is a composite entity:
map from composite entity property names to property values
- Else: parameter value
.google.protobuf.Struct parameters = 3;
setParameters(Struct.Builder builderForValue)
public Context.Builder setParameters(Struct.Builder builderForValue)
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: map
- Else: depending on parameter value type, could be one of string,
number, boolean, null, list or map
- MapValue value:
- If parameter's entity type is a composite entity:
map from composite entity property names to property values
- Else: parameter value
.google.protobuf.Struct parameters = 3;
| Name | Description |
| builderForValue | Builder
|
Returns
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Context.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final Context.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
