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"> 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"> 108 <code><a href="#close">close()</a></code></p> 109<p class="firstline">Close httplib2 connections.</p> 110<p class="toc_element"> 111 <code><a href="#export">export(parent, body=None, x__xgafv=None)</a></code></p> 112<p class="firstline">Exports the specified agent to a ZIP file. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: ExportAgentResponse</p> 113<p class="toc_element"> 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> 118<p class="firstline">Gets agent validation result. Agent validation is performed during training time and is updated automatically when training is completed.</p> 119<p class="toc_element"> 120 <code><a href="#import_">import_(parent, body=None, x__xgafv=None)</a></code></p> 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. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) The operation only tracks when importing is complete, not when it is done training. Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training).</p> 122<p class="toc_element"> 123 <code><a href="#restore">restore(parent, body=None, x__xgafv=None)</a></code></p> 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. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) The operation only tracks when restoring is complete, not when it is done training. Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training).</p> 125<p class="toc_element"> 126 <code><a href="#search">search(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 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> 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> 133<p class="firstline">Trains the specified agent. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training).</p> 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> 137<h3>Method Details</h3> 138<div class="method"> 139 <code class="details" id="close">close()</code> 140 <pre>Close httplib2 connections.</pre> 141</div> 142 143<div class="method"> 144 <code class="details" id="export">export(parent, body=None, x__xgafv=None)</code> 145 <pre>Exports the specified agent to a ZIP file. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: ExportAgentResponse 146 147Args: 148 parent: string, Required. The project that the agent to export is associated with. Format: `projects/` or `projects//locations/`. (required) 149 body: object, The request body. 150 The object takes the form of: 151 152{ # The request message for Agents.ExportAgent. 153 "agentUri": "A String", # 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} 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 164 { # This resource represents a long-running operation that is the result of a network API call. 165 "done": 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 "error": { # 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 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 168 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 169 { 170 "a_key": "", # Properties of the object. Contains field @type with type URL. 171 }, 172 ], 173 "message": "A String", # 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 "metadata": { # 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 "a_key": "", # Properties of the object. Contains field @type with type URL. 177 }, 178 "name": "A String", # 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 "response": { # 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 "a_key": "", # Properties of the object. Contains field @type with type URL. 181 }, 182}</pre> 183</div> 184 185<div class="method"> 186 <code class="details" id="getFulfillment">getFulfillment(name, x__xgafv=None)</code> 187 <pre>Retrieves the fulfillment. 188 189Args: 190 name: string, Required. The name of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` (required) 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 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). 200 "displayName": "A String", # The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment. 201 "enabled": True or False, # Whether fulfillment is enabled. 202 "features": [ # The field defines whether the fulfillment is enabled for certain features. 203 { # Whether fulfillment is enabled for the specific feature. 204 "type": "A String", # The type of the feature that enabled for fulfillment. 205 }, 206 ], 207 "genericWebService": { # 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. 208 "isCloudFunction": 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. 209 "password": "A String", # The password for HTTP Basic authentication. 210 "requestHeaders": { # The HTTP request headers to send together with fulfillment requests. 211 "a_key": "A String", 212 }, 213 "uri": "A String", # Required. The fulfillment URI for receiving POST requests. It must use https protocol. 214 "username": "A String", # The user name for HTTP Basic authentication. 215 }, 216 "name": "A 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. 217}</pre> 218</div> 219 220<div class="method"> 221 <code class="details" id="getValidationResult">getValidationResult(parent, languageCode=None, x__xgafv=None)</code> 222 <pre>Gets agent validation result. Agent validation is performed during training time and is updated automatically when training is completed. 223 224Args: 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'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. 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. 236 "validationErrors": [ # Contains all validation errors. 237 { # Represents a single validation error. 238 "entries": [ # The names of the entries that the error is associated with. Format: - "projects//agent", if the error is associated with the entire agent. - "projects//agent/intents/", if the error is associated with certain intents. - "projects//agent/intents//trainingPhrases/", if the error is associated with certain intent training phrases. - "projects//agent/intents//parameters/", if the error is associated with certain intent parameters. - "projects//agent/entities/", if the error is associated with certain entities. 239 "A String", 240 ], 241 "errorMessage": "A String", # The detailed error message. 242 "severity": "A String", # The severity of the error. 243 }, 244 ], 245}</pre> 246</div> 247 248<div class="method"> 249 <code class="details" id="import_">import_(parent, body=None, x__xgafv=None)</code> 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. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) The operation only tracks when importing is complete, not when it is done training. Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training). 251 252Args: 253 parent: string, Required. The project that the agent to import is associated with. Format: `projects/` or `projects//locations/`. (required) 254 body: object, The request body. 255 The object takes the form of: 256 257{ # The request message for Agents.ImportAgent. 258 "agentContent": "A String", # Zip compressed raw byte content for agent. 259 "agentUri": "A String", # The URI to a Google Cloud Storage file containing the agent to import. Note: The URI must start with "gs://". 260} 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 270 { # This resource represents a long-running operation that is the result of a network API call. 271 "done": 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 "error": { # 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 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 274 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 275 { 276 "a_key": "", # Properties of the object. Contains field @type with type URL. 277 }, 278 ], 279 "message": "A String", # 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 "metadata": { # 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 "a_key": "", # Properties of the object. Contains field @type with type URL. 283 }, 284 "name": "A String", # 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 "response": { # 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 "a_key": "", # Properties of the object. Contains field @type with type URL. 287 }, 288}</pre> 289</div> 290 291<div class="method"> 292 <code class="details" id="restore">restore(parent, body=None, x__xgafv=None)</code> 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. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) The operation only tracks when restoring is complete, not when it is done training. Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training). 294 295Args: 296 parent: string, Required. The project that the agent to restore is associated with. Format: `projects/` or `projects//locations/`. (required) 297 body: object, The request body. 298 The object takes the form of: 299 300{ # The request message for Agents.RestoreAgent. 301 "agentContent": "A String", # Zip compressed raw byte content for agent. 302 "agentUri": "A String", # The URI to a Google Cloud Storage file containing the agent to restore. Note: The URI must start with "gs://". 303} 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 313 { # This resource represents a long-running operation that is the result of a network API call. 314 "done": 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 "error": { # 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 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 317 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 318 { 319 "a_key": "", # Properties of the object. Contains field @type with type URL. 320 }, 321 ], 322 "message": "A String", # 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 "metadata": { # 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 "a_key": "", # Properties of the object. Contains field @type with type URL. 326 }, 327 "name": "A String", # 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 "response": { # 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 "a_key": "", # Properties of the object. Contains field @type with type URL. 330 }, 331}</pre> 332</div> 333 334<div class="method"> 335 <code class="details" id="search">search(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> 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 "-". Refer to [List Sub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-collections). 337 338Args: 339 parent: string, Required. The project to list agents from. Format: `projects/` or `projects//locations/`. (required) 340 pageSize: integer, Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. 341 pageToken: string, Optional. The next_page_token value returned from a previous list request. 342 x__xgafv: string, V1 error format. 343 Allowed values 344 1 - v1 error format 345 2 - v2 error format 346 347Returns: 348 An object of the form: 349 350 { # The response message for Agents.SearchAgents. 351 "agents": [ # 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 "apiVersion": "A String", # 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 "avatarUri": "A String", # Optional. The URI of the agent'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 "classificationThreshold": 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 "defaultLanguageCode": "A String", # 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 "description": "A String", # Optional. The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected. 358 "displayName": "A String", # Required. The name of this agent. 359 "enableLogging": True or False, # Optional. Determines whether this agent should log conversation queries. 360 "matchMode": "A String", # Optional. Determines how intents are detected from user queries. 361 "parent": "A String", # Required. The project of this agent. Format: `projects/` or `projects//locations/` 362 "supportedLanguageCodes": [ # Optional. The list of all languages supported by this agent (except for the `default_language_code`). 363 "A String", 364 ], 365 "tier": "A String", # Optional. The agent tier. If not specified, TIER_STANDARD is assumed. 366 "timeZone": "A String", # 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 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list. 370}</pre> 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: 382 A request object that you can call 'execute()' on to request the next 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> 389 <pre>Trains the specified agent. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training). 390 391Args: 392 parent: string, Required. The project that the agent to train is associated with. Format: `projects/` or `projects//locations/`. (required) 393 body: object, The request body. 394 The object takes the form of: 395 396{ # The request message for Agents.TrainAgent. 397} 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 407 { # This resource represents a long-running operation that is the result of a network API call. 408 "done": 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 "error": { # 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 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 411 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 412 { 413 "a_key": "", # Properties of the object. Contains field @type with type URL. 414 }, 415 ], 416 "message": "A String", # 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 "metadata": { # 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 "a_key": "", # Properties of the object. Contains field @type with type URL. 420 }, 421 "name": "A String", # 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 "response": { # 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 "a_key": "", # Properties of the object. Contains field @type with type URL. 424 }, 425}</pre> 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: 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) 434 body: object, The request body. 435 The object takes the form of: 436 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). 438 "displayName": "A String", # The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment. 439 "enabled": True or False, # Whether fulfillment is enabled. 440 "features": [ # The field defines whether the fulfillment is enabled for certain features. 441 { # Whether fulfillment is enabled for the specific feature. 442 "type": "A String", # The type of the feature that enabled for fulfillment. 443 }, 444 ], 445 "genericWebService": { # 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. 446 "isCloudFunction": 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. 447 "password": "A String", # The password for HTTP Basic authentication. 448 "requestHeaders": { # The HTTP request headers to send together with fulfillment requests. 449 "a_key": "A String", 450 }, 451 "uri": "A String", # Required. The fulfillment URI for receiving POST requests. It must use https protocol. 452 "username": "A String", # The user name for HTTP Basic authentication. 453 }, 454 "name": "A 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. 455} 456 457 updateMask: string, Required. The mask to control which fields get updated. If the mask is not present, all fields will be updated. 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 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). 467 "displayName": "A String", # The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment. 468 "enabled": True or False, # Whether fulfillment is enabled. 469 "features": [ # The field defines whether the fulfillment is enabled for certain features. 470 { # Whether fulfillment is enabled for the specific feature. 471 "type": "A String", # The type of the feature that enabled for fulfillment. 472 }, 473 ], 474 "genericWebService": { # 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. 475 "isCloudFunction": 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. 476 "password": "A String", # The password for HTTP Basic authentication. 477 "requestHeaders": { # The HTTP request headers to send together with fulfillment requests. 478 "a_key": "A String", 479 }, 480 "uri": "A String", # Required. The fulfillment URI for receiving POST requests. It must use https protocol. 481 "username": "A String", # The user name for HTTP Basic authentication. 482 }, 483 "name": "A 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. 484}</pre> 485</div> 486 487</body></html>