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_v3beta1.html">Dialogflow API</a> . <a href="dialogflow_v3beta1.projects.html">projects</a> . <a href="dialogflow_v3beta1.projects.locations.html">locations</a> . <a href="dialogflow_v3beta1.projects.locations.agents.html">agents</a> . <a href="dialogflow_v3beta1.projects.locations.agents.flows.html">flows</a> . <a href="dialogflow_v3beta1.projects.locations.agents.flows.versions.html">versions</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#compareVersions">compareVersions(baseVersion, body=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Compares the specified base version with target version.</p> 83<p class="toc_element"> 84 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Creates a Version in the specified Flow. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: CreateVersionOperationMetadata - `response`: Version</p> 86<p class="toc_element"> 87 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 88<p class="firstline">Deletes the specified Version.</p> 89<p class="toc_element"> 90 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 91<p class="firstline">Retrieves the specified Version.</p> 92<p class="toc_element"> 93 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Returns the list of all versions in the specified Flow.</p> 95<p class="toc_element"> 96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 97<p class="firstline">Retrieves the next page of results.</p> 98<p class="toc_element"> 99 <code><a href="#load">load(name, body=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Loads resources in the specified version to the draft flow. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). 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)</p> 101<p class="toc_element"> 102 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 103<p class="firstline">Updates the specified Version.</p> 104<h3>Method Details</h3> 105<div class="method"> 106 <code class="details" id="close">close()</code> 107 <pre>Close httplib2 connections.</pre> 108</div> 109 110<div class="method"> 111 <code class="details" id="compareVersions">compareVersions(baseVersion, body=None, x__xgafv=None)</code> 112 <pre>Compares the specified base version with target version. 113 114Args: 115 baseVersion: string, Required. Name of the base flow version to compare with the target version. Use version ID `0` to indicate the draft version of the specified flow. Format: `projects//locations//agents/ /flows//versions/`. (required) 116 body: object, The request body. 117 The object takes the form of: 118 119{ # The request message for Versions.CompareVersions. 120 "languageCode": "A String", # The language to compare the flow versions for. 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. 121 "targetVersion": "A String", # Required. Name of the target flow version to compare with the base version. Use version ID `0` to indicate the draft version of the specified flow. Format: `projects//locations//agents//flows//versions/`. 122} 123 124 x__xgafv: string, V1 error format. 125 Allowed values 126 1 - v1 error format 127 2 - v2 error format 128 129Returns: 130 An object of the form: 131 132 { # The response message for Versions.CompareVersions. 133 "baseVersionContentJson": "A String", # JSON representation of the base version content. 134 "compareTime": "A String", # The timestamp when the two version compares. 135 "targetVersionContentJson": "A String", # JSON representation of the target version content. 136}</pre> 137</div> 138 139<div class="method"> 140 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 141 <pre>Creates a Version in the specified Flow. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: CreateVersionOperationMetadata - `response`: Version 142 143Args: 144 parent: string, Required. The Flow to create an Version for. Format: `projects//locations//agents//flows/`. (required) 145 body: object, The request body. 146 The object takes the form of: 147 148{ # Represents a version of a flow. 149 "createTime": "A String", # Output only. Create time of the version. 150 "description": "A String", # The description of the version. The maximum length is 500 characters. If exceeded, the request is rejected. 151 "displayName": "A String", # Required. The human-readable name of the version. Limit of 64 characters. 152 "name": "A String", # Format: projects//locations//agents//flows//versions/. Version ID is a self-increasing number generated by Dialogflow upon version creation. 153 "nluSettings": { # Settings related to NLU. # Output only. The NLU settings of the flow at version creation. 154 "classificationThreshold": 3.14, # 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 no-match event 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. 155 "modelTrainingMode": "A String", # Indicates NLU model training mode. 156 "modelType": "A String", # Indicates the type of NLU model. 157 }, 158 "state": "A String", # Output only. The state of this version. This field is read-only and cannot be set by create and update methods. 159} 160 161 x__xgafv: string, V1 error format. 162 Allowed values 163 1 - v1 error format 164 2 - v2 error format 165 166Returns: 167 An object of the form: 168 169 { # This resource represents a long-running operation that is the result of a network API call. 170 "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. 171 "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. 172 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 173 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 174 { 175 "a_key": "", # Properties of the object. Contains field @type with type URL. 176 }, 177 ], 178 "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. 179 }, 180 "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. 181 "a_key": "", # Properties of the object. Contains field @type with type URL. 182 }, 183 "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}`. 184 "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`. 185 "a_key": "", # Properties of the object. Contains field @type with type URL. 186 }, 187}</pre> 188</div> 189 190<div class="method"> 191 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 192 <pre>Deletes the specified Version. 193 194Args: 195 name: string, Required. The name of the Version to delete. Format: `projects//locations//agents//flows//versions/`. (required) 196 x__xgafv: string, V1 error format. 197 Allowed values 198 1 - v1 error format 199 2 - v2 error format 200 201Returns: 202 An object of the form: 203 204 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 205}</pre> 206</div> 207 208<div class="method"> 209 <code class="details" id="get">get(name, x__xgafv=None)</code> 210 <pre>Retrieves the specified Version. 211 212Args: 213 name: string, Required. The name of the Version. Format: `projects//locations//agents//flows//versions/`. (required) 214 x__xgafv: string, V1 error format. 215 Allowed values 216 1 - v1 error format 217 2 - v2 error format 218 219Returns: 220 An object of the form: 221 222 { # Represents a version of a flow. 223 "createTime": "A String", # Output only. Create time of the version. 224 "description": "A String", # The description of the version. The maximum length is 500 characters. If exceeded, the request is rejected. 225 "displayName": "A String", # Required. The human-readable name of the version. Limit of 64 characters. 226 "name": "A String", # Format: projects//locations//agents//flows//versions/. Version ID is a self-increasing number generated by Dialogflow upon version creation. 227 "nluSettings": { # Settings related to NLU. # Output only. The NLU settings of the flow at version creation. 228 "classificationThreshold": 3.14, # 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 no-match event 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. 229 "modelTrainingMode": "A String", # Indicates NLU model training mode. 230 "modelType": "A String", # Indicates the type of NLU model. 231 }, 232 "state": "A String", # Output only. The state of this version. This field is read-only and cannot be set by create and update methods. 233}</pre> 234</div> 235 236<div class="method"> 237 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> 238 <pre>Returns the list of all versions in the specified Flow. 239 240Args: 241 parent: string, Required. The Flow to list all versions for. Format: `projects//locations//agents//flows/`. (required) 242 pageSize: integer, The maximum number of items to return in a single page. By default 20 and at most 100. 243 pageToken: string, The next_page_token value returned from a previous list request. 244 x__xgafv: string, V1 error format. 245 Allowed values 246 1 - v1 error format 247 2 - v2 error format 248 249Returns: 250 An object of the form: 251 252 { # The response message for Versions.ListVersions. 253 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list. 254 "versions": [ # A list of versions. There will be a maximum number of items returned based on the page_size field in the request. The list may in some cases be empty or contain fewer entries than page_size even if this isn't the last page. 255 { # Represents a version of a flow. 256 "createTime": "A String", # Output only. Create time of the version. 257 "description": "A String", # The description of the version. The maximum length is 500 characters. If exceeded, the request is rejected. 258 "displayName": "A String", # Required. The human-readable name of the version. Limit of 64 characters. 259 "name": "A String", # Format: projects//locations//agents//flows//versions/. Version ID is a self-increasing number generated by Dialogflow upon version creation. 260 "nluSettings": { # Settings related to NLU. # Output only. The NLU settings of the flow at version creation. 261 "classificationThreshold": 3.14, # 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 no-match event 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. 262 "modelTrainingMode": "A String", # Indicates NLU model training mode. 263 "modelType": "A String", # Indicates the type of NLU model. 264 }, 265 "state": "A String", # Output only. The state of this version. This field is read-only and cannot be set by create and update methods. 266 }, 267 ], 268}</pre> 269</div> 270 271<div class="method"> 272 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 273 <pre>Retrieves the next page of results. 274 275Args: 276 previous_request: The request for the previous page. (required) 277 previous_response: The response from the request for the previous page. (required) 278 279Returns: 280 A request object that you can call 'execute()' on to request the next 281 page. Returns None if there are no more items in the collection. 282 </pre> 283</div> 284 285<div class="method"> 286 <code class="details" id="load">load(name, body=None, x__xgafv=None)</code> 287 <pre>Loads resources in the specified version to the draft flow. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). 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) 288 289Args: 290 name: string, Required. The Version to be loaded to draft flow. Format: `projects//locations//agents//flows//versions/`. (required) 291 body: object, The request body. 292 The object takes the form of: 293 294{ # The request message for Versions.LoadVersion. 295 "allowOverrideAgentResources": True or False, # This field is used to prevent accidental overwrite of other agent resources, which can potentially impact other flow's behavior. If `allow_override_agent_resources` is false, conflicted agent-level resources will not be overridden (i.e. intents, entities, webhooks). 296} 297 298 x__xgafv: string, V1 error format. 299 Allowed values 300 1 - v1 error format 301 2 - v2 error format 302 303Returns: 304 An object of the form: 305 306 { # This resource represents a long-running operation that is the result of a network API call. 307 "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. 308 "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. 309 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 310 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 311 { 312 "a_key": "", # Properties of the object. Contains field @type with type URL. 313 }, 314 ], 315 "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. 316 }, 317 "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. 318 "a_key": "", # Properties of the object. Contains field @type with type URL. 319 }, 320 "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}`. 321 "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`. 322 "a_key": "", # Properties of the object. Contains field @type with type URL. 323 }, 324}</pre> 325</div> 326 327<div class="method"> 328 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 329 <pre>Updates the specified Version. 330 331Args: 332 name: string, Format: projects//locations//agents//flows//versions/. Version ID is a self-increasing number generated by Dialogflow upon version creation. (required) 333 body: object, The request body. 334 The object takes the form of: 335 336{ # Represents a version of a flow. 337 "createTime": "A String", # Output only. Create time of the version. 338 "description": "A String", # The description of the version. The maximum length is 500 characters. If exceeded, the request is rejected. 339 "displayName": "A String", # Required. The human-readable name of the version. Limit of 64 characters. 340 "name": "A String", # Format: projects//locations//agents//flows//versions/. Version ID is a self-increasing number generated by Dialogflow upon version creation. 341 "nluSettings": { # Settings related to NLU. # Output only. The NLU settings of the flow at version creation. 342 "classificationThreshold": 3.14, # 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 no-match event 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. 343 "modelTrainingMode": "A String", # Indicates NLU model training mode. 344 "modelType": "A String", # Indicates the type of NLU model. 345 }, 346 "state": "A String", # Output only. The state of this version. This field is read-only and cannot be set by create and update methods. 347} 348 349 updateMask: string, Required. The mask to control which fields get updated. Currently only `description` and `display_name` can be updated. 350 x__xgafv: string, V1 error format. 351 Allowed values 352 1 - v1 error format 353 2 - v2 error format 354 355Returns: 356 An object of the form: 357 358 { # Represents a version of a flow. 359 "createTime": "A String", # Output only. Create time of the version. 360 "description": "A String", # The description of the version. The maximum length is 500 characters. If exceeded, the request is rejected. 361 "displayName": "A String", # Required. The human-readable name of the version. Limit of 64 characters. 362 "name": "A String", # Format: projects//locations//agents//flows//versions/. Version ID is a self-increasing number generated by Dialogflow upon version creation. 363 "nluSettings": { # Settings related to NLU. # Output only. The NLU settings of the flow at version creation. 364 "classificationThreshold": 3.14, # 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 no-match event 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. 365 "modelTrainingMode": "A String", # Indicates NLU model training mode. 366 "modelType": "A String", # Indicates the type of NLU model. 367 }, 368 "state": "A String", # Output only. The state of this version. This field is read-only and cannot be set by create and update methods. 369}</pre> 370</div> 371 372</body></html>