Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d059ad881c7ae58c67931c48788d0bd7343ab16c / . / docs / dyn / dialogflow_v2beta1.projects.agent.html
blob: d5a23426042132824575935c1b8f9fd75b7cb93f [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></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="dialogflow_v2beta1.projects.agent.entityTypes.html">entityTypes()</a></code>
79</p>
80<p class="firstline">Returns the entityTypes Resource.</p>
81
82<p class="toc_element">
83 <code><a href="dialogflow_v2beta1.projects.agent.environments.html">environments()</a></code>
84</p>
85<p class="firstline">Returns the environments Resource.</p>
86
87<p class="toc_element">
88 <code><a href="dialogflow_v2beta1.projects.agent.intents.html">intents()</a></code>
89</p>
90<p class="firstline">Returns the intents Resource.</p>
91
92<p class="toc_element">
93 <code><a href="dialogflow_v2beta1.projects.agent.knowledgeBases.html">knowledgeBases()</a></code>
94</p>
95<p class="firstline">Returns the knowledgeBases Resource.</p>
96
97<p class="toc_element">
98 <code><a href="dialogflow_v2beta1.projects.agent.sessions.html">sessions()</a></code>
99</p>
100<p class="firstline">Returns the sessions Resource.</p>
101
102<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]103 <code><a href="#export">export(parent, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]104<p class="firstline">Exports the specified agent to a ZIP file.</p>
105<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]106 <code><a href="#getFulfillment">getFulfillment(name, x__xgafv=None)</a></code></p>
107<p class="firstline">Retrieves the fulfillment.</p>
108<p class="toc_element">
109 <code><a href="#getValidationResult">getValidationResult(parent, languageCode=None, x__xgafv=None)</a></code></p>
110<p class="firstline">Gets agent validation result. Agent validation is performed during</p>
111<p class="toc_element">
112 <code><a href="#import_">import_(parent, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]113<p class="firstline">Imports the specified agent from a ZIP file.</p>
114<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]115 <code><a href="#restore">restore(parent, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]116<p class="firstline">Restores the specified agent from a ZIP file.</p>
117<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]118 <code><a href="#search">search(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]119<p class="firstline">Returns the list of agents.</p>
120<p class="toc_element">
121 <code><a href="#search_next">search_next(previous_request, previous_response)</a></code></p>
122<p class="firstline">Retrieves the next page of results.</p>
123<p class="toc_element">
124 <code><a href="#train">train(parent, body=None, x__xgafv=None)</a></code></p>
125<p class="firstline">Trains the specified agent.</p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]126<p class="toc_element">
127 <code><a href="#updateFulfillment">updateFulfillment(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
128<p class="firstline">Updates the fulfillment.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]129<h3>Method Details</h3>
130<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]131 <code class="details" id="export">export(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]132 <pre>Exports the specified agent to a ZIP file.
133
134
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]135Operation &lt;response: ExportAgentResponse&gt;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]136
137Args:
138 parent: string, Required. The project that the agent to export is associated with.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]139Format: `projects/&lt;Project ID&gt;`. (required)
140 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]141 The object takes the form of:
142
143{ # The request message for Agents.ExportAgent.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]144 &quot;agentUri&quot;: &quot;A String&quot;, # Optional. The
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]145 # [Google Cloud Storage](https://cloud.google.com/storage/docs/)
146 # URI to export the agent to.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]147 # The format of this URI must be `gs://&lt;bucket-name&gt;/&lt;object-name&gt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]148 # If left unspecified, the serialized agent is returned inline.
149 }
150
151 x__xgafv: string, V1 error format.
152 Allowed values
153 1 - v1 error format
154 2 - v2 error format
155
156Returns:
157 An object of the form:
158
159 { # This resource represents a long-running operation that is the result of a
160 # network API call.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]161 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
162 # originally returns it. If you use the default HTTP mapping, the
163 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]164 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]165 # method returns no data on success, such as `Delete`, the response is
166 # `google.protobuf.Empty`. If the original method is standard
167 # `Get`/`Create`/`Update`, the response should be the resource. For other
168 # methods, the response should have the type `XxxResponse`, where `Xxx`
169 # is the original method name. For example, if the original method name
170 # is `TakeSnapshot()`, the inferred response type is
171 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]172 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]173 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]174 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
175 # If `true`, the operation is completed, and either `error` or `response` is
176 # available.
177 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
178 # different programming environments, including REST APIs and RPC APIs. It is
179 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
180 # three pieces of data: error code, error message, and error details.
181 #
182 # You can find out more about this error model and how to work with it in the
183 # [API Design Guide](https://cloud.google.com/apis/design/errors).
184 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
185 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
186 # message types for APIs to use.
187 {
188 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
189 },
190 ],
191 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
192 # user-facing error message should be localized and sent in the
193 # google.rpc.Status.details field, or localized by the client.
194 },
195 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
196 # contains progress information and common metadata such as create time.
197 # Some services might not provide such metadata. Any method that returns a
198 # long-running operation should document the metadata type, if any.
199 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
200 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]201 }</pre>
202</div>
203
204<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]205 <code class="details" id="getFulfillment">getFulfillment(name, x__xgafv=None)</code>
206 <pre>Retrieves the fulfillment.
207
208Args:
209 name: string, Required. The name of the fulfillment.
210Format: `projects/&lt;Project ID&gt;/agent/fulfillment`. (required)
211 x__xgafv: string, V1 error format.
212 Allowed values
213 1 - v1 error format
214 2 - v2 error format
215
216Returns:
217 An object of the form:
218
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]219 { # By default, your agent responds to a matched intent with a static response.
220 # As an alternative, you can provide a more dynamic response by using
221 # fulfillment. When you enable fulfillment for an intent, Dialogflow responds
222 # to that intent by calling a service that you define. For example, if an
223 # end-user wants to schedule a haircut on Friday, your service can check your
224 # database and respond to the end-user with availability information for
225 # Friday.
226 #
227 # For more information, see the [fulfillment
228 # guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]229 &quot;features&quot;: [ # Optional. The field defines whether the fulfillment is enabled for certain features.
230 { # Whether fulfillment is enabled for the specific feature.
231 &quot;type&quot;: &quot;A String&quot;, # The type of the feature that enabled for fulfillment.
232 },
233 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]234 &quot;displayName&quot;: &quot;A String&quot;, # Optional. The human-readable name of the fulfillment, unique within the agent.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]235 &quot;genericWebService&quot;: { # Represents configuration for a generic web service. # Configuration for a generic web service.
236 # Dialogflow supports two mechanisms for authentications:
237 # - Basic authentication with username and password.
238 # - Authentication with additional authentication headers.
239 # More information could be found at:
240 # https://cloud.google.com/dialogflow/docs/fulfillment-configure.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]241 &quot;requestHeaders&quot;: { # Optional. The HTTP request headers to send together with fulfillment requests.
242 &quot;a_key&quot;: &quot;A String&quot;,
243 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]244 &quot;uri&quot;: &quot;A String&quot;, # Required. The fulfillment URI for receiving POST requests.
245 # It must use https protocol.
246 &quot;isCloudFunction&quot;: True or False, # Optional. Indicates if generic web service is created through Cloud Functions
247 # integration. Defaults to false.
248 &quot;username&quot;: &quot;A String&quot;, # Optional. The user name for HTTP Basic authentication.
249 &quot;password&quot;: &quot;A String&quot;, # Optional. The password for HTTP Basic authentication.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]250 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]251 &quot;enabled&quot;: True or False, # Optional. Whether fulfillment is enabled.
252 &quot;name&quot;: &quot;A String&quot;, # Required. The unique identifier of the fulfillment.
253 # Format: `projects/&lt;Project ID&gt;/agent/fulfillment`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]254 }</pre>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]255</div>
256
257<div class="method">
258 <code class="details" id="getValidationResult">getValidationResult(parent, languageCode=None, x__xgafv=None)</code>
259 <pre>Gets agent validation result. Agent validation is performed during
260training time and is updated automatically when training is completed.
261
262Args:
263 parent: string, Required. The project that the agent is associated with.
264Format: `projects/&lt;Project ID&gt;`. (required)
265 languageCode: string, Optional. The language for which you want a validation result. If not
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]266specified, the agent&#x27;s default language is used. [Many
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]267languages](https://cloud.google.com/dialogflow/docs/reference/language)
268are supported. Note: languages must be enabled in the agent before they can
269be used.
270 x__xgafv: string, V1 error format.
271 Allowed values
272 1 - v1 error format
273 2 - v2 error format
274
275Returns:
276 An object of the form:
277
278 { # Represents the output of agent validation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]279 &quot;validationErrors&quot;: [ # Contains all validation errors.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]280 { # Represents a single validation error.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]281 &quot;severity&quot;: &quot;A String&quot;, # The severity of the error.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]282 &quot;entries&quot;: [ # The names of the entries that the error is associated with.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]283 # Format:
284 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]285 # - &quot;projects/&lt;Project ID&gt;/agent&quot;, if the error is associated with the entire
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]286 # agent.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]287 # - &quot;projects/&lt;Project ID&gt;/agent/intents/&lt;Intent ID&gt;&quot;, if the error is
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]288 # associated with certain intents.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]289 # - &quot;projects/&lt;Project
290 # ID&gt;/agent/intents/&lt;Intent Id&gt;/trainingPhrases/&lt;Training Phrase ID&gt;&quot;, if the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]291 # error is associated with certain intent training phrases.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]292 # - &quot;projects/&lt;Project ID&gt;/agent/intents/&lt;Intent Id&gt;/parameters/&lt;Parameter
293 # ID&gt;&quot;, if the error is associated with certain intent parameters.
294 # - &quot;projects/&lt;Project ID&gt;/agent/entities/&lt;Entity ID&gt;&quot;, if the error is
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]295 # associated with certain entities.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]296 &quot;A String&quot;,
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]297 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]298 &quot;errorMessage&quot;: &quot;A String&quot;, # The detailed error messsage.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]299 },
300 ],
301 }</pre>
302</div>
303
304<div class="method">
305 <code class="details" id="import_">import_(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]306 <pre>Imports the specified agent from a ZIP file.
307
308Uploads new intents and entity types without deleting the existing ones.
309Intents and entity types with the same name are replaced with the new
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]310versions from ImportAgentRequest. After the import, the imported draft
311agent will be trained automatically (unless disabled in agent settings).
312However, once the import is done, training may not be completed yet. Please
313call TrainAgent and wait for the operation it returns in order to train
314explicitly.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]315
316
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]317Operation &lt;response: google.protobuf.Empty&gt;
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]318An operation which tracks when importing is complete. It only tracks
319when the draft agent is updated not when it is done training.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]320
321Args:
322 parent: string, Required. The project that the agent to import is associated with.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]323Format: `projects/&lt;Project ID&gt;`. (required)
324 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]325 The object takes the form of:
326
327{ # The request message for Agents.ImportAgent.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]328 &quot;agentContent&quot;: &quot;A String&quot;, # Zip compressed raw byte content for agent.
329 &quot;agentUri&quot;: &quot;A String&quot;, # The URI to a Google Cloud Storage file containing the agent to import.
330 # Note: The URI must start with &quot;gs://&quot;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]331 }
332
333 x__xgafv: string, V1 error format.
334 Allowed values
335 1 - v1 error format
336 2 - v2 error format
337
338Returns:
339 An object of the form:
340
341 { # This resource represents a long-running operation that is the result of a
342 # network API call.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]343 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
344 # originally returns it. If you use the default HTTP mapping, the
345 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]346 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]347 # method returns no data on success, such as `Delete`, the response is
348 # `google.protobuf.Empty`. If the original method is standard
349 # `Get`/`Create`/`Update`, the response should be the resource. For other
350 # methods, the response should have the type `XxxResponse`, where `Xxx`
351 # is the original method name. For example, if the original method name
352 # is `TakeSnapshot()`, the inferred response type is
353 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]354 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]355 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]356 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
357 # If `true`, the operation is completed, and either `error` or `response` is
358 # available.
359 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
360 # different programming environments, including REST APIs and RPC APIs. It is
361 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
362 # three pieces of data: error code, error message, and error details.
363 #
364 # You can find out more about this error model and how to work with it in the
365 # [API Design Guide](https://cloud.google.com/apis/design/errors).
366 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
367 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
368 # message types for APIs to use.
369 {
370 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
371 },
372 ],
373 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
374 # user-facing error message should be localized and sent in the
375 # google.rpc.Status.details field, or localized by the client.
376 },
377 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
378 # contains progress information and common metadata such as create time.
379 # Some services might not provide such metadata. Any method that returns a
380 # long-running operation should document the metadata type, if any.
381 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
382 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]383 }</pre>
384</div>
385
386<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]387 <code class="details" id="restore">restore(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]388 <pre>Restores the specified agent from a ZIP file.
389
390Replaces the current agent version with a new one. All the intents and
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]391entity types in the older version are deleted. After the restore, the
392restored draft agent will be trained automatically (unless disabled in
393agent settings). However, once the restore is done, training may not be
394completed yet. Please call TrainAgent and wait for the operation it
395returns in order to train explicitly.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]396
397
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]398Operation &lt;response: google.protobuf.Empty&gt;
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]399An operation which tracks when restoring is complete. It only tracks
400when the draft agent is updated not when it is done training.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]401
402Args:
403 parent: string, Required. The project that the agent to restore is associated with.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]404Format: `projects/&lt;Project ID&gt;`. (required)
405 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]406 The object takes the form of:
407
408{ # The request message for Agents.RestoreAgent.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]409 &quot;agentContent&quot;: &quot;A String&quot;, # Zip compressed raw byte content for agent.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]410 &quot;agentUri&quot;: &quot;A String&quot;, # The URI to a Google Cloud Storage file containing the agent to restore.
411 # Note: The URI must start with &quot;gs://&quot;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]412 }
413
414 x__xgafv: string, V1 error format.
415 Allowed values
416 1 - v1 error format
417 2 - v2 error format
418
419Returns:
420 An object of the form:
421
422 { # This resource represents a long-running operation that is the result of a
423 # network API call.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]424 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
425 # originally returns it. If you use the default HTTP mapping, the
426 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]427 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]428 # method returns no data on success, such as `Delete`, the response is
429 # `google.protobuf.Empty`. If the original method is standard
430 # `Get`/`Create`/`Update`, the response should be the resource. For other
431 # methods, the response should have the type `XxxResponse`, where `Xxx`
432 # is the original method name. For example, if the original method name
433 # is `TakeSnapshot()`, the inferred response type is
434 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]435 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]436 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]437 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
438 # If `true`, the operation is completed, and either `error` or `response` is
439 # available.
440 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
441 # different programming environments, including REST APIs and RPC APIs. It is
442 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
443 # three pieces of data: error code, error message, and error details.
444 #
445 # You can find out more about this error model and how to work with it in the
446 # [API Design Guide](https://cloud.google.com/apis/design/errors).
447 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
448 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
449 # message types for APIs to use.
450 {
451 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
452 },
453 ],
454 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
455 # user-facing error message should be localized and sent in the
456 # google.rpc.Status.details field, or localized by the client.
457 },
458 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
459 # contains progress information and common metadata such as create time.
460 # Some services might not provide such metadata. Any method that returns a
461 # long-running operation should document the metadata type, if any.
462 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
463 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]464 }</pre>
465</div>
466
467<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]468 <code class="details" id="search">search(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]469 <pre>Returns the list of agents.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]470Since there is at most one conversational agent per project, this method is
471useful primarily for listing all agents across projects the caller has
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]472access to. One can achieve that with a wildcard project collection id &quot;-&quot;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]473Refer to [List
474Sub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-collections).
475
476Args:
477 parent: string, Required. The project to list agents from.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]478Format: `projects/&lt;Project ID or &#x27;-&#x27;&gt;`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]479 pageSize: integer, Optional. The maximum number of items to return in a single page. By
480default 100 and at most 1000.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]481 pageToken: string, Optional. The next_page_token value returned from a previous list request.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]482 x__xgafv: string, V1 error format.
483 Allowed values
484 1 - v1 error format
485 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]486
487Returns:
488 An object of the form:
489
490 { # The response message for Agents.SearchAgents.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]491 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no
492 # more results in the list.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]493 &quot;agents&quot;: [ # The list of agents. There will be a maximum number of items returned based
494 # on the page_size field in the request.
495 { # A Dialogflow agent is a virtual agent that handles conversations with your
496 # end-users. It is a natural language understanding module that understands the
497 # nuances of human language. Dialogflow translates end-user text or audio
498 # during a conversation to structured data that your apps and services can
499 # understand. You design and build a Dialogflow agent to handle the types of
500 # conversations required for your system.
501 #
502 # For more information about agents, see the
503 # [Agent guide](https://cloud.google.com/dialogflow/docs/agents-overview).
504 &quot;displayName&quot;: &quot;A String&quot;, # Required. The name of this agent.
505 &quot;timeZone&quot;: &quot;A String&quot;, # Required. The time zone of this agent from the
506 # [time zone database](https://www.iana.org/time-zones), e.g.,
507 # America/New_York, Europe/Paris.
508 &quot;parent&quot;: &quot;A String&quot;, # Required. The project of this agent.
509 # Format: `projects/&lt;Project ID&gt;`.
510 &quot;classificationThreshold&quot;: 3.14, # Optional. To filter out false positive results and still get variety in
511 # matched natural language inputs for your agent, you can tune the machine
512 # learning classification threshold. If the returned score value is less than
513 # the threshold value, then a fallback intent will be triggered or, if there
514 # are no fallback intents defined, no intent will be triggered. The score
515 # values range from 0.0 (completely uncertain) to 1.0 (completely certain).
516 # If set to 0.0, the default of 0.3 is used.
517 &quot;defaultLanguageCode&quot;: &quot;A String&quot;, # Required. The default language of the agent as a language tag. See
518 # [Language
519 # Support](https://cloud.google.com/dialogflow/docs/reference/language)
520 # for a list of the currently supported language codes. This field cannot be
521 # set by the `Update` method.
522 &quot;enableLogging&quot;: True or False, # Optional. Determines whether this agent should log conversation queries.
523 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of this agent.
524 # The maximum length is 500 characters. If exceeded, the request is rejected.
525 &quot;apiVersion&quot;: &quot;A String&quot;, # Optional. API version displayed in Dialogflow console. If not specified,
526 # V2 API is assumed. Clients are free to query different service endpoints
527 # for different API versions. However, bots connectors and webhook calls will
528 # follow the specified API version.
529 &quot;tier&quot;: &quot;A String&quot;, # Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
530 &quot;avatarUri&quot;: &quot;A String&quot;, # Optional. The URI of the agent&#x27;s avatar.
531 # Avatars are used throughout the Dialogflow console and in the self-hosted
532 # [Web
533 # Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo)
534 # integration.
535 &quot;matchMode&quot;: &quot;A String&quot;, # Optional. Determines how intents are detected from user queries.
536 &quot;supportedLanguageCodes&quot;: [ # Optional. The list of all languages supported by this agent (except for the
537 # `default_language_code`).
538 &quot;A String&quot;,
539 ],
540 },
541 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]542 }</pre>
543</div>
544
545<div class="method">
546 <code class="details" id="search_next">search_next(previous_request, previous_response)</code>
547 <pre>Retrieves the next page of results.
548
549Args:
550 previous_request: The request for the previous page. (required)
551 previous_response: The response from the request for the previous page. (required)
552
553Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]554 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]555 page. Returns None if there are no more items in the collection.
556 </pre>
557</div>
558
559<div class="method">
560 <code class="details" id="train">train(parent, body=None, x__xgafv=None)</code>
561 <pre>Trains the specified agent.
562
563
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]564Operation &lt;response: google.protobuf.Empty&gt;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]565
566Args:
567 parent: string, Required. The project that the agent to train is associated with.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]568Format: `projects/&lt;Project ID&gt;`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]569 body: object, The request body.
570 The object takes the form of:
571
572{ # The request message for Agents.TrainAgent.
573 }
574
575 x__xgafv: string, V1 error format.
576 Allowed values
577 1 - v1 error format
578 2 - v2 error format
579
580Returns:
581 An object of the form:
582
583 { # This resource represents a long-running operation that is the result of a
584 # network API call.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]585 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
586 # originally returns it. If you use the default HTTP mapping, the
587 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]588 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]589 # method returns no data on success, such as `Delete`, the response is
590 # `google.protobuf.Empty`. If the original method is standard
591 # `Get`/`Create`/`Update`, the response should be the resource. For other
592 # methods, the response should have the type `XxxResponse`, where `Xxx`
593 # is the original method name. For example, if the original method name
594 # is `TakeSnapshot()`, the inferred response type is
595 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]596 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]597 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]598 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
599 # If `true`, the operation is completed, and either `error` or `response` is
600 # available.
601 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
602 # different programming environments, including REST APIs and RPC APIs. It is
603 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
604 # three pieces of data: error code, error message, and error details.
605 #
606 # You can find out more about this error model and how to work with it in the
607 # [API Design Guide](https://cloud.google.com/apis/design/errors).
608 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
609 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
610 # message types for APIs to use.
611 {
612 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
613 },
614 ],
615 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
616 # user-facing error message should be localized and sent in the
617 # google.rpc.Status.details field, or localized by the client.
618 },
619 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
620 # contains progress information and common metadata such as create time.
621 # Some services might not provide such metadata. Any method that returns a
622 # long-running operation should document the metadata type, if any.
623 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
624 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]625 }</pre>
626</div>
627
628<div class="method">
629 <code class="details" id="updateFulfillment">updateFulfillment(name, body=None, updateMask=None, x__xgafv=None)</code>
630 <pre>Updates the fulfillment.
631
632Args:
633 name: string, Required. The unique identifier of the fulfillment.
634Format: `projects/&lt;Project ID&gt;/agent/fulfillment`. (required)
635 body: object, The request body.
636 The object takes the form of:
637
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]638{ # By default, your agent responds to a matched intent with a static response.
639 # As an alternative, you can provide a more dynamic response by using
640 # fulfillment. When you enable fulfillment for an intent, Dialogflow responds
641 # to that intent by calling a service that you define. For example, if an
642 # end-user wants to schedule a haircut on Friday, your service can check your
643 # database and respond to the end-user with availability information for
644 # Friday.
645 #
646 # For more information, see the [fulfillment
647 # guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]648 &quot;features&quot;: [ # Optional. The field defines whether the fulfillment is enabled for certain features.
649 { # Whether fulfillment is enabled for the specific feature.
650 &quot;type&quot;: &quot;A String&quot;, # The type of the feature that enabled for fulfillment.
651 },
652 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]653 &quot;displayName&quot;: &quot;A String&quot;, # Optional. The human-readable name of the fulfillment, unique within the agent.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]654 &quot;genericWebService&quot;: { # Represents configuration for a generic web service. # Configuration for a generic web service.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]655 # Dialogflow supports two mechanisms for authentications:
656 # - Basic authentication with username and password.
657 # - Authentication with additional authentication headers.
658 # More information could be found at:
659 # https://cloud.google.com/dialogflow/docs/fulfillment-configure.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]660 &quot;requestHeaders&quot;: { # Optional. The HTTP request headers to send together with fulfillment requests.
661 &quot;a_key&quot;: &quot;A String&quot;,
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]662 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]663 &quot;uri&quot;: &quot;A String&quot;, # Required. The fulfillment URI for receiving POST requests.
664 # It must use https protocol.
665 &quot;isCloudFunction&quot;: True or False, # Optional. Indicates if generic web service is created through Cloud Functions
666 # integration. Defaults to false.
667 &quot;username&quot;: &quot;A String&quot;, # Optional. The user name for HTTP Basic authentication.
668 &quot;password&quot;: &quot;A String&quot;, # Optional. The password for HTTP Basic authentication.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]669 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]670 &quot;enabled&quot;: True or False, # Optional. Whether fulfillment is enabled.
671 &quot;name&quot;: &quot;A String&quot;, # Required. The unique identifier of the fulfillment.
672 # Format: `projects/&lt;Project ID&gt;/agent/fulfillment`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]673 }
674
675 updateMask: string, Required. The mask to control which fields get updated. If the mask is not
676present, all fields will be updated.
677 x__xgafv: string, V1 error format.
678 Allowed values
679 1 - v1 error format
680 2 - v2 error format
681
682Returns:
683 An object of the form:
684
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]685 { # By default, your agent responds to a matched intent with a static response.
686 # As an alternative, you can provide a more dynamic response by using
687 # fulfillment. When you enable fulfillment for an intent, Dialogflow responds
688 # to that intent by calling a service that you define. For example, if an
689 # end-user wants to schedule a haircut on Friday, your service can check your
690 # database and respond to the end-user with availability information for
691 # Friday.
692 #
693 # For more information, see the [fulfillment
694 # guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]695 &quot;features&quot;: [ # Optional. The field defines whether the fulfillment is enabled for certain features.
696 { # Whether fulfillment is enabled for the specific feature.
697 &quot;type&quot;: &quot;A String&quot;, # The type of the feature that enabled for fulfillment.
698 },
699 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]700 &quot;displayName&quot;: &quot;A String&quot;, # Optional. The human-readable name of the fulfillment, unique within the agent.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]701 &quot;genericWebService&quot;: { # Represents configuration for a generic web service. # Configuration for a generic web service.
702 # Dialogflow supports two mechanisms for authentications:
703 # - Basic authentication with username and password.
704 # - Authentication with additional authentication headers.
705 # More information could be found at:
706 # https://cloud.google.com/dialogflow/docs/fulfillment-configure.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]707 &quot;requestHeaders&quot;: { # Optional. The HTTP request headers to send together with fulfillment requests.
708 &quot;a_key&quot;: &quot;A String&quot;,
709 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]710 &quot;uri&quot;: &quot;A String&quot;, # Required. The fulfillment URI for receiving POST requests.
711 # It must use https protocol.
712 &quot;isCloudFunction&quot;: True or False, # Optional. Indicates if generic web service is created through Cloud Functions
713 # integration. Defaults to false.
714 &quot;username&quot;: &quot;A String&quot;, # Optional. The user name for HTTP Basic authentication.
715 &quot;password&quot;: &quot;A String&quot;, # Optional. The password for HTTP Basic authentication.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]716 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]717 &quot;enabled&quot;: True or False, # Optional. Whether fulfillment is enabled.
718 &quot;name&quot;: &quot;A String&quot;, # Required. The unique identifier of the fulfillment.
719 # Format: `projects/&lt;Project ID&gt;/agent/fulfillment`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]720 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]721</div>
722
723</body></html>