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