Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class Context.
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 .
Generated from protobuf message google.cloud.dialogflow.v2.Context
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Required. The unique identifier of the context. Format: projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>
, or projects/<Project 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
↳ lifespan_count
int
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.
↳ parameters
Google\Protobuf\Struct
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
getName
Required. The unique identifier of the context. Format: projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>
,
or projects/<Project 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
setName
Required. The unique identifier of the context. Format: projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>
,
or projects/<Project 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
var
string
$this
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.
int
setLifespanCount
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.
var
int
$this
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
hasParameters
clearParameters
setParameters
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
$this
