File: dialogflow_v2beta1.projects.agent.environments.users.sessions.contexts.html

package info (click to toggle)
python-googleapi 1.7.11-4
  • links: PTS
  • area: main
  • in suites: bullseye
  • size: 110,952 kB
  • sloc: python: 7,784; javascript: 249; makefile: 59; sh: 53; xml: 5
file content (382 lines) | stat: -rw-r--r-- 15,456 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<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>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#create">create(parent, body, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a 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>
<p class="toc_element">
  <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, pageSize=None, pageToken=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>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#patch">patch(name, body, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the specified context.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="create">create(parent, body, 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)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a context.
  "parameters": { # Optional. The collection of parameters associated with this context.
      # Refer to [this
      # doc](https://cloud.google.com/dialogflow-enterprise/docs/intents-actions-parameters)
      # for syntax.
    "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.
  "lifespanCount": 42, # Optional. The number of conversational query requests after which the
      # context expires. If set to `0` (the default) the context expires
      # immediately. Contexts expire automatically after 20 minutes if there
      # are no matching queries.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a context.
    "parameters": { # Optional. The collection of parameters associated with this context.
        # Refer to [this
        # doc](https://cloud.google.com/dialogflow-enterprise/docs/intents-actions-parameters)
        # for syntax.
      "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.
    "lifespanCount": 42, # Optional. The number of conversational query requests after which the
        # context expires. If set to `0` (the default) 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="delete">delete(name, x__xgafv=None)</code>
  <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)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

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 `{}`.
  }</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <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)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a context.
    "parameters": { # Optional. The collection of parameters associated with this context.
        # Refer to [this
        # doc](https://cloud.google.com/dialogflow-enterprise/docs/intents-actions-parameters)
        # for syntax.
      "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.
    "lifespanCount": 42, # Optional. The number of conversational query requests after which the
        # context expires. If set to `0` (the default) 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, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <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.
  pageToken: string, Optional. The next_page_token value returned from a previous list request.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  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.
      { # Represents a context.
        "parameters": { # Optional. The collection of parameters associated with this context.
            # Refer to [this
            # doc](https://cloud.google.com/dialogflow-enterprise/docs/intents-actions-parameters)
            # for syntax.
          "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.
        "lifespanCount": 42, # Optional. The number of conversational query requests after which the
            # context expires. If set to `0` (the default) 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_next">list_next(previous_request, previous_response)</code>
  <pre>Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  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
  page. Returns None if there are no more items in the collection.
    </pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(name, body, updateMask=None, x__xgafv=None)</code>
  <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. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a context.
  "parameters": { # Optional. The collection of parameters associated with this context.
      # Refer to [this
      # doc](https://cloud.google.com/dialogflow-enterprise/docs/intents-actions-parameters)
      # for syntax.
    "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.
  "lifespanCount": 42, # Optional. The number of conversational query requests after which the
      # context expires. If set to `0` (the default) 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.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a context.
    "parameters": { # Optional. The collection of parameters associated with this context.
        # Refer to [this
        # doc](https://cloud.google.com/dialogflow-enterprise/docs/intents-actions-parameters)
        # for syntax.
      "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.
    "lifespanCount": 42, # Optional. The number of conversational query requests after which the
        # context expires. If set to `0` (the default) the context expires
        # immediately. Contexts expire automatically after 20 minutes if there
        # are no matching queries.
  }</pre>
</div>

</body></html>