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