Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 7700bbffda386345cc4426ef413fc643f6368ef4 / . / docs / dyn / dialogflow_v2beta1.projects.agent.html
blob: 18bf4e30f54c4cdf7fff824636b7489fc61c0365 [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">
yoshi-code-bot3dd15272021-04-21 15:07:48 -0700[diff] [blame]103 <code><a href="dialogflow_v2beta1.projects.agent.versions.html">versions()</a></code>
104</p>
105<p class="firstline">Returns the versions Resource.</p>
106
107<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]108 <code><a href="#close">close()</a></code></p>
109<p class="firstline">Close httplib2 connections.</p>
110<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]111 <code><a href="#export">export(parent, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]112<p class="firstline">Exports the specified agent to a ZIP file. Operation </p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]113<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]114 <code><a href="#getFulfillment">getFulfillment(name, x__xgafv=None)</a></code></p>
115<p class="firstline">Retrieves the fulfillment.</p>
116<p class="toc_element">
117 <code><a href="#getValidationResult">getValidationResult(parent, languageCode=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]118<p class="firstline">Gets agent validation result. Agent validation is performed during training time and is updated automatically when training is completed.</p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]119<p class="toc_element">
120 <code><a href="#import_">import_(parent, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]121<p class="firstline">Imports the specified agent from a ZIP file. Uploads new intents and entity types without deleting the existing ones. Intents and entity types with the same name are replaced with the new versions from ImportAgentRequest. After the import, the imported draft agent will be trained automatically (unless disabled in agent settings). However, once the import is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly. Operation An operation which tracks when importing is complete. It only tracks when the draft agent is updated not when it is done training.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]122<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]123 <code><a href="#restore">restore(parent, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]124<p class="firstline">Restores the specified agent from a ZIP file. Replaces the current agent version with a new one. All the intents and entity types in the older version are deleted. After the restore, the restored draft agent will be trained automatically (unless disabled in agent settings). However, once the restore is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly. Operation An operation which tracks when restoring is complete. It only tracks when the draft agent is updated not when it is done training.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]125<p class="toc_element">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]126 <code><a href="#search">search(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]127<p class="firstline">Returns the list of agents. Since there is at most one conversational agent per project, this method is useful primarily for listing all agents across projects the caller has access to. One can achieve that with a wildcard project collection id "-". Refer to [List Sub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-collections).</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]128<p class="toc_element">
129 <code><a href="#search_next">search_next(previous_request, previous_response)</a></code></p>
130<p class="firstline">Retrieves the next page of results.</p>
131<p class="toc_element">
132 <code><a href="#train">train(parent, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]133<p class="firstline">Trains the specified agent. Operation </p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]134<p class="toc_element">
135 <code><a href="#updateFulfillment">updateFulfillment(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
136<p class="firstline">Updates the fulfillment.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]137<h3>Method Details</h3>
138<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]139 <code class="details" id="close">close()</code>
140 <pre>Close httplib2 connections.</pre>
141</div>
142
143<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]144 <code class="details" id="export">export(parent, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]145 <pre>Exports the specified agent to a ZIP file. Operation
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]146
147Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]148 parent: string, Required. The project that the agent to export is associated with. Format: `projects/` or `projects//locations/`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]149 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]150 The object takes the form of:
151
152{ # The request message for Agents.ExportAgent.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]153 &quot;agentUri&quot;: &quot;A String&quot;, # Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to export the agent to. The format of this URI must be `gs:///`. If left unspecified, the serialized agent is returned inline.
154}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]155
156 x__xgafv: string, V1 error format.
157 Allowed values
158 1 - v1 error format
159 2 - v2 error format
160
161Returns:
162 An object of the form:
163
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]164 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]165 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
166 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
167 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
168 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
169 {
170 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
171 },
172 ],
173 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
174 },
175 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
176 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
177 },
178 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
179 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
180 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
181 },
182}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]183</div>
184
185<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]186 <code class="details" id="getFulfillment">getFulfillment(name, x__xgafv=None)</code>
187 <pre>Retrieves the fulfillment.
188
189Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]190 name: string, Required. The name of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]191 x__xgafv: string, V1 error format.
192 Allowed values
193 1 - v1 error format
194 2 - v2 error format
195
196Returns:
197 An object of the form:
198
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]199 { # By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview).
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]200 &quot;displayName&quot;: &quot;A String&quot;, # The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]201 &quot;enabled&quot;: True or False, # Whether fulfillment is enabled.
202 &quot;features&quot;: [ # The field defines whether the fulfillment is enabled for certain features.
203 { # Whether fulfillment is enabled for the specific feature.
204 &quot;type&quot;: &quot;A String&quot;, # The type of the feature that enabled for fulfillment.
205 },
206 ],
207 &quot;genericWebService&quot;: { # Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure. # Configuration for a generic web service.
yoshi-code-bot3dd15272021-04-21 15:07:48 -0700[diff] [blame]208 &quot;isCloudFunction&quot;: True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]209 &quot;password&quot;: &quot;A String&quot;, # The password for HTTP Basic authentication.
210 &quot;requestHeaders&quot;: { # The HTTP request headers to send together with fulfillment requests.
211 &quot;a_key&quot;: &quot;A String&quot;,
212 },
213 &quot;uri&quot;: &quot;A String&quot;, # Required. The fulfillment URI for receiving POST requests. It must use https protocol.
214 &quot;username&quot;: &quot;A String&quot;, # The user name for HTTP Basic authentication.
215 },
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]216 &quot;name&quot;: &quot;A String&quot;, # Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]217}</pre>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]218</div>
219
220<div class="method">
221 <code class="details" id="getValidationResult">getValidationResult(parent, languageCode=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]222 <pre>Gets agent validation result. Agent validation is performed during training time and is updated automatically when training is completed.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]223
224Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]225 parent: string, Required. The project that the agent is associated with. Format: `projects/` or `projects//locations/`. (required)
226 languageCode: string, Optional. The language for which you want a validation result. If not specified, the agent&#x27;s default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]227 x__xgafv: string, V1 error format.
228 Allowed values
229 1 - v1 error format
230 2 - v2 error format
231
232Returns:
233 An object of the form:
234
235 { # Represents the output of agent validation.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]236 &quot;validationErrors&quot;: [ # Contains all validation errors.
237 { # Represents a single validation error.
238 &quot;entries&quot;: [ # The names of the entries that the error is associated with. Format: - &quot;projects//agent&quot;, if the error is associated with the entire agent. - &quot;projects//agent/intents/&quot;, if the error is associated with certain intents. - &quot;projects//agent/intents//trainingPhrases/&quot;, if the error is associated with certain intent training phrases. - &quot;projects//agent/intents//parameters/&quot;, if the error is associated with certain intent parameters. - &quot;projects//agent/entities/&quot;, if the error is associated with certain entities.
239 &quot;A String&quot;,
240 ],
241 &quot;errorMessage&quot;: &quot;A String&quot;, # The detailed error messsage.
242 &quot;severity&quot;: &quot;A String&quot;, # The severity of the error.
243 },
244 ],
245}</pre>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]246</div>
247
248<div class="method">
249 <code class="details" id="import_">import_(parent, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]250 <pre>Imports the specified agent from a ZIP file. Uploads new intents and entity types without deleting the existing ones. Intents and entity types with the same name are replaced with the new versions from ImportAgentRequest. After the import, the imported draft agent will be trained automatically (unless disabled in agent settings). However, once the import is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly. Operation An operation which tracks when importing is complete. It only tracks when the draft agent is updated not when it is done training.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]251
252Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]253 parent: string, Required. The project that the agent to import is associated with. Format: `projects/` or `projects//locations/`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]254 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]255 The object takes the form of:
256
257{ # The request message for Agents.ImportAgent.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]258 &quot;agentContent&quot;: &quot;A String&quot;, # Zip compressed raw byte content for agent.
259 &quot;agentUri&quot;: &quot;A String&quot;, # The URI to a Google Cloud Storage file containing the agent to import. Note: The URI must start with &quot;gs://&quot;.
260}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]261
262 x__xgafv: string, V1 error format.
263 Allowed values
264 1 - v1 error format
265 2 - v2 error format
266
267Returns:
268 An object of the form:
269
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]270 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]271 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
272 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
273 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
274 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
275 {
276 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
277 },
278 ],
279 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
280 },
281 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
282 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
283 },
284 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
285 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
286 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
287 },
288}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]289</div>
290
291<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]292 <code class="details" id="restore">restore(parent, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]293 <pre>Restores the specified agent from a ZIP file. Replaces the current agent version with a new one. All the intents and entity types in the older version are deleted. After the restore, the restored draft agent will be trained automatically (unless disabled in agent settings). However, once the restore is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly. Operation An operation which tracks when restoring is complete. It only tracks when the draft agent is updated not when it is done training.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]294
295Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]296 parent: string, Required. The project that the agent to restore is associated with. Format: `projects/` or `projects//locations/`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]297 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]298 The object takes the form of:
299
300{ # The request message for Agents.RestoreAgent.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]301 &quot;agentContent&quot;: &quot;A String&quot;, # Zip compressed raw byte content for agent.
302 &quot;agentUri&quot;: &quot;A String&quot;, # The URI to a Google Cloud Storage file containing the agent to restore. Note: The URI must start with &quot;gs://&quot;.
303}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]304
305 x__xgafv: string, V1 error format.
306 Allowed values
307 1 - v1 error format
308 2 - v2 error format
309
310Returns:
311 An object of the form:
312
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]313 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]314 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
315 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
316 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
317 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
318 {
319 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
320 },
321 ],
322 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
323 },
324 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
325 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
326 },
327 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
328 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
329 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
330 },
331}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]332</div>
333
334<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]335 <code class="details" id="search">search(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]336 <pre>Returns the list of agents. Since there is at most one conversational agent per project, this method is useful primarily for listing all agents across projects the caller has access to. One can achieve that with a wildcard project collection id &quot;-&quot;. Refer to [List Sub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-collections).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]337
338Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]339 parent: string, Required. The project to list agents from. Format: `projects/` or `projects//locations/`. (required)
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]340 pageSize: integer, Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]341 pageToken: string, Optional. The next_page_token value returned from a previous list request.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]342 x__xgafv: string, V1 error format.
343 Allowed values
344 1 - v1 error format
345 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]346
347Returns:
348 An object of the form:
349
350 { # The response message for Agents.SearchAgents.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]351 &quot;agents&quot;: [ # The list of agents. There will be a maximum number of items returned based on the page_size field in the request.
352 { # A Dialogflow agent is a virtual agent that handles conversations with your end-users. It is a natural language understanding module that understands the nuances of human language. Dialogflow translates end-user text or audio during a conversation to structured data that your apps and services can understand. You design and build a Dialogflow agent to handle the types of conversations required for your system. For more information about agents, see the [Agent guide](https://cloud.google.com/dialogflow/docs/agents-overview).
353 &quot;apiVersion&quot;: &quot;A String&quot;, # Optional. API version displayed in Dialogflow console. If not specified, V2 API is assumed. Clients are free to query different service endpoints for different API versions. However, bots connectors and webhook calls will follow the specified API version.
354 &quot;avatarUri&quot;: &quot;A String&quot;, # Optional. The URI of the agent&#x27;s avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration.
355 &quot;classificationThreshold&quot;: 3.14, # Optional. To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a fallback intent will be triggered or, if there are no fallback intents defined, no intent will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used.
356 &quot;defaultLanguageCode&quot;: &quot;A String&quot;, # Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the `Update` method.
357 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
358 &quot;displayName&quot;: &quot;A String&quot;, # Required. The name of this agent.
359 &quot;enableLogging&quot;: True or False, # Optional. Determines whether this agent should log conversation queries.
360 &quot;matchMode&quot;: &quot;A String&quot;, # Optional. Determines how intents are detected from user queries.
361 &quot;parent&quot;: &quot;A String&quot;, # Required. The project of this agent. Format: `projects/` or `projects//locations/`
362 &quot;supportedLanguageCodes&quot;: [ # Optional. The list of all languages supported by this agent (except for the `default_language_code`).
363 &quot;A String&quot;,
364 ],
365 &quot;tier&quot;: &quot;A String&quot;, # Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
366 &quot;timeZone&quot;: &quot;A String&quot;, # Required. The time zone of this agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
367 },
368 ],
369 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more results in the list.
370}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]371</div>
372
373<div class="method">
374 <code class="details" id="search_next">search_next(previous_request, previous_response)</code>
375 <pre>Retrieves the next page of results.
376
377Args:
378 previous_request: The request for the previous page. (required)
379 previous_response: The response from the request for the previous page. (required)
380
381Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]382 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]383 page. Returns None if there are no more items in the collection.
384 </pre>
385</div>
386
387<div class="method">
388 <code class="details" id="train">train(parent, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]389 <pre>Trains the specified agent. Operation
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]390
391Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]392 parent: string, Required. The project that the agent to train is associated with. Format: `projects/` or `projects//locations/`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]393 body: object, The request body.
394 The object takes the form of:
395
396{ # The request message for Agents.TrainAgent.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]397}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]398
399 x__xgafv: string, V1 error format.
400 Allowed values
401 1 - v1 error format
402 2 - v2 error format
403
404Returns:
405 An object of the form:
406
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]407 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]408 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
409 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
410 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
411 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
412 {
413 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
414 },
415 ],
416 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
417 },
418 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
419 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
420 },
421 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
422 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
423 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
424 },
425}</pre>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]426</div>
427
428<div class="method">
429 <code class="details" id="updateFulfillment">updateFulfillment(name, body=None, updateMask=None, x__xgafv=None)</code>
430 <pre>Updates the fulfillment.
431
432Args:
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]433 name: string, Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]434 body: object, The request body.
435 The object takes the form of:
436
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]437{ # By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview).
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]438 &quot;displayName&quot;: &quot;A String&quot;, # The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]439 &quot;enabled&quot;: True or False, # Whether fulfillment is enabled.
440 &quot;features&quot;: [ # The field defines whether the fulfillment is enabled for certain features.
441 { # Whether fulfillment is enabled for the specific feature.
442 &quot;type&quot;: &quot;A String&quot;, # The type of the feature that enabled for fulfillment.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]443 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]444 ],
445 &quot;genericWebService&quot;: { # Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure. # Configuration for a generic web service.
yoshi-code-bot3dd15272021-04-21 15:07:48 -0700[diff] [blame]446 &quot;isCloudFunction&quot;: True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]447 &quot;password&quot;: &quot;A String&quot;, # The password for HTTP Basic authentication.
448 &quot;requestHeaders&quot;: { # The HTTP request headers to send together with fulfillment requests.
449 &quot;a_key&quot;: &quot;A String&quot;,
450 },
451 &quot;uri&quot;: &quot;A String&quot;, # Required. The fulfillment URI for receiving POST requests. It must use https protocol.
452 &quot;username&quot;: &quot;A String&quot;, # The user name for HTTP Basic authentication.
453 },
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]454 &quot;name&quot;: &quot;A String&quot;, # Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]455}
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]456
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]457 updateMask: string, Required. The mask to control which fields get updated. If the mask is not present, all fields will be updated.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]458 x__xgafv: string, V1 error format.
459 Allowed values
460 1 - v1 error format
461 2 - v2 error format
462
463Returns:
464 An object of the form:
465
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]466 { # By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview).
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]467 &quot;displayName&quot;: &quot;A String&quot;, # The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]468 &quot;enabled&quot;: True or False, # Whether fulfillment is enabled.
469 &quot;features&quot;: [ # The field defines whether the fulfillment is enabled for certain features.
470 { # Whether fulfillment is enabled for the specific feature.
471 &quot;type&quot;: &quot;A String&quot;, # The type of the feature that enabled for fulfillment.
472 },
473 ],
474 &quot;genericWebService&quot;: { # Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure. # Configuration for a generic web service.
yoshi-code-bot3dd15272021-04-21 15:07:48 -0700[diff] [blame]475 &quot;isCloudFunction&quot;: True or False, # Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]476 &quot;password&quot;: &quot;A String&quot;, # The password for HTTP Basic authentication.
477 &quot;requestHeaders&quot;: { # The HTTP request headers to send together with fulfillment requests.
478 &quot;a_key&quot;: &quot;A String&quot;,
479 },
480 &quot;uri&quot;: &quot;A String&quot;, # Required. The fulfillment URI for receiving POST requests. It must use https protocol.
481 &quot;username&quot;: &quot;A String&quot;, # The user name for HTTP Basic authentication.
482 },
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]483 &quot;name&quot;: &quot;A String&quot;, # Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]484}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]485</div>
486
487</body></html>