google-apis-dialogflow_v3beta1 0.89.0 → 0.91.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.
@@ -1069,7 +1069,7 @@ module Google
1069
1069
  # fields: - `metadata`: DeployFlowMetadata - `response`: DeployFlowResponse
1070
1070
  # @param [String] environment
1071
1071
  # Required. The environment to deploy the flow to. Format: `projects//locations//
1072
- # agents// environments/`.
1072
+ # agents//environments/`.
1073
1073
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1DeployFlowRequest] google_cloud_dialogflow_cx_v3beta1_deploy_flow_request_object
1074
1074
  # @param [String] fields
1075
1075
  # Selector specifying which fields to include in a partial response.
@@ -1288,7 +1288,7 @@ module Google
1288
1288
  # Fetches a list of continuous test results for a given environment.
1289
1289
  # @param [String] parent
1290
1290
  # Required. The environment to list results for. Format: `projects//locations//
1291
- # agents// environments/`.
1291
+ # agents//environments/`.
1292
1292
  # @param [Fixnum] page_size
1293
1293
  # The maximum number of items to return in a single page. By default 100 and at
1294
1294
  # most 1000.
@@ -1529,7 +1529,7 @@ module Google
1529
1529
  # Updates the specified Experiment.
1530
1530
  # @param [String] name
1531
1531
  # The name of the experiment. Format: projects//locations//agents//environments//
1532
- # experiments/..
1532
+ # experiments/.
1533
1533
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Experiment] google_cloud_dialogflow_cx_v3beta1_experiment_object
1534
1534
  # @param [String] update_mask
1535
1535
  # Required. The mask to control which fields get updated.
@@ -2869,7 +2869,7 @@ module Google
2869
2869
  # @param [String] base_version
2870
2870
  # Required. Name of the base flow version to compare with the target version.
2871
2871
  # Use version ID `0` to indicate the draft version of the specified flow. Format:
2872
- # `projects//locations//agents/ /flows//versions/`.
2872
+ # `projects//locations//agents//flows//versions/`.
2873
2873
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1CompareVersionsRequest] google_cloud_dialogflow_cx_v3beta1_compare_versions_request_object
2874
2874
  # @param [String] fields
2875
2875
  # Selector specifying which fields to include in a partial response.
@@ -3658,6 +3658,41 @@ module Google
3658
3658
  execute_or_queue_command(command, &block)
3659
3659
  end
3660
3660
 
3661
+ # Exports the specified playbook to a binary file. Note that resources (e.g.
3662
+ # examples, tools) that the playbook references will also be exported.
3663
+ # @param [String] name
3664
+ # Required. The name of the playbook to export. Format: `projects//locations//
3665
+ # agents//playbooks/`.
3666
+ # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ExportPlaybookRequest] google_cloud_dialogflow_cx_v3beta1_export_playbook_request_object
3667
+ # @param [String] fields
3668
+ # Selector specifying which fields to include in a partial response.
3669
+ # @param [String] quota_user
3670
+ # Available to use for quota purposes for server-side applications. Can be any
3671
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3672
+ # @param [Google::Apis::RequestOptions] options
3673
+ # Request-specific options
3674
+ #
3675
+ # @yield [result, err] Result & error if block supplied
3676
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation] parsed result object
3677
+ # @yieldparam err [StandardError] error object if request failed
3678
+ #
3679
+ # @return [Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation]
3680
+ #
3681
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3682
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3683
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3684
+ def export_project_location_agent_playbook(name, google_cloud_dialogflow_cx_v3beta1_export_playbook_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
3685
+ command = make_simple_command(:post, 'v3beta1/{+name}:export', options)
3686
+ command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ExportPlaybookRequest::Representation
3687
+ command.request_object = google_cloud_dialogflow_cx_v3beta1_export_playbook_request_object
3688
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation::Representation
3689
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation
3690
+ command.params['name'] = name unless name.nil?
3691
+ command.query['fields'] = fields unless fields.nil?
3692
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3693
+ execute_or_queue_command(command, &block)
3694
+ end
3695
+
3661
3696
  # Retrieves the specified Playbook.
3662
3697
  # @param [String] name
3663
3698
  # Required. The name of the playbook. Format: `projects//locations//agents//
@@ -3689,6 +3724,40 @@ module Google
3689
3724
  execute_or_queue_command(command, &block)
3690
3725
  end
3691
3726
 
3727
+ # Imports the specified playbook to the specified agent from a binary file.
3728
+ # @param [String] parent
3729
+ # Required. The agent to import the playbook into. Format: `projects//locations//
3730
+ # agents/`.
3731
+ # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ImportPlaybookRequest] google_cloud_dialogflow_cx_v3beta1_import_playbook_request_object
3732
+ # @param [String] fields
3733
+ # Selector specifying which fields to include in a partial response.
3734
+ # @param [String] quota_user
3735
+ # Available to use for quota purposes for server-side applications. Can be any
3736
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3737
+ # @param [Google::Apis::RequestOptions] options
3738
+ # Request-specific options
3739
+ #
3740
+ # @yield [result, err] Result & error if block supplied
3741
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation] parsed result object
3742
+ # @yieldparam err [StandardError] error object if request failed
3743
+ #
3744
+ # @return [Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation]
3745
+ #
3746
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3747
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3748
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3749
+ def import_project_location_agent_playbook(parent, google_cloud_dialogflow_cx_v3beta1_import_playbook_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
3750
+ command = make_simple_command(:post, 'v3beta1/{+parent}/playbooks:import', options)
3751
+ command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ImportPlaybookRequest::Representation
3752
+ command.request_object = google_cloud_dialogflow_cx_v3beta1_import_playbook_request_object
3753
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation::Representation
3754
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation
3755
+ command.params['parent'] = parent unless parent.nil?
3756
+ command.query['fields'] = fields unless fields.nil?
3757
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3758
+ execute_or_queue_command(command, &block)
3759
+ end
3760
+
3692
3761
  # Returns a list of playbooks in the specified agent.
3693
3762
  # @param [String] parent
3694
3763
  # Required. The agent to list playbooks from. Format: `projects//locations//
@@ -3866,9 +3935,9 @@ module Google
3866
3935
  # Required. The playbook to list the examples from. Format: `projects//locations/
3867
3936
  # /agents//playbooks/`.
3868
3937
  # @param [String] language_code
3869
- # Optional. The language to list examples for. If not specified, the agent's
3870
- # default language is used. Note: languages must be enabled in the agent before
3871
- # they can be used.
3938
+ # Optional. The language to list examples for. If not specified, list all
3939
+ # examples under the playbook. Note: languages must be enabled in the agent
3940
+ # before they can be used.
3872
3941
  # @param [Fixnum] page_size
3873
3942
  # Optional. The maximum number of items to return in a single page. By default
3874
3943
  # 100 and at most 1000.
@@ -4076,6 +4145,41 @@ module Google
4076
4145
  execute_or_queue_command(command, &block)
4077
4146
  end
4078
4147
 
4148
+ # Retrieves the specified version of the Playbook and stores it as the current
4149
+ # playbook draft, returning the playbook with resources updated.
4150
+ # @param [String] name
4151
+ # Required. The name of the playbook version. Format: `projects//locations//
4152
+ # agents//playbooks//versions/`.
4153
+ # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1RestorePlaybookVersionRequest] google_cloud_dialogflow_cx_v3beta1_restore_playbook_version_request_object
4154
+ # @param [String] fields
4155
+ # Selector specifying which fields to include in a partial response.
4156
+ # @param [String] quota_user
4157
+ # Available to use for quota purposes for server-side applications. Can be any
4158
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4159
+ # @param [Google::Apis::RequestOptions] options
4160
+ # Request-specific options
4161
+ #
4162
+ # @yield [result, err] Result & error if block supplied
4163
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1RestorePlaybookVersionResponse] parsed result object
4164
+ # @yieldparam err [StandardError] error object if request failed
4165
+ #
4166
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1RestorePlaybookVersionResponse]
4167
+ #
4168
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4169
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4170
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4171
+ def restore_project_location_agent_playbook_version(name, google_cloud_dialogflow_cx_v3beta1_restore_playbook_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
4172
+ command = make_simple_command(:post, 'v3beta1/{+name}:restore', options)
4173
+ command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1RestorePlaybookVersionRequest::Representation
4174
+ command.request_object = google_cloud_dialogflow_cx_v3beta1_restore_playbook_version_request_object
4175
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1RestorePlaybookVersionResponse::Representation
4176
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1RestorePlaybookVersionResponse
4177
+ command.params['name'] = name unless name.nil?
4178
+ command.query['fields'] = fields unless fields.nil?
4179
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4180
+ execute_or_queue_command(command, &block)
4181
+ end
4182
+
4079
4183
  # Processes a natural language query and returns structured, actionable data as
4080
4184
  # a result. This method is not idempotent, because it may cause session entity
4081
4185
  # types to be updated, which in turn might affect results of future queries.
@@ -4503,7 +4607,7 @@ module Google
4503
4607
  # returned `Operation` type has the following method-specific fields: - `
4504
4608
  # metadata`: BatchRunTestCasesMetadata - `response`: BatchRunTestCasesResponse
4505
4609
  # @param [String] parent
4506
- # Required. Agent name. Format: `projects//locations//agents/ `.
4610
+ # Required. Agent name. Format: `projects//locations//agents/`.
4507
4611
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1BatchRunTestCasesRequest] google_cloud_dialogflow_cx_v3beta1_batch_run_test_cases_request_object
4508
4612
  # @param [String] fields
4509
4613
  # Selector specifying which fields to include in a partial response.
@@ -4757,7 +4861,7 @@ module Google
4757
4861
  # Updates the specified test case.
4758
4862
  # @param [String] name
4759
4863
  # The unique identifier of the test case. TestCases.CreateTestCase will populate
4760
- # the name automatically. Otherwise use format: `projects//locations//agents/ /
4864
+ # the name automatically. Otherwise use format: `projects//locations//agents//
4761
4865
  # testCases/`.
4762
4866
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TestCase] google_cloud_dialogflow_cx_v3beta1_test_case_object
4763
4867
  # @param [String] update_mask
@@ -4798,7 +4902,7 @@ module Google
4798
4902
  # Operation` type has the following method-specific fields: - `metadata`:
4799
4903
  # RunTestCaseMetadata - `response`: RunTestCaseResponse
4800
4904
  # @param [String] name
4801
- # Required. Format of test case name to run: `projects//locations/ /agents//
4905
+ # Required. Format of test case name to run: `projects//locations//agents//
4802
4906
  # testCases/`.
4803
4907
  # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1RunTestCaseRequest] google_cloud_dialogflow_cx_v3beta1_run_test_case_request_object
4804
4908
  # @param [String] fields
@@ -4865,7 +4969,7 @@ module Google
4865
4969
  # results are kept for each test case.
4866
4970
  # @param [String] parent
4867
4971
  # Required. The test case to list results for. Format: `projects//locations//
4868
- # agents// testCases/`. Specify a `-` as a wildcard for TestCase ID to list
4972
+ # agents//testCases/`. Specify a `-` as a wildcard for TestCase ID to list
4869
4973
  # results across multiple test cases.
4870
4974
  # @param [String] filter
4871
4975
  # The filter expression used to filter test case results. See [API Filtering](
@@ -5536,8 +5640,8 @@ module Google
5536
5640
  # Clients can use Operations.GetOperation or other methods to check whether the
5537
5641
  # cancellation succeeded or whether the operation completed despite cancellation.
5538
5642
  # On successful cancellation, the operation is not deleted; instead, it becomes
5539
- # an operation with an Operation.error value with a google.rpc.Status.code of 1,
5540
- # corresponding to `Code.CANCELLED`.
5643
+ # an operation with an Operation.error value with a google.rpc.Status.code of `1`
5644
+ # , corresponding to `Code.CANCELLED`.
5541
5645
  # @param [String] name
5542
5646
  # The name of the operation resource to be cancelled.
5543
5647
  # @param [String] fields
@@ -5819,8 +5923,8 @@ module Google
5819
5923
  # Clients can use Operations.GetOperation or other methods to check whether the
5820
5924
  # cancellation succeeded or whether the operation completed despite cancellation.
5821
5925
  # On successful cancellation, the operation is not deleted; instead, it becomes
5822
- # an operation with an Operation.error value with a google.rpc.Status.code of 1,
5823
- # corresponding to `Code.CANCELLED`.
5926
+ # an operation with an Operation.error value with a google.rpc.Status.code of `1`
5927
+ # , corresponding to `Code.CANCELLED`.
5824
5928
  # @param [String] name
5825
5929
  # The name of the operation resource to be cancelled.
5826
5930
  # @param [String] fields
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-dialogflow_v3beta1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.89.0
4
+ version: 0.91.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: 2024-07-25 00:00:00.000000000 Z
11
+ date: 2024-12-15 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-dialogflow_v3beta1/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-dialogflow_v3beta1/v0.89.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-dialogflow_v3beta1/v0.91.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-dialogflow_v3beta1
63
63
  post_install_message:
64
64
  rdoc_options: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
75
75
  - !ruby/object:Gem::Version
76
76
  version: '0'
77
77
  requirements: []
78
- rubygems_version: 3.5.6
78
+ rubygems_version: 3.5.23
79
79
  signing_key:
80
80
  specification_version: 4
81
81
  summary: Simple REST client for Dialogflow API V3beta1