docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/dialogflow_v2.projects.agent.sessions.contexts.html b/docs/dyn/dialogflow_v2.projects.agent.sessions.contexts.html
index f7110fb..4586ab4 100644
--- a/docs/dyn/dialogflow_v2.projects.agent.sessions.contexts.html
+++ b/docs/dyn/dialogflow_v2.projects.agent.sessions.contexts.html
@@ -84,7 +84,7 @@
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves the specified context.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
+ <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the list of all contexts in the specified session.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -104,13 +104,17 @@
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)
+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:
{ # Represents a context.
- "name": "A String", # Required. The unique identifier of the context. Format:
+ "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/<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>`.
@@ -118,8 +122,8 @@
# 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.
+ # 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:
@@ -127,7 +131,7 @@
# * `__system_counters__`
# * `*_id_dialog_context`
# * `*_dialog_params_size`
- "parameters": { # Optional. The collection of parameters associated with this context.
+ "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
@@ -136,18 +140,14 @@
# - MapKey type: string
# - MapKey value: parameter name
# - MapValue type:
- # - If parameter's entity type is a composite entity: map
+ # - 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:
+ # - 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.
+ "a_key": "", # Properties of the object.
},
- "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.
}
x__xgafv: string, V1 error format.
@@ -159,7 +159,11 @@
An object of the form:
{ # Represents a context.
- "name": "A String", # Required. The unique identifier of the context. Format:
+ "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/<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>`.
@@ -167,8 +171,8 @@
# 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.
+ # 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:
@@ -176,7 +180,7 @@
# * `__system_counters__`
# * `*_id_dialog_context`
# * `*_dialog_params_size`
- "parameters": { # Optional. The collection of parameters associated with this context.
+ "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
@@ -185,18 +189,14 @@
# - MapKey type: string
# - MapKey value: parameter name
# - MapValue type:
- # - If parameter's entity type is a composite entity: map
+ # - 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:
+ # - 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.
+ "a_key": "", # Properties of the object.
},
- "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.
}</pre>
</div>
@@ -209,8 +209,8 @@
`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)
+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
@@ -240,8 +240,8 @@
`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)
+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
@@ -251,7 +251,11 @@
An object of the form:
{ # Represents a context.
- "name": "A String", # Required. The unique identifier of the context. Format:
+ "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/<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>`.
@@ -259,8 +263,8 @@
# 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.
+ # 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:
@@ -268,7 +272,7 @@
# * `__system_counters__`
# * `*_id_dialog_context`
# * `*_dialog_params_size`
- "parameters": { # Optional. The collection of parameters associated with this context.
+ "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
@@ -277,23 +281,19 @@
# - MapKey type: string
# - MapKey value: parameter name
# - MapValue type:
- # - If parameter's entity type is a composite entity: map
+ # - 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:
+ # - 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.
+ "a_key": "", # Properties of the object.
},
- "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.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code>
+ <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
<pre>Returns the list of all contexts in the specified session.
Args:
@@ -301,24 +301,30 @@
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)
+If `Environment ID` is not specified, we assume default 'draft'
+environment. If `User ID` is not specified, we assume default '-' user. (required)
pageToken: string, Optional. The next_page_token value returned from a previous list request.
+ pageSize: integer, Optional. The maximum number of items to return in a single page. By
+default 100 and at most 1000.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
- pageSize: integer, Optional. The maximum number of items to return in a single page. By
-default 100 and at most 1000.
Returns:
An object of the form:
{ # The response message for Contexts.ListContexts.
- "contexts": [ # The list of contexts. There will be a maximum number of items
+ "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.
{ # Represents a context.
- "name": "A String", # Required. The unique identifier of the context. Format:
+ "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/<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>`.
@@ -326,8 +332,8 @@
# 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.
+ # 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:
@@ -335,7 +341,7 @@
# * `__system_counters__`
# * `*_id_dialog_context`
# * `*_dialog_params_size`
- "parameters": { # Optional. The collection of parameters associated with this context.
+ "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
@@ -344,22 +350,16 @@
# - MapKey type: string
# - MapKey value: parameter name
# - MapValue type:
- # - If parameter's entity type is a composite entity: map
+ # - 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:
+ # - 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.
+ "a_key": "", # Properties of the object.
},
- "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.
},
],
- "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
- # more results in the list.
}</pre>
</div>
@@ -372,7 +372,7 @@
previous_response: The response from the request for the previous page. (required)
Returns:
- A request object that you can call 'execute()' on to request the next
+ A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
@@ -390,8 +390,8 @@
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.
+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:
@@ -403,7 +403,11 @@
The object takes the form of:
{ # Represents a context.
- "name": "A String", # Required. The unique identifier of the context. Format:
+ "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/<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>`.
@@ -411,8 +415,8 @@
# 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.
+ # 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:
@@ -420,7 +424,7 @@
# * `__system_counters__`
# * `*_id_dialog_context`
# * `*_dialog_params_size`
- "parameters": { # Optional. The collection of parameters associated with this context.
+ "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
@@ -429,18 +433,14 @@
# - MapKey type: string
# - MapKey value: parameter name
# - MapValue type:
- # - If parameter's entity type is a composite entity: map
+ # - 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:
+ # - 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.
+ "a_key": "", # Properties of the object.
},
- "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.
}
updateMask: string, Optional. The mask to control which fields get updated.
@@ -453,7 +453,11 @@
An object of the form:
{ # Represents a context.
- "name": "A String", # Required. The unique identifier of the context. Format:
+ "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/<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>`.
@@ -461,8 +465,8 @@
# 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.
+ # 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:
@@ -470,7 +474,7 @@
# * `__system_counters__`
# * `*_id_dialog_context`
# * `*_dialog_params_size`
- "parameters": { # Optional. The collection of parameters associated with this context.
+ "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
@@ -479,18 +483,14 @@
# - MapKey type: string
# - MapKey value: parameter name
# - MapValue type:
- # - If parameter's entity type is a composite entity: map
+ # - 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:
+ # - 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.
+ "a_key": "", # Properties of the object.
},
- "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.
}</pre>
</div>