Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f80be181200f4aae910badec3f4bddea08ae5044 / . / docs / dyn / dialogflow_v2beta1.projects.agent.environments.users.sessions.contexts.html
blob: 3acd38fbdf206cfe9ce2037e2e06ade68d64e613 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="dialogflow_v2beta1.html">Dialogflow API</a> . <a href="dialogflow_v2beta1.projects.html">projects</a> . <a href="dialogflow_v2beta1.projects.agent.html">agent</a> . <a href="dialogflow_v2beta1.projects.agent.environments.html">environments</a> . <a href="dialogflow_v2beta1.projects.agent.environments.users.html">users</a> . <a href="dialogflow_v2beta1.projects.agent.environments.users.sessions.html">sessions</a> . <a href="dialogflow_v2beta1.projects.agent.environments.users.sessions.contexts.html">contexts</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]78 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">Creates a context.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes the specified context.</p>
83<p class="toc_element">
84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Retrieves the specified context.</p>
86<p class="toc_element">
87 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Returns the list of all contexts in the specified session.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]93 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]94<p class="firstline">Updates the specified context.</p>
95<h3>Method Details</h3>
96<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]97 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]98 <pre>Creates a context.
99
100If the specified context already exists, overrides the context.
101
102Args:
103 parent: string, Required. The session to create a context for.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]104Format: `projects/&lt;Project ID&gt;/agent/sessions/&lt;Session ID&gt;` or
105`projects/&lt;Project ID&gt;/agent/environments/&lt;Environment ID&gt;/users/&lt;User
106ID&gt;/sessions/&lt;Session ID&gt;`. If `Environment ID` is not specified, we assume
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]107default 'draft' environment. If `User ID` is not specified, we assume
108default '-' user. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]109 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]110 The object takes the form of:
111
112{ # Represents a context.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]113 "name": "A String", # Required. The unique identifier of the context. Format:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]114 # `projects/&lt;Project ID&gt;/agent/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`,
115 # or `projects/&lt;Project ID&gt;/agent/environments/&lt;Environment ID&gt;/users/&lt;User
116 # ID&gt;/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]117 #
118 # The `Context ID` is always converted to lowercase, may only contain
119 # characters in a-zA-Z0-9_-% and may be at most 250 bytes long.
120 #
121 # If `Environment ID` is not specified, we assume default 'draft'
122 # environment. If `User ID` is not specified, we assume default '-' user.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]123 #
124 # The following context names are reserved for internal use by Dialogflow.
125 # You should not use these contexts or create contexts with these names:
126 #
127 # * `__system_counters__`
128 # * `*_id_dialog_context`
129 # * `*_dialog_params_size`
130 "parameters": { # Optional. The collection of parameters associated with this context.
131 #
132 # Depending on your protocol or client library language, this is a
133 # map, associative array, symbol table, dictionary, or JSON object
134 # composed of a collection of (MapKey, MapValue) pairs:
135 #
136 # - MapKey type: string
137 # - MapKey value: parameter name
138 # - MapValue type:
139 # - If parameter's entity type is a composite entity: map
140 # - Else: string or number, depending on parameter value type
141 # - MapValue value:
142 # - If parameter's entity type is a composite entity:
143 # map from composite entity property names to property values
144 # - Else: parameter value
145 "a_key": "", # Properties of the object.
146 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]147 "lifespanCount": 42, # Optional. The number of conversational query requests after which the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]148 # context expires. The default is `0`. If set to `0`, the context expires
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]149 # immediately. Contexts expire automatically after 20 minutes if there
150 # are no matching queries.
151}
152
153 x__xgafv: string, V1 error format.
154 Allowed values
155 1 - v1 error format
156 2 - v2 error format
157
158Returns:
159 An object of the form:
160
161 { # Represents a context.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]162 "name": "A String", # Required. The unique identifier of the context. Format:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]163 # `projects/&lt;Project ID&gt;/agent/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`,
164 # or `projects/&lt;Project ID&gt;/agent/environments/&lt;Environment ID&gt;/users/&lt;User
165 # ID&gt;/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]166 #
167 # The `Context ID` is always converted to lowercase, may only contain
168 # characters in a-zA-Z0-9_-% and may be at most 250 bytes long.
169 #
170 # If `Environment ID` is not specified, we assume default 'draft'
171 # environment. If `User ID` is not specified, we assume default '-' user.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]172 #
173 # The following context names are reserved for internal use by Dialogflow.
174 # You should not use these contexts or create contexts with these names:
175 #
176 # * `__system_counters__`
177 # * `*_id_dialog_context`
178 # * `*_dialog_params_size`
179 "parameters": { # Optional. The collection of parameters associated with this context.
180 #
181 # Depending on your protocol or client library language, this is a
182 # map, associative array, symbol table, dictionary, or JSON object
183 # composed of a collection of (MapKey, MapValue) pairs:
184 #
185 # - MapKey type: string
186 # - MapKey value: parameter name
187 # - MapValue type:
188 # - If parameter's entity type is a composite entity: map
189 # - Else: string or number, depending on parameter value type
190 # - MapValue value:
191 # - If parameter's entity type is a composite entity:
192 # map from composite entity property names to property values
193 # - Else: parameter value
194 "a_key": "", # Properties of the object.
195 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]196 "lifespanCount": 42, # Optional. The number of conversational query requests after which the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]197 # context expires. The default is `0`. If set to `0`, the context expires
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]198 # immediately. Contexts expire automatically after 20 minutes if there
199 # are no matching queries.
200 }</pre>
201</div>
202
203<div class="method">
204 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
205 <pre>Deletes the specified context.
206
207Args:
208 name: string, Required. The name of the context to delete. Format:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]209`projects/&lt;Project ID&gt;/agent/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`
210or `projects/&lt;Project ID&gt;/agent/environments/&lt;Environment ID&gt;/users/&lt;User
211ID&gt;/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`. If `Environment ID` is
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]212not specified, we assume default 'draft' environment. If `User ID` is not
213specified, we assume default '-' user. (required)
214 x__xgafv: string, V1 error format.
215 Allowed values
216 1 - v1 error format
217 2 - v2 error format
218
219Returns:
220 An object of the form:
221
222 { # A generic empty message that you can re-use to avoid defining duplicated
223 # empty messages in your APIs. A typical example is to use it as the request
224 # or the response type of an API method. For instance:
225 #
226 # service Foo {
227 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
228 # }
229 #
230 # The JSON representation for `Empty` is empty JSON object `{}`.
231 }</pre>
232</div>
233
234<div class="method">
235 <code class="details" id="get">get(name, x__xgafv=None)</code>
236 <pre>Retrieves the specified context.
237
238Args:
239 name: string, Required. The name of the context. Format:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]240`projects/&lt;Project ID&gt;/agent/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`
241or `projects/&lt;Project ID&gt;/agent/environments/&lt;Environment ID&gt;/users/&lt;User
242ID&gt;/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`. If `Environment ID` is
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]243not specified, we assume default 'draft' environment. If `User ID` is not
244specified, we assume default '-' user. (required)
245 x__xgafv: string, V1 error format.
246 Allowed values
247 1 - v1 error format
248 2 - v2 error format
249
250Returns:
251 An object of the form:
252
253 { # Represents a context.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]254 "name": "A String", # Required. The unique identifier of the context. Format:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]255 # `projects/&lt;Project ID&gt;/agent/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`,
256 # or `projects/&lt;Project ID&gt;/agent/environments/&lt;Environment ID&gt;/users/&lt;User
257 # ID&gt;/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]258 #
259 # The `Context ID` is always converted to lowercase, may only contain
260 # characters in a-zA-Z0-9_-% and may be at most 250 bytes long.
261 #
262 # If `Environment ID` is not specified, we assume default 'draft'
263 # environment. If `User ID` is not specified, we assume default '-' user.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]264 #
265 # The following context names are reserved for internal use by Dialogflow.
266 # You should not use these contexts or create contexts with these names:
267 #
268 # * `__system_counters__`
269 # * `*_id_dialog_context`
270 # * `*_dialog_params_size`
271 "parameters": { # Optional. The collection of parameters associated with this context.
272 #
273 # Depending on your protocol or client library language, this is a
274 # map, associative array, symbol table, dictionary, or JSON object
275 # composed of a collection of (MapKey, MapValue) pairs:
276 #
277 # - MapKey type: string
278 # - MapKey value: parameter name
279 # - MapValue type:
280 # - If parameter's entity type is a composite entity: map
281 # - Else: string or number, depending on parameter value type
282 # - MapValue value:
283 # - If parameter's entity type is a composite entity:
284 # map from composite entity property names to property values
285 # - Else: parameter value
286 "a_key": "", # Properties of the object.
287 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]288 "lifespanCount": 42, # Optional. The number of conversational query requests after which the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]289 # context expires. The default is `0`. If set to `0`, the context expires
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]290 # immediately. Contexts expire automatically after 20 minutes if there
291 # are no matching queries.
292 }</pre>
293</div>
294
295<div class="method">
296 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
297 <pre>Returns the list of all contexts in the specified session.
298
299Args:
300 parent: string, Required. The session to list all contexts from.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]301Format: `projects/&lt;Project ID&gt;/agent/sessions/&lt;Session ID&gt;` or
302`projects/&lt;Project ID&gt;/agent/environments/&lt;Environment ID&gt;/users/&lt;User
303ID&gt;/sessions/&lt;Session ID&gt;`. If `Environment ID` is not specified, we assume
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]304default 'draft' environment. If `User ID` is not specified, we assume
305default '-' user. (required)
306 pageSize: integer, Optional. The maximum number of items to return in a single page. By
307default 100 and at most 1000.
308 pageToken: string, Optional. The next_page_token value returned from a previous list request.
309 x__xgafv: string, V1 error format.
310 Allowed values
311 1 - v1 error format
312 2 - v2 error format
313
314Returns:
315 An object of the form:
316
317 { # The response message for Contexts.ListContexts.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]318 "contexts": [ # The list of contexts. There will be a maximum number of items
319 # returned based on the page_size field in the request.
320 { # Represents a context.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]321 "name": "A String", # Required. The unique identifier of the context. Format:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]322 # `projects/&lt;Project ID&gt;/agent/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`,
323 # or `projects/&lt;Project ID&gt;/agent/environments/&lt;Environment ID&gt;/users/&lt;User
324 # ID&gt;/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]325 #
326 # The `Context ID` is always converted to lowercase, may only contain
327 # characters in a-zA-Z0-9_-% and may be at most 250 bytes long.
328 #
329 # If `Environment ID` is not specified, we assume default 'draft'
330 # environment. If `User ID` is not specified, we assume default '-' user.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]331 #
332 # The following context names are reserved for internal use by Dialogflow.
333 # You should not use these contexts or create contexts with these names:
334 #
335 # * `__system_counters__`
336 # * `*_id_dialog_context`
337 # * `*_dialog_params_size`
338 "parameters": { # Optional. The collection of parameters associated with this context.
339 #
340 # Depending on your protocol or client library language, this is a
341 # map, associative array, symbol table, dictionary, or JSON object
342 # composed of a collection of (MapKey, MapValue) pairs:
343 #
344 # - MapKey type: string
345 # - MapKey value: parameter name
346 # - MapValue type:
347 # - If parameter's entity type is a composite entity: map
348 # - Else: string or number, depending on parameter value type
349 # - MapValue value:
350 # - If parameter's entity type is a composite entity:
351 # map from composite entity property names to property values
352 # - Else: parameter value
353 "a_key": "", # Properties of the object.
354 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]355 "lifespanCount": 42, # Optional. The number of conversational query requests after which the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]356 # context expires. The default is `0`. If set to `0`, the context expires
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]357 # immediately. Contexts expire automatically after 20 minutes if there
358 # are no matching queries.
359 },
360 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]361 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
362 # more results in the list.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]363 }</pre>
364</div>
365
366<div class="method">
367 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
368 <pre>Retrieves the next page of results.
369
370Args:
371 previous_request: The request for the previous page. (required)
372 previous_response: The response from the request for the previous page. (required)
373
374Returns:
375 A request object that you can call 'execute()' on to request the next
376 page. Returns None if there are no more items in the collection.
377 </pre>
378</div>
379
380<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]381 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]382 <pre>Updates the specified context.
383
384Args:
385 name: string, Required. The unique identifier of the context. Format:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]386`projects/&lt;Project ID&gt;/agent/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`,
387or `projects/&lt;Project ID&gt;/agent/environments/&lt;Environment ID&gt;/users/&lt;User
388ID&gt;/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]389
390The `Context ID` is always converted to lowercase, may only contain
391characters in a-zA-Z0-9_-% and may be at most 250 bytes long.
392
393If `Environment ID` is not specified, we assume default 'draft'
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]394environment. If `User ID` is not specified, we assume default '-' user.
395
396The following context names are reserved for internal use by Dialogflow.
397You should not use these contexts or create contexts with these names:
398
399* `__system_counters__`
400* `*_id_dialog_context`
401* `*_dialog_params_size` (required)
402 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]403 The object takes the form of:
404
405{ # Represents a context.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]406 "name": "A String", # Required. The unique identifier of the context. Format:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]407 # `projects/&lt;Project ID&gt;/agent/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`,
408 # or `projects/&lt;Project ID&gt;/agent/environments/&lt;Environment ID&gt;/users/&lt;User
409 # ID&gt;/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]410 #
411 # The `Context ID` is always converted to lowercase, may only contain
412 # characters in a-zA-Z0-9_-% and may be at most 250 bytes long.
413 #
414 # If `Environment ID` is not specified, we assume default 'draft'
415 # environment. If `User ID` is not specified, we assume default '-' user.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]416 #
417 # The following context names are reserved for internal use by Dialogflow.
418 # You should not use these contexts or create contexts with these names:
419 #
420 # * `__system_counters__`
421 # * `*_id_dialog_context`
422 # * `*_dialog_params_size`
423 "parameters": { # Optional. The collection of parameters associated with this context.
424 #
425 # Depending on your protocol or client library language, this is a
426 # map, associative array, symbol table, dictionary, or JSON object
427 # composed of a collection of (MapKey, MapValue) pairs:
428 #
429 # - MapKey type: string
430 # - MapKey value: parameter name
431 # - MapValue type:
432 # - If parameter's entity type is a composite entity: map
433 # - Else: string or number, depending on parameter value type
434 # - MapValue value:
435 # - If parameter's entity type is a composite entity:
436 # map from composite entity property names to property values
437 # - Else: parameter value
438 "a_key": "", # Properties of the object.
439 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]440 "lifespanCount": 42, # Optional. The number of conversational query requests after which the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]441 # context expires. The default is `0`. If set to `0`, the context expires
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]442 # immediately. Contexts expire automatically after 20 minutes if there
443 # are no matching queries.
444}
445
446 updateMask: string, Optional. The mask to control which fields get updated.
447 x__xgafv: string, V1 error format.
448 Allowed values
449 1 - v1 error format
450 2 - v2 error format
451
452Returns:
453 An object of the form:
454
455 { # Represents a context.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]456 "name": "A String", # Required. The unique identifier of the context. Format:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]457 # `projects/&lt;Project ID&gt;/agent/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`,
458 # or `projects/&lt;Project ID&gt;/agent/environments/&lt;Environment ID&gt;/users/&lt;User
459 # ID&gt;/sessions/&lt;Session ID&gt;/contexts/&lt;Context ID&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]460 #
461 # The `Context ID` is always converted to lowercase, may only contain
462 # characters in a-zA-Z0-9_-% and may be at most 250 bytes long.
463 #
464 # If `Environment ID` is not specified, we assume default 'draft'
465 # environment. If `User ID` is not specified, we assume default '-' user.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]466 #
467 # The following context names are reserved for internal use by Dialogflow.
468 # You should not use these contexts or create contexts with these names:
469 #
470 # * `__system_counters__`
471 # * `*_id_dialog_context`
472 # * `*_dialog_params_size`
473 "parameters": { # Optional. The collection of parameters associated with this context.
474 #
475 # Depending on your protocol or client library language, this is a
476 # map, associative array, symbol table, dictionary, or JSON object
477 # composed of a collection of (MapKey, MapValue) pairs:
478 #
479 # - MapKey type: string
480 # - MapKey value: parameter name
481 # - MapValue type:
482 # - If parameter's entity type is a composite entity: map
483 # - Else: string or number, depending on parameter value type
484 # - MapValue value:
485 # - If parameter's entity type is a composite entity:
486 # map from composite entity property names to property values
487 # - Else: parameter value
488 "a_key": "", # Properties of the object.
489 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]490 "lifespanCount": 42, # Optional. The number of conversational query requests after which the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]491 # context expires. The default is `0`. If set to `0`, the context expires
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]492 # immediately. Contexts expire automatically after 20 minutes if there
493 # are no matching queries.
494 }</pre>
495</div>
496
497</body></html>