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