google-apis-dialogflow_v3beta1 0.79.0 → 0.80.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.
@@ -3484,6 +3484,489 @@ module Google
3484
3484
  execute_or_queue_command(command, &block)
3485
3485
  end
3486
3486
 
3487
+ # Creates a playbook in a specified agent.
3488
+ # @param [String] parent
3489
+ # Required. The agent to create a playbook for. Format: `projects//locations//
3490
+ # agents/`.
3491
+ # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook] google_cloud_dialogflow_cx_v3beta1_playbook_object
3492
+ # @param [String] fields
3493
+ # Selector specifying which fields to include in a partial response.
3494
+ # @param [String] quota_user
3495
+ # Available to use for quota purposes for server-side applications. Can be any
3496
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3497
+ # @param [Google::Apis::RequestOptions] options
3498
+ # Request-specific options
3499
+ #
3500
+ # @yield [result, err] Result & error if block supplied
3501
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook] parsed result object
3502
+ # @yieldparam err [StandardError] error object if request failed
3503
+ #
3504
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook]
3505
+ #
3506
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3507
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3508
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3509
+ def create_project_location_agent_playbook(parent, google_cloud_dialogflow_cx_v3beta1_playbook_object = nil, fields: nil, quota_user: nil, options: nil, &block)
3510
+ command = make_simple_command(:post, 'v3beta1/{+parent}/playbooks', options)
3511
+ command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook::Representation
3512
+ command.request_object = google_cloud_dialogflow_cx_v3beta1_playbook_object
3513
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook::Representation
3514
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook
3515
+ command.params['parent'] = parent unless parent.nil?
3516
+ command.query['fields'] = fields unless fields.nil?
3517
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3518
+ execute_or_queue_command(command, &block)
3519
+ end
3520
+
3521
+ # Deletes a specified playbook.
3522
+ # @param [String] name
3523
+ # Required. The name of the playbook to delete. Format: `projects//locations//
3524
+ # agents//playbooks/`.
3525
+ # @param [String] fields
3526
+ # Selector specifying which fields to include in a partial response.
3527
+ # @param [String] quota_user
3528
+ # Available to use for quota purposes for server-side applications. Can be any
3529
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3530
+ # @param [Google::Apis::RequestOptions] options
3531
+ # Request-specific options
3532
+ #
3533
+ # @yield [result, err] Result & error if block supplied
3534
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty] parsed result object
3535
+ # @yieldparam err [StandardError] error object if request failed
3536
+ #
3537
+ # @return [Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty]
3538
+ #
3539
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3540
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3541
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3542
+ def delete_project_location_agent_playbook(name, fields: nil, quota_user: nil, options: nil, &block)
3543
+ command = make_simple_command(:delete, 'v3beta1/{+name}', options)
3544
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty::Representation
3545
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty
3546
+ command.params['name'] = name unless name.nil?
3547
+ command.query['fields'] = fields unless fields.nil?
3548
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3549
+ execute_or_queue_command(command, &block)
3550
+ end
3551
+
3552
+ # Retrieves the specified Playbook.
3553
+ # @param [String] name
3554
+ # Required. The name of the playbook. Format: `projects//locations//agents//
3555
+ # playbooks/`.
3556
+ # @param [String] fields
3557
+ # Selector specifying which fields to include in a partial response.
3558
+ # @param [String] quota_user
3559
+ # Available to use for quota purposes for server-side applications. Can be any
3560
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3561
+ # @param [Google::Apis::RequestOptions] options
3562
+ # Request-specific options
3563
+ #
3564
+ # @yield [result, err] Result & error if block supplied
3565
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook] parsed result object
3566
+ # @yieldparam err [StandardError] error object if request failed
3567
+ #
3568
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook]
3569
+ #
3570
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3571
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3572
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3573
+ def get_project_location_agent_playbook(name, fields: nil, quota_user: nil, options: nil, &block)
3574
+ command = make_simple_command(:get, 'v3beta1/{+name}', options)
3575
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook::Representation
3576
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook
3577
+ command.params['name'] = name unless name.nil?
3578
+ command.query['fields'] = fields unless fields.nil?
3579
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3580
+ execute_or_queue_command(command, &block)
3581
+ end
3582
+
3583
+ # Returns a list of playbooks in the specified agent.
3584
+ # @param [String] parent
3585
+ # Required. The agent to list playbooks from. Format: `projects//locations//
3586
+ # agents/`.
3587
+ # @param [Fixnum] page_size
3588
+ # The maximum number of items to return in a single page. By default 100 and at
3589
+ # most 1000.
3590
+ # @param [String] page_token
3591
+ # The next_page_token value returned from a previous list request.
3592
+ # @param [String] fields
3593
+ # Selector specifying which fields to include in a partial response.
3594
+ # @param [String] quota_user
3595
+ # Available to use for quota purposes for server-side applications. Can be any
3596
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3597
+ # @param [Google::Apis::RequestOptions] options
3598
+ # Request-specific options
3599
+ #
3600
+ # @yield [result, err] Result & error if block supplied
3601
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListPlaybooksResponse] parsed result object
3602
+ # @yieldparam err [StandardError] error object if request failed
3603
+ #
3604
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListPlaybooksResponse]
3605
+ #
3606
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3607
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3608
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3609
+ def list_project_location_agent_playbooks(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
3610
+ command = make_simple_command(:get, 'v3beta1/{+parent}/playbooks', options)
3611
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListPlaybooksResponse::Representation
3612
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListPlaybooksResponse
3613
+ command.params['parent'] = parent unless parent.nil?
3614
+ command.query['pageSize'] = page_size unless page_size.nil?
3615
+ command.query['pageToken'] = page_token unless page_token.nil?
3616
+ command.query['fields'] = fields unless fields.nil?
3617
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3618
+ execute_or_queue_command(command, &block)
3619
+ end
3620
+
3621
+ # Updates the specified Playbook.
3622
+ # @param [String] name
3623
+ # The unique identifier of the playbook. Format: `projects//locations//agents//
3624
+ # playbooks/`.
3625
+ # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook] google_cloud_dialogflow_cx_v3beta1_playbook_object
3626
+ # @param [String] update_mask
3627
+ # The mask to control which fields get updated. If the mask is not present, all
3628
+ # fields will be updated.
3629
+ # @param [String] fields
3630
+ # Selector specifying which fields to include in a partial response.
3631
+ # @param [String] quota_user
3632
+ # Available to use for quota purposes for server-side applications. Can be any
3633
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3634
+ # @param [Google::Apis::RequestOptions] options
3635
+ # Request-specific options
3636
+ #
3637
+ # @yield [result, err] Result & error if block supplied
3638
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook] parsed result object
3639
+ # @yieldparam err [StandardError] error object if request failed
3640
+ #
3641
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook]
3642
+ #
3643
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3644
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3645
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3646
+ 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)
3647
+ command = make_simple_command(:patch, 'v3beta1/{+name}', options)
3648
+ command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook::Representation
3649
+ command.request_object = google_cloud_dialogflow_cx_v3beta1_playbook_object
3650
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook::Representation
3651
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook
3652
+ command.params['name'] = name unless name.nil?
3653
+ command.query['updateMask'] = update_mask unless update_mask.nil?
3654
+ command.query['fields'] = fields unless fields.nil?
3655
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3656
+ execute_or_queue_command(command, &block)
3657
+ end
3658
+
3659
+ # Creates an example in the specified playbook.
3660
+ # @param [String] parent
3661
+ # Required. The playbook to create an example for. Format: `projects//locations//
3662
+ # agents//playbooks/`.
3663
+ # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example] google_cloud_dialogflow_cx_v3beta1_example_object
3664
+ # @param [String] fields
3665
+ # Selector specifying which fields to include in a partial response.
3666
+ # @param [String] quota_user
3667
+ # Available to use for quota purposes for server-side applications. Can be any
3668
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3669
+ # @param [Google::Apis::RequestOptions] options
3670
+ # Request-specific options
3671
+ #
3672
+ # @yield [result, err] Result & error if block supplied
3673
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example] parsed result object
3674
+ # @yieldparam err [StandardError] error object if request failed
3675
+ #
3676
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example]
3677
+ #
3678
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3679
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3680
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3681
+ def create_project_location_agent_playbook_example(parent, google_cloud_dialogflow_cx_v3beta1_example_object = nil, fields: nil, quota_user: nil, options: nil, &block)
3682
+ command = make_simple_command(:post, 'v3beta1/{+parent}/examples', options)
3683
+ command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example::Representation
3684
+ command.request_object = google_cloud_dialogflow_cx_v3beta1_example_object
3685
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example::Representation
3686
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example
3687
+ command.params['parent'] = parent unless parent.nil?
3688
+ command.query['fields'] = fields unless fields.nil?
3689
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3690
+ execute_or_queue_command(command, &block)
3691
+ end
3692
+
3693
+ # Deletes the specified example.
3694
+ # @param [String] name
3695
+ # Required. The name of the example to delete. Format: `projects//locations//
3696
+ # agents//playbooks//examples/`.
3697
+ # @param [String] fields
3698
+ # Selector specifying which fields to include in a partial response.
3699
+ # @param [String] quota_user
3700
+ # Available to use for quota purposes for server-side applications. Can be any
3701
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3702
+ # @param [Google::Apis::RequestOptions] options
3703
+ # Request-specific options
3704
+ #
3705
+ # @yield [result, err] Result & error if block supplied
3706
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty] parsed result object
3707
+ # @yieldparam err [StandardError] error object if request failed
3708
+ #
3709
+ # @return [Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty]
3710
+ #
3711
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3712
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3713
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3714
+ def delete_project_location_agent_playbook_example(name, fields: nil, quota_user: nil, options: nil, &block)
3715
+ command = make_simple_command(:delete, 'v3beta1/{+name}', options)
3716
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty::Representation
3717
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty
3718
+ command.params['name'] = name unless name.nil?
3719
+ command.query['fields'] = fields unless fields.nil?
3720
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3721
+ execute_or_queue_command(command, &block)
3722
+ end
3723
+
3724
+ # Retrieves the specified example.
3725
+ # @param [String] name
3726
+ # Required. The name of the example. Format: `projects//locations//agents//
3727
+ # playbooks//examples/`.
3728
+ # @param [String] fields
3729
+ # Selector specifying which fields to include in a partial response.
3730
+ # @param [String] quota_user
3731
+ # Available to use for quota purposes for server-side applications. Can be any
3732
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3733
+ # @param [Google::Apis::RequestOptions] options
3734
+ # Request-specific options
3735
+ #
3736
+ # @yield [result, err] Result & error if block supplied
3737
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example] parsed result object
3738
+ # @yieldparam err [StandardError] error object if request failed
3739
+ #
3740
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example]
3741
+ #
3742
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3743
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3744
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3745
+ def get_project_location_agent_playbook_example(name, fields: nil, quota_user: nil, options: nil, &block)
3746
+ command = make_simple_command(:get, 'v3beta1/{+name}', options)
3747
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example::Representation
3748
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example
3749
+ command.params['name'] = name unless name.nil?
3750
+ command.query['fields'] = fields unless fields.nil?
3751
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3752
+ execute_or_queue_command(command, &block)
3753
+ end
3754
+
3755
+ # Returns a list of examples in the specified playbook.
3756
+ # @param [String] parent
3757
+ # Required. The playbook to list the examples from. Format: `projects//locations/
3758
+ # /agents//playbooks/`.
3759
+ # @param [String] language_code
3760
+ # Optional. The language to list examples for. If not specified, the agent's
3761
+ # default language is used. Note: languages must be enabled in the agent before
3762
+ # they can be used.
3763
+ # @param [Fixnum] page_size
3764
+ # Optional. The maximum number of items to return in a single page. By default
3765
+ # 100 and at most 1000.
3766
+ # @param [String] page_token
3767
+ # Optional. The next_page_token value returned from a previous list request.
3768
+ # @param [String] fields
3769
+ # Selector specifying which fields to include in a partial response.
3770
+ # @param [String] quota_user
3771
+ # Available to use for quota purposes for server-side applications. Can be any
3772
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3773
+ # @param [Google::Apis::RequestOptions] options
3774
+ # Request-specific options
3775
+ #
3776
+ # @yield [result, err] Result & error if block supplied
3777
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListExamplesResponse] parsed result object
3778
+ # @yieldparam err [StandardError] error object if request failed
3779
+ #
3780
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListExamplesResponse]
3781
+ #
3782
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3783
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3784
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3785
+ 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)
3786
+ command = make_simple_command(:get, 'v3beta1/{+parent}/examples', options)
3787
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListExamplesResponse::Representation
3788
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListExamplesResponse
3789
+ command.params['parent'] = parent unless parent.nil?
3790
+ command.query['languageCode'] = language_code unless language_code.nil?
3791
+ command.query['pageSize'] = page_size unless page_size.nil?
3792
+ command.query['pageToken'] = page_token unless page_token.nil?
3793
+ command.query['fields'] = fields unless fields.nil?
3794
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3795
+ execute_or_queue_command(command, &block)
3796
+ end
3797
+
3798
+ # Update the specified example.
3799
+ # @param [String] name
3800
+ # The unique identifier of the playbook example. Format: `projects//locations//
3801
+ # agents//playbooks//examples/`.
3802
+ # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example] google_cloud_dialogflow_cx_v3beta1_example_object
3803
+ # @param [String] update_mask
3804
+ # Optional. The mask to control which fields get updated. If the mask is not
3805
+ # present, all fields will be updated.
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::GoogleCloudDialogflowCxV3beta1Example] parsed result object
3816
+ # @yieldparam err [StandardError] error object if request failed
3817
+ #
3818
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example]
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 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)
3824
+ command = make_simple_command(:patch, 'v3beta1/{+name}', options)
3825
+ command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example::Representation
3826
+ command.request_object = google_cloud_dialogflow_cx_v3beta1_example_object
3827
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example::Representation
3828
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example
3829
+ command.params['name'] = name unless name.nil?
3830
+ command.query['updateMask'] = update_mask unless update_mask.nil?
3831
+ command.query['fields'] = fields unless fields.nil?
3832
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3833
+ execute_or_queue_command(command, &block)
3834
+ end
3835
+
3836
+ # Creates a version for the specified Playbook.
3837
+ # @param [String] parent
3838
+ # Required. The playbook to create a version for. Format: `projects//locations//
3839
+ # agents//playbooks/`.
3840
+ # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookVersion] google_cloud_dialogflow_cx_v3beta1_playbook_version_object
3841
+ # @param [String] fields
3842
+ # Selector specifying which fields to include in a partial response.
3843
+ # @param [String] quota_user
3844
+ # Available to use for quota purposes for server-side applications. Can be any
3845
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3846
+ # @param [Google::Apis::RequestOptions] options
3847
+ # Request-specific options
3848
+ #
3849
+ # @yield [result, err] Result & error if block supplied
3850
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookVersion] parsed result object
3851
+ # @yieldparam err [StandardError] error object if request failed
3852
+ #
3853
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookVersion]
3854
+ #
3855
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3856
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3857
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3858
+ 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)
3859
+ command = make_simple_command(:post, 'v3beta1/{+parent}/versions', options)
3860
+ command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookVersion::Representation
3861
+ command.request_object = google_cloud_dialogflow_cx_v3beta1_playbook_version_object
3862
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookVersion::Representation
3863
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookVersion
3864
+ command.params['parent'] = parent unless parent.nil?
3865
+ command.query['fields'] = fields unless fields.nil?
3866
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3867
+ execute_or_queue_command(command, &block)
3868
+ end
3869
+
3870
+ # Deletes the specified version of the Playbook.
3871
+ # @param [String] name
3872
+ # Required. The name of the playbook version to delete. Format: `projects//
3873
+ # locations//agents//playbooks//versions/`.
3874
+ # @param [String] fields
3875
+ # Selector specifying which fields to include in a partial response.
3876
+ # @param [String] quota_user
3877
+ # Available to use for quota purposes for server-side applications. Can be any
3878
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3879
+ # @param [Google::Apis::RequestOptions] options
3880
+ # Request-specific options
3881
+ #
3882
+ # @yield [result, err] Result & error if block supplied
3883
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty] parsed result object
3884
+ # @yieldparam err [StandardError] error object if request failed
3885
+ #
3886
+ # @return [Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty]
3887
+ #
3888
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3889
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3890
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3891
+ def delete_project_location_agent_playbook_version(name, fields: nil, quota_user: nil, options: nil, &block)
3892
+ command = make_simple_command(:delete, 'v3beta1/{+name}', options)
3893
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty::Representation
3894
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty
3895
+ command.params['name'] = name unless name.nil?
3896
+ command.query['fields'] = fields unless fields.nil?
3897
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3898
+ execute_or_queue_command(command, &block)
3899
+ end
3900
+
3901
+ # Retrieves the specified version of the Playbook.
3902
+ # @param [String] name
3903
+ # Required. The name of the playbook version. Format: `projects//locations//
3904
+ # agents//playbooks//versions/`.
3905
+ # @param [String] fields
3906
+ # Selector specifying which fields to include in a partial response.
3907
+ # @param [String] quota_user
3908
+ # Available to use for quota purposes for server-side applications. Can be any
3909
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3910
+ # @param [Google::Apis::RequestOptions] options
3911
+ # Request-specific options
3912
+ #
3913
+ # @yield [result, err] Result & error if block supplied
3914
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookVersion] parsed result object
3915
+ # @yieldparam err [StandardError] error object if request failed
3916
+ #
3917
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookVersion]
3918
+ #
3919
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3920
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3921
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3922
+ def get_project_location_agent_playbook_version(name, fields: nil, quota_user: nil, options: nil, &block)
3923
+ command = make_simple_command(:get, 'v3beta1/{+name}', options)
3924
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookVersion::Representation
3925
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookVersion
3926
+ command.params['name'] = name unless name.nil?
3927
+ command.query['fields'] = fields unless fields.nil?
3928
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3929
+ execute_or_queue_command(command, &block)
3930
+ end
3931
+
3932
+ # Lists versions for the specified Playbook.
3933
+ # @param [String] parent
3934
+ # Required. The playbook to list versions for. Format: `projects//locations//
3935
+ # agents//playbooks/`.
3936
+ # @param [Fixnum] page_size
3937
+ # Optional. The maximum number of items to return in a single page. By default
3938
+ # 100 and at most 1000.
3939
+ # @param [String] page_token
3940
+ # Optional. The next_page_token value returned from a previous list request.
3941
+ # @param [String] fields
3942
+ # Selector specifying which fields to include in a partial response.
3943
+ # @param [String] quota_user
3944
+ # Available to use for quota purposes for server-side applications. Can be any
3945
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3946
+ # @param [Google::Apis::RequestOptions] options
3947
+ # Request-specific options
3948
+ #
3949
+ # @yield [result, err] Result & error if block supplied
3950
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListPlaybookVersionsResponse] parsed result object
3951
+ # @yieldparam err [StandardError] error object if request failed
3952
+ #
3953
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListPlaybookVersionsResponse]
3954
+ #
3955
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3956
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3957
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3958
+ def list_project_location_agent_playbook_versions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
3959
+ command = make_simple_command(:get, 'v3beta1/{+parent}/versions', options)
3960
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListPlaybookVersionsResponse::Representation
3961
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListPlaybookVersionsResponse
3962
+ command.params['parent'] = parent unless parent.nil?
3963
+ command.query['pageSize'] = page_size unless page_size.nil?
3964
+ command.query['pageToken'] = page_token unless page_token.nil?
3965
+ command.query['fields'] = fields unless fields.nil?
3966
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3967
+ execute_or_queue_command(command, &block)
3968
+ end
3969
+
3487
3970
  # Processes a natural language query and returns structured, actionable data as
3488
3971
  # a result. This method is not idempotent, because it may cause session entity
3489
3972
  # types to be updated, which in turn might affect results of future queries.
@@ -4323,6 +4806,217 @@ module Google
4323
4806
  execute_or_queue_command(command, &block)
4324
4807
  end
4325
4808
 
4809
+ # Creates a Tool in the specified agent.
4810
+ # @param [String] parent
4811
+ # Required. The agent to create a Tool for. Format: `projects//locations//agents/
4812
+ # `.
4813
+ # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool] google_cloud_dialogflow_cx_v3beta1_tool_object
4814
+ # @param [String] fields
4815
+ # Selector specifying which fields to include in a partial response.
4816
+ # @param [String] quota_user
4817
+ # Available to use for quota purposes for server-side applications. Can be any
4818
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4819
+ # @param [Google::Apis::RequestOptions] options
4820
+ # Request-specific options
4821
+ #
4822
+ # @yield [result, err] Result & error if block supplied
4823
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool] parsed result object
4824
+ # @yieldparam err [StandardError] error object if request failed
4825
+ #
4826
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool]
4827
+ #
4828
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4829
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4830
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4831
+ def create_project_location_agent_tool(parent, google_cloud_dialogflow_cx_v3beta1_tool_object = nil, fields: nil, quota_user: nil, options: nil, &block)
4832
+ command = make_simple_command(:post, 'v3beta1/{+parent}/tools', options)
4833
+ command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool::Representation
4834
+ command.request_object = google_cloud_dialogflow_cx_v3beta1_tool_object
4835
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool::Representation
4836
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool
4837
+ command.params['parent'] = parent unless parent.nil?
4838
+ command.query['fields'] = fields unless fields.nil?
4839
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4840
+ execute_or_queue_command(command, &block)
4841
+ end
4842
+
4843
+ # Deletes a specified Tool.
4844
+ # @param [String] name
4845
+ # Required. The name of the Tool to be deleted. Format: `projects//locations//
4846
+ # agents//tools/`.
4847
+ # @param [Boolean] force
4848
+ # This field has no effect for Tools not being used. For Tools that are used: *
4849
+ # If `force` is set to false, an error will be returned with message indicating
4850
+ # the referenced resources. * If `force` is set to true, Dialogflow will remove
4851
+ # the tool, as well as any references to the tool.
4852
+ # @param [String] fields
4853
+ # Selector specifying which fields to include in a partial response.
4854
+ # @param [String] quota_user
4855
+ # Available to use for quota purposes for server-side applications. Can be any
4856
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4857
+ # @param [Google::Apis::RequestOptions] options
4858
+ # Request-specific options
4859
+ #
4860
+ # @yield [result, err] Result & error if block supplied
4861
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty] parsed result object
4862
+ # @yieldparam err [StandardError] error object if request failed
4863
+ #
4864
+ # @return [Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty]
4865
+ #
4866
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4867
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4868
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4869
+ def delete_project_location_agent_tool(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
4870
+ command = make_simple_command(:delete, 'v3beta1/{+name}', options)
4871
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty::Representation
4872
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty
4873
+ command.params['name'] = name unless name.nil?
4874
+ command.query['force'] = force unless force.nil?
4875
+ command.query['fields'] = fields unless fields.nil?
4876
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4877
+ execute_or_queue_command(command, &block)
4878
+ end
4879
+
4880
+ # Exports the selected tools.
4881
+ # @param [String] parent
4882
+ # Required. The agent to export tools from. Format: `projects//locations//agents/
4883
+ # `.
4884
+ # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ExportToolsRequest] google_cloud_dialogflow_cx_v3beta1_export_tools_request_object
4885
+ # @param [String] fields
4886
+ # Selector specifying which fields to include in a partial response.
4887
+ # @param [String] quota_user
4888
+ # Available to use for quota purposes for server-side applications. Can be any
4889
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4890
+ # @param [Google::Apis::RequestOptions] options
4891
+ # Request-specific options
4892
+ #
4893
+ # @yield [result, err] Result & error if block supplied
4894
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation] parsed result object
4895
+ # @yieldparam err [StandardError] error object if request failed
4896
+ #
4897
+ # @return [Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation]
4898
+ #
4899
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4900
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4901
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4902
+ 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)
4903
+ command = make_simple_command(:post, 'v3beta1/{+parent}/tools:export', options)
4904
+ command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ExportToolsRequest::Representation
4905
+ command.request_object = google_cloud_dialogflow_cx_v3beta1_export_tools_request_object
4906
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation::Representation
4907
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation
4908
+ command.params['parent'] = parent unless parent.nil?
4909
+ command.query['fields'] = fields unless fields.nil?
4910
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4911
+ execute_or_queue_command(command, &block)
4912
+ end
4913
+
4914
+ # Retrieves the specified Tool.
4915
+ # @param [String] name
4916
+ # Required. The name of the Tool. Format: `projects//locations//agents//tools/`.
4917
+ # @param [String] fields
4918
+ # Selector specifying which fields to include in a partial response.
4919
+ # @param [String] quota_user
4920
+ # Available to use for quota purposes for server-side applications. Can be any
4921
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4922
+ # @param [Google::Apis::RequestOptions] options
4923
+ # Request-specific options
4924
+ #
4925
+ # @yield [result, err] Result & error if block supplied
4926
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool] parsed result object
4927
+ # @yieldparam err [StandardError] error object if request failed
4928
+ #
4929
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool]
4930
+ #
4931
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4932
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4933
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4934
+ def get_project_location_agent_tool(name, fields: nil, quota_user: nil, options: nil, &block)
4935
+ command = make_simple_command(:get, 'v3beta1/{+name}', options)
4936
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool::Representation
4937
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool
4938
+ command.params['name'] = name unless name.nil?
4939
+ command.query['fields'] = fields unless fields.nil?
4940
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4941
+ execute_or_queue_command(command, &block)
4942
+ end
4943
+
4944
+ # Returns a list of Tools in the specified agent.
4945
+ # @param [String] parent
4946
+ # Required. The agent to list the Tools from. Format: `projects//locations//
4947
+ # agents/`.
4948
+ # @param [Fixnum] page_size
4949
+ # The maximum number of items to return in a single page. By default 100 and at
4950
+ # most 1000.
4951
+ # @param [String] page_token
4952
+ # The next_page_token value returned from a previous list request.
4953
+ # @param [String] fields
4954
+ # Selector specifying which fields to include in a partial response.
4955
+ # @param [String] quota_user
4956
+ # Available to use for quota purposes for server-side applications. Can be any
4957
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4958
+ # @param [Google::Apis::RequestOptions] options
4959
+ # Request-specific options
4960
+ #
4961
+ # @yield [result, err] Result & error if block supplied
4962
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListToolsResponse] parsed result object
4963
+ # @yieldparam err [StandardError] error object if request failed
4964
+ #
4965
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListToolsResponse]
4966
+ #
4967
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4968
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4969
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4970
+ def list_project_location_agent_tools(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
4971
+ command = make_simple_command(:get, 'v3beta1/{+parent}/tools', options)
4972
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListToolsResponse::Representation
4973
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListToolsResponse
4974
+ command.params['parent'] = parent unless parent.nil?
4975
+ command.query['pageSize'] = page_size unless page_size.nil?
4976
+ command.query['pageToken'] = page_token unless page_token.nil?
4977
+ command.query['fields'] = fields unless fields.nil?
4978
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4979
+ execute_or_queue_command(command, &block)
4980
+ end
4981
+
4982
+ # Update the specified Tool.
4983
+ # @param [String] name
4984
+ # The unique identifier of the Tool. Format: `projects//locations//agents//tools/
4985
+ # `.
4986
+ # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool] google_cloud_dialogflow_cx_v3beta1_tool_object
4987
+ # @param [String] update_mask
4988
+ # The mask to control which fields get updated. If the mask is not present, all
4989
+ # fields will be updated.
4990
+ # @param [String] fields
4991
+ # Selector specifying which fields to include in a partial response.
4992
+ # @param [String] quota_user
4993
+ # Available to use for quota purposes for server-side applications. Can be any
4994
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4995
+ # @param [Google::Apis::RequestOptions] options
4996
+ # Request-specific options
4997
+ #
4998
+ # @yield [result, err] Result & error if block supplied
4999
+ # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool] parsed result object
5000
+ # @yieldparam err [StandardError] error object if request failed
5001
+ #
5002
+ # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool]
5003
+ #
5004
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5005
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5006
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5007
+ 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)
5008
+ command = make_simple_command(:patch, 'v3beta1/{+name}', options)
5009
+ command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool::Representation
5010
+ command.request_object = google_cloud_dialogflow_cx_v3beta1_tool_object
5011
+ command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool::Representation
5012
+ command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool
5013
+ command.params['name'] = name unless name.nil?
5014
+ command.query['updateMask'] = update_mask unless update_mask.nil?
5015
+ command.query['fields'] = fields unless fields.nil?
5016
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5017
+ execute_or_queue_command(command, &block)
5018
+ end
5019
+
4326
5020
  # Creates an TransitionRouteGroup in the specified flow. Note: You should always
4327
5021
  # train a flow prior to sending it queries. See the [training documentation](
4328
5022
  # https://cloud.google.com/dialogflow/cx/docs/concept/training).