google-apis-dialogflow_v3beta1 0.85.0 → 0.87.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.
@@ -3593,6 +3593,489 @@ module Google
3593
3593
  execute_or_queue_command(command, &block)
3594
3594
  end
3595
3595
 
3596
+ # Creates a playbook in a specified agent.
3597
+ # @param [String] parent
3598
+ # Required. The agent to create a playbook for. Format: `projects//locations//
3599
+ # agents/`.
3600
+ # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook] google_cloud_dialogflow_cx_v3beta1_playbook_object
3601
+ # @param [String] fields
3602
+ # Selector specifying which fields to include in a partial response.
3603
+ # @param [String] quota_user
3604
+ # Available to use for quota purposes for server-side applications. Can be any
3605
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3606
+ # @param [Google::Apis::RequestOptions] options
3607
+ # Request-specific options
3608
+ #
3609
+ # @yield [result, err] Result & error if block supplied
3610
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook] parsed result object
3611
+ # @yieldparam err [StandardError] error object if request failed
3612
+ #
3613
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook]
3614
+ #
3615
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3616
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3617
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3618
+ def create_project_location_agent_playbook(parent, google_cloud_dialogflow_cx_v3beta1_playbook_object = nil, fields: nil, quota_user: nil, options: nil, &block)
3619
+ command = make_simple_command(:post, 'v3beta1/{+parent}/playbooks', options)
3620
+ command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook::Representation
3621
+ command.request_object = google_cloud_dialogflow_cx_v3beta1_playbook_object
3622
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook::Representation
3623
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook
3624
+ command.params['parent'] = parent unless parent.nil?
3625
+ command.query['fields'] = fields unless fields.nil?
3626
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3627
+ execute_or_queue_command(command, &block)
3628
+ end
3629
+
3630
+ # Deletes a specified playbook.
3631
+ # @param [String] name
3632
+ # Required. The name of the playbook to delete. Format: `projects//locations//
3633
+ # agents//playbooks/`.
3634
+ # @param [String] fields
3635
+ # Selector specifying which fields to include in a partial response.
3636
+ # @param [String] quota_user
3637
+ # Available to use for quota purposes for server-side applications. Can be any
3638
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3639
+ # @param [Google::Apis::RequestOptions] options
3640
+ # Request-specific options
3641
+ #
3642
+ # @yield [result, err] Result & error if block supplied
3643
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty] parsed result object
3644
+ # @yieldparam err [StandardError] error object if request failed
3645
+ #
3646
+ # @return [Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty]
3647
+ #
3648
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3649
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3650
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3651
+ def delete_project_location_agent_playbook(name, fields: nil, quota_user: nil, options: nil, &block)
3652
+ command = make_simple_command(:delete, 'v3beta1/{+name}', options)
3653
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty::Representation
3654
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty
3655
+ command.params['name'] = name unless name.nil?
3656
+ command.query['fields'] = fields unless fields.nil?
3657
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3658
+ execute_or_queue_command(command, &block)
3659
+ end
3660
+
3661
+ # Retrieves the specified Playbook.
3662
+ # @param [String] name
3663
+ # Required. The name of the playbook. Format: `projects//locations//agents//
3664
+ # playbooks/`.
3665
+ # @param [String] fields
3666
+ # Selector specifying which fields to include in a partial response.
3667
+ # @param [String] quota_user
3668
+ # Available to use for quota purposes for server-side applications. Can be any
3669
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3670
+ # @param [Google::Apis::RequestOptions] options
3671
+ # Request-specific options
3672
+ #
3673
+ # @yield [result, err] Result & error if block supplied
3674
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook] parsed result object
3675
+ # @yieldparam err [StandardError] error object if request failed
3676
+ #
3677
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook]
3678
+ #
3679
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3680
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3681
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3682
+ def get_project_location_agent_playbook(name, fields: nil, quota_user: nil, options: nil, &block)
3683
+ command = make_simple_command(:get, 'v3beta1/{+name}', options)
3684
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook::Representation
3685
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook
3686
+ command.params['name'] = name unless name.nil?
3687
+ command.query['fields'] = fields unless fields.nil?
3688
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3689
+ execute_or_queue_command(command, &block)
3690
+ end
3691
+
3692
+ # Returns a list of playbooks in the specified agent.
3693
+ # @param [String] parent
3694
+ # Required. The agent to list playbooks from. Format: `projects//locations//
3695
+ # agents/`.
3696
+ # @param [Fixnum] page_size
3697
+ # The maximum number of items to return in a single page. By default 100 and at
3698
+ # most 1000.
3699
+ # @param [String] page_token
3700
+ # The next_page_token value returned from a previous list request.
3701
+ # @param [String] fields
3702
+ # Selector specifying which fields to include in a partial response.
3703
+ # @param [String] quota_user
3704
+ # Available to use for quota purposes for server-side applications. Can be any
3705
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3706
+ # @param [Google::Apis::RequestOptions] options
3707
+ # Request-specific options
3708
+ #
3709
+ # @yield [result, err] Result & error if block supplied
3710
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListPlaybooksResponse] parsed result object
3711
+ # @yieldparam err [StandardError] error object if request failed
3712
+ #
3713
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListPlaybooksResponse]
3714
+ #
3715
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3716
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3717
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3718
+ def list_project_location_agent_playbooks(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
3719
+ command = make_simple_command(:get, 'v3beta1/{+parent}/playbooks', options)
3720
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListPlaybooksResponse::Representation
3721
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListPlaybooksResponse
3722
+ command.params['parent'] = parent unless parent.nil?
3723
+ command.query['pageSize'] = page_size unless page_size.nil?
3724
+ command.query['pageToken'] = page_token unless page_token.nil?
3725
+ command.query['fields'] = fields unless fields.nil?
3726
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3727
+ execute_or_queue_command(command, &block)
3728
+ end
3729
+
3730
+ # Updates the specified Playbook.
3731
+ # @param [String] name
3732
+ # The unique identifier of the playbook. Format: `projects//locations//agents//
3733
+ # playbooks/`.
3734
+ # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook] google_cloud_dialogflow_cx_v3beta1_playbook_object
3735
+ # @param [String] update_mask
3736
+ # The mask to control which fields get updated. If the mask is not present, all
3737
+ # fields will be updated.
3738
+ # @param [String] fields
3739
+ # Selector specifying which fields to include in a partial response.
3740
+ # @param [String] quota_user
3741
+ # Available to use for quota purposes for server-side applications. Can be any
3742
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3743
+ # @param [Google::Apis::RequestOptions] options
3744
+ # Request-specific options
3745
+ #
3746
+ # @yield [result, err] Result & error if block supplied
3747
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook] parsed result object
3748
+ # @yieldparam err [StandardError] error object if request failed
3749
+ #
3750
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook]
3751
+ #
3752
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3753
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3754
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3755
+ def patch_project_location_agent_playbook(name, google_cloud_dialogflow_cx_v3beta1_playbook_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
3756
+ command = make_simple_command(:patch, 'v3beta1/{+name}', options)
3757
+ command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook::Representation
3758
+ command.request_object = google_cloud_dialogflow_cx_v3beta1_playbook_object
3759
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook::Representation
3760
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook
3761
+ command.params['name'] = name unless name.nil?
3762
+ command.query['updateMask'] = update_mask unless update_mask.nil?
3763
+ command.query['fields'] = fields unless fields.nil?
3764
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3765
+ execute_or_queue_command(command, &block)
3766
+ end
3767
+
3768
+ # Creates an example in the specified playbook.
3769
+ # @param [String] parent
3770
+ # Required. The playbook to create an example for. Format: `projects//locations//
3771
+ # agents//playbooks/`.
3772
+ # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example] google_cloud_dialogflow_cx_v3beta1_example_object
3773
+ # @param [String] fields
3774
+ # Selector specifying which fields to include in a partial response.
3775
+ # @param [String] quota_user
3776
+ # Available to use for quota purposes for server-side applications. Can be any
3777
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3778
+ # @param [Google::Apis::RequestOptions] options
3779
+ # Request-specific options
3780
+ #
3781
+ # @yield [result, err] Result & error if block supplied
3782
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example] parsed result object
3783
+ # @yieldparam err [StandardError] error object if request failed
3784
+ #
3785
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example]
3786
+ #
3787
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3788
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3789
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3790
+ def create_project_location_agent_playbook_example(parent, google_cloud_dialogflow_cx_v3beta1_example_object = nil, fields: nil, quota_user: nil, options: nil, &block)
3791
+ command = make_simple_command(:post, 'v3beta1/{+parent}/examples', options)
3792
+ command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example::Representation
3793
+ command.request_object = google_cloud_dialogflow_cx_v3beta1_example_object
3794
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example::Representation
3795
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example
3796
+ command.params['parent'] = parent unless parent.nil?
3797
+ command.query['fields'] = fields unless fields.nil?
3798
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3799
+ execute_or_queue_command(command, &block)
3800
+ end
3801
+
3802
+ # Deletes the specified example.
3803
+ # @param [String] name
3804
+ # Required. The name of the example to delete. Format: `projects//locations//
3805
+ # agents//playbooks//examples/`.
3806
+ # @param [String] fields
3807
+ # Selector specifying which fields to include in a partial response.
3808
+ # @param [String] quota_user
3809
+ # Available to use for quota purposes for server-side applications. Can be any
3810
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3811
+ # @param [Google::Apis::RequestOptions] options
3812
+ # Request-specific options
3813
+ #
3814
+ # @yield [result, err] Result & error if block supplied
3815
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty] parsed result object
3816
+ # @yieldparam err [StandardError] error object if request failed
3817
+ #
3818
+ # @return [Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty]
3819
+ #
3820
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3821
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3822
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3823
+ def delete_project_location_agent_playbook_example(name, fields: nil, quota_user: nil, options: nil, &block)
3824
+ command = make_simple_command(:delete, 'v3beta1/{+name}', options)
3825
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty::Representation
3826
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty
3827
+ command.params['name'] = name unless name.nil?
3828
+ command.query['fields'] = fields unless fields.nil?
3829
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3830
+ execute_or_queue_command(command, &block)
3831
+ end
3832
+
3833
+ # Retrieves the specified example.
3834
+ # @param [String] name
3835
+ # Required. The name of the example. Format: `projects//locations//agents//
3836
+ # playbooks//examples/`.
3837
+ # @param [String] fields
3838
+ # Selector specifying which fields to include in a partial response.
3839
+ # @param [String] quota_user
3840
+ # Available to use for quota purposes for server-side applications. Can be any
3841
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3842
+ # @param [Google::Apis::RequestOptions] options
3843
+ # Request-specific options
3844
+ #
3845
+ # @yield [result, err] Result & error if block supplied
3846
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example] parsed result object
3847
+ # @yieldparam err [StandardError] error object if request failed
3848
+ #
3849
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example]
3850
+ #
3851
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3852
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3853
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3854
+ def get_project_location_agent_playbook_example(name, fields: nil, quota_user: nil, options: nil, &block)
3855
+ command = make_simple_command(:get, 'v3beta1/{+name}', options)
3856
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example::Representation
3857
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example
3858
+ command.params['name'] = name unless name.nil?
3859
+ command.query['fields'] = fields unless fields.nil?
3860
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3861
+ execute_or_queue_command(command, &block)
3862
+ end
3863
+
3864
+ # Returns a list of examples in the specified playbook.
3865
+ # @param [String] parent
3866
+ # Required. The playbook to list the examples from. Format: `projects//locations/
3867
+ # /agents//playbooks/`.
3868
+ # @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.
3872
+ # @param [Fixnum] page_size
3873
+ # Optional. The maximum number of items to return in a single page. By default
3874
+ # 100 and at most 1000.
3875
+ # @param [String] page_token
3876
+ # Optional. The next_page_token value returned from a previous list request.
3877
+ # @param [String] fields
3878
+ # Selector specifying which fields to include in a partial response.
3879
+ # @param [String] quota_user
3880
+ # Available to use for quota purposes for server-side applications. Can be any
3881
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3882
+ # @param [Google::Apis::RequestOptions] options
3883
+ # Request-specific options
3884
+ #
3885
+ # @yield [result, err] Result & error if block supplied
3886
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListExamplesResponse] parsed result object
3887
+ # @yieldparam err [StandardError] error object if request failed
3888
+ #
3889
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListExamplesResponse]
3890
+ #
3891
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3892
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3893
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3894
+ def list_project_location_agent_playbook_examples(parent, language_code: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
3895
+ command = make_simple_command(:get, 'v3beta1/{+parent}/examples', options)
3896
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListExamplesResponse::Representation
3897
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListExamplesResponse
3898
+ command.params['parent'] = parent unless parent.nil?
3899
+ command.query['languageCode'] = language_code unless language_code.nil?
3900
+ command.query['pageSize'] = page_size unless page_size.nil?
3901
+ command.query['pageToken'] = page_token unless page_token.nil?
3902
+ command.query['fields'] = fields unless fields.nil?
3903
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3904
+ execute_or_queue_command(command, &block)
3905
+ end
3906
+
3907
+ # Update the specified example.
3908
+ # @param [String] name
3909
+ # The unique identifier of the playbook example. Format: `projects//locations//
3910
+ # agents//playbooks//examples/`.
3911
+ # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example] google_cloud_dialogflow_cx_v3beta1_example_object
3912
+ # @param [String] update_mask
3913
+ # Optional. The mask to control which fields get updated. If the mask is not
3914
+ # present, all fields will be updated.
3915
+ # @param [String] fields
3916
+ # Selector specifying which fields to include in a partial response.
3917
+ # @param [String] quota_user
3918
+ # Available to use for quota purposes for server-side applications. Can be any
3919
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3920
+ # @param [Google::Apis::RequestOptions] options
3921
+ # Request-specific options
3922
+ #
3923
+ # @yield [result, err] Result & error if block supplied
3924
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example] parsed result object
3925
+ # @yieldparam err [StandardError] error object if request failed
3926
+ #
3927
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example]
3928
+ #
3929
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3930
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3931
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3932
+ def patch_project_location_agent_playbook_example(name, google_cloud_dialogflow_cx_v3beta1_example_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
3933
+ command = make_simple_command(:patch, 'v3beta1/{+name}', options)
3934
+ command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example::Representation
3935
+ command.request_object = google_cloud_dialogflow_cx_v3beta1_example_object
3936
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example::Representation
3937
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example
3938
+ command.params['name'] = name unless name.nil?
3939
+ command.query['updateMask'] = update_mask unless update_mask.nil?
3940
+ command.query['fields'] = fields unless fields.nil?
3941
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3942
+ execute_or_queue_command(command, &block)
3943
+ end
3944
+
3945
+ # Creates a version for the specified Playbook.
3946
+ # @param [String] parent
3947
+ # Required. The playbook to create a version for. Format: `projects//locations//
3948
+ # agents//playbooks/`.
3949
+ # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookVersion] google_cloud_dialogflow_cx_v3beta1_playbook_version_object
3950
+ # @param [String] fields
3951
+ # Selector specifying which fields to include in a partial response.
3952
+ # @param [String] quota_user
3953
+ # Available to use for quota purposes for server-side applications. Can be any
3954
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3955
+ # @param [Google::Apis::RequestOptions] options
3956
+ # Request-specific options
3957
+ #
3958
+ # @yield [result, err] Result & error if block supplied
3959
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookVersion] parsed result object
3960
+ # @yieldparam err [StandardError] error object if request failed
3961
+ #
3962
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookVersion]
3963
+ #
3964
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3965
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3966
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3967
+ def create_project_location_agent_playbook_version(parent, google_cloud_dialogflow_cx_v3beta1_playbook_version_object = nil, fields: nil, quota_user: nil, options: nil, &block)
3968
+ command = make_simple_command(:post, 'v3beta1/{+parent}/versions', options)
3969
+ command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookVersion::Representation
3970
+ command.request_object = google_cloud_dialogflow_cx_v3beta1_playbook_version_object
3971
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookVersion::Representation
3972
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookVersion
3973
+ command.params['parent'] = parent unless parent.nil?
3974
+ command.query['fields'] = fields unless fields.nil?
3975
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3976
+ execute_or_queue_command(command, &block)
3977
+ end
3978
+
3979
+ # Deletes the specified version of the Playbook.
3980
+ # @param [String] name
3981
+ # Required. The name of the playbook version to delete. Format: `projects//
3982
+ # locations//agents//playbooks//versions/`.
3983
+ # @param [String] fields
3984
+ # Selector specifying which fields to include in a partial response.
3985
+ # @param [String] quota_user
3986
+ # Available to use for quota purposes for server-side applications. Can be any
3987
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3988
+ # @param [Google::Apis::RequestOptions] options
3989
+ # Request-specific options
3990
+ #
3991
+ # @yield [result, err] Result & error if block supplied
3992
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty] parsed result object
3993
+ # @yieldparam err [StandardError] error object if request failed
3994
+ #
3995
+ # @return [Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty]
3996
+ #
3997
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3998
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3999
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4000
+ def delete_project_location_agent_playbook_version(name, fields: nil, quota_user: nil, options: nil, &block)
4001
+ command = make_simple_command(:delete, 'v3beta1/{+name}', options)
4002
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty::Representation
4003
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty
4004
+ command.params['name'] = name unless name.nil?
4005
+ command.query['fields'] = fields unless fields.nil?
4006
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4007
+ execute_or_queue_command(command, &block)
4008
+ end
4009
+
4010
+ # Retrieves the specified version of the Playbook.
4011
+ # @param [String] name
4012
+ # Required. The name of the playbook version. Format: `projects//locations//
4013
+ # agents//playbooks//versions/`.
4014
+ # @param [String] fields
4015
+ # Selector specifying which fields to include in a partial response.
4016
+ # @param [String] quota_user
4017
+ # Available to use for quota purposes for server-side applications. Can be any
4018
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4019
+ # @param [Google::Apis::RequestOptions] options
4020
+ # Request-specific options
4021
+ #
4022
+ # @yield [result, err] Result & error if block supplied
4023
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookVersion] parsed result object
4024
+ # @yieldparam err [StandardError] error object if request failed
4025
+ #
4026
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookVersion]
4027
+ #
4028
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4029
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4030
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4031
+ def get_project_location_agent_playbook_version(name, fields: nil, quota_user: nil, options: nil, &block)
4032
+ command = make_simple_command(:get, 'v3beta1/{+name}', options)
4033
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookVersion::Representation
4034
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookVersion
4035
+ command.params['name'] = name unless name.nil?
4036
+ command.query['fields'] = fields unless fields.nil?
4037
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4038
+ execute_or_queue_command(command, &block)
4039
+ end
4040
+
4041
+ # Lists versions for the specified Playbook.
4042
+ # @param [String] parent
4043
+ # Required. The playbook to list versions for. Format: `projects//locations//
4044
+ # agents//playbooks/`.
4045
+ # @param [Fixnum] page_size
4046
+ # Optional. The maximum number of items to return in a single page. By default
4047
+ # 100 and at most 1000.
4048
+ # @param [String] page_token
4049
+ # Optional. The next_page_token value returned from a previous list request.
4050
+ # @param [String] fields
4051
+ # Selector specifying which fields to include in a partial response.
4052
+ # @param [String] quota_user
4053
+ # Available to use for quota purposes for server-side applications. Can be any
4054
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4055
+ # @param [Google::Apis::RequestOptions] options
4056
+ # Request-specific options
4057
+ #
4058
+ # @yield [result, err] Result & error if block supplied
4059
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListPlaybookVersionsResponse] parsed result object
4060
+ # @yieldparam err [StandardError] error object if request failed
4061
+ #
4062
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListPlaybookVersionsResponse]
4063
+ #
4064
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4065
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4066
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4067
+ def list_project_location_agent_playbook_versions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
4068
+ command = make_simple_command(:get, 'v3beta1/{+parent}/versions', options)
4069
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListPlaybookVersionsResponse::Representation
4070
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListPlaybookVersionsResponse
4071
+ command.params['parent'] = parent unless parent.nil?
4072
+ command.query['pageSize'] = page_size unless page_size.nil?
4073
+ command.query['pageToken'] = page_token unless page_token.nil?
4074
+ command.query['fields'] = fields unless fields.nil?
4075
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4076
+ execute_or_queue_command(command, &block)
4077
+ end
4078
+
3596
4079
  # Processes a natural language query and returns structured, actionable data as
3597
4080
  # a result. This method is not idempotent, because it may cause session entity
3598
4081
  # types to be updated, which in turn might affect results of future queries.
@@ -4432,6 +4915,217 @@ module Google
4432
4915
  execute_or_queue_command(command, &block)
4433
4916
  end
4434
4917
 
4918
+ # Creates a Tool in the specified agent.
4919
+ # @param [String] parent
4920
+ # Required. The agent to create a Tool for. Format: `projects//locations//agents/
4921
+ # `.
4922
+ # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool] google_cloud_dialogflow_cx_v3beta1_tool_object
4923
+ # @param [String] fields
4924
+ # Selector specifying which fields to include in a partial response.
4925
+ # @param [String] quota_user
4926
+ # Available to use for quota purposes for server-side applications. Can be any
4927
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4928
+ # @param [Google::Apis::RequestOptions] options
4929
+ # Request-specific options
4930
+ #
4931
+ # @yield [result, err] Result & error if block supplied
4932
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool] parsed result object
4933
+ # @yieldparam err [StandardError] error object if request failed
4934
+ #
4935
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool]
4936
+ #
4937
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4938
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4939
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4940
+ def create_project_location_agent_tool(parent, google_cloud_dialogflow_cx_v3beta1_tool_object = nil, fields: nil, quota_user: nil, options: nil, &block)
4941
+ command = make_simple_command(:post, 'v3beta1/{+parent}/tools', options)
4942
+ command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool::Representation
4943
+ command.request_object = google_cloud_dialogflow_cx_v3beta1_tool_object
4944
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool::Representation
4945
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool
4946
+ command.params['parent'] = parent unless parent.nil?
4947
+ command.query['fields'] = fields unless fields.nil?
4948
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4949
+ execute_or_queue_command(command, &block)
4950
+ end
4951
+
4952
+ # Deletes a specified Tool.
4953
+ # @param [String] name
4954
+ # Required. The name of the Tool to be deleted. Format: `projects//locations//
4955
+ # agents//tools/`.
4956
+ # @param [Boolean] force
4957
+ # This field has no effect for Tools not being used. For Tools that are used: *
4958
+ # If `force` is set to false, an error will be returned with message indicating
4959
+ # the referenced resources. * If `force` is set to true, Dialogflow will remove
4960
+ # the tool, as well as any references to the tool.
4961
+ # @param [String] fields
4962
+ # Selector specifying which fields to include in a partial response.
4963
+ # @param [String] quota_user
4964
+ # Available to use for quota purposes for server-side applications. Can be any
4965
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4966
+ # @param [Google::Apis::RequestOptions] options
4967
+ # Request-specific options
4968
+ #
4969
+ # @yield [result, err] Result & error if block supplied
4970
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty] parsed result object
4971
+ # @yieldparam err [StandardError] error object if request failed
4972
+ #
4973
+ # @return [Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty]
4974
+ #
4975
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4976
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4977
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4978
+ def delete_project_location_agent_tool(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
4979
+ command = make_simple_command(:delete, 'v3beta1/{+name}', options)
4980
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty::Representation
4981
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty
4982
+ command.params['name'] = name unless name.nil?
4983
+ command.query['force'] = force unless force.nil?
4984
+ command.query['fields'] = fields unless fields.nil?
4985
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4986
+ execute_or_queue_command(command, &block)
4987
+ end
4988
+
4989
+ # Exports the selected tools.
4990
+ # @param [String] parent
4991
+ # Required. The agent to export tools from. Format: `projects//locations//agents/
4992
+ # `.
4993
+ # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ExportToolsRequest] google_cloud_dialogflow_cx_v3beta1_export_tools_request_object
4994
+ # @param [String] fields
4995
+ # Selector specifying which fields to include in a partial response.
4996
+ # @param [String] quota_user
4997
+ # Available to use for quota purposes for server-side applications. Can be any
4998
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4999
+ # @param [Google::Apis::RequestOptions] options
5000
+ # Request-specific options
5001
+ #
5002
+ # @yield [result, err] Result & error if block supplied
5003
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation] parsed result object
5004
+ # @yieldparam err [StandardError] error object if request failed
5005
+ #
5006
+ # @return [Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation]
5007
+ #
5008
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5009
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5010
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5011
+ def export_project_location_agent_tool(parent, google_cloud_dialogflow_cx_v3beta1_export_tools_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
5012
+ command = make_simple_command(:post, 'v3beta1/{+parent}/tools:export', options)
5013
+ command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ExportToolsRequest::Representation
5014
+ command.request_object = google_cloud_dialogflow_cx_v3beta1_export_tools_request_object
5015
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation::Representation
5016
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation
5017
+ command.params['parent'] = parent unless parent.nil?
5018
+ command.query['fields'] = fields unless fields.nil?
5019
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5020
+ execute_or_queue_command(command, &block)
5021
+ end
5022
+
5023
+ # Retrieves the specified Tool.
5024
+ # @param [String] name
5025
+ # Required. The name of the Tool. Format: `projects//locations//agents//tools/`.
5026
+ # @param [String] fields
5027
+ # Selector specifying which fields to include in a partial response.
5028
+ # @param [String] quota_user
5029
+ # Available to use for quota purposes for server-side applications. Can be any
5030
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5031
+ # @param [Google::Apis::RequestOptions] options
5032
+ # Request-specific options
5033
+ #
5034
+ # @yield [result, err] Result & error if block supplied
5035
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool] parsed result object
5036
+ # @yieldparam err [StandardError] error object if request failed
5037
+ #
5038
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool]
5039
+ #
5040
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5041
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5042
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5043
+ def get_project_location_agent_tool(name, fields: nil, quota_user: nil, options: nil, &block)
5044
+ command = make_simple_command(:get, 'v3beta1/{+name}', options)
5045
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool::Representation
5046
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool
5047
+ command.params['name'] = name unless name.nil?
5048
+ command.query['fields'] = fields unless fields.nil?
5049
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5050
+ execute_or_queue_command(command, &block)
5051
+ end
5052
+
5053
+ # Returns a list of Tools in the specified agent.
5054
+ # @param [String] parent
5055
+ # Required. The agent to list the Tools from. Format: `projects//locations//
5056
+ # agents/`.
5057
+ # @param [Fixnum] page_size
5058
+ # The maximum number of items to return in a single page. By default 100 and at
5059
+ # most 1000.
5060
+ # @param [String] page_token
5061
+ # The next_page_token value returned from a previous list request.
5062
+ # @param [String] fields
5063
+ # Selector specifying which fields to include in a partial response.
5064
+ # @param [String] quota_user
5065
+ # Available to use for quota purposes for server-side applications. Can be any
5066
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5067
+ # @param [Google::Apis::RequestOptions] options
5068
+ # Request-specific options
5069
+ #
5070
+ # @yield [result, err] Result & error if block supplied
5071
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListToolsResponse] parsed result object
5072
+ # @yieldparam err [StandardError] error object if request failed
5073
+ #
5074
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListToolsResponse]
5075
+ #
5076
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5077
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5078
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5079
+ def list_project_location_agent_tools(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
5080
+ command = make_simple_command(:get, 'v3beta1/{+parent}/tools', options)
5081
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListToolsResponse::Representation
5082
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListToolsResponse
5083
+ command.params['parent'] = parent unless parent.nil?
5084
+ command.query['pageSize'] = page_size unless page_size.nil?
5085
+ command.query['pageToken'] = page_token unless page_token.nil?
5086
+ command.query['fields'] = fields unless fields.nil?
5087
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5088
+ execute_or_queue_command(command, &block)
5089
+ end
5090
+
5091
+ # Update the specified Tool.
5092
+ # @param [String] name
5093
+ # The unique identifier of the Tool. Format: `projects//locations//agents//tools/
5094
+ # `.
5095
+ # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool] google_cloud_dialogflow_cx_v3beta1_tool_object
5096
+ # @param [String] update_mask
5097
+ # The mask to control which fields get updated. If the mask is not present, all
5098
+ # fields will be updated.
5099
+ # @param [String] fields
5100
+ # Selector specifying which fields to include in a partial response.
5101
+ # @param [String] quota_user
5102
+ # Available to use for quota purposes for server-side applications. Can be any
5103
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5104
+ # @param [Google::Apis::RequestOptions] options
5105
+ # Request-specific options
5106
+ #
5107
+ # @yield [result, err] Result & error if block supplied
5108
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool] parsed result object
5109
+ # @yieldparam err [StandardError] error object if request failed
5110
+ #
5111
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool]
5112
+ #
5113
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5114
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5115
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5116
+ def patch_project_location_agent_tool(name, google_cloud_dialogflow_cx_v3beta1_tool_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
5117
+ command = make_simple_command(:patch, 'v3beta1/{+name}', options)
5118
+ command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool::Representation
5119
+ command.request_object = google_cloud_dialogflow_cx_v3beta1_tool_object
5120
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool::Representation
5121
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool
5122
+ command.params['name'] = name unless name.nil?
5123
+ command.query['updateMask'] = update_mask unless update_mask.nil?
5124
+ command.query['fields'] = fields unless fields.nil?
5125
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5126
+ execute_or_queue_command(command, &block)
5127
+ end
5128
+
4435
5129
  # Creates an TransitionRouteGroup in the specified flow. Note: You should always
4436
5130
  # train a flow prior to sending it queries. See the [training documentation](
4437
5131
  # https://cloud.google.com/dialogflow/cx/docs/concept/training).