docs: update generated docs (#1053)
Updates for both discovery docs and epydoc API Documentation
Fixes: #1049
diff --git a/docs/dyn/dialogflow_v2.projects.agent.environments.users.sessions.contexts.html b/docs/dyn/dialogflow_v2.projects.agent.environments.users.sessions.contexts.html
index da00997..6765cbd 100644
--- a/docs/dyn/dialogflow_v2.projects.agent.environments.users.sessions.contexts.html
+++ b/docs/dyn/dialogflow_v2.projects.agent.environments.users.sessions.contexts.html
@@ -75,8 +75,11 @@
<h1><a href="dialogflow_v2.html">Dialogflow API</a> . <a href="dialogflow_v2.projects.html">projects</a> . <a href="dialogflow_v2.projects.agent.html">agent</a> . <a href="dialogflow_v2.projects.agent.environments.html">environments</a> . <a href="dialogflow_v2.projects.agent.environments.users.html">users</a> . <a href="dialogflow_v2.projects.agent.environments.users.sessions.html">sessions</a> . <a href="dialogflow_v2.projects.agent.environments.users.sessions.contexts.html">contexts</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
+<p class="toc_element">
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Creates a context.</p>
+<p class="firstline">Creates a context. If the specified context already exists, overrides the context.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes the specified context.</p>
@@ -94,74 +97,25 @@
<p class="firstline">Updates the specified context.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
- <pre>Creates a context.
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
-If the specified context already exists, overrides the context.
+<div class="method">
+ <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
+ <pre>Creates a context. If the specified context already exists, overrides the context.
Args:
- parent: string, Required. The session to create a context for.
-Format: `projects/<Project ID>/agent/sessions/<Session ID>` or
-`projects/<Project ID>/agent/environments/<Environment ID>/users/<User
-ID>/sessions/<Session ID>`.
-If `Environment ID` is not specified, we assume default 'draft'
-environment. If `User ID` is not specified, we assume default '-' user. (required)
+ parent: string, Required. The session to create a context for. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. (required)
body: object, The request body.
The object takes the form of:
-{ # 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](https://cloud.google.com/dialogflow/docs/contexts-overview).
- "parameters": { # 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: string or number, depending on parameter value type
- # - MapValue value:
- # - If parameter's entity type is a composite entity:
- # map from composite entity property names to property values
- # - Else: parameter value
+{ # 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](https://cloud.google.com/dialogflow/docs/contexts-overview).
+ "lifespanCount": 42, # 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": { # 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: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value
"a_key": "", # Properties of the object.
},
- "name": "A 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`
- "lifespanCount": 42, # 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.
+ "name": "A String", # Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. 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`
}
x__xgafv: string, V1 error format.
@@ -172,59 +126,12 @@
Returns:
An object of the form:
- { # 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](https://cloud.google.com/dialogflow/docs/contexts-overview).
- "parameters": { # 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: string or number, depending on parameter value type
- # - MapValue value:
- # - If parameter's entity type is a composite entity:
- # map from composite entity property names to property values
- # - Else: parameter value
+ { # 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](https://cloud.google.com/dialogflow/docs/contexts-overview).
+ "lifespanCount": 42, # 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": { # 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: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value
"a_key": "", # Properties of the object.
},
- "name": "A 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`
- "lifespanCount": 42, # 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.
+ "name": "A String", # Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. 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`
}</pre>
</div>
@@ -233,12 +140,7 @@
<pre>Deletes the specified context.
Args:
- name: string, Required. The name of the context to delete. 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>`.
-If `Environment ID` is not specified, we assume default 'draft'
-environment. If `User ID` is not specified, we assume default '-' user. (required)
+ name: string, Required. The name of the context to delete. Format: `projects//agent/sessions//contexts/` or `projects//agent/environments//users//sessions//contexts/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -247,15 +149,7 @@
Returns:
An object of the form:
- { # A generic empty message that you can re-use to avoid defining duplicated
- # empty messages in your APIs. A typical example is to use it as the request
- # or the response type of an API method. For instance:
- #
- # service Foo {
- # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
- # }
- #
- # The JSON representation for `Empty` is empty JSON object `{}`.
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>
@@ -264,12 +158,7 @@
<pre>Retrieves the specified context.
Args:
- name: string, Required. The name 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>`.
-If `Environment ID` is not specified, we assume default 'draft'
-environment. If `User ID` is not specified, we assume default '-' user. (required)
+ name: string, Required. The name of the context. Format: `projects//agent/sessions//contexts/` or `projects//agent/environments//users//sessions//contexts/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -278,59 +167,12 @@
Returns:
An object of the form:
- { # 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](https://cloud.google.com/dialogflow/docs/contexts-overview).
- "parameters": { # 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: string or number, depending on parameter value type
- # - MapValue value:
- # - If parameter's entity type is a composite entity:
- # map from composite entity property names to property values
- # - Else: parameter value
+ { # 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](https://cloud.google.com/dialogflow/docs/contexts-overview).
+ "lifespanCount": 42, # 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": { # 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: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value
"a_key": "", # Properties of the object.
},
- "name": "A 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`
- "lifespanCount": 42, # 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.
+ "name": "A String", # Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. 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`
}</pre>
</div>
@@ -339,14 +181,8 @@
<pre>Returns the list of all contexts in the specified session.
Args:
- parent: string, Required. The session to list all contexts from.
-Format: `projects/<Project ID>/agent/sessions/<Session ID>` or
-`projects/<Project ID>/agent/environments/<Environment ID>/users/<User
-ID>/sessions/<Session ID>`.
-If `Environment ID` is not specified, we assume default 'draft'
-environment. If `User ID` is not specified, we assume default '-' user. (required)
- pageSize: integer, Optional. The maximum number of items to return in a single page. By
-default 100 and at most 1000.
+ parent: string, Required. The session to list all contexts from. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. (required)
+ pageSize: integer, Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
pageToken: string, Optional. The next_page_token value returned from a previous list request.
x__xgafv: string, V1 error format.
Allowed values
@@ -357,65 +193,16 @@
An object of the form:
{ # The response message for Contexts.ListContexts.
- "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
- # more results in the list.
- "contexts": [ # The list of contexts. There will be a maximum number of items
- # returned based on the page_size field in the request.
- { # 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](https://cloud.google.com/dialogflow/docs/contexts-overview).
- "parameters": { # 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: string or number, depending on parameter value type
- # - MapValue value:
- # - If parameter's entity type is a composite entity:
- # map from composite entity property names to property values
- # - Else: parameter value
+ "contexts": [ # The list of contexts. There will be a maximum number of items returned based on the page_size field in the request.
+ { # 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](https://cloud.google.com/dialogflow/docs/contexts-overview).
+ "lifespanCount": 42, # 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": { # 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: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value
"a_key": "", # Properties of the object.
},
- "name": "A 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`
- "lifespanCount": 42, # 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.
+ "name": "A String", # Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. 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`
},
],
+ "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
}</pre>
</div>
@@ -438,79 +225,16 @@
<pre>Updates the specified context.
Args:
- 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` (required)
+ name: string, Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. 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` (required)
body: object, The request body.
The object takes the form of:
-{ # 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](https://cloud.google.com/dialogflow/docs/contexts-overview).
- "parameters": { # 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: string or number, depending on parameter value type
- # - MapValue value:
- # - If parameter's entity type is a composite entity:
- # map from composite entity property names to property values
- # - Else: parameter value
+{ # 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](https://cloud.google.com/dialogflow/docs/contexts-overview).
+ "lifespanCount": 42, # 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": { # 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: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value
"a_key": "", # Properties of the object.
},
- "name": "A 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`
- "lifespanCount": 42, # 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.
+ "name": "A String", # Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. 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`
}
updateMask: string, Optional. The mask to control which fields get updated.
@@ -522,59 +246,12 @@
Returns:
An object of the form:
- { # 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](https://cloud.google.com/dialogflow/docs/contexts-overview).
- "parameters": { # 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: string or number, depending on parameter value type
- # - MapValue value:
- # - If parameter's entity type is a composite entity:
- # map from composite entity property names to property values
- # - Else: parameter value
+ { # 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](https://cloud.google.com/dialogflow/docs/contexts-overview).
+ "lifespanCount": 42, # 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": { # 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: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value
"a_key": "", # Properties of the object.
},
- "name": "A 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`
- "lifespanCount": 42, # 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.
+ "name": "A String", # Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. 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`
}</pre>
</div>