google-apis-dialogflow_v3 0.20.0 → 0.24.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +16 -0
- data/OVERVIEW.md +2 -2
- data/lib/google/apis/dialogflow_v3/classes.rb +727 -18
- data/lib/google/apis/dialogflow_v3/gem_version.rb +2 -2
- data/lib/google/apis/dialogflow_v3/representations.rb +313 -0
- data/lib/google/apis/dialogflow_v3/service.rb +383 -24
- data/lib/google/apis/dialogflow_v3.rb +1 -1
- metadata +5 -5
@@ -50,6 +50,79 @@ module Google
|
|
50
50
|
@batch_path = 'batch'
|
51
51
|
end
|
52
52
|
|
53
|
+
# Gets information about a location.
|
54
|
+
# @param [String] name
|
55
|
+
# Resource name for the location.
|
56
|
+
# @param [String] fields
|
57
|
+
# Selector specifying which fields to include in a partial response.
|
58
|
+
# @param [String] quota_user
|
59
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
60
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
61
|
+
# @param [Google::Apis::RequestOptions] options
|
62
|
+
# Request-specific options
|
63
|
+
#
|
64
|
+
# @yield [result, err] Result & error if block supplied
|
65
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudLocationLocation] parsed result object
|
66
|
+
# @yieldparam err [StandardError] error object if request failed
|
67
|
+
#
|
68
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudLocationLocation]
|
69
|
+
#
|
70
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
71
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
72
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
73
|
+
def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
|
74
|
+
command = make_simple_command(:get, 'v3/{+name}', options)
|
75
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudLocationLocation::Representation
|
76
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudLocationLocation
|
77
|
+
command.params['name'] = name unless name.nil?
|
78
|
+
command.query['fields'] = fields unless fields.nil?
|
79
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
80
|
+
execute_or_queue_command(command, &block)
|
81
|
+
end
|
82
|
+
|
83
|
+
# Lists information about the supported locations for this service.
|
84
|
+
# @param [String] name
|
85
|
+
# The resource that owns the locations collection, if applicable.
|
86
|
+
# @param [String] filter
|
87
|
+
# A filter to narrow down results to a preferred subset. The filtering language
|
88
|
+
# accepts strings like "displayName=tokyo", and is documented in more detail in [
|
89
|
+
# AIP-160](https://google.aip.dev/160).
|
90
|
+
# @param [Fixnum] page_size
|
91
|
+
# The maximum number of results to return. If not set, the service selects a
|
92
|
+
# default.
|
93
|
+
# @param [String] page_token
|
94
|
+
# A page token received from the `next_page_token` field in the response. Send
|
95
|
+
# that page token to receive the subsequent page.
|
96
|
+
# @param [String] fields
|
97
|
+
# Selector specifying which fields to include in a partial response.
|
98
|
+
# @param [String] quota_user
|
99
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
100
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
101
|
+
# @param [Google::Apis::RequestOptions] options
|
102
|
+
# Request-specific options
|
103
|
+
#
|
104
|
+
# @yield [result, err] Result & error if block supplied
|
105
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudLocationListLocationsResponse] parsed result object
|
106
|
+
# @yieldparam err [StandardError] error object if request failed
|
107
|
+
#
|
108
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudLocationListLocationsResponse]
|
109
|
+
#
|
110
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
111
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
112
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
113
|
+
def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
114
|
+
command = make_simple_command(:get, 'v3/{+name}/locations', options)
|
115
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudLocationListLocationsResponse::Representation
|
116
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudLocationListLocationsResponse
|
117
|
+
command.params['name'] = name unless name.nil?
|
118
|
+
command.query['filter'] = filter unless filter.nil?
|
119
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
120
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
121
|
+
command.query['fields'] = fields unless fields.nil?
|
122
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
123
|
+
execute_or_queue_command(command, &block)
|
124
|
+
end
|
125
|
+
|
53
126
|
# Creates an agent in the specified location. Note: You should always train
|
54
127
|
# flows prior to sending them queries. See the [training documentation](https://
|
55
128
|
# cloud.google.com/dialogflow/cx/docs/concept/training).
|
@@ -116,7 +189,12 @@ module Google
|
|
116
189
|
execute_or_queue_command(command, &block)
|
117
190
|
end
|
118
191
|
|
119
|
-
# Exports the specified agent to a binary file.
|
192
|
+
# Exports the specified agent to a binary file. This method is a [long-running
|
193
|
+
# operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-
|
194
|
+
# operation). The returned `Operation` type has the following method-specific
|
195
|
+
# fields: - `metadata`: An empty [Struct message](https://developers.google.com/
|
196
|
+
# protocol-buffers/docs/reference/google.protobuf#struct) - `response`:
|
197
|
+
# ExportAgentResponse
|
120
198
|
# @param [String] name
|
121
199
|
# Required. The name of the agent to export. Format: `projects//locations//
|
122
200
|
# agents/`.
|
@@ -295,9 +373,15 @@ module Google
|
|
295
373
|
|
296
374
|
# Restores the specified agent from a binary file. Replaces the current agent
|
297
375
|
# with a new one. Note that all existing resources in agent (e.g. intents,
|
298
|
-
# entity types, flows) will be removed.
|
299
|
-
#
|
300
|
-
#
|
376
|
+
# entity types, flows) will be removed. This method is a [long-running operation]
|
377
|
+
# (https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
|
378
|
+
# returned `Operation` type has the following method-specific fields: - `
|
379
|
+
# metadata`: An empty [Struct message](https://developers.google.com/protocol-
|
380
|
+
# buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message]
|
381
|
+
# (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#
|
382
|
+
# empty) Note: You should always train flows prior to sending them queries. See
|
383
|
+
# the [training documentation](https://cloud.google.com/dialogflow/cx/docs/
|
384
|
+
# concept/training).
|
301
385
|
# @param [String] name
|
302
386
|
# Required. The name of the agent to restore into. Format: `projects//locations//
|
303
387
|
# agents/`.
|
@@ -366,6 +450,87 @@ module Google
|
|
366
450
|
execute_or_queue_command(command, &block)
|
367
451
|
end
|
368
452
|
|
453
|
+
# Retrieves the specified Changelog.
|
454
|
+
# @param [String] name
|
455
|
+
# Required. The name of the changelog to get. Format: `projects//locations//
|
456
|
+
# agents//changelogs/`.
|
457
|
+
# @param [String] fields
|
458
|
+
# Selector specifying which fields to include in a partial response.
|
459
|
+
# @param [String] quota_user
|
460
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
461
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
462
|
+
# @param [Google::Apis::RequestOptions] options
|
463
|
+
# Request-specific options
|
464
|
+
#
|
465
|
+
# @yield [result, err] Result & error if block supplied
|
466
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Changelog] parsed result object
|
467
|
+
# @yieldparam err [StandardError] error object if request failed
|
468
|
+
#
|
469
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Changelog]
|
470
|
+
#
|
471
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
472
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
473
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
474
|
+
def get_project_location_agent_changelog(name, fields: nil, quota_user: nil, options: nil, &block)
|
475
|
+
command = make_simple_command(:get, 'v3/{+name}', options)
|
476
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Changelog::Representation
|
477
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Changelog
|
478
|
+
command.params['name'] = name unless name.nil?
|
479
|
+
command.query['fields'] = fields unless fields.nil?
|
480
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
481
|
+
execute_or_queue_command(command, &block)
|
482
|
+
end
|
483
|
+
|
484
|
+
# Returns the list of Changelogs.
|
485
|
+
# @param [String] parent
|
486
|
+
# Required. The agent containing the changelogs. Format: `projects//locations//
|
487
|
+
# agents/`.
|
488
|
+
# @param [String] filter
|
489
|
+
# The filter string. Supports filter by user_email, resource, type and
|
490
|
+
# create_time. Some examples: 1. By user email: user_email = "someone@google.com"
|
491
|
+
# 2. By resource name: resource = "projects/123/locations/global/agents/456/
|
492
|
+
# flows/789" 3. By resource display name: display_name = "my agent" 4. By action:
|
493
|
+
# action = "Create" 5. By type: type = "flows" 6. By create time. Currently
|
494
|
+
# predicates on `create_time` and `create_time_epoch_seconds` are supported:
|
495
|
+
# create_time_epoch_seconds > 1551790877 AND create_time <= 2017-01-15T01:30:15.
|
496
|
+
# 01Z 7. Combination of above filters: resource = "projects/123/locations/global/
|
497
|
+
# agents/456/flows/789" AND user_email = "someone@google.com" AND create_time <=
|
498
|
+
# 2017-01-15T01:30:15.01Z
|
499
|
+
# @param [Fixnum] page_size
|
500
|
+
# The maximum number of items to return in a single page. By default 100 and at
|
501
|
+
# most 1000.
|
502
|
+
# @param [String] page_token
|
503
|
+
# The next_page_token value returned from a previous list request.
|
504
|
+
# @param [String] fields
|
505
|
+
# Selector specifying which fields to include in a partial response.
|
506
|
+
# @param [String] quota_user
|
507
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
508
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
509
|
+
# @param [Google::Apis::RequestOptions] options
|
510
|
+
# Request-specific options
|
511
|
+
#
|
512
|
+
# @yield [result, err] Result & error if block supplied
|
513
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListChangelogsResponse] parsed result object
|
514
|
+
# @yieldparam err [StandardError] error object if request failed
|
515
|
+
#
|
516
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListChangelogsResponse]
|
517
|
+
#
|
518
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
519
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
520
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
521
|
+
def list_project_location_agent_changelogs(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
522
|
+
command = make_simple_command(:get, 'v3/{+parent}/changelogs', options)
|
523
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListChangelogsResponse::Representation
|
524
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListChangelogsResponse
|
525
|
+
command.params['parent'] = parent unless parent.nil?
|
526
|
+
command.query['filter'] = filter unless filter.nil?
|
527
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
528
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
529
|
+
command.query['fields'] = fields unless fields.nil?
|
530
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
531
|
+
execute_or_queue_command(command, &block)
|
532
|
+
end
|
533
|
+
|
369
534
|
# Creates an entity type in the specified agent. Note: You should always train a
|
370
535
|
# flow prior to sending it queries. See the [training documentation](https://
|
371
536
|
# cloud.google.com/dialogflow/cx/docs/concept/training).
|
@@ -581,7 +746,12 @@ module Google
|
|
581
746
|
execute_or_queue_command(command, &block)
|
582
747
|
end
|
583
748
|
|
584
|
-
# Creates an Environment in the specified Agent.
|
749
|
+
# Creates an Environment in the specified Agent. This method is a [long-running
|
750
|
+
# operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-
|
751
|
+
# operation). The returned `Operation` type has the following method-specific
|
752
|
+
# fields: - `metadata`: An empty [Struct message](https://developers.google.com/
|
753
|
+
# protocol-buffers/docs/reference/google.protobuf#struct) - `response`:
|
754
|
+
# Environment
|
585
755
|
# @param [String] parent
|
586
756
|
# Required. The Agent to create an Environment for. Format: `projects//locations/
|
587
757
|
# /agents/`.
|
@@ -646,6 +816,43 @@ module Google
|
|
646
816
|
execute_or_queue_command(command, &block)
|
647
817
|
end
|
648
818
|
|
819
|
+
# Deploys a flow to the specified Environment. This method is a [long-running
|
820
|
+
# operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-
|
821
|
+
# operation). The returned `Operation` type has the following method-specific
|
822
|
+
# fields: - `metadata`: DeployFlowMetadata - `response`: DeployFlowResponse
|
823
|
+
# @param [String] environment
|
824
|
+
# Required. The environment to deploy the flow to. Format: `projects//locations//
|
825
|
+
# agents// environments/`.
|
826
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DeployFlowRequest] google_cloud_dialogflow_cx_v3_deploy_flow_request_object
|
827
|
+
# @param [String] fields
|
828
|
+
# Selector specifying which fields to include in a partial response.
|
829
|
+
# @param [String] quota_user
|
830
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
831
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
832
|
+
# @param [Google::Apis::RequestOptions] options
|
833
|
+
# Request-specific options
|
834
|
+
#
|
835
|
+
# @yield [result, err] Result & error if block supplied
|
836
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleLongrunningOperation] parsed result object
|
837
|
+
# @yieldparam err [StandardError] error object if request failed
|
838
|
+
#
|
839
|
+
# @return [Google::Apis::DialogflowV3::GoogleLongrunningOperation]
|
840
|
+
#
|
841
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
842
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
843
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
844
|
+
def deploy_project_location_agent_environment_flow(environment, google_cloud_dialogflow_cx_v3_deploy_flow_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
845
|
+
command = make_simple_command(:post, 'v3/{+environment}:deployFlow', options)
|
846
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DeployFlowRequest::Representation
|
847
|
+
command.request_object = google_cloud_dialogflow_cx_v3_deploy_flow_request_object
|
848
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleLongrunningOperation::Representation
|
849
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleLongrunningOperation
|
850
|
+
command.params['environment'] = environment unless environment.nil?
|
851
|
+
command.query['fields'] = fields unless fields.nil?
|
852
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
853
|
+
execute_or_queue_command(command, &block)
|
854
|
+
end
|
855
|
+
|
649
856
|
# Retrieves the specified Environment.
|
650
857
|
# @param [String] name
|
651
858
|
# Required. The name of the Environment. Format: `projects//locations//agents//
|
@@ -753,7 +960,11 @@ module Google
|
|
753
960
|
execute_or_queue_command(command, &block)
|
754
961
|
end
|
755
962
|
|
756
|
-
# Updates the specified Environment.
|
963
|
+
# Updates the specified Environment. This method is a [long-running operation](
|
964
|
+
# https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
|
965
|
+
# returned `Operation` type has the following method-specific fields: - `
|
966
|
+
# metadata`: An empty [Struct message](https://developers.google.com/protocol-
|
967
|
+
# buffers/docs/reference/google.protobuf#struct) - `response`: Environment
|
757
968
|
# @param [String] name
|
758
969
|
# The name of the environment. Format: `projects//locations//agents//
|
759
970
|
# environments/`.
|
@@ -790,7 +1001,11 @@ module Google
|
|
790
1001
|
execute_or_queue_command(command, &block)
|
791
1002
|
end
|
792
1003
|
|
793
|
-
# Kicks off a continuous test under the specified Environment.
|
1004
|
+
# Kicks off a continuous test under the specified Environment. This method is a [
|
1005
|
+
# long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-
|
1006
|
+
# running-operation). The returned `Operation` type has the following method-
|
1007
|
+
# specific fields: - `metadata`: RunContinuousTestMetadata - `response`:
|
1008
|
+
# RunContinuousTestResponse
|
794
1009
|
# @param [String] environment
|
795
1010
|
# Required. Format: `projects//locations//agents//environments/`.
|
796
1011
|
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3RunContinuousTestRequest] google_cloud_dialogflow_cx_v3_run_continuous_test_request_object
|
@@ -861,6 +1076,75 @@ module Google
|
|
861
1076
|
execute_or_queue_command(command, &block)
|
862
1077
|
end
|
863
1078
|
|
1079
|
+
# Retrieves the specified Deployment.
|
1080
|
+
# @param [String] name
|
1081
|
+
# Required. The name of the Deployment. Format: `projects//locations//agents//
|
1082
|
+
# environments//deployments/`.
|
1083
|
+
# @param [String] fields
|
1084
|
+
# Selector specifying which fields to include in a partial response.
|
1085
|
+
# @param [String] quota_user
|
1086
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1087
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1088
|
+
# @param [Google::Apis::RequestOptions] options
|
1089
|
+
# Request-specific options
|
1090
|
+
#
|
1091
|
+
# @yield [result, err] Result & error if block supplied
|
1092
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Deployment] parsed result object
|
1093
|
+
# @yieldparam err [StandardError] error object if request failed
|
1094
|
+
#
|
1095
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Deployment]
|
1096
|
+
#
|
1097
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1098
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1099
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1100
|
+
def get_project_location_agent_environment_deployment(name, fields: nil, quota_user: nil, options: nil, &block)
|
1101
|
+
command = make_simple_command(:get, 'v3/{+name}', options)
|
1102
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Deployment::Representation
|
1103
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Deployment
|
1104
|
+
command.params['name'] = name unless name.nil?
|
1105
|
+
command.query['fields'] = fields unless fields.nil?
|
1106
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1107
|
+
execute_or_queue_command(command, &block)
|
1108
|
+
end
|
1109
|
+
|
1110
|
+
# Returns the list of all deployments in the specified Environment.
|
1111
|
+
# @param [String] parent
|
1112
|
+
# Required. The Environment to list all environments for. Format: `projects//
|
1113
|
+
# locations//agents//environments/`.
|
1114
|
+
# @param [Fixnum] page_size
|
1115
|
+
# The maximum number of items to return in a single page. By default 20 and at
|
1116
|
+
# most 100.
|
1117
|
+
# @param [String] page_token
|
1118
|
+
# The next_page_token value returned from a previous list request.
|
1119
|
+
# @param [String] fields
|
1120
|
+
# Selector specifying which fields to include in a partial response.
|
1121
|
+
# @param [String] quota_user
|
1122
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1123
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1124
|
+
# @param [Google::Apis::RequestOptions] options
|
1125
|
+
# Request-specific options
|
1126
|
+
#
|
1127
|
+
# @yield [result, err] Result & error if block supplied
|
1128
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListDeploymentsResponse] parsed result object
|
1129
|
+
# @yieldparam err [StandardError] error object if request failed
|
1130
|
+
#
|
1131
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListDeploymentsResponse]
|
1132
|
+
#
|
1133
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1134
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1135
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1136
|
+
def list_project_location_agent_environment_deployments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1137
|
+
command = make_simple_command(:get, 'v3/{+parent}/deployments', options)
|
1138
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListDeploymentsResponse::Representation
|
1139
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListDeploymentsResponse
|
1140
|
+
command.params['parent'] = parent unless parent.nil?
|
1141
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1142
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1143
|
+
command.query['fields'] = fields unless fields.nil?
|
1144
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1145
|
+
execute_or_queue_command(command, &block)
|
1146
|
+
end
|
1147
|
+
|
864
1148
|
# Creates an Experiment in the specified Environment.
|
865
1149
|
# @param [String] parent
|
866
1150
|
# Required. The Agent to create an Environment for. Format: `projects//locations/
|
@@ -1495,8 +1779,13 @@ module Google
|
|
1495
1779
|
execute_or_queue_command(command, &block)
|
1496
1780
|
end
|
1497
1781
|
|
1498
|
-
# Exports the specified flow to a binary file.
|
1499
|
-
#
|
1782
|
+
# Exports the specified flow to a binary file. This method is a [long-running
|
1783
|
+
# operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-
|
1784
|
+
# operation). The returned `Operation` type has the following method-specific
|
1785
|
+
# fields: - `metadata`: An empty [Struct message](https://developers.google.com/
|
1786
|
+
# protocol-buffers/docs/reference/google.protobuf#struct) - `response`:
|
1787
|
+
# ExportFlowResponse Note that resources (e.g. intents, entities, webhooks) that
|
1788
|
+
# the flow references will also be exported.
|
1500
1789
|
# @param [String] name
|
1501
1790
|
# Required. The name of the flow to export. Format: `projects//locations//agents/
|
1502
1791
|
# /flows/`.
|
@@ -1606,9 +1895,14 @@ module Google
|
|
1606
1895
|
execute_or_queue_command(command, &block)
|
1607
1896
|
end
|
1608
1897
|
|
1609
|
-
# Imports the specified flow to the specified agent from a binary file.
|
1610
|
-
#
|
1611
|
-
#
|
1898
|
+
# Imports the specified flow to the specified agent from a binary file. This
|
1899
|
+
# method is a [long-running operation](https://cloud.google.com/dialogflow/cx/
|
1900
|
+
# docs/how/long-running-operation). The returned `Operation` type has the
|
1901
|
+
# following method-specific fields: - `metadata`: An empty [Struct message](
|
1902
|
+
# https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#
|
1903
|
+
# struct) - `response`: ImportFlowResponse Note: You should always train a flow
|
1904
|
+
# prior to sending it queries. See the [training documentation](https://cloud.
|
1905
|
+
# google.com/dialogflow/cx/docs/concept/training).
|
1612
1906
|
# @param [String] parent
|
1613
1907
|
# Required. The agent to import the flow into. Format: `projects//locations//
|
1614
1908
|
# agents/`.
|
@@ -1706,8 +2000,8 @@ module Google
|
|
1706
2000
|
# com/dialogflow/cx/docs/reference/language) are supported. Note: languages must
|
1707
2001
|
# be enabled in the agent before they can be used.
|
1708
2002
|
# @param [String] update_mask
|
1709
|
-
#
|
1710
|
-
#
|
2003
|
+
# The mask to control which fields get updated. If the mask is not present, all
|
2004
|
+
# fields will be updated.
|
1711
2005
|
# @param [String] fields
|
1712
2006
|
# Selector specifying which fields to include in a partial response.
|
1713
2007
|
# @param [String] quota_user
|
@@ -1740,9 +2034,14 @@ module Google
|
|
1740
2034
|
end
|
1741
2035
|
|
1742
2036
|
# Trains the specified flow. Note that only the flow in 'draft' environment is
|
1743
|
-
# trained.
|
1744
|
-
#
|
1745
|
-
#
|
2037
|
+
# trained. This method is a [long-running operation](https://cloud.google.com/
|
2038
|
+
# dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type
|
2039
|
+
# has the following method-specific fields: - `metadata`: An empty [Struct
|
2040
|
+
# message](https://developers.google.com/protocol-buffers/docs/reference/google.
|
2041
|
+
# protobuf#struct) - `response`: An [Empty message](https://developers.google.
|
2042
|
+
# com/protocol-buffers/docs/reference/google.protobuf#empty) Note: You should
|
2043
|
+
# always train a flow prior to sending it queries. See the [training
|
2044
|
+
# documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
|
1746
2045
|
# @param [String] name
|
1747
2046
|
# Required. The flow to train. Format: `projects//locations//agents//flows/`.
|
1748
2047
|
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TrainFlowRequest] google_cloud_dialogflow_cx_v3_train_flow_request_object
|
@@ -2276,7 +2575,45 @@ module Google
|
|
2276
2575
|
execute_or_queue_command(command, &block)
|
2277
2576
|
end
|
2278
2577
|
|
2279
|
-
#
|
2578
|
+
# Compares the specified base version with target version.
|
2579
|
+
# @param [String] base_version
|
2580
|
+
# Required. Name of the base flow version to compare with the target version.
|
2581
|
+
# Use version ID `0` to indicate the draft version of the specified flow. Format:
|
2582
|
+
# `projects//locations//agents/ /flows//versions/`.
|
2583
|
+
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3CompareVersionsRequest] google_cloud_dialogflow_cx_v3_compare_versions_request_object
|
2584
|
+
# @param [String] fields
|
2585
|
+
# Selector specifying which fields to include in a partial response.
|
2586
|
+
# @param [String] quota_user
|
2587
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2588
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2589
|
+
# @param [Google::Apis::RequestOptions] options
|
2590
|
+
# Request-specific options
|
2591
|
+
#
|
2592
|
+
# @yield [result, err] Result & error if block supplied
|
2593
|
+
# @yieldparam result [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3CompareVersionsResponse] parsed result object
|
2594
|
+
# @yieldparam err [StandardError] error object if request failed
|
2595
|
+
#
|
2596
|
+
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3CompareVersionsResponse]
|
2597
|
+
#
|
2598
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2599
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2600
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2601
|
+
def compare_project_location_agent_flow_version_versions(base_version, google_cloud_dialogflow_cx_v3_compare_versions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2602
|
+
command = make_simple_command(:post, 'v3/{+baseVersion}:compareVersions', options)
|
2603
|
+
command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3CompareVersionsRequest::Representation
|
2604
|
+
command.request_object = google_cloud_dialogflow_cx_v3_compare_versions_request_object
|
2605
|
+
command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3CompareVersionsResponse::Representation
|
2606
|
+
command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3CompareVersionsResponse
|
2607
|
+
command.params['baseVersion'] = base_version unless base_version.nil?
|
2608
|
+
command.query['fields'] = fields unless fields.nil?
|
2609
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2610
|
+
execute_or_queue_command(command, &block)
|
2611
|
+
end
|
2612
|
+
|
2613
|
+
# Creates a Version in the specified Flow. This method is a [long-running
|
2614
|
+
# operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-
|
2615
|
+
# operation). The returned `Operation` type has the following method-specific
|
2616
|
+
# fields: - `metadata`: CreateVersionOperationMetadata - `response`: Version
|
2280
2617
|
# @param [String] parent
|
2281
2618
|
# Required. The Flow to create an Version for. Format: `projects//locations//
|
2282
2619
|
# agents//flows/`.
|
@@ -2410,7 +2747,13 @@ module Google
|
|
2410
2747
|
execute_or_queue_command(command, &block)
|
2411
2748
|
end
|
2412
2749
|
|
2413
|
-
# Loads resources in the specified version to the draft flow.
|
2750
|
+
# Loads resources in the specified version to the draft flow. This method is a [
|
2751
|
+
# long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-
|
2752
|
+
# running-operation). The returned `Operation` type has the following method-
|
2753
|
+
# specific fields: - `metadata`: An empty [Struct message](https://developers.
|
2754
|
+
# google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`
|
2755
|
+
# : An [Empty message](https://developers.google.com/protocol-buffers/docs/
|
2756
|
+
# reference/google.protobuf#empty)
|
2414
2757
|
# @param [String] name
|
2415
2758
|
# Required. The Version to be loaded to draft flow. Format: `projects//locations/
|
2416
2759
|
# /agents//flows//versions/`.
|
@@ -3035,7 +3378,10 @@ module Google
|
|
3035
3378
|
execute_or_queue_command(command, &block)
|
3036
3379
|
end
|
3037
3380
|
|
3038
|
-
# Kicks off a batch run of test cases.
|
3381
|
+
# Kicks off a batch run of test cases. This method is a [long-running operation](
|
3382
|
+
# https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
|
3383
|
+
# returned `Operation` type has the following method-specific fields: - `
|
3384
|
+
# metadata`: BatchRunTestCasesMetadata - `response`: BatchRunTestCasesResponse
|
3039
3385
|
# @param [String] parent
|
3040
3386
|
# Required. Agent name. Format: `projects//locations//agents/ `.
|
3041
3387
|
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3BatchRunTestCasesRequest] google_cloud_dialogflow_cx_v3_batch_run_test_cases_request_object
|
@@ -3137,7 +3483,11 @@ module Google
|
|
3137
3483
|
end
|
3138
3484
|
|
3139
3485
|
# Exports the test cases under the agent to a Cloud Storage bucket or a local
|
3140
|
-
# file. Filter can be applied to export a subset of test cases.
|
3486
|
+
# file. Filter can be applied to export a subset of test cases. This method is a
|
3487
|
+
# [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-
|
3488
|
+
# running-operation). The returned `Operation` type has the following method-
|
3489
|
+
# specific fields: - `metadata`: ExportTestCasesMetadata - `response`:
|
3490
|
+
# ExportTestCasesResponse
|
3141
3491
|
# @param [String] parent
|
3142
3492
|
# Required. The agent where to export test cases from. Format: `projects//
|
3143
3493
|
# locations//agents/`.
|
@@ -3204,7 +3554,11 @@ module Google
|
|
3204
3554
|
|
3205
3555
|
# Imports the test cases from a Cloud Storage bucket or a local file. It always
|
3206
3556
|
# creates new test cases and won't overwite any existing ones. The provided ID
|
3207
|
-
# in the imported test case is neglected.
|
3557
|
+
# in the imported test case is neglected. This method is a [long-running
|
3558
|
+
# operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-
|
3559
|
+
# operation). The returned `Operation` type has the following method-specific
|
3560
|
+
# fields: - `metadata`: ImportTestCasesMetadata - `response`:
|
3561
|
+
# ImportTestCasesResponse
|
3208
3562
|
# @param [String] parent
|
3209
3563
|
# Required. The agent to import test cases to. Format: `projects//locations//
|
3210
3564
|
# agents/`.
|
@@ -3319,7 +3673,10 @@ module Google
|
|
3319
3673
|
execute_or_queue_command(command, &block)
|
3320
3674
|
end
|
3321
3675
|
|
3322
|
-
# Kicks off a test case run.
|
3676
|
+
# Kicks off a test case run. This method is a [long-running operation](https://
|
3677
|
+
# cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `
|
3678
|
+
# Operation` type has the following method-specific fields: - `metadata`:
|
3679
|
+
# RunTestCaseMetadata - `response`: RunTestCaseResponse
|
3323
3680
|
# @param [String] name
|
3324
3681
|
# Required. Format of test case name to run: `projects//locations/ /agents//
|
3325
3682
|
# testCases/`.
|
@@ -3869,7 +4226,9 @@ module Google
|
|
3869
4226
|
|
3870
4227
|
# Updates the specified SecuritySettings.
|
3871
4228
|
# @param [String] name
|
3872
|
-
#
|
4229
|
+
# Resource name of the settings. Required for the SecuritySettingsService.
|
4230
|
+
# UpdateSecuritySettings method. SecuritySettingsService.CreateSecuritySettings
|
4231
|
+
# populates the name automatically. Format: `projects//locations//
|
3873
4232
|
# securitySettings/`.
|
3874
4233
|
# @param [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SecuritySettings] google_cloud_dialogflow_cx_v3_security_settings_object
|
3875
4234
|
# @param [String] update_mask
|
@@ -30,7 +30,7 @@ module Google
|
|
30
30
|
# This is NOT the gem version.
|
31
31
|
VERSION = 'V3'
|
32
32
|
|
33
|
-
# See, edit, configure, and delete your Google Cloud
|
33
|
+
# See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
|
34
34
|
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
|
35
35
|
|
36
36
|
# View, manage and query your Dialogflow agents
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-apis-dialogflow_v3
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.24.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2021-
|
11
|
+
date: 2021-12-06 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: google-apis-core
|
@@ -57,9 +57,9 @@ licenses:
|
|
57
57
|
- Apache-2.0
|
58
58
|
metadata:
|
59
59
|
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
60
|
-
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/
|
61
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-dialogflow_v3/v0.
|
62
|
-
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/
|
60
|
+
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-dialogflow_v3/CHANGELOG.md
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-dialogflow_v3/v0.24.0
|
62
|
+
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-dialogflow_v3
|
63
63
|
post_install_message:
|
64
64
|
rdoc_options: []
|
65
65
|
require_paths:
|