Class: Google::Apis::DialogflowV3beta1::DialogflowService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/dialogflow_v3beta1/service.rb

Overview

Dialogflow API

Builds conversational interfaces (for example, chatbots, and voice-powered apps and devices).

Examples:

require 'google/apis/dialogflow_v3beta1'

Dialogflow = Google::Apis::DialogflowV3beta1 # Alias the module
service = Dialogflow::DialogflowService.new

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE =
"https://dialogflow.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeDialogflowService

Returns a new instance of DialogflowService.



48
49
50
51
52
53
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 48

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-dialogflow_v3beta1',
        client_version: Google::Apis::DialogflowV3beta1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String)

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



41
42
43
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 41

def key
  @key
end

#quota_userString

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



46
47
48
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 46

def quota_user
  @quota_user
end

Instance Method Details

#batch_project_location_agent_test_case_delete(parent, google_cloud_dialogflow_cx_v3beta1_batch_delete_test_cases_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty

Batch deletes test cases.

Parameters:

  • parent (String)

    Required. The agent to delete test cases from. Format: projects//locations// agents/.

  • google_cloud_dialogflow_cx_v3beta1_batch_delete_test_cases_request_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1BatchDeleteTestCasesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 4593

def batch_project_location_agent_test_case_delete(parent, google_cloud_dialogflow_cx_v3beta1_batch_delete_test_cases_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+parent}/testCases:batchDelete', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1BatchDeleteTestCasesRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_batch_delete_test_cases_request_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_project_location_agent_test_case_run(parent, google_cloud_dialogflow_cx_v3beta1_batch_run_test_cases_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation

Kicks off a batch run of test cases. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: BatchRunTestCasesMetadata - response: BatchRunTestCasesResponse

Parameters:

  • parent (String)

    Required. Agent name. Format: projects//locations//agents/.

  • google_cloud_dialogflow_cx_v3beta1_batch_run_test_cases_request_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1BatchRunTestCasesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 4629

def batch_project_location_agent_test_case_run(parent, google_cloud_dialogflow_cx_v3beta1_batch_run_test_cases_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+parent}/testCases:batchRun', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1BatchRunTestCasesRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_batch_run_test_cases_request_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#calculate_project_location_agent_test_case_coverage(agent, type: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1CalculateCoverageResponse

Calculates the test coverage for an agent.

Parameters:

  • agent (String)

    Required. The agent to calculate coverage for. Format: projects//locations// agents/.

  • type (String) (defaults to: nil)

    Required. The type of coverage requested.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 4664

def calculate_project_location_agent_test_case_coverage(agent, type: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+agent}/testCases:calculateCoverage', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1CalculateCoverageResponse::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1CalculateCoverageResponse
  command.params['agent'] = agent unless agent.nil?
  command.query['type'] = type unless type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1 , corresponding to Code.CANCELLED.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5664
5665
5666
5667
5668
5669
5670
5671
5672
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 5664

def cancel_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1 , corresponding to Code.CANCELLED.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5947
5948
5949
5950
5951
5952
5953
5954
5955
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 5947

def cancel_project_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#compare_project_location_agent_flow_version_versions(base_version, google_cloud_dialogflow_cx_v3beta1_compare_versions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1CompareVersionsResponse

Compares the specified base version with target version.

Parameters:

  • base_version (String)

    Required. Name of the base flow version to compare with the target version. Use version ID 0 to indicate the draft version of the specified flow. Format: projects//locations//agents//flows//versions/.

  • google_cloud_dialogflow_cx_v3beta1_compare_versions_request_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1CompareVersionsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 2891

def compare_project_location_agent_flow_version_versions(base_version, google_cloud_dialogflow_cx_v3beta1_compare_versions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+baseVersion}:compareVersions', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1CompareVersionsRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_compare_versions_request_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1CompareVersionsResponse::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1CompareVersionsResponse
  command.params['baseVersion'] = base_version unless base_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_agent(parent, google_cloud_dialogflow_cx_v3beta1_agent_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Agent

Creates an agent in the specified location. Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters:

  • parent (String)

    Required. The location to create a agent for. Format: projects//locations/.

  • google_cloud_dialogflow_cx_v3beta1_agent_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Agent) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



151
152
153
154
155
156
157
158
159
160
161
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 151

def create_project_location_agent(parent, google_cloud_dialogflow_cx_v3beta1_agent_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+parent}/agents', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Agent::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_agent_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Agent::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Agent
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_agent_entity_type(parent, google_cloud_dialogflow_cx_v3beta1_entity_type_object = nil, language_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1EntityType

Creates an entity type in the specified agent.

Parameters:

  • parent (String)

    Required. The agent to create a entity type for. Format: projects//locations// agents/.

  • google_cloud_dialogflow_cx_v3beta1_entity_type_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1EntityType) (defaults to: nil)
  • language_code (String) (defaults to: nil)

    The language of the following fields in entity_type: * EntityType.entities. value * EntityType.entities.synonyms * EntityType.excluded_phrases.value If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



743
744
745
746
747
748
749
750
751
752
753
754
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 743

def create_project_location_agent_entity_type(parent, google_cloud_dialogflow_cx_v3beta1_entity_type_object = nil, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+parent}/entityTypes', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1EntityType::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_entity_type_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1EntityType::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1EntityType
  command.params['parent'] = parent unless parent.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_agent_environment(parent, google_cloud_dialogflow_cx_v3beta1_environment_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation

Creates an Environment in the specified Agent. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: Environment

Parameters:

  • parent (String)

    Required. The Agent to create an Environment for. Format: projects//locations/ /agents/.

  • google_cloud_dialogflow_cx_v3beta1_environment_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Environment) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 1023

def create_project_location_agent_environment(parent, google_cloud_dialogflow_cx_v3beta1_environment_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+parent}/environments', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Environment::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_environment_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_agent_environment_experiment(parent, google_cloud_dialogflow_cx_v3beta1_experiment_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Experiment

Creates an Experiment in the specified Environment.

Parameters:

  • parent (String)

    Required. The Agent to create an Environment for. Format: projects//locations/ /agents//environments/.

  • google_cloud_dialogflow_cx_v3beta1_experiment_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Experiment) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 1417

def create_project_location_agent_environment_experiment(parent, google_cloud_dialogflow_cx_v3beta1_experiment_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+parent}/experiments', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Experiment::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_experiment_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Experiment::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Experiment
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_agent_environment_session_entity_type(parent, google_cloud_dialogflow_cx_v3beta1_session_entity_type_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SessionEntityType

Creates a session entity type.

Parameters:

  • parent (String)

    Required. The session to create a session entity type for. Format: projects// locations//agents//sessions/ or projects//locations//agents//environments// sessions/. If Environment ID is not specified, we assume default 'draft' environment.

  • google_cloud_dialogflow_cx_v3beta1_session_entity_type_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SessionEntityType) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 1833

def create_project_location_agent_environment_session_entity_type(parent, google_cloud_dialogflow_cx_v3beta1_session_entity_type_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+parent}/entityTypes', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SessionEntityType::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_session_entity_type_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SessionEntityType::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SessionEntityType
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_agent_flow(parent, google_cloud_dialogflow_cx_v3beta1_flow_object = nil, language_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Flow

Creates a flow in the specified agent. Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters:

  • parent (String)

    Required. The agent to create a flow for. Format: projects//locations//agents/ .

  • google_cloud_dialogflow_cx_v3beta1_flow_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Flow) (defaults to: nil)
  • language_code (String) (defaults to: nil)

    The language of the following fields in flow: * Flow.event_handlers. trigger_fulfillment.messages * Flow.event_handlers.trigger_fulfillment. conditional_cases * Flow.transition_routes.trigger_fulfillment.messages * Flow.transition_routes.trigger_fulfillment.conditional_cases If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 2022

def create_project_location_agent_flow(parent, google_cloud_dialogflow_cx_v3beta1_flow_object = nil, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+parent}/flows', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Flow::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_flow_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Flow::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Flow
  command.params['parent'] = parent unless parent.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_agent_flow_page(parent, google_cloud_dialogflow_cx_v3beta1_page_object = nil, language_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Page

Creates a page in the specified flow.

Parameters:

  • parent (String)

    Required. The flow to create a page for. Format: projects//locations//agents// flows/.

  • google_cloud_dialogflow_cx_v3beta1_page_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Page) (defaults to: nil)
  • language_code (String) (defaults to: nil)

    The language of the following fields in page: * Page.entry_fulfillment. messages * Page.entry_fulfillment.conditional_cases * Page.event_handlers. trigger_fulfillment.messages * Page.event_handlers.trigger_fulfillment. conditional_cases * Page.form.parameters.fill_behavior. initial_prompt_fulfillment.messages * Page.form.parameters.fill_behavior. initial_prompt_fulfillment.conditional_cases * Page.form.parameters. fill_behavior.reprompt_event_handlers.messages * Page.form.parameters. fill_behavior.reprompt_event_handlers.conditional_cases * Page. transition_routes.trigger_fulfillment.messages * Page.transition_routes. trigger_fulfillment.conditional_cases If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 2440

def create_project_location_agent_flow_page(parent, google_cloud_dialogflow_cx_v3beta1_page_object = nil, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+parent}/pages', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Page::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_page_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Page::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Page
  command.params['parent'] = parent unless parent.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_agent_flow_transition_route_group(parent, google_cloud_dialogflow_cx_v3beta1_transition_route_group_object = nil, language_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TransitionRouteGroup

Creates an TransitionRouteGroup in the specified flow. Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters:

  • parent (String)

    Required. The flow to create an TransitionRouteGroup for. Format: projects// locations//agents//flows/ or projects//locations//agents/ for agent-level groups.

  • google_cloud_dialogflow_cx_v3beta1_transition_route_group_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TransitionRouteGroup) (defaults to: nil)
  • language_code (String) (defaults to: nil)

    The language of the following fields in TransitionRouteGroup: * TransitionRouteGroup.transition_routes.trigger_fulfillment.messages * TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 2677

def create_project_location_agent_flow_transition_route_group(parent, google_cloud_dialogflow_cx_v3beta1_transition_route_group_object = nil, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+parent}/transitionRouteGroups', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TransitionRouteGroup::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_transition_route_group_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TransitionRouteGroup::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TransitionRouteGroup
  command.params['parent'] = parent unless parent.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_agent_flow_version(parent, google_cloud_dialogflow_cx_v3beta1_version_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation

Creates a Version in the specified Flow. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: CreateVersionOperationMetadata - response: Version

Parameters:

  • parent (String)

    Required. The Flow to create an Version for. Format: projects//locations// agents//flows/.

  • google_cloud_dialogflow_cx_v3beta1_version_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Version) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 2928

def create_project_location_agent_flow_version(parent, google_cloud_dialogflow_cx_v3beta1_version_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+parent}/versions', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Version::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_version_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_agent_generator(parent, google_cloud_dialogflow_cx_v3beta1_generator_object = nil, language_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Generator

Creates a generator in the specified agent.

Parameters:

  • parent (String)

    Required. The agent to create a generator for. Format: projects//locations// agents/.

  • google_cloud_dialogflow_cx_v3beta1_generator_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Generator) (defaults to: nil)
  • language_code (String) (defaults to: nil)

    The language to create generators for the following fields: * Generator. prompt_text.text If not specified, the agent's default language is used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 3143

def create_project_location_agent_generator(parent, google_cloud_dialogflow_cx_v3beta1_generator_object = nil, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+parent}/generators', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Generator::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_generator_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Generator::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Generator
  command.params['parent'] = parent unless parent.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_agent_intent(parent, google_cloud_dialogflow_cx_v3beta1_intent_object = nil, language_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Intent

Creates an intent in the specified agent. Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters:

  • parent (String)

    Required. The agent to create an intent for. Format: projects//locations// agents/.

  • google_cloud_dialogflow_cx_v3beta1_intent_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Intent) (defaults to: nil)
  • language_code (String) (defaults to: nil)

    The language of the following fields in intent: * Intent.training_phrases. parts.text If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 3341

def create_project_location_agent_intent(parent, google_cloud_dialogflow_cx_v3beta1_intent_object = nil, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+parent}/intents', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Intent::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_intent_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Intent::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Intent
  command.params['parent'] = parent unless parent.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_agent_playbook(parent, google_cloud_dialogflow_cx_v3beta1_playbook_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook

Creates a playbook in a specified agent.

Parameters:

  • parent (String)

    Required. The agent to create a playbook for. Format: projects//locations// agents/.

  • google_cloud_dialogflow_cx_v3beta1_playbook_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 3618

def create_project_location_agent_playbook(parent, google_cloud_dialogflow_cx_v3beta1_playbook_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+parent}/playbooks', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_playbook_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_agent_playbook_example(parent, google_cloud_dialogflow_cx_v3beta1_example_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example

Creates an example in the specified playbook.

Parameters:

  • parent (String)

    Required. The playbook to create an example for. Format: projects//locations// agents//playbooks/.

  • google_cloud_dialogflow_cx_v3beta1_example_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 3859

def create_project_location_agent_playbook_example(parent, google_cloud_dialogflow_cx_v3beta1_example_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+parent}/examples', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_example_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_agent_playbook_version(parent, google_cloud_dialogflow_cx_v3beta1_playbook_version_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookVersion

Creates a version for the specified Playbook.

Parameters:

  • parent (String)

    Required. The playbook to create a version for. Format: projects//locations// agents//playbooks/.

  • google_cloud_dialogflow_cx_v3beta1_playbook_version_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookVersion) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 4036

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)
  command = make_simple_command(:post, 'v3beta1/{+parent}/versions', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookVersion::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_playbook_version_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookVersion::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookVersion
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_agent_session_entity_type(parent, google_cloud_dialogflow_cx_v3beta1_session_entity_type_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SessionEntityType

Creates a session entity type.

Parameters:

  • parent (String)

    Required. The session to create a session entity type for. Format: projects// locations//agents//sessions/ or projects//locations//agents//environments// sessions/. If Environment ID is not specified, we assume default 'draft' environment.

  • google_cloud_dialogflow_cx_v3beta1_session_entity_type_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SessionEntityType) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 4414

def create_project_location_agent_session_entity_type(parent, google_cloud_dialogflow_cx_v3beta1_session_entity_type_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+parent}/entityTypes', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SessionEntityType::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_session_entity_type_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SessionEntityType::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SessionEntityType
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_agent_test_case(parent, google_cloud_dialogflow_cx_v3beta1_test_case_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TestCase

Creates a test case for the given agent.

Parameters:

  • parent (String)

    Required. The agent to create the test case for. Format: projects//locations// agents/.

  • google_cloud_dialogflow_cx_v3beta1_test_case_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TestCase) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 4697

def create_project_location_agent_test_case(parent, google_cloud_dialogflow_cx_v3beta1_test_case_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+parent}/testCases', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TestCase::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_test_case_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TestCase::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TestCase
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_agent_tool(parent, google_cloud_dialogflow_cx_v3beta1_tool_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool

Creates a Tool in the specified agent.

Parameters:

  • parent (String)

    Required. The agent to create a Tool for. Format: projects//locations//agents/ .

  • google_cloud_dialogflow_cx_v3beta1_tool_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 5044

def create_project_location_agent_tool(parent, google_cloud_dialogflow_cx_v3beta1_tool_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+parent}/tools', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_tool_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_agent_transition_route_group(parent, google_cloud_dialogflow_cx_v3beta1_transition_route_group_object = nil, language_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TransitionRouteGroup

Creates an TransitionRouteGroup in the specified flow. Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters:

  • parent (String)

    Required. The flow to create an TransitionRouteGroup for. Format: projects// locations//agents//flows/ or projects//locations//agents/ for agent-level groups.

  • google_cloud_dialogflow_cx_v3beta1_transition_route_group_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TransitionRouteGroup) (defaults to: nil)
  • language_code (String) (defaults to: nil)

    The language of the following fields in TransitionRouteGroup: * TransitionRouteGroup.transition_routes.trigger_fulfillment.messages * TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 5265

def create_project_location_agent_transition_route_group(parent, google_cloud_dialogflow_cx_v3beta1_transition_route_group_object = nil, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+parent}/transitionRouteGroups', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TransitionRouteGroup::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_transition_route_group_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TransitionRouteGroup::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TransitionRouteGroup
  command.params['parent'] = parent unless parent.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_agent_webhook(parent, google_cloud_dialogflow_cx_v3beta1_webhook_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Webhook

Creates a webhook in the specified agent.

Parameters:

  • parent (String)

    Required. The agent to create a webhook for. Format: projects//locations// agents/.

  • google_cloud_dialogflow_cx_v3beta1_webhook_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Webhook) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 5478

def create_project_location_agent_webhook(parent, google_cloud_dialogflow_cx_v3beta1_webhook_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+parent}/webhooks', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Webhook::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_webhook_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Webhook::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Webhook
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_security_setting(parent, google_cloud_dialogflow_cx_v3beta1_security_settings_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SecuritySettings

Create security settings in the specified location.

Parameters:

  • parent (String)

    Required. The location to create an SecuritySettings for. Format: projects// locations/.

  • google_cloud_dialogflow_cx_v3beta1_security_settings_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SecuritySettings) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 5767

def create_project_location_security_setting(parent, google_cloud_dialogflow_cx_v3beta1_security_settings_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+parent}/securitySettings', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SecuritySettings::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_security_settings_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SecuritySettings::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SecuritySettings
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_agent(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty

Deletes the specified agent.

Parameters:

  • name (String)

    Required. The name of the agent to delete. Format: projects//locations// agents/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



184
185
186
187
188
189
190
191
192
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 184

def delete_project_location_agent(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_agent_conversation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty

Deletes the specified conversation.

Parameters:

  • name (String)

    Required. The name of the conversation. Format: projects//locations//agents// conversations/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



627
628
629
630
631
632
633
634
635
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 627

def delete_project_location_agent_conversation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_agent_entity_type(name, force: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty

Deletes the specified entity type. Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters:

  • name (String)

    Required. The name of the entity type to delete. Format: projects//locations// agents//entityTypes/.

  • force (Boolean) (defaults to: nil)

    This field has no effect for entity type not being used. For entity types that are used by intents or pages: * If force is set to false, an error will be returned with message indicating the referencing resources. * If force is set to true, Dialogflow will remove the entity type, as well as any references to the entity type (i.e. Page parameter of the entity type will be changed to ' @sys.any' and intent parameter of the entity type will be removed).

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



786
787
788
789
790
791
792
793
794
795
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 786

def delete_project_location_agent_entity_type(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['force'] = force unless force.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_agent_environment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty

Deletes the specified Environment.

Parameters:

  • name (String)

    Required. The name of the Environment to delete. Format: projects//locations// agents//environments/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1056
1057
1058
1059
1060
1061
1062
1063
1064
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 1056

def delete_project_location_agent_environment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_agent_environment_experiment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty

Deletes the specified Experiment.

Parameters:

  • name (String)

    Required. The name of the Environment to delete. Format: projects//locations// agents//environments//experiments/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1450
1451
1452
1453
1454
1455
1456
1457
1458
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 1450

def delete_project_location_agent_environment_experiment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_agent_environment_session_entity_type(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty

Deletes the specified session entity type.

Parameters:

  • name (String)

    Required. The name of the session entity type to delete. Format: projects// locations//agents//sessions//entityTypes/ or projects//locations//agents// environments//sessions//entityTypes/. If Environment ID is not specified, we assume default 'draft' environment.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1868
1869
1870
1871
1872
1873
1874
1875
1876
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 1868

def delete_project_location_agent_environment_session_entity_type(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_agent_flow(name, force: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty

Deletes a specified flow.

Parameters:

  • name (String)

    Required. The name of the flow to delete. Format: projects//locations//agents/ /flows/.

  • force (Boolean) (defaults to: nil)

    This field has no effect for flows with no incoming transitions. For flows with incoming transitions: * If force is set to false, an error will be returned with message indicating the incoming transitions. * If force is set to true, Dialogflow will remove the flow, as well as any transitions to the flow (i.e. Target flow in event handlers or Target flow in transition routes that point to this flow will be cleared).

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 2063

def delete_project_location_agent_flow(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['force'] = force unless force.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_agent_flow_page(name, force: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty

Deletes the specified page.

Parameters:

  • name (String)

    Required. The name of the page to delete. Format: projects//locations//agents/ /Flows//pages/.

  • force (Boolean) (defaults to: nil)

    This field has no effect for pages with no incoming transitions. For pages with incoming transitions: * If force is set to false, an error will be returned with message indicating the incoming transitions. * If force is set to true, Dialogflow will remove the page, as well as any transitions to the page (i.e. Target page in event handlers or Target page in transition routes that point to this page will be cleared).

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 2481

def delete_project_location_agent_flow_page(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['force'] = force unless force.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_agent_flow_transition_route_group(name, force: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty

Deletes the specified TransitionRouteGroup. Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters:

  • name (String)

    Required. The name of the TransitionRouteGroup to delete. Format: projects// locations//agents//flows//transitionRouteGroups/ or projects//locations// agents//transitionRouteGroups/.

  • force (Boolean) (defaults to: nil)

    This field has no effect for transition route group that no page is using. If the transition route group is referenced by any page: * If force is set to false, an error will be returned with message indicating pages that reference the transition route group. * If force is set to true, Dialogflow will remove the transition route group, as well as any reference to it.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 2720

def delete_project_location_agent_flow_transition_route_group(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['force'] = force unless force.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_agent_flow_version(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty

Deletes the specified Version.

Parameters:

  • name (String)

    Required. The name of the Version to delete. Format: projects//locations// agents//flows//versions/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2961
2962
2963
2964
2965
2966
2967
2968
2969
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 2961

def delete_project_location_agent_flow_version(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_agent_generator(name, force: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty

Deletes the specified generators.

Parameters:

  • name (String)

    Required. The name of the generator to delete. Format: projects//locations// agents//generators/.

  • force (Boolean) (defaults to: nil)

    This field has no effect for generators not being used. For generators that are used by pages/flows/transition route groups: * If force is set to false, an error will be returned with message indicating the referenced resources. * If force is set to true, Dialogflow will remove the generator, as well as any references to the generator (i.e. Generator) in fulfillments.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 3183

def delete_project_location_agent_generator(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['force'] = force unless force.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_agent_intent(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty

Deletes the specified intent. Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters:

  • name (String)

    Required. The name of the intent to delete. Format: projects//locations// agents//intents/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3377
3378
3379
3380
3381
3382
3383
3384
3385
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 3377

def delete_project_location_agent_intent(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_agent_playbook(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty

Deletes a specified playbook.

Parameters:

  • name (String)

    Required. The name of the playbook to delete. Format: projects//locations// agents//playbooks/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3651
3652
3653
3654
3655
3656
3657
3658
3659
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 3651

def delete_project_location_agent_playbook(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_agent_playbook_example(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty

Deletes the specified example.

Parameters:

  • name (String)

    Required. The name of the example to delete. Format: projects//locations// agents//playbooks//examples/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3892
3893
3894
3895
3896
3897
3898
3899
3900
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 3892

def delete_project_location_agent_playbook_example(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_agent_playbook_version(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty

Deletes the specified version of the Playbook.

Parameters:

  • name (String)

    Required. The name of the playbook version to delete. Format: projects// locations//agents//playbooks//versions/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4069
4070
4071
4072
4073
4074
4075
4076
4077
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 4069

def delete_project_location_agent_playbook_version(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_agent_session_entity_type(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty

Deletes the specified session entity type.

Parameters:

  • name (String)

    Required. The name of the session entity type to delete. Format: projects// locations//agents//sessions//entityTypes/ or projects//locations//agents// environments//sessions//entityTypes/. If Environment ID is not specified, we assume default 'draft' environment.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4449
4450
4451
4452
4453
4454
4455
4456
4457
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 4449

def delete_project_location_agent_session_entity_type(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_agent_tool(name, force: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty

Deletes a specified Tool.

Parameters:

  • name (String)

    Required. The name of the Tool to be deleted. Format: projects//locations// agents//tools/.

  • force (Boolean) (defaults to: nil)

    This field has no effect for Tools not being used. For Tools that are used: * If force is set to false, an error will be returned with message indicating the referenced resources. * If force is set to true, Dialogflow will remove the tool, as well as any references to the tool.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 5082

def delete_project_location_agent_tool(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['force'] = force unless force.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_agent_transition_route_group(name, force: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty

Deletes the specified TransitionRouteGroup. Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters:

  • name (String)

    Required. The name of the TransitionRouteGroup to delete. Format: projects// locations//agents//flows//transitionRouteGroups/ or projects//locations// agents//transitionRouteGroups/.

  • force (Boolean) (defaults to: nil)

    This field has no effect for transition route group that no page is using. If the transition route group is referenced by any page: * If force is set to false, an error will be returned with message indicating pages that reference the transition route group. * If force is set to true, Dialogflow will remove the transition route group, as well as any reference to it.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 5308

def delete_project_location_agent_transition_route_group(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['force'] = force unless force.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_agent_webhook(name, force: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty

Deletes the specified webhook.

Parameters:

  • name (String)

    Required. The name of the webhook to delete. Format: projects//locations// agents//webhooks/.

  • force (Boolean) (defaults to: nil)

    This field has no effect for webhook not being used. For webhooks that are used by pages/flows/transition route groups: * If force is set to false, an error will be returned with message indicating the referenced resources. * If force is set to true, Dialogflow will remove the webhook, as well as any references to the webhook (i.e. Webhook and tagin fulfillments that point to this webhook will be removed).

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 5518

def delete_project_location_agent_webhook(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['force'] = force unless force.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_security_setting(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty

Deletes the specified SecuritySettings.

Parameters:

  • name (String)

    Required. The name of the SecuritySettings to delete. Format: projects// locations//securitySettings/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5800
5801
5802
5803
5804
5805
5806
5807
5808
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 5800

def delete_project_location_security_setting(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#deploy_project_location_agent_environment_flow(environment, google_cloud_dialogflow_cx_v3beta1_deploy_flow_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation

Deploys a flow to the specified Environment. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: DeployFlowMetadata - response: DeployFlowResponse

Parameters:

  • environment (String)

    Required. The environment to deploy the flow to. Format: projects//locations// agents//environments/.

  • google_cloud_dialogflow_cx_v3beta1_deploy_flow_request_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1DeployFlowRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 1091

def deploy_project_location_agent_environment_flow(environment, google_cloud_dialogflow_cx_v3beta1_deploy_flow_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+environment}:deployFlow', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1DeployFlowRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_deploy_flow_request_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation
  command.params['environment'] = environment unless environment.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#detect_project_location_agent_environment_session_intent(session, google_cloud_dialogflow_cx_v3beta1_detect_intent_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1DetectIntentResponse

Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause session entity types to be updated, which in turn might affect results of future queries. Note: Always use agent versions for production traffic. See Versions and environments.

Parameters:

  • session (String)

    Required. The name of the session this query is sent to. Format: projects// locations//agents//sessions/ or projects//locations//agents//environments// sessions/. If Environment ID is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate Session ID. It can be a random number or some type of session identifiers (preferably hashed). The length of the Session ID must not exceed 36 characters. For more information, see the sessions guide. Note: Always use agent versions for production traffic. See Versions and environments.

  • google_cloud_dialogflow_cx_v3beta1_detect_intent_request_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1DetectIntentRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 1670

def detect_project_location_agent_environment_session_intent(session, google_cloud_dialogflow_cx_v3beta1_detect_intent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+session}:detectIntent', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1DetectIntentRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_detect_intent_request_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1DetectIntentResponse::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1DetectIntentResponse
  command.params['session'] = session unless session.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#detect_project_location_agent_session_intent(session, google_cloud_dialogflow_cx_v3beta1_detect_intent_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1DetectIntentResponse

Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause session entity types to be updated, which in turn might affect results of future queries. Note: Always use agent versions for production traffic. See Versions and environments.

Parameters:

  • session (String)

    Required. The name of the session this query is sent to. Format: projects// locations//agents//sessions/ or projects//locations//agents//environments// sessions/. If Environment ID is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate Session ID. It can be a random number or some type of session identifiers (preferably hashed). The length of the Session ID must not exceed 36 characters. For more information, see the sessions guide. Note: Always use agent versions for production traffic. See Versions and environments.

  • google_cloud_dialogflow_cx_v3beta1_detect_intent_request_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1DetectIntentRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 4217

def detect_project_location_agent_session_intent(session, google_cloud_dialogflow_cx_v3beta1_detect_intent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+session}:detectIntent', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1DetectIntentRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_detect_intent_request_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1DetectIntentResponse::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1DetectIntentResponse
  command.params['session'] = session unless session.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#export_project_location_agent(name, google_cloud_dialogflow_cx_v3beta1_export_agent_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation

Exports the specified agent to a binary file. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: ExportAgentResponse

Parameters:

  • name (String)

    Required. The name of the agent to export. Format: projects//locations// agents/.

  • google_cloud_dialogflow_cx_v3beta1_export_agent_request_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ExportAgentRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



221
222
223
224
225
226
227
228
229
230
231
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 221

def export_project_location_agent(name, google_cloud_dialogflow_cx_v3beta1_export_agent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+name}:export', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ExportAgentRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_export_agent_request_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#export_project_location_agent_entity_type(parent, google_cloud_dialogflow_cx_v3beta1_export_entity_types_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation

Exports the selected entity types.

Parameters:

  • parent (String)

    Required. The name of the parent agent to export entity types. Format: projects//locations//agents/.

  • google_cloud_dialogflow_cx_v3beta1_export_entity_types_request_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ExportEntityTypesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



819
820
821
822
823
824
825
826
827
828
829
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 819

def export_project_location_agent_entity_type(parent, google_cloud_dialogflow_cx_v3beta1_export_entity_types_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+parent}/entityTypes:export', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ExportEntityTypesRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_export_entity_types_request_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#export_project_location_agent_flow(name, google_cloud_dialogflow_cx_v3beta1_export_flow_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation

Exports the specified flow to a binary file. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: ExportFlowResponse Note that resources (e.g. intents, entities, webhooks) that the flow references will also be exported.

Parameters:

  • name (String)

    Required. The name of the flow to export. Format: projects//locations//agents/ /flows/.

  • google_cloud_dialogflow_cx_v3beta1_export_flow_request_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ExportFlowRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 2102

def export_project_location_agent_flow(name, google_cloud_dialogflow_cx_v3beta1_export_flow_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+name}:export', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ExportFlowRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_export_flow_request_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#export_project_location_agent_intent(parent, google_cloud_dialogflow_cx_v3beta1_export_intents_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation

Exports the selected intents. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: ExportIntentsMetadata - response: ExportIntentsResponse

Parameters:

  • parent (String)

    Required. The name of the parent agent to export intents. Format: projects// locations//agents/.

  • google_cloud_dialogflow_cx_v3beta1_export_intents_request_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ExportIntentsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 3412

def export_project_location_agent_intent(parent, google_cloud_dialogflow_cx_v3beta1_export_intents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+parent}/intents:export', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ExportIntentsRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_export_intents_request_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#export_project_location_agent_playbook(name, google_cloud_dialogflow_cx_v3beta1_export_playbook_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation

Exports the specified playbook to a binary file. Note that resources (e.g. examples, tools) that the playbook references will also be exported.

Parameters:

  • name (String)

    Required. The name of the playbook to export. Format: projects//locations// agents//playbooks/.

  • google_cloud_dialogflow_cx_v3beta1_export_playbook_request_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ExportPlaybookRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 3684

def export_project_location_agent_playbook(name, google_cloud_dialogflow_cx_v3beta1_export_playbook_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+name}:export', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ExportPlaybookRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_export_playbook_request_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#export_project_location_agent_test_case(parent, google_cloud_dialogflow_cx_v3beta1_export_test_cases_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation

Exports the test cases under the agent to a Cloud Storage bucket or a local file. Filter can be applied to export a subset of test cases. This method is a long-running operation. The returned Operation type has the following method- specific fields: - metadata: ExportTestCasesMetadata - response: ExportTestCasesResponse

Parameters:

  • parent (String)

    Required. The agent where to export test cases from. Format: projects// locations//agents/.

  • google_cloud_dialogflow_cx_v3beta1_export_test_cases_request_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ExportTestCasesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 4736

def export_project_location_agent_test_case(parent, google_cloud_dialogflow_cx_v3beta1_export_test_cases_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+parent}/testCases:export', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ExportTestCasesRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_export_test_cases_request_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#export_project_location_agent_tool(parent, google_cloud_dialogflow_cx_v3beta1_export_tools_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation

Exports the selected tools.

Parameters:

  • parent (String)

    Required. The agent to export tools from. Format: projects//locations//agents/ .

  • google_cloud_dialogflow_cx_v3beta1_export_tools_request_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ExportToolsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 5115

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)
  command = make_simple_command(:post, 'v3beta1/{+parent}/tools:export', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ExportToolsRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_export_tools_request_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#fulfill_project_location_agent_environment_session_intent(session, google_cloud_dialogflow_cx_v3beta1_fulfill_intent_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1FulfillIntentResponse

Fulfills a matched intent returned by MatchIntent. Must be called after MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is undefined.

Parameters:

  • session (String)

    Required. The name of the session this query is sent to. Format: projects// locations//agents//sessions/ or projects//locations//agents//environments// sessions/. If Environment ID is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate Session ID. It can be a random number or some type of session identifiers (preferably hashed). The length of the Session ID must not exceed 36 characters. For more information, see the sessions guide.

  • google_cloud_dialogflow_cx_v3beta1_fulfill_intent_request_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1FulfillIntentRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 1712

def fulfill_project_location_agent_environment_session_intent(session, google_cloud_dialogflow_cx_v3beta1_fulfill_intent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+session}:fulfillIntent', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1FulfillIntentRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_fulfill_intent_request_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1FulfillIntentResponse::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1FulfillIntentResponse
  command.params['session'] = session unless session.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#fulfill_project_location_agent_session_intent(session, google_cloud_dialogflow_cx_v3beta1_fulfill_intent_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1FulfillIntentResponse

Fulfills a matched intent returned by MatchIntent. Must be called after MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is undefined.

Parameters:

  • session (String)

    Required. The name of the session this query is sent to. Format: projects// locations//agents//sessions/ or projects//locations//agents//environments// sessions/. If Environment ID is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate Session ID. It can be a random number or some type of session identifiers (preferably hashed). The length of the Session ID must not exceed 36 characters. For more information, see the sessions guide.

  • google_cloud_dialogflow_cx_v3beta1_fulfill_intent_request_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1FulfillIntentRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 4259

def fulfill_project_location_agent_session_intent(session, google_cloud_dialogflow_cx_v3beta1_fulfill_intent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+session}:fulfillIntent', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1FulfillIntentRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_fulfill_intent_request_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1FulfillIntentResponse::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1FulfillIntentResponse
  command.params['session'] = session unless session.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudLocationLocation

Gets information about a location.

Parameters:

  • name (String)

    Resource name for the location.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



75
76
77
78
79
80
81
82
83
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 75

def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudLocationLocation::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudLocationLocation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_agent(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Agent

Retrieves the specified agent.

Parameters:

  • name (String)

    Required. The name of the agent. Format: projects//locations//agents/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



253
254
255
256
257
258
259
260
261
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 253

def get_project_location_agent(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Agent::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Agent
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_agent_changelog(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Changelog

Retrieves the specified Changelog.

Parameters:

  • name (String)

    Required. The name of the changelog to get. Format: projects//locations// agents//changelogs/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



546
547
548
549
550
551
552
553
554
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 546

def get_project_location_agent_changelog(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Changelog::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Changelog
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_agent_conversation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Conversation

Retrieves the specified conversation.

Parameters:

  • name (String)

    Required. The name of the conversation. Format: projects//locations//agents// conversations/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



658
659
660
661
662
663
664
665
666
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 658

def get_project_location_agent_conversation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Conversation::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Conversation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_agent_entity_type(name, language_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1EntityType

Retrieves the specified entity type.

Parameters:

  • name (String)

    Required. The name of the entity type. Format: projects//locations//agents// entityTypes/.

  • language_code (String) (defaults to: nil)

    The language to retrieve the entity type for. The following fields are language dependent: * EntityType.entities.value * EntityType.entities. synonyms * EntityType.excluded_phrases.value If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



859
860
861
862
863
864
865
866
867
868
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 859

def get_project_location_agent_entity_type(name, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1EntityType::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1EntityType
  command.params['name'] = name unless name.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_agent_environment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Environment

Retrieves the specified Environment.

Parameters:

  • name (String)

    Required. The name of the Environment. Format: projects//locations//agents// environments/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1124
1125
1126
1127
1128
1129
1130
1131
1132
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 1124

def get_project_location_agent_environment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Environment::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Environment
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_agent_environment_deployment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Deployment

Retrieves the specified Deployment.

Parameters:

  • name (String)

    Required. The name of the Deployment. Format: projects//locations//agents// environments//deployments/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1347
1348
1349
1350
1351
1352
1353
1354
1355
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 1347

def get_project_location_agent_environment_deployment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Deployment::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Deployment
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_agent_environment_experiment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Experiment

Retrieves the specified Experiment.

Parameters:

  • name (String)

    Required. The name of the Environment. Format: projects//locations//agents// environments//experiments/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1481
1482
1483
1484
1485
1486
1487
1488
1489
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 1481

def get_project_location_agent_environment_experiment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Experiment::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Experiment
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_agent_environment_session_entity_type(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SessionEntityType

Retrieves the specified session entity type.

Parameters:

  • name (String)

    Required. The name of the session entity type. Format: projects//locations// agents//sessions//entityTypes/ or projects//locations//agents//environments// sessions//entityTypes/. If Environment ID is not specified, we assume default 'draft' environment.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1901
1902
1903
1904
1905
1906
1907
1908
1909
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 1901

def get_project_location_agent_environment_session_entity_type(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SessionEntityType::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SessionEntityType
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_agent_flow(name, language_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Flow

Retrieves the specified flow.

Parameters:

  • name (String)

    Required. The name of the flow to get. Format: projects//locations//agents// flows/.

  • language_code (String) (defaults to: nil)

    The language to retrieve the flow for. The following fields are language dependent: * Flow.event_handlers.trigger_fulfillment.messages * Flow. event_handlers.trigger_fulfillment.conditional_cases * Flow. transition_routes.trigger_fulfillment.messages * Flow.transition_routes. trigger_fulfillment.conditional_cases If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 2144

def get_project_location_agent_flow(name, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Flow::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Flow
  command.params['name'] = name unless name.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_agent_flow_page(name, language_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Page

Retrieves the specified page.

Parameters:

  • name (String)

    Required. The name of the page. Format: projects//locations//agents//flows// pages/.

  • language_code (String) (defaults to: nil)

    The language to retrieve the page for. The following fields are language dependent: * Page.entry_fulfillment.messages * Page.entry_fulfillment. conditional_cases * Page.event_handlers.trigger_fulfillment.messages * Page.event_handlers.trigger_fulfillment.conditional_cases * Page.form. parameters.fill_behavior.initial_prompt_fulfillment.messages * Page.form. parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases * Page. form.parameters.fill_behavior.reprompt_event_handlers.messages * Page.form. parameters.fill_behavior.reprompt_event_handlers.conditional_cases * Page. transition_routes.trigger_fulfillment.messages * Page.transition_routes. trigger_fulfillment.conditional_cases If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 2527

def get_project_location_agent_flow_page(name, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Page::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Page
  command.params['name'] = name unless name.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_agent_flow_transition_route_group(name, language_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TransitionRouteGroup

Retrieves the specified TransitionRouteGroup.

Parameters:

  • name (String)

    Required. The name of the TransitionRouteGroup. Format: projects//locations// agents//flows//transitionRouteGroups/ or projects//locations//agents// transitionRouteGroups/.

  • language_code (String) (defaults to: nil)

    The language to retrieve the transition route group for. The following fields are language dependent: * TransitionRouteGroup.transition_routes. trigger_fulfillment.messages * TransitionRouteGroup.transition_routes. trigger_fulfillment.conditional_cases If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 2761

def get_project_location_agent_flow_transition_route_group(name, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TransitionRouteGroup::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TransitionRouteGroup
  command.params['name'] = name unless name.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_agent_flow_validation_result(name, language_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1FlowValidationResult

Gets the latest flow validation result. Flow validation is performed when ValidateFlow is called.

Parameters:

  • name (String)

    Required. The flow name. Format: projects//locations//agents//flows// validationResult.

  • language_code (String) (defaults to: nil)

    If not specified, the agent's default language is used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 2179

def get_project_location_agent_flow_validation_result(name, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1FlowValidationResult::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1FlowValidationResult
  command.params['name'] = name unless name.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_agent_flow_version(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Version

Retrieves the specified Version.

Parameters:

  • name (String)

    Required. The name of the Version. Format: projects//locations//agents//flows/ /versions/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2992
2993
2994
2995
2996
2997
2998
2999
3000
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 2992

def get_project_location_agent_flow_version(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Version::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Version
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_agent_generative_settings(name, language_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1GenerativeSettings

Gets the generative settings for the agent.

Parameters:

  • name (String)

    Required. Format: projects//locations//agents//generativeSettings.

  • language_code (String) (defaults to: nil)

    Required. Language code of the generative settings.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



285
286
287
288
289
290
291
292
293
294
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 285

def get_project_location_agent_generative_settings(name, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1GenerativeSettings::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1GenerativeSettings
  command.params['name'] = name unless name.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_agent_generator(name, language_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Generator

Retrieves the specified generator.

Parameters:

  • name (String)

    Required. The name of the generator. Format: projects//locations//agents// generators/.

  • language_code (String) (defaults to: nil)

    The language to list generators for.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 3217

def get_project_location_agent_generator(name, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Generator::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Generator
  command.params['name'] = name unless name.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_agent_intent(name, language_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Intent

Retrieves the specified intent.

Parameters:

  • name (String)

    Required. The name of the intent. Format: projects//locations//agents// intents/.

  • language_code (String) (defaults to: nil)

    The language to retrieve the intent for. The following fields are language dependent: * Intent.training_phrases.parts.text If not specified, the agent' s default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 3451

def get_project_location_agent_intent(name, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Intent::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Intent
  command.params['name'] = name unless name.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_agent_playbook(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook

Retrieves the specified Playbook.

Parameters:

  • name (String)

    Required. The name of the playbook. Format: projects//locations//agents// playbooks/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3717
3718
3719
3720
3721
3722
3723
3724
3725
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 3717

def get_project_location_agent_playbook(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_agent_playbook_example(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example

Retrieves the specified example.

Parameters:

  • name (String)

    Required. The name of the example. Format: projects//locations//agents// playbooks//examples/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3923
3924
3925
3926
3927
3928
3929
3930
3931
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 3923

def get_project_location_agent_playbook_example(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_agent_playbook_version(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookVersion

Retrieves the specified version of the Playbook.

Parameters:

  • name (String)

    Required. The name of the playbook version. Format: projects//locations// agents//playbooks//versions/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4100
4101
4102
4103
4104
4105
4106
4107
4108
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 4100

def get_project_location_agent_playbook_version(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookVersion::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookVersion
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_agent_session_entity_type(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SessionEntityType

Retrieves the specified session entity type.

Parameters:

  • name (String)

    Required. The name of the session entity type. Format: projects//locations// agents//sessions//entityTypes/ or projects//locations//agents//environments// sessions//entityTypes/. If Environment ID is not specified, we assume default 'draft' environment.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4482
4483
4484
4485
4486
4487
4488
4489
4490
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 4482

def get_project_location_agent_session_entity_type(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SessionEntityType::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SessionEntityType
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_agent_test_case(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TestCase

Gets a test case.

Parameters:

  • name (String)

    Required. The name of the testcase. Format: projects//locations//agents// testCases/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4769
4770
4771
4772
4773
4774
4775
4776
4777
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 4769

def get_project_location_agent_test_case(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TestCase::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TestCase
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_agent_test_case_result(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TestCaseResult

Gets a test case result.

Parameters:

  • name (String)

    Required. The name of the testcase. Format: projects//locations//agents// testCases//results/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4958
4959
4960
4961
4962
4963
4964
4965
4966
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 4958

def get_project_location_agent_test_case_result(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TestCaseResult::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TestCaseResult
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_agent_tool(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool

Retrieves the specified Tool.

Parameters:

  • name (String)

    Required. The name of the Tool. Format: projects//locations//agents//tools/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5147
5148
5149
5150
5151
5152
5153
5154
5155
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 5147

def get_project_location_agent_tool(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_agent_transition_route_group(name, language_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TransitionRouteGroup

Retrieves the specified TransitionRouteGroup.

Parameters:

  • name (String)

    Required. The name of the TransitionRouteGroup. Format: projects//locations// agents//flows//transitionRouteGroups/ or projects//locations//agents// transitionRouteGroups/.

  • language_code (String) (defaults to: nil)

    The language to retrieve the transition route group for. The following fields are language dependent: * TransitionRouteGroup.transition_routes. trigger_fulfillment.messages * TransitionRouteGroup.transition_routes. trigger_fulfillment.conditional_cases If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 5349

def get_project_location_agent_transition_route_group(name, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TransitionRouteGroup::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TransitionRouteGroup
  command.params['name'] = name unless name.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_agent_validation_result(name, language_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1AgentValidationResult

Gets the latest agent validation result. Agent validation is performed when ValidateAgent is called.

Parameters:

  • name (String)

    Required. The agent name. Format: projects//locations//agents// validationResult.

  • language_code (String) (defaults to: nil)

    If not specified, the agent's default language is used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



320
321
322
323
324
325
326
327
328
329
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 320

def get_project_location_agent_validation_result(name, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1AgentValidationResult::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1AgentValidationResult
  command.params['name'] = name unless name.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_agent_webhook(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Webhook

Retrieves the specified webhook.

Parameters:

  • name (String)

    Required. The name of the webhook. Format: projects//locations//agents// webhooks/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5550
5551
5552
5553
5554
5555
5556
5557
5558
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 5550

def get_project_location_agent_webhook(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Webhook::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Webhook
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5695
5696
5697
5698
5699
5700
5701
5702
5703
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 5695

def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_security_setting(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SecuritySettings

Retrieves the specified SecuritySettings. The returned settings may be stale by up to 1 minute.

Parameters:

  • name (String)

    Required. Resource name of the settings. Format: projects//locations// securitySettings/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5832
5833
5834
5835
5836
5837
5838
5839
5840
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 5832

def get_project_location_security_setting(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SecuritySettings::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SecuritySettings
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5978
5979
5980
5981
5982
5983
5984
5985
5986
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 5978

def get_project_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#import_project_location_agent_entity_type(parent, google_cloud_dialogflow_cx_v3beta1_import_entity_types_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation

Imports the specified entitytypes into the agent.

Parameters:

  • parent (String)

    Required. The agent to import the entity types into. Format: projects// locations//agents/.

  • google_cloud_dialogflow_cx_v3beta1_import_entity_types_request_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ImportEntityTypesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



892
893
894
895
896
897
898
899
900
901
902
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 892

def import_project_location_agent_entity_type(parent, google_cloud_dialogflow_cx_v3beta1_import_entity_types_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+parent}/entityTypes:import', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ImportEntityTypesRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_import_entity_types_request_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#import_project_location_agent_flow(parent, google_cloud_dialogflow_cx_v3beta1_import_flow_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation

Imports the specified flow to the specified agent from a binary file. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: ImportFlowResponse Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters:

  • parent (String)

    Required. The agent to import the flow into. Format: projects//locations// agents/.

  • google_cloud_dialogflow_cx_v3beta1_import_flow_request_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ImportFlowRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 2219

def import_project_location_agent_flow(parent, google_cloud_dialogflow_cx_v3beta1_import_flow_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+parent}/flows:import', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ImportFlowRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_import_flow_request_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#import_project_location_agent_intent(parent, google_cloud_dialogflow_cx_v3beta1_import_intents_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation

Imports the specified intents into the agent. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: ImportIntentsMetadata - response: ImportIntentsResponse

Parameters:

  • parent (String)

    Required. The agent to import the intents into. Format: projects//locations// agents/.

  • google_cloud_dialogflow_cx_v3beta1_import_intents_request_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ImportIntentsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 3488

def import_project_location_agent_intent(parent, google_cloud_dialogflow_cx_v3beta1_import_intents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+parent}/intents:import', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ImportIntentsRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_import_intents_request_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#import_project_location_agent_playbook(parent, google_cloud_dialogflow_cx_v3beta1_import_playbook_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation

Imports the specified playbook to the specified agent from a binary file.

Parameters:

  • parent (String)

    Required. The agent to import the playbook into. Format: projects//locations// agents/.

  • google_cloud_dialogflow_cx_v3beta1_import_playbook_request_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ImportPlaybookRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 3749

def import_project_location_agent_playbook(parent, google_cloud_dialogflow_cx_v3beta1_import_playbook_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+parent}/playbooks:import', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ImportPlaybookRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_import_playbook_request_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#import_project_location_agent_test_case(parent, google_cloud_dialogflow_cx_v3beta1_import_test_cases_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation

Imports the test cases from a Cloud Storage bucket or a local file. It always creates new test cases and won't overwrite any existing ones. The provided ID in the imported test case is neglected. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: ImportTestCasesMetadata - response: ImportTestCasesResponse

Parameters:

  • parent (String)

    Required. The agent to import test cases to. Format: projects//locations// agents/.

  • google_cloud_dialogflow_cx_v3beta1_import_test_cases_request_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ImportTestCasesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 4807

def import_project_location_agent_test_case(parent, google_cloud_dialogflow_cx_v3beta1_import_test_cases_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+parent}/testCases:import', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ImportTestCasesRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_import_test_cases_request_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_agent_changelogs(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListChangelogsResponse

Returns the list of Changelogs.

Parameters:

  • parent (String)

    Required. The agent containing the changelogs. Format: projects//locations// agents/.

  • filter (String) (defaults to: nil)

    The filter string. Supports filter by user_email, resource, type and create_time. Some examples: 1. By user email: user_email = "someone@google.com"

    1. By resource name: resource = "projects/123/locations/global/agents/456/ flows/789" 3. By resource display name: display_name = "my agent" 4. By action: action = "Create" 5. By type: type = "flows" 6. By create time. Currently predicates on create_time and create_time_epoch_seconds are supported: create_time_epoch_seconds > 1551790877 AND create_time <= 2017-01-15T01:30:15. 01Z 7. Combination of above filters: resource = "projects/123/locations/global/ agents/456/flows/789" AND user_email = "someone@google.com" AND create_time <= 2017-01-15T01:30:15.01Z
  • page_size (Fixnum) (defaults to: nil)

    The maximum number of items to return in a single page. By default 100 and at most 1000.

  • page_token (String) (defaults to: nil)

    The next_page_token value returned from a previous list request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



593
594
595
596
597
598
599
600
601
602
603
604
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 593

def list_project_location_agent_changelogs(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+parent}/changelogs', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListChangelogsResponse::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListChangelogsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_agent_conversations(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListConversationsResponse

Returns the list of all conversations.

Parameters:

  • parent (String)

    Required. The agent to list all conversations for. Format: projects// locations//agents/.

  • filter (String) (defaults to: nil)

    Optional. The filter string. Supports filter by create_time, metrics. has_end_interaction, metrics.has_live_agent_handoff, intents.display_name, pages.display_name and flows.display_name. Timestamps expect an RFC-3339 formatted string (e.g. 2012-04-21T11:30:00-04:00). UTC offsets are supported. Some examples: 1. By create time: create_time > "2022-04-21T11:30:00-04:00" 2. By intent display name: intents.display_name : "billing" 3. By end interaction signal: metrics.has_end_interaction = true

  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.

  • page_token (String) (defaults to: nil)

    Optional. The next_page_token value returned from a previous list request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



702
703
704
705
706
707
708
709
710
711
712
713
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 702

def list_project_location_agent_conversations(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+parent}/conversations', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListConversationsResponse::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListConversationsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_agent_entity_types(parent, language_code: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListEntityTypesResponse

Returns the list of all entity types in the specified agent.

Parameters:

  • parent (String)

    Required. The agent to list all entity types for. Format: projects//locations/ /agents/.

  • language_code (String) (defaults to: nil)

    The language to list entity types for. The following fields are language dependent: * EntityType.entities.value * EntityType.entities.synonyms * EntityType.excluded_phrases.value If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of items to return in a single page. By default 100 and at most 1000.

  • page_token (String) (defaults to: nil)

    The next_page_token value returned from a previous list request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



937
938
939
940
941
942
943
944
945
946
947
948
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 937

def list_project_location_agent_entity_types(parent, language_code: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+parent}/entityTypes', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListEntityTypesResponse::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListEntityTypesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_agent_environment_continuous_test_results(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListContinuousTestResultsResponse

Fetches a list of continuous test results for a given environment.

Parameters:

  • parent (String)

    Required. The environment to list results for. Format: projects//locations// agents//environments/.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of items to return in a single page. By default 100 and at most 1000.

  • page_token (String) (defaults to: nil)

    The next_page_token value returned from a previous list request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 1314

def list_project_location_agent_environment_continuous_test_results(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+parent}/continuousTestResults', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListContinuousTestResultsResponse::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListContinuousTestResultsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_agent_environment_deployments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListDeploymentsResponse

Returns the list of all deployments in the specified Environment.

Parameters:

  • parent (String)

    Required. The Environment to list all environments for. Format: projects// locations//agents//environments/.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of items to return in a single page. By default 20 and at most 100.

  • page_token (String) (defaults to: nil)

    The next_page_token value returned from a previous list request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 1383

def list_project_location_agent_environment_deployments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+parent}/deployments', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListDeploymentsResponse::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListDeploymentsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_agent_environment_experiments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListExperimentsResponse

Returns the list of all experiments in the specified Environment.

Parameters:

  • parent (String)

    Required. The Environment to list all environments for. Format: projects// locations//agents//environments/.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of items to return in a single page. By default 20 and at most 100.

  • page_token (String) (defaults to: nil)

    The next_page_token value returned from a previous list request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 1517

def list_project_location_agent_environment_experiments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+parent}/experiments', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListExperimentsResponse::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListExperimentsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_agent_environment_session_entity_types(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListSessionEntityTypesResponse

Returns the list of all session entity types in the specified session.

Parameters:

  • parent (String)

    Required. The session to list all session entity types from. Format: projects/ /locations//agents//sessions/ or projects//locations//agents//environments// sessions/. If Environment ID is not specified, we assume default 'draft' environment.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of items to return in a single page. By default 100 and at most 1000.

  • page_token (String) (defaults to: nil)

    The next_page_token value returned from a previous list request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 1939

def list_project_location_agent_environment_session_entity_types(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+parent}/entityTypes', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListSessionEntityTypesResponse::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListSessionEntityTypesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_agent_environments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListEnvironmentsResponse

Returns the list of all environments in the specified Agent.

Parameters:

  • parent (String)

    Required. The Agent to list all environments for. Format: projects//locations/ /agents/.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of items to return in a single page. By default 20 and at most 100.

  • page_token (String) (defaults to: nil)

    The next_page_token value returned from a previous list request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 1160

def list_project_location_agent_environments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+parent}/environments', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListEnvironmentsResponse::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListEnvironmentsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_agent_flow_pages(parent, language_code: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListPagesResponse

Returns the list of all pages in the specified flow.

Parameters:

  • parent (String)

    Required. The flow to list all pages for. Format: projects//locations//agents/ /flows/.

  • language_code (String) (defaults to: nil)

    The language to list pages for. The following fields are language dependent: * Page.entry_fulfillment.messages * Page.entry_fulfillment.conditional_cases

    • Page.event_handlers.trigger_fulfillment.messages * Page.event_handlers. trigger_fulfillment.conditional_cases * Page.form.parameters.fill_behavior. initial_prompt_fulfillment.messages * Page.form.parameters.fill_behavior. initial_prompt_fulfillment.conditional_cases * Page.form.parameters. fill_behavior.reprompt_event_handlers.messages * Page.form.parameters. fill_behavior.reprompt_event_handlers.conditional_cases * Page. transition_routes.trigger_fulfillment.messages * Page.transition_routes. trigger_fulfillment.conditional_cases If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.
  • page_size (Fixnum) (defaults to: nil)

    The maximum number of items to return in a single page. By default 100 and at most 1000.

  • page_token (String) (defaults to: nil)

    The next_page_token value returned from a previous list request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 2578

def list_project_location_agent_flow_pages(parent, language_code: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+parent}/pages', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListPagesResponse::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListPagesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_agent_flow_transition_route_groups(parent, language_code: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListTransitionRouteGroupsResponse

Returns the list of all transition route groups in the specified flow.

Parameters:

  • parent (String)

    Required. The flow to list all transition route groups for. Format: projects// locations//agents//flows/ or `projects//locations//agents/.

  • language_code (String) (defaults to: nil)

    The language to list transition route groups for. The following fields are language dependent: * TransitionRouteGroup.transition_routes. trigger_fulfillment.messages * TransitionRouteGroup.transition_routes. trigger_fulfillment.conditional_cases If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of items to return in a single page. By default 100 and at most 1000.

  • page_token (String) (defaults to: nil)

    The next_page_token value returned from a previous list request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 2806

def list_project_location_agent_flow_transition_route_groups(parent, language_code: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+parent}/transitionRouteGroups', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListTransitionRouteGroupsResponse::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListTransitionRouteGroupsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_agent_flow_versions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListVersionsResponse

Returns the list of all versions in the specified Flow.

Parameters:

  • parent (String)

    Required. The Flow to list all versions for. Format: projects//locations// agents//flows/.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of items to return in a single page. By default 20 and at most 100.

  • page_token (String) (defaults to: nil)

    The next_page_token value returned from a previous list request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 3028

def list_project_location_agent_flow_versions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+parent}/versions', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListVersionsResponse::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListVersionsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_agent_flows(parent, language_code: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListFlowsResponse

Returns the list of all flows in the specified agent.

Parameters:

  • parent (String)

    Required. The agent containing the flows. Format: projects//locations//agents/ .

  • language_code (String) (defaults to: nil)

    The language to list flows for. The following fields are language dependent: * Flow.event_handlers.trigger_fulfillment.messages * Flow.event_handlers. trigger_fulfillment.conditional_cases * Flow.transition_routes. trigger_fulfillment.messages * Flow.transition_routes.trigger_fulfillment. conditional_cases If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of items to return in a single page. By default 100 and at most 1000.

  • page_token (String) (defaults to: nil)

    The next_page_token value returned from a previous list request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 2266

def list_project_location_agent_flows(parent, language_code: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+parent}/flows', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListFlowsResponse::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListFlowsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_agent_generators(parent, language_code: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListGeneratorsResponse

Returns the list of all generators in the specified agent.

Parameters:

  • parent (String)

    Required. The agent to list all generators for. Format: projects//locations// agents/.

  • language_code (String) (defaults to: nil)

    The language to list generators for.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of items to return in a single page. By default 100 and at most 1000.

  • page_token (String) (defaults to: nil)

    The next_page_token value returned from a previous list request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 3256

def list_project_location_agent_generators(parent, language_code: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+parent}/generators', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListGeneratorsResponse::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListGeneratorsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_agent_intents(parent, intent_view: nil, language_code: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListIntentsResponse

Returns the list of all intents in the specified agent.

Parameters:

  • parent (String)

    Required. The agent to list all intents for. Format: projects//locations// agents/.

  • intent_view (String) (defaults to: nil)

    The resource view to apply to the returned intent.

  • language_code (String) (defaults to: nil)

    The language to list intents for. The following fields are language dependent:

    • Intent.training_phrases.parts.text If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.
  • page_size (Fixnum) (defaults to: nil)

    The maximum number of items to return in a single page. By default 100 and at most 1000.

  • page_token (String) (defaults to: nil)

    The next_page_token value returned from a previous list request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 3534

def list_project_location_agent_intents(parent, intent_view: nil, language_code: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+parent}/intents', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListIntentsResponse::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListIntentsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['intentView'] = intent_view unless intent_view.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_agent_playbook_examples(parent, language_code: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListExamplesResponse

Returns a list of examples in the specified playbook.

Parameters:

  • parent (String)

    Required. The playbook to list the examples from. Format: projects//locations/ /agents//playbooks/.

  • language_code (String) (defaults to: nil)

    Optional. The language to list examples for. If not specified, list all examples under the playbook. Note: languages must be enabled in the agent before they can be used.

  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.

  • page_token (String) (defaults to: nil)

    Optional. The next_page_token value returned from a previous list request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 3963

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)
  command = make_simple_command(:get, 'v3beta1/{+parent}/examples', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListExamplesResponse::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListExamplesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_agent_playbook_versions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListPlaybookVersionsResponse

Lists versions for the specified Playbook.

Parameters:

  • parent (String)

    Required. The playbook to list versions for. Format: projects//locations// agents//playbooks/.

  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.

  • page_token (String) (defaults to: nil)

    Optional. The next_page_token value returned from a previous list request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 4136

def list_project_location_agent_playbook_versions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+parent}/versions', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListPlaybookVersionsResponse::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListPlaybookVersionsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_agent_playbooks(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListPlaybooksResponse

Returns a list of playbooks in the specified agent.

Parameters:

  • parent (String)

    Required. The agent to list playbooks from. Format: projects//locations// agents/.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of items to return in a single page. By default 100 and at most 1000.

  • page_token (String) (defaults to: nil)

    The next_page_token value returned from a previous list request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 3787

def list_project_location_agent_playbooks(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+parent}/playbooks', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListPlaybooksResponse::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListPlaybooksResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_agent_session_entity_types(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListSessionEntityTypesResponse

Returns the list of all session entity types in the specified session.

Parameters:

  • parent (String)

    Required. The session to list all session entity types from. Format: projects/ /locations//agents//sessions/ or projects//locations//agents//environments// sessions/. If Environment ID is not specified, we assume default 'draft' environment.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of items to return in a single page. By default 100 and at most 1000.

  • page_token (String) (defaults to: nil)

    The next_page_token value returned from a previous list request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 4520

def list_project_location_agent_session_entity_types(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+parent}/entityTypes', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListSessionEntityTypesResponse::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListSessionEntityTypesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_agent_test_case_results(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListTestCaseResultsResponse

Fetches the list of run results for the given test case. A maximum of 100 results are kept for each test case.

Parameters:

  • parent (String)

    Required. The test case to list results for. Format: projects//locations// agents//testCases/. Specify a - as a wildcard for TestCase ID to list results across multiple test cases.

  • filter (String) (defaults to: nil)

    The filter expression used to filter test case results. See API Filtering. The expression is case insensitive. Only 'AND' is supported for logical operators. The supported syntax is listed below in detail: [AND ] ... [AND latest] The supported fields and operators are: field operator environment =, IN (Use value draft for draft environment) test_time >, < latest only returns the latest test result in all results for each test case. Examples: * "environment=draft AND latest" matches the latest test result for each test case in the draft environment. * " environment IN (e1,e2)" matches any test case results with an environment resource name of either "e1" or "e2". * "test_time > 1602540713" matches any test case results with test time later than a unix timestamp in seconds 1602540713.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of items to return in a single page. By default 100 and at most 1000.

  • page_token (String) (defaults to: nil)

    The next_page_token value returned from a previous list request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 5009

def list_project_location_agent_test_case_results(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+parent}/results', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListTestCaseResultsResponse::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListTestCaseResultsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_agent_test_cases(parent, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListTestCasesResponse

Fetches a list of test cases for a given agent.

Parameters:

  • parent (String)

    Required. The agent to list all pages for. Format: projects//locations// agents/.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of items to return in a single page. By default 20. Note that when TestCaseView = FULL, the maximum page size allowed is 20. When TestCaseView = BASIC, the maximum page size allowed is 500.

  • page_token (String) (defaults to: nil)

    The next_page_token value returned from a previous list request.

  • view (String) (defaults to: nil)

    Specifies whether response should include all fields or just the metadata.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 4848

def list_project_location_agent_test_cases(parent, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+parent}/testCases', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListTestCasesResponse::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListTestCasesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_agent_tools(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListToolsResponse

Returns a list of Tools in the specified agent.

Parameters:

  • parent (String)

    Required. The agent to list the Tools from. Format: projects//locations// agents/.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of items to return in a single page. By default 100 and at most 1000.

  • page_token (String) (defaults to: nil)

    The next_page_token value returned from a previous list request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 5183

def list_project_location_agent_tools(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+parent}/tools', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListToolsResponse::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListToolsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_agent_transition_route_groups(parent, language_code: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListTransitionRouteGroupsResponse

Returns the list of all transition route groups in the specified flow.

Parameters:

  • parent (String)

    Required. The flow to list all transition route groups for. Format: projects// locations//agents//flows/ or `projects//locations//agents/.

  • language_code (String) (defaults to: nil)

    The language to list transition route groups for. The following fields are language dependent: * TransitionRouteGroup.transition_routes. trigger_fulfillment.messages * TransitionRouteGroup.transition_routes. trigger_fulfillment.conditional_cases If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of items to return in a single page. By default 100 and at most 1000.

  • page_token (String) (defaults to: nil)

    The next_page_token value returned from a previous list request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 5394

def list_project_location_agent_transition_route_groups(parent, language_code: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+parent}/transitionRouteGroups', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListTransitionRouteGroupsResponse::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListTransitionRouteGroupsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_agent_webhooks(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListWebhooksResponse

Returns the list of all webhooks in the specified agent.

Parameters:

  • parent (String)

    Required. The agent to list all webhooks for. Format: projects//locations// agents/.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of items to return in a single page. By default 100 and at most 1000.

  • page_token (String) (defaults to: nil)

    The next_page_token value returned from a previous list request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 5586

def list_project_location_agent_webhooks(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+parent}/webhooks', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListWebhooksResponse::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListWebhooksResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_agents(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListAgentsResponse

Returns the list of all agents in the specified location.

Parameters:

  • parent (String)

    Required. The location to list all agents for. Format: projects//locations/.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of items to return in a single page. By default 100 and at most 1000.

  • page_token (String) (defaults to: nil)

    The next_page_token value returned from a previous list request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



356
357
358
359
360
361
362
363
364
365
366
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 356

def list_project_location_agents(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+parent}/agents', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListAgentsResponse::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListAgentsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 5732

def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_security_settings(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListSecuritySettingsResponse

Returns the list of all security settings in the specified location.

Parameters:

  • parent (String)

    Required. The location to list all security settings for. Format: projects// locations/.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of items to return in a single page. By default 20 and at most 100.

  • page_token (String) (defaults to: nil)

    The next_page_token value returned from a previous list request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 5868

def list_project_location_security_settings(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+parent}/securitySettings', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListSecuritySettingsResponse::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ListSecuritySettingsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudLocationListLocationsResponse

Lists information about the supported locations for this service.

Parameters:

  • name (String)

    The resource that owns the locations collection, if applicable.

  • filter (String) (defaults to: nil)

    A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of results to return. If not set, the service selects a default.

  • page_token (String) (defaults to: nil)

    A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



115
116
117
118
119
120
121
122
123
124
125
126
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 115

def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+name}/locations', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudLocationListLocationsResponse::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudLocationListLocationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 6015

def list_project_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#load_project_location_agent_flow_version(name, google_cloud_dialogflow_cx_v3beta1_load_version_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation

Loads resources in the specified version to the draft flow. This method is a long-running operation. The returned Operation type has the following method- specific fields: - metadata: An empty Struct message - response : An Empty message

Parameters:

  • name (String)

    Required. The Version to be loaded to draft flow. Format: projects//locations/ /agents//flows//versions/.

  • google_cloud_dialogflow_cx_v3beta1_load_version_request_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1LoadVersionRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 3068

def load_project_location_agent_flow_version(name, google_cloud_dialogflow_cx_v3beta1_load_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+name}:load', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1LoadVersionRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_load_version_request_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#lookup_project_location_agent_environment_environment_history(name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1LookupEnvironmentHistoryResponse

Looks up the history of the specified Environment.

Parameters:

  • name (String)

    Required. Resource name of the environment to look up the history for. Format: projects//locations//agents//environments/.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of items to return in a single page. By default 100 and at most 1000.

  • page_token (String) (defaults to: nil)

    The next_page_token value returned from a previous list request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 1198

def lookup_project_location_agent_environment_environment_history(name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3beta1/{+name}:lookupEnvironmentHistory', options)
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1LookupEnvironmentHistoryResponse::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1LookupEnvironmentHistoryResponse
  command.params['name'] = name unless name.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#match_project_location_agent_environment_session_intent(session, google_cloud_dialogflow_cx_v3beta1_match_intent_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1MatchIntentResponse

Returns preliminary intent match results, doesn't change the session status.

Parameters:

  • session (String)

    Required. The name of the session this query is sent to. Format: projects// locations//agents//sessions/ or projects//locations//agents//environments// sessions/. If Environment ID is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate Session ID. It can be a random number or some type of session identifiers (preferably hashed). The length of the Session ID must not exceed 36 characters. For more information, see the sessions guide.

  • google_cloud_dialogflow_cx_v3beta1_match_intent_request_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1MatchIntentRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 1752

def match_project_location_agent_environment_session_intent(session, google_cloud_dialogflow_cx_v3beta1_match_intent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+session}:matchIntent', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1MatchIntentRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_match_intent_request_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1MatchIntentResponse::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1MatchIntentResponse
  command.params['session'] = session unless session.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#match_project_location_agent_session_intent(session, google_cloud_dialogflow_cx_v3beta1_match_intent_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1MatchIntentResponse

Returns preliminary intent match results, doesn't change the session status.

Parameters:

  • session (String)

    Required. The name of the session this query is sent to. Format: projects// locations//agents//sessions/ or projects//locations//agents//environments// sessions/. If Environment ID is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate Session ID. It can be a random number or some type of session identifiers (preferably hashed). The length of the Session ID must not exceed 36 characters. For more information, see the sessions guide.

  • google_cloud_dialogflow_cx_v3beta1_match_intent_request_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1MatchIntentRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 4299

def match_project_location_agent_session_intent(session, google_cloud_dialogflow_cx_v3beta1_match_intent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+session}:matchIntent', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1MatchIntentRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_match_intent_request_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1MatchIntentResponse::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1MatchIntentResponse
  command.params['session'] = session unless session.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_agent(name, google_cloud_dialogflow_cx_v3beta1_agent_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Agent

Updates the specified agent. Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters:

  • name (String)

    The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: projects// locations//agents/.

  • google_cloud_dialogflow_cx_v3beta1_agent_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Agent) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    The mask to control which fields get updated. If the mask is not present, all fields will be updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



396
397
398
399
400
401
402
403
404
405
406
407
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 396

def patch_project_location_agent(name, google_cloud_dialogflow_cx_v3beta1_agent_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Agent::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_agent_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Agent::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Agent
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_agent_entity_type(name, google_cloud_dialogflow_cx_v3beta1_entity_type_object = nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1EntityType

Updates the specified entity type. Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters:

  • name (String)

    The unique identifier of the entity type. Required for EntityTypes. UpdateEntityType. Format: projects//locations//agents//entityTypes/.

  • google_cloud_dialogflow_cx_v3beta1_entity_type_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1EntityType) (defaults to: nil)
  • language_code (String) (defaults to: nil)

    The language of the following fields in entity_type: * EntityType.entities. value * EntityType.entities.synonyms * EntityType.excluded_phrases.value If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

  • update_mask (String) (defaults to: nil)

    The mask to control which fields get updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



982
983
984
985
986
987
988
989
990
991
992
993
994
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 982

def patch_project_location_agent_entity_type(name, google_cloud_dialogflow_cx_v3beta1_entity_type_object = nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1EntityType::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_entity_type_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1EntityType::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1EntityType
  command.params['name'] = name unless name.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_agent_environment(name, google_cloud_dialogflow_cx_v3beta1_environment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation

Updates the specified Environment. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: Environment

Parameters:

  • name (String)

    The name of the environment. Format: projects//locations//agents// environments/.

  • google_cloud_dialogflow_cx_v3beta1_environment_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Environment) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. The mask to control which fields get updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 1238

def patch_project_location_agent_environment(name, google_cloud_dialogflow_cx_v3beta1_environment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Environment::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_environment_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_agent_environment_experiment(name, google_cloud_dialogflow_cx_v3beta1_experiment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Experiment

Updates the specified Experiment.

Parameters:

  • name (String)

    The name of the experiment. Format: projects//locations//agents//environments// experiments/.

  • google_cloud_dialogflow_cx_v3beta1_experiment_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Experiment) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. The mask to control which fields get updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 1553

def patch_project_location_agent_environment_experiment(name, google_cloud_dialogflow_cx_v3beta1_experiment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Experiment::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_experiment_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Experiment::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Experiment
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_agent_environment_session_entity_type(name, google_cloud_dialogflow_cx_v3beta1_session_entity_type_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SessionEntityType

Updates the specified session entity type.

Parameters:

  • name (String)

    Required. The unique identifier of the session entity type. Format: projects// locations//agents//sessions//entityTypes/ or projects//locations//agents// environments//sessions//entityTypes/. If Environment ID is not specified, we assume default 'draft' environment.

  • google_cloud_dialogflow_cx_v3beta1_session_entity_type_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SessionEntityType) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    The mask to control which fields get updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 1977

def patch_project_location_agent_environment_session_entity_type(name, google_cloud_dialogflow_cx_v3beta1_session_entity_type_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SessionEntityType::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_session_entity_type_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SessionEntityType::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SessionEntityType
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_agent_flow(name, google_cloud_dialogflow_cx_v3beta1_flow_object = nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Flow

Updates the specified flow. Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters:

  • name (String)

    The unique identifier of the flow. Format: projects//locations//agents//flows/ .

  • google_cloud_dialogflow_cx_v3beta1_flow_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Flow) (defaults to: nil)
  • language_code (String) (defaults to: nil)

    The language of the following fields in flow: * Flow.event_handlers. trigger_fulfillment.messages * Flow.event_handlers.trigger_fulfillment. conditional_cases * Flow.transition_routes.trigger_fulfillment.messages * Flow.transition_routes.trigger_fulfillment.conditional_cases If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

  • update_mask (String) (defaults to: nil)

    The mask to control which fields get updated. If the mask is not present, all fields will be updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 2314

def patch_project_location_agent_flow(name, google_cloud_dialogflow_cx_v3beta1_flow_object = nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Flow::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_flow_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Flow::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Flow
  command.params['name'] = name unless name.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_agent_flow_page(name, google_cloud_dialogflow_cx_v3beta1_page_object = nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Page

Updates the specified page.

Parameters:

  • name (String)

    The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: projects// locations//agents//flows//pages/.

  • google_cloud_dialogflow_cx_v3beta1_page_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Page) (defaults to: nil)
  • language_code (String) (defaults to: nil)

    The language of the following fields in page: * Page.entry_fulfillment. messages * Page.entry_fulfillment.conditional_cases * Page.event_handlers. trigger_fulfillment.messages * Page.event_handlers.trigger_fulfillment. conditional_cases * Page.form.parameters.fill_behavior. initial_prompt_fulfillment.messages * Page.form.parameters.fill_behavior. initial_prompt_fulfillment.conditional_cases * Page.form.parameters. fill_behavior.reprompt_event_handlers.messages * Page.form.parameters. fill_behavior.reprompt_event_handlers.conditional_cases * Page. transition_routes.trigger_fulfillment.messages * Page.transition_routes. trigger_fulfillment.conditional_cases If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

  • update_mask (String) (defaults to: nil)

    The mask to control which fields get updated. If the mask is not present, all fields will be updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 2631

def patch_project_location_agent_flow_page(name, google_cloud_dialogflow_cx_v3beta1_page_object = nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Page::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_page_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Page::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Page
  command.params['name'] = name unless name.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_agent_flow_transition_route_group(name, google_cloud_dialogflow_cx_v3beta1_transition_route_group_object = nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TransitionRouteGroup

Updates the specified TransitionRouteGroup. Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters:

  • name (String)

    The unique identifier of the transition route group. TransitionRouteGroups. CreateTransitionRouteGroup populates the name automatically. Format: projects/ /locations//agents//flows//transitionRouteGroups/ or projects//locations// agents//transitionRouteGroups/ for agent-level groups.

  • google_cloud_dialogflow_cx_v3beta1_transition_route_group_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TransitionRouteGroup) (defaults to: nil)
  • language_code (String) (defaults to: nil)

    The language of the following fields in TransitionRouteGroup: * TransitionRouteGroup.transition_routes.trigger_fulfillment.messages * TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

  • update_mask (String) (defaults to: nil)

    The mask to control which fields get updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 2854

def patch_project_location_agent_flow_transition_route_group(name, google_cloud_dialogflow_cx_v3beta1_transition_route_group_object = nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TransitionRouteGroup::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_transition_route_group_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TransitionRouteGroup::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TransitionRouteGroup
  command.params['name'] = name unless name.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_agent_flow_version(name, google_cloud_dialogflow_cx_v3beta1_version_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Version

Updates the specified Version.

Parameters:

  • name (String)

    Format: projects//locations//agents//flows//versions/. Version ID is a self- increasing number generated by Dialogflow upon version creation.

  • google_cloud_dialogflow_cx_v3beta1_version_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Version) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. The mask to control which fields get updated. Currently only description and display_name can be updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 3105

def patch_project_location_agent_flow_version(name, google_cloud_dialogflow_cx_v3beta1_version_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Version::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_version_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Version::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Version
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_agent_generator(name, google_cloud_dialogflow_cx_v3beta1_generator_object = nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Generator

Update the specified generator.

Parameters:

  • name (String)

    The unique identifier of the generator. Must be set for the Generators. UpdateGenerator method. Generators.CreateGenerate populates the name automatically. Format: projects//locations//agents//generators/.

  • google_cloud_dialogflow_cx_v3beta1_generator_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Generator) (defaults to: nil)
  • language_code (String) (defaults to: nil)

    The language to list generators for.

  • update_mask (String) (defaults to: nil)

    The mask to control which fields get updated. If the mask is not present, all fields will be updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 3297

def patch_project_location_agent_generator(name, google_cloud_dialogflow_cx_v3beta1_generator_object = nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Generator::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_generator_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Generator::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Generator
  command.params['name'] = name unless name.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_agent_intent(name, google_cloud_dialogflow_cx_v3beta1_intent_object = nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Intent

Updates the specified intent. Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters:

  • name (String)

    The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: projects//locations//agents//intents/.

  • google_cloud_dialogflow_cx_v3beta1_intent_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Intent) (defaults to: nil)
  • language_code (String) (defaults to: nil)

    The language of the following fields in intent: * Intent.training_phrases. parts.text If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

  • update_mask (String) (defaults to: nil)

    The mask to control which fields get updated. If the mask is not present, all fields will be updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 3582

def patch_project_location_agent_intent(name, google_cloud_dialogflow_cx_v3beta1_intent_object = nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Intent::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_intent_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Intent::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Intent
  command.params['name'] = name unless name.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_agent_playbook(name, google_cloud_dialogflow_cx_v3beta1_playbook_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook

Updates the specified Playbook.

Parameters:

  • name (String)

    The unique identifier of the playbook. Format: projects//locations//agents// playbooks/.

  • google_cloud_dialogflow_cx_v3beta1_playbook_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    The mask to control which fields get updated. If the mask is not present, all fields will be updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 3824

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)
  command = make_simple_command(:patch, 'v3beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_playbook_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Playbook
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#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) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example

Update the specified example.

Parameters:

  • name (String)

    The unique identifier of the playbook example. Format: projects//locations// agents//playbooks//examples/.

  • google_cloud_dialogflow_cx_v3beta1_example_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Optional. The mask to control which fields get updated. If the mask is not present, all fields will be updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 4001

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)
  command = make_simple_command(:patch, 'v3beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_example_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Example
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_agent_session_entity_type(name, google_cloud_dialogflow_cx_v3beta1_session_entity_type_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SessionEntityType

Updates the specified session entity type.

Parameters:

  • name (String)

    Required. The unique identifier of the session entity type. Format: projects// locations//agents//sessions//entityTypes/ or projects//locations//agents// environments//sessions//entityTypes/. If Environment ID is not specified, we assume default 'draft' environment.

  • google_cloud_dialogflow_cx_v3beta1_session_entity_type_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SessionEntityType) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    The mask to control which fields get updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 4558

def patch_project_location_agent_session_entity_type(name, google_cloud_dialogflow_cx_v3beta1_session_entity_type_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SessionEntityType::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_session_entity_type_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SessionEntityType::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SessionEntityType
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_agent_test_case(name, google_cloud_dialogflow_cx_v3beta1_test_case_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TestCase

Updates the specified test case.

Parameters:

  • name (String)

    The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: projects//locations//agents// testCases/.

  • google_cloud_dialogflow_cx_v3beta1_test_case_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TestCase) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. The mask to specify which fields should be updated. The creationTime and lastTestResult cannot be updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 4887

def patch_project_location_agent_test_case(name, google_cloud_dialogflow_cx_v3beta1_test_case_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TestCase::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_test_case_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TestCase::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TestCase
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_agent_tool(name, google_cloud_dialogflow_cx_v3beta1_tool_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool

Update the specified Tool.

Parameters:

  • name (String)

    The unique identifier of the Tool. Format: projects//locations//agents//tools/ .

  • google_cloud_dialogflow_cx_v3beta1_tool_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    The mask to control which fields get updated. If the mask is not present, all fields will be updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 5220

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)
  command = make_simple_command(:patch, 'v3beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_tool_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Tool
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_agent_transition_route_group(name, google_cloud_dialogflow_cx_v3beta1_transition_route_group_object = nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TransitionRouteGroup

Updates the specified TransitionRouteGroup. Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters:

  • name (String)

    The unique identifier of the transition route group. TransitionRouteGroups. CreateTransitionRouteGroup populates the name automatically. Format: projects/ /locations//agents//flows//transitionRouteGroups/ or projects//locations// agents//transitionRouteGroups/ for agent-level groups.

  • google_cloud_dialogflow_cx_v3beta1_transition_route_group_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TransitionRouteGroup) (defaults to: nil)
  • language_code (String) (defaults to: nil)

    The language of the following fields in TransitionRouteGroup: * TransitionRouteGroup.transition_routes.trigger_fulfillment.messages * TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

  • update_mask (String) (defaults to: nil)

    The mask to control which fields get updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 5442

def patch_project_location_agent_transition_route_group(name, google_cloud_dialogflow_cx_v3beta1_transition_route_group_object = nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TransitionRouteGroup::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_transition_route_group_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TransitionRouteGroup::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TransitionRouteGroup
  command.params['name'] = name unless name.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_agent_webhook(name, google_cloud_dialogflow_cx_v3beta1_webhook_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Webhook

Updates the specified webhook.

Parameters:

  • name (String)

    The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: projects//locations//agents//webhooks/.

  • google_cloud_dialogflow_cx_v3beta1_webhook_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Webhook) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    The mask to control which fields get updated. If the mask is not present, all fields will be updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 5624

def patch_project_location_agent_webhook(name, google_cloud_dialogflow_cx_v3beta1_webhook_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Webhook::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_webhook_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Webhook::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Webhook
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_security_setting(name, google_cloud_dialogflow_cx_v3beta1_security_settings_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SecuritySettings

Updates the specified SecuritySettings.

Parameters:

  • name (String)

    Resource name of the settings. Required for the SecuritySettingsService. UpdateSecuritySettings method. SecuritySettingsService.CreateSecuritySettings populates the name automatically. Format: projects//locations// securitySettings/.

  • google_cloud_dialogflow_cx_v3beta1_security_settings_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SecuritySettings) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. The mask to control which fields get updated. If the mask is not present, all fields will be updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 5907

def patch_project_location_security_setting(name, google_cloud_dialogflow_cx_v3beta1_security_settings_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SecuritySettings::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_security_settings_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SecuritySettings::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SecuritySettings
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#restore_project_location_agent(name, google_cloud_dialogflow_cx_v3beta1_restore_agent_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation

Restores the specified agent from a binary file. Replaces the current agent with a new one. Note that all existing resources in agent (e.g. intents, entity types, flows) will be removed. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: An Empty message Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters:

  • name (String)

    Required. The name of the agent to restore into. Format: projects//locations// agents/.

  • google_cloud_dialogflow_cx_v3beta1_restore_agent_request_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1RestoreAgentRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



441
442
443
444
445
446
447
448
449
450
451
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 441

def restore_project_location_agent(name, google_cloud_dialogflow_cx_v3beta1_restore_agent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+name}:restore', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1RestoreAgentRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_restore_agent_request_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#restore_project_location_agent_playbook_version(name, google_cloud_dialogflow_cx_v3beta1_restore_playbook_version_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1RestorePlaybookVersionResponse

Retrieves the specified version of the Playbook and stores it as the current playbook draft, returning the playbook with resources updated.

Parameters:

  • name (String)

    Required. The name of the playbook version. Format: projects//locations// agents//playbooks//versions/.

  • google_cloud_dialogflow_cx_v3beta1_restore_playbook_version_request_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1RestorePlaybookVersionRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 4171

def restore_project_location_agent_playbook_version(name, google_cloud_dialogflow_cx_v3beta1_restore_playbook_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+name}:restore', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1RestorePlaybookVersionRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_restore_playbook_version_request_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1RestorePlaybookVersionResponse::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1RestorePlaybookVersionResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#run_project_location_agent_environment_continuous_test(environment, google_cloud_dialogflow_cx_v3beta1_run_continuous_test_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation

Kicks off a continuous test under the specified Environment. This method is a long-running operation. The returned Operation type has the following method- specific fields: - metadata: RunContinuousTestMetadata - response: RunContinuousTestResponse

Parameters:

  • environment (String)

    Required. Format: projects//locations//agents//environments/.

  • google_cloud_dialogflow_cx_v3beta1_run_continuous_test_request_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1RunContinuousTestRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 1276

def run_project_location_agent_environment_continuous_test(environment, google_cloud_dialogflow_cx_v3beta1_run_continuous_test_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+environment}:runContinuousTest', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1RunContinuousTestRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_run_continuous_test_request_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation
  command.params['environment'] = environment unless environment.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#run_project_location_agent_test_case(name, google_cloud_dialogflow_cx_v3beta1_run_test_case_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation

Kicks off a test case run. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: RunTestCaseMetadata - response: RunTestCaseResponse

Parameters:

  • name (String)

    Required. Format of test case name to run: projects//locations//agents// testCases/.

  • google_cloud_dialogflow_cx_v3beta1_run_test_case_request_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1RunTestCaseRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 4925

def run_project_location_agent_test_case(name, google_cloud_dialogflow_cx_v3beta1_run_test_case_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+name}:run', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1RunTestCaseRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_run_test_case_request_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#server_project_location_agent_environment_session_streaming_detect_intent(session, google_cloud_dialogflow_cx_v3beta1_detect_intent_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1DetectIntentResponse

Processes a natural language query and returns structured, actionable data as a result through server-side streaming. Server-side streaming allows Dialogflow to send partial responses earlier in a single request.

Parameters:

  • session (String)

    Required. The name of the session this query is sent to. Format: projects// locations//agents//sessions/ or projects//locations//agents//environments// sessions/. If Environment ID is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate Session ID. It can be a random number or some type of session identifiers (preferably hashed). The length of the Session ID must not exceed 36 characters. For more information, see the sessions guide. Note: Always use agent versions for production traffic. See Versions and environments.

  • google_cloud_dialogflow_cx_v3beta1_detect_intent_request_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1DetectIntentRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 1797

def server_project_location_agent_environment_session_streaming_detect_intent(session, google_cloud_dialogflow_cx_v3beta1_detect_intent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+session}:serverStreamingDetectIntent', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1DetectIntentRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_detect_intent_request_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1DetectIntentResponse::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1DetectIntentResponse
  command.params['session'] = session unless session.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#server_project_location_agent_session_streaming_detect_intent(session, google_cloud_dialogflow_cx_v3beta1_detect_intent_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1DetectIntentResponse

Processes a natural language query and returns structured, actionable data as a result through server-side streaming. Server-side streaming allows Dialogflow to send partial responses earlier in a single request.

Parameters:

  • session (String)

    Required. The name of the session this query is sent to. Format: projects// locations//agents//sessions/ or projects//locations//agents//environments// sessions/. If Environment ID is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate Session ID. It can be a random number or some type of session identifiers (preferably hashed). The length of the Session ID must not exceed 36 characters. For more information, see the sessions guide. Note: Always use agent versions for production traffic. See Versions and environments.

  • google_cloud_dialogflow_cx_v3beta1_detect_intent_request_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1DetectIntentRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 4344

def server_project_location_agent_session_streaming_detect_intent(session, google_cloud_dialogflow_cx_v3beta1_detect_intent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+session}:serverStreamingDetectIntent', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1DetectIntentRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_detect_intent_request_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1DetectIntentResponse::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1DetectIntentResponse
  command.params['session'] = session unless session.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#start_project_location_agent_environment_experiment(name, google_cloud_dialogflow_cx_v3beta1_start_experiment_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Experiment

Starts the specified Experiment. This rpc only changes the state of experiment from PENDING to RUNNING.

Parameters:

  • name (String)

    Required. Resource name of the experiment to start. Format: projects// locations//agents//environments//experiments/.

  • google_cloud_dialogflow_cx_v3beta1_start_experiment_request_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1StartExperimentRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 1589

def start_project_location_agent_environment_experiment(name, google_cloud_dialogflow_cx_v3beta1_start_experiment_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+name}:start', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1StartExperimentRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_start_experiment_request_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Experiment::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Experiment
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#stop_project_location_agent_environment_experiment(name, google_cloud_dialogflow_cx_v3beta1_stop_experiment_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Experiment

Stops the specified Experiment. This rpc only changes the state of experiment from RUNNING to DONE.

Parameters:

  • name (String)

    Required. Resource name of the experiment to stop. Format: projects// locations//agents//environments//experiments/.

  • google_cloud_dialogflow_cx_v3beta1_stop_experiment_request_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1StopExperimentRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 1624

def stop_project_location_agent_environment_experiment(name, google_cloud_dialogflow_cx_v3beta1_stop_experiment_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+name}:stop', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1StopExperimentRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_stop_experiment_request_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Experiment::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Experiment
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#submit_project_location_agent_session_answer_feedback(session, google_cloud_dialogflow_cx_v3beta1_submit_answer_feedback_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1AnswerFeedback

Updates the feedback received from the user for a single turn of the bot response.

Parameters:

  • session (String)

    Required. The name of the session the feedback was sent to.

  • google_cloud_dialogflow_cx_v3beta1_submit_answer_feedback_request_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SubmitAnswerFeedbackRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 4378

def submit_project_location_agent_session_answer_feedback(session, google_cloud_dialogflow_cx_v3beta1_submit_answer_feedback_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+session}:submitAnswerFeedback', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SubmitAnswerFeedbackRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_submit_answer_feedback_request_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1AnswerFeedback::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1AnswerFeedback
  command.params['session'] = session unless session.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#train_project_location_agent_flow(name, google_cloud_dialogflow_cx_v3beta1_train_flow_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation

Trains the specified flow. Note that only the flow in 'draft' environment is trained. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: An Empty message Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters:

  • name (String)

    Required. The flow to train. Format: projects//locations//agents//flows/.

  • google_cloud_dialogflow_cx_v3beta1_train_flow_request_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TrainFlowRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 2357

def train_project_location_agent_flow(name, google_cloud_dialogflow_cx_v3beta1_train_flow_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+name}:train', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TrainFlowRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_train_flow_request_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_project_location_agent_generative_settings(name, google_cloud_dialogflow_cx_v3beta1_generative_settings_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1GenerativeSettings

Updates the generative settings for the agent.

Parameters:

  • name (String)

    Format: projects//locations//agents//generativeSettings.

  • google_cloud_dialogflow_cx_v3beta1_generative_settings_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1GenerativeSettings) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Optional. The mask to control which fields get updated. If the mask is not present, all fields will be updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



477
478
479
480
481
482
483
484
485
486
487
488
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 477

def update_project_location_agent_generative_settings(name, google_cloud_dialogflow_cx_v3beta1_generative_settings_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1GenerativeSettings::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_generative_settings_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1GenerativeSettings::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1GenerativeSettings
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#validate_project_location_agent(name, google_cloud_dialogflow_cx_v3beta1_validate_agent_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1AgentValidationResult

Validates the specified agent and creates or updates validation results. The agent in draft version is validated. Please call this API after the training is completed to get the complete validation results.

Parameters:

  • name (String)

    Required. The agent to validate. Format: projects//locations//agents/.

  • google_cloud_dialogflow_cx_v3beta1_validate_agent_request_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ValidateAgentRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



513
514
515
516
517
518
519
520
521
522
523
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 513

def validate_project_location_agent(name, google_cloud_dialogflow_cx_v3beta1_validate_agent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+name}:validate', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ValidateAgentRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_validate_agent_request_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1AgentValidationResult::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1AgentValidationResult
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#validate_project_location_agent_flow(name, google_cloud_dialogflow_cx_v3beta1_validate_flow_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1FlowValidationResult

Validates the specified flow and creates or updates validation results. Please call this API after the training is completed to get the complete validation results.

Parameters:

  • name (String)

    Required. The flow to validate. Format: projects//locations//agents//flows/.

  • google_cloud_dialogflow_cx_v3beta1_validate_flow_request_object (Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ValidateFlowRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
# File 'lib/google/apis/dialogflow_v3beta1/service.rb', line 2392

def validate_project_location_agent_flow(name, google_cloud_dialogflow_cx_v3beta1_validate_flow_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3beta1/{+name}:validate', options)
  command.request_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ValidateFlowRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3beta1_validate_flow_request_object
  command.response_representation = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1FlowValidationResult::Representation
  command.response_class = Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1FlowValidationResult
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end